Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create new notice for missing shapes.txt file #1275

Open
owades opened this issue Oct 17, 2022 · 3 comments
Open

Create new notice for missing shapes.txt file #1275

owades opened this issue Oct 17, 2022 · 3 comments
Labels
community rules This is used for Out of Spec / Out of Best Practice rules that we'd like to include in the validator new rule New rule to be added status: Blocked Can't work on it currently because of an external factor. status: Needs discussion We need a discussion on requirements before calling this issue ready

Comments

@owades
Copy link

owades commented Oct 17, 2022

Describe the problem

Per the California Minimum General Transit Feed Specification (GTFS) Guidelines, the file shapes.txt is required for all GTFS schedule feeds. We don't yet have a validation rule that checks for the file's presence.

Describe the new validation rule

I can think of two options:

  1. Go through the process of making shapes.txt a "required file", so it will be caught with the missing_required_file error
  2. Create a new warning called missing_shapes_file, which appears whenever the file is not present for a given feed.

Sample GTFS datasets

No response

Severity

Warning

Additional context

No response

@isabelle-dr
Copy link
Contributor

Hello @owades, thanks for opening this issue!

This validator "only" validates according to the official specification, and GTFS Best Practices. We would like to offer users the possibility to set up their own criteria easily, so they can evaluate feeds according to what matters to them, and they can share their criteria with others in a more efficient way. There is ongoing work to support this, and the discussion is happening in issue #1067. Cal-ITP's GTFS Guidelines are actually used as a use case!
@asvechnikov2 at Google proposed a modification of the validator to support this, feel free to have a look at it, it is linked below in the same issue.

So one option that is not listed here will be to add this check as part of future Cal-ITP's set of rules when this functionality will be released. 😊

About the two options you proposed:

Go through the process of making shapes.txt a "required file", so it will be caught with the missing_required_file error

Making this file Required in the specification would break backward compatibility (feeds previously valid becoming invalid), which is one of the core principles in GTFS.

Create a new warning called missing_shapes_file, which appears whenever the file is not present for a given feed.

If this was added to the Best Practices first, we could add this check as part of the canonical set of rules. Here is a link to the amendment process if you'd like to try that route.

@isabelle-dr isabelle-dr added status: Needs discussion We need a discussion on requirements before calling this issue ready and removed status: Needs triage Applied to all new issues labels Nov 3, 2022
@isabelle-dr isabelle-dr added community rules This is used for Out of Spec / Out of Best Practice rules that we'd like to include in the validator status: Blocked Can't work on it currently because of an external factor. labels Nov 3, 2022
@isabelle-dr
Copy link
Contributor

Labeling as blocked, this rule can be added if either:

@owades
Copy link
Author

owades commented Nov 3, 2022

Thanks for the helpful explanation, @isabelle-dr! I believe we will eventually try to take the amendment route.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community rules This is used for Out of Spec / Out of Best Practice rules that we'd like to include in the validator new rule New rule to be added status: Blocked Can't work on it currently because of an external factor. status: Needs discussion We need a discussion on requirements before calling this issue ready
Projects
None yet
Development

No branches or pull requests

2 participants