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

Release 2.0.1 #893

Merged
merged 23 commits into from
Dec 18, 2023
Merged

Release 2.0.1 #893

merged 23 commits into from
Dec 18, 2023

Conversation

schnuerle
Copy link
Member

Summary

The Release for MDS 2.0.1 has been created: https://github.com/openmobilityfoundation/mobility-data-specification/releases/tag/2.0.1

Action Item

This pull request will be merged by OMF staff following approval by the WGSC.

egor-bayandin and others added 23 commits June 3, 2023 11:42
I noticed a few places in the provider README where it
was still referring to "status changes" instead of the new
term "events". There was also an inconsistency in the depiction
of the response format.
In older versions of MDS data was nested under a `data`
key in provider API responses, so trips data would e.g.
be response['data']['trips']. This ended up reflected
in the docs where each section would have a label like
"`data` Payload" describing what was under the `data`
key in the payload.

In MDS 2.0 this nesting was removed, `trips` is now a top
level key in the response from provider trips endpoint.
However, the docs were not updated to remove the word
"data" from the payload descriptions, leading to potential
confusion for readers of the documentation. This PR
changes "`data` Payload" to "Payload" throughout the provider
README to bring it in line with the spec.
The description of the Provider vehicles endpoints was never
really updated in the MDS 1 -> 2 transition so this rearranges
and clarifies some things now that there are two vehicle information
endpoints, one for static information like vehicle/propulsion type
and another for realtime status. These changes are mostly
rearranging/clarifying, but there is one major addition to the
description of the `/vehicles` endpoint describing that when
called without a device ID it is expected to return every vehicle
ever deployed in a jurisdiction.
Update "status changes" to "events" in provider
…-response-docs

Remove word "data" from provider response payload descriptions
Update to pairing list of vehicle_state and event_type for car sharing
…e-reports

Reworded comment for start_date in Reports
The example API response for the /vehicles/status endpoint
had the data key as 'vehicles' when it is in fact 'vehicles_status'.
Fix JSON key in /vehicles/status example response
- Specify that /vehicles called without a device ID should return
  all vehicles deployed in a region in the last thirty days
- Specify that vehicle information about all device IDs present
  in MDS data for a region must be accessible via /vehicles/device_id
  regardless of when the vehicle was deployed
…clude

Clarify which vehicles to include in the `/vehicles` endpoint
Fixing broken links in data-types markdown document
@schnuerle schnuerle added the admin Administrative chores etc. label Dec 18, 2023
@schnuerle schnuerle added this to the 2.0.1 milestone Dec 18, 2023
@schnuerle schnuerle self-assigned this Dec 18, 2023
@schnuerle schnuerle requested a review from a team as a code owner December 18, 2023 21:00
@schnuerle schnuerle merged commit ec4f010 into main Dec 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
admin Administrative chores etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants