openmobilityfoundation / mobility-data-specification

A data standard to enable right-of-way regulation and two-way communication between mobility companies and local governments.
https://www.openmobilityfoundation.org/about-mds/
Other
676 stars 232 forks source link

Replace unknown state #814

Closed jean-populus closed 1 year ago

jean-populus commented 1 year ago

name: Replace unknown state about: Replace unknown state with two new states so that vehicles can definitely be yes/no in PROW. title: Replace unknown state


MDS Pull Request

Thank you for your contribution! Please review our OMF contributing page to understand guidelines and policies for participation, and our Code of Conduct page.

To avoid complications and help make the Review process as smooth as possible, make sure to:

  1. Target dev branch. Please ensure you are targeting dev, not main.
  2. Keep the "Allow edits from maintainers" button checked to help us resolve some issues for you.
  3. Be ready to resolve any merge conflicts before we approve your Pull Request.
  4. Have an up to date profile, per our Github community profile guildance.

Explain pull request

Replacing unknown state which is maybe PROW with new states - non_contactable which is yes PROW, and missing which is no PROW.

Is this a breaking change

A breaking change would require consumers or implementors of the 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

Which spec(s) will this pull request impact?

Additional context

Issue was discussed in multiple MDS Planning meetings. PR was created based on this proposal - https://github.com/openmobilityfoundation/mobility-data-specification/issues/749#issuecomment-1267459795.

Still open is whether MDS wants to recommend a transition time limit fromnon-contactable to missing state.

CLAassistant commented 1 year ago

CLA assistant check
All committers have signed the CLA.

schnuerle commented 1 year ago

I'm going to merge to dev and hopefully any issues with this tedious work will come out during the release candidate review.

Also a note to me to update the micromobility SVG file and point to it when doing that state machine work.