Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace unknown state #814

Merged

Conversation

jean-populus
Copy link
Collaborator


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

  • Yes, breaking

Impacted Spec

Which spec(s) will this pull request impact?

  • agency
  • policy
  • provider

Additional context

Issue was discussed in multiple MDS Planning meetings. PR was created based on this proposal - #749 (comment).

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

Replaced 'unknown' with 'non-contactable' and 'missing' in the Vehicles States table to be clearer about the transition from Yes PROW -> No PROW as discussed in openmobilityfoundation#749.

Changed explanatory paragraph on 'unknown' to instead describe use of 'non-contactable' and 'missing'.

Open Question: should MDS recommend a specific time limit for the transition from 'non-contactable' to 'missing' if the city does not have an SLA around this?
Changed 'missing' to 'not_located' since there's a new vehicle state for 'missing'. Clarified 'located' to match. See openmobilityfoundation#749 (comment)
Replaced 'unknown' state with new 'non_contactable' along with associated event types in the transitions.

Note: event types included 'located' and 'missing' but this isn't in the transitions table. If they are to be included then need to add 'missing' vehicle state and modify event type to 'not_located'.
Replaced 'unknown' state with new 'non_contactable' along with associated event types in the transitions.
Replaced 'unknown' state with new 'non_contactable' along with associated event types in the transitions.
Replaced 'unknown' state with new 'non_contactable' and 'missing' along with associated event types in the transitions.
Updated transitions so that only 'non_contactable' -> 'missing', but 'missing' -> any state
Added Missing state and transitions. Cleaned up some other transitions where noticed dupes or missing.
@jean-populus jean-populus requested a review from a team as a code owner December 16, 2022 20:49
@CLAassistant
Copy link

CLAassistant commented Dec 16, 2022

CLA assistant check
All committers have signed the CLA.

@schnuerle schnuerle added this to the 2.0.0 milestone Dec 19, 2022
@schnuerle schnuerle added Provider Specific to the Provider API Agency Specific to the Agency API Policy Specific to the Policy API labels Dec 19, 2022
@schnuerle schnuerle requested a review from marie-x December 19, 2022 14:23
Updated micromobility state diagram to remove 'unknown' state and replace with 'non-contactable' and 'missing' states
@schnuerle
Copy link
Member

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.

@schnuerle schnuerle merged commit 570245d into openmobilityfoundation:dev Jan 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Agency Specific to the Agency API Policy Specific to the Policy API Provider Specific to the Provider API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants