curb-data-specification
curb-data-specification copied to clipboard
openmobilityfoundation
Clarify `street name` field description
Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
It's unclear in the documentation whether the street_name field is allowed to contain the actual street address of the zone. Ex: Is "438 N Center St" compliant? Or is street_name meant to literally contain just the street name (e.g. "Center St")
Describe the solution you'd like
A clear and concise description of what you want to happen.
Either scenario is fine, the documentation just doesn't seem explicit.
Is this a breaking change
A breaking change would require consumers or implementors of an API to modify their code for it to continue to function (ex: renaming of a required field or the change in data type of an existing field). A non-breaking change would allow existing code to continue to function (ex: addition of an optional field or the creation of a new optional endpoint).
- Yes, breaking
- No, not breaking
- I'm not sure<<this one
Impacted Spec
For which spec is this feature being requested?
Curbs<<this oneEventsMetrics
Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.
Additional context
Add any other context or screenshots about the feature request here.
Again, not sure if this is the right method to ask questions and happy to remove these issues if that's the case
It is meant to be just the street name, eg "Center St". But I don't see the harm in using an address if warranted as this field is a bit more for informational purposes. Though I suspect most zones would span more than one address, maybe there are cases for defining the specific address, which could help maybe clarify which side of a street a zone is at?
My interpretation of this is that it's only the name of the street, so "N Center St" would be valid, but the example "438 N Center St" would not. If there's a use case requiring the street number it could be redefined, or we could add a street_number field. GBFS has a stations[].address field which combines the two.
Does the language change here address your concerns @MirandaBradshawPassport ? From @mplsmitch #139 pull request.
The name of the street that this Curb Zone is on, including directionals. SHOULD NOT contain address numbers. Example:
Main Street NE