Merging City of LA MDS dev branch into Ride Reports dev branch #4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated based on compliance changed approved by LADOT Compliance will exist in a seperate document.
Approved by LADOT. Updated compliance for in-trip telemetry for scooters.
This commit adds a section to the release guidelines doc clarifying the distinction between breaking and non-breaking changes, including an enumeration of what kinds of changes fall in each category. This builds on language added in #286; I didn't modify those templates here since their description of breaking vs. non-breaking is still accurate. I think the most likely area of controversy here is the handling of enum values. My inclination would actually be to treat changes to enum values as breaking changes, but it seems like the consensus during the 0.3.1 process so far has been that the benefits of having a lightweight process for updating enums outweigh the risk of breaking clients that are doing stricter validations. Fixes #279
This implements the change suggested in #289 by clarifying that any trip-ending event can and should have an `associated_trip`, not just `user_drop_off` events. Since the Provider event system currently doesn't define which states are allowed to transition to which other states, it's already spec-compliant to follow a `reserved`/`user_pick_up` event with an `unavailable`/`low_battery` event, and this is the most semantically-accurate way to describe the scenario where a device shuts down during a trip because of low battery. In this situation, the implementer should include an `associated_trip` field in both events so that API consumers can correctly identify these events as the endpoints of the relevant trip.
Add event_type_reason for agency admin access.
Explicitly allow `associated_trip` for any event type
Flesh out definition of breaking vs. non-breaking changes
Add versions endpoint.
0.3.1 release notes
quicklywilliam
pushed a commit
that referenced
this pull request
Sep 15, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.