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

Adds a "missing" status to the "agency" specification. #429

Closed

Conversation

wellorder
Copy link
Contributor

Explain pull request

This PR creates a missing status as part of the agency specification. It is often the case that scooters go missing for a short period of time due to GPS issues, connectivity issues, etc. Under the current spec, this is supposed to be handled by deregistering the scooter and setting its state to removed, but this makes it difficult to distinguish scooters which have been removed by our operations people and scooters which have simply gone missing, which causes confusion when someone comes across a scooter in the wild which shows up as removed. What's more, deregistering and re-registering a scooter is more work to implement than changing the state to and from missing would be.

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

As written, this removes the missing transition to removed, which would break existing implementations that use this transition.

Impacted Spec

Which spec(s) will this pull request impact?

  • agency

Additional context

This follows up discussion in #67 and #376 (comment) . Mark said he would work on such a PR, but since I had already started on this one I figured I could post it. I was holding off until I had figured out provider changes, but I think he was right and that can be put in a separate PR.

@wellorder wellorder requested a review from a team January 16, 2020 21:15
@wellorder wellorder requested a review from a team as a code owner January 16, 2020 21:15
@marie-x
Copy link
Collaborator

marie-x commented Jan 16, 2020

Thanks @wellorder !

@marie-x
Copy link
Collaborator

marie-x commented Mar 2, 2020

Propose we fold this into the Agency/Provider reconciliation project #271

@CLAassistant
Copy link

CLA assistant check
All committers have signed the CLA.

@thekaveman
Copy link
Collaborator

missing was included as an event_type with #506. Thanks for the work on it @wellorder!

@thekaveman thekaveman closed this Jun 26, 2020
@schnuerle schnuerle removed this from the Future milestone Sep 2, 2021
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants