search

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

Update the `rate` attribute within the rate object to be `rate_in_cents` #106

Open michael-danko-passport opened 2 years ago

michael-danko-passport commented 2 years ago

Is your feature request related to a problem? Please describe.

While discussiing #103 in the 7/26 CDS WG meeting, we highlighted that within the rate object, we have a field called rate. This can be confusing to API documentation consumers since the rate field within the rate object represents a subset of information and not the entirety of a rate.

Describe the solution you'd like

Since the rate field within the rate object does not entirely describe what a rate is, it would be more clearer to rename the field rate_in_cents.

Is this a breaking change

Yes this would be a breaking change.

Impacted Spec

For which spec is this feature being requested?

schnuerle commented 1 year ago

We need to keep the names international and not all counties use cents as their base unit. I agree it's a bit confusing to have a rate field in a rate object, but It's not too bad and we do it elsewhere in MDS I believe. But we could come up with a more universal but clear field name, like rate_amount or rate_sub_unit. Most counties have sub units of 100, though a few have it based on 10s or 1000s.

schnuerle commented 4 months ago

This came up tangentially in Issue https://github.com/openmobilityfoundation/curb-data-specification/issues/120 and latest comment has MDS links.