search

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

Remove word "data" from provider response payload descriptions #880

Closed jiffyclub closed 8 months ago

jiffyclub commented 8 months ago

MDS Pull Request

Explain pull request

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.

Is this a breaking change

Impacted Spec

Which spec(s) will this pull request impact?

schnuerle commented 8 months ago

We are looking at creating a 2.0.1 release soon for all open issues and PRs tagged with the 2.0.1 Milestone.

Any feedback from the community is welcome before merging to dev.