openmobilityfoundation / curb-data-specification

A data specification to help cities manage their curb zone programs and surrounding areas, and measure the utilization and impact.
https://www.openmobilityfoundation.org/about-cds/
Other
47 stars 18 forks source link

Clarify `street name` field description #128

Open MirandaBradshawPassport opened 9 months ago

MirandaBradshawPassport commented 9 months ago

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).

Impacted Spec

For which spec is this feature being requested?

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.

MirandaBradshawPassport commented 9 months ago

Again, not sure if this is the right method to ask questions and happy to remove these issues if that's the case

schnuerle commented 4 months ago

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?

mplsmitch commented 4 months ago

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.

schnuerle commented 4 months ago

I think we should just clarify this in the 1.0.1 patch release.

schnuerle commented 4 months ago

Could someone make a PR for this please?

schnuerle commented 2 months ago

@mplsmitch can you make a PR for this please?

schnuerle commented 2 months ago

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