rename attribute "rate" in Rule object into "rates"

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

rename attribute "rate" in Rule object into "rates" #103

Open lecuretFlowbird opened 2 years ago

lecuretFlowbird commented 2 years ago

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

Attribute "rate" is ambiguous because it is used in Rate object to describe a single integer value but object Rule also use it to named an array of object Rate.

Describe the solution you'd like

A better solution could be that attribute in Rule object to be changed to "rates" (in plural like "user_classes")

Is this a breaking change

Yes, breaking

Impacted Spec

Curbs

michael-danko-passport commented 2 years ago

I believe @lecuretFlowbird is correct that this can be misleading. While this would be a breaking change, I think we may also want to consider similar clarification outlined within #106