Add name and desciption fields to policy & rule#175
Add name and desciption fields to policy & rule#175schnuerle merged 1 commit intoopenmobilityfoundation:devfrom
Conversation
Add name and description fields to the policy and policy rule schemas so that users can provide a human-readable name. At the moment there's nothing to easily distinguish a policy to a human user.
|
Is there a way we can pass this attribute to the Curb Zones/Spaces/Areas the policy applies to, in addition to the Curb Policy ID. |
@jacobmalleau I don't think we want to duplicate this data across different endpoints. That's a big reason it's split out this way, to avoid duplication. @jiffyclub what do you think? |
|
I agree that this information shouldn't be duplicated around within MDS, it should live in one place. I have seen use cases at Populus where cities seem to find CDS' normalized schema hard to work with, but helping with that should be part of the interface layer, not the data storage layer. |
Explain pull request
At the moment there are no fields on the curb policy and policy rule schemas that allow humans looking at the data to easily tell things apart or ID policies. This adds
nameanddescriptionfields the Policy and Rule schemas so those can be filled in with info useful to human readers. This is similar to fields already present on MDS policies and rules. I've marked these new fields as optional so that this isn't a breaking change.Is this a breaking change
Not breaking as long as the new fields are optional.
Impacted Spec
Which API(s) will this pull request impact?
CurbsAdditional context
I wonder if we may also need a field containing an arbitrary identifier from a user's system for doing round-trip matching of curb regulations, but at the moment I don't have a use case for that.