Merge pull request #610 from openmobilityfoundation/release-1.1.0

Release Candidate 1.1.0

Author: schnuerle

README.md

@@ -1,7 +1,64 @@
+## 1.1.0
+
+> Released: 2021-03-30 
+
+> [Release Plan](https://github.com/openmobilityfoundation/governance/wiki/Release-1.1.0)
+
+The 1.1.0 minor release adds new top level APIs (geography, jurisdictions), privacy options (provider reports, geography-driven events, metrics), and transparency features (public endpoints). 
+
+### CHANGES
+
+See the closed PRs tagged with [Milestone 1.1.0](https://github.com/openmobilityfoundation/mobility-data-specification/pulls?q=is%3Apr+is%3Aclosed+milestone%3A1.1.0) and [Issues](https://github.com/openmobilityfoundation/mobility-data-specification/issues?q=is%3Aissue+milestone%3A1.1.0+is%3Aclosed) for a full list of changes.
+
+**_MDS_**
+
+- [Policy and Geography can be public](https://github.com/openmobilityfoundation/mobility-data-specification/pull/585)
+- [Geography-Driven Events](https://github.com/openmobilityfoundation/mobility-data-specification/pull/503): [Issue](https://github.com/openmobilityfoundation/mobility-data-specification/issues/480)
+   
+_Minor Updates_
+
+- [Unregistered error](https://github.com/openmobilityfoundation/mobility-data-specification/pull/565)
+- [Geography updates](https://github.com/openmobilityfoundation/mobility-data-specification/issues/474)
+- [Stops updates](https://github.com/openmobilityfoundation/mobility-data-specification/pull/603)
+- [Response time expectations](https://github.com/openmobilityfoundation/mobility-data-specification/pull/563)
+- [Geography publish date field consistency](https://github.com/openmobilityfoundation/mobility-data-specification/pull/597)
+- [Adding more cities using MDS](https://github.com/openmobilityfoundation/mobility-data-specification/pull/591)
+- [Adding more providers using MDS](https://github.com/openmobilityfoundation/mobility-data-specification/blob/dev/providers.csv)
+- [Added a section for third party software companies using MDS](https://github.com/openmobilityfoundation/mobility-data-specification/issues/552) and cleaned up home page, moving list content to the OMF website
+- [Update geography_json field type](https://github.com/openmobilityfoundation/mobility-data-specification/issues/635)
+
+**_Provider_**
+
+- [New Reports](https://github.com/openmobilityfoundation/mobility-data-specification/pull/607): [Issue](https://github.com/openmobilityfoundation/mobility-data-specification/issues/569)
+
+**_Agency_**
+
+- N/A
+
+**_Policy_**
+
+- [Images of Stops](https://github.com/openmobilityfoundation/mobility-data-specification/issues/555)
+- [Clarify update frequency](https://github.com/openmobilityfoundation/mobility-data-specification/pull/609): [Issue](https://github.com/openmobilityfoundation/mobility-data-specification/issues/567)
+
+**_Geography_**
+
+- [Elevating Geography to a first class API](https://github.com/openmobilityfoundation/mobility-data-specification/pull/582): [PR](https://github.com/openmobilityfoundation/mobility-data-specification/pull/499), [Issue](https://github.com/openmobilityfoundation/mobility-data-specification/issues/500)
+- [Geography Types](https://github.com/openmobilityfoundation/mobility-data-specification/pull/581): [Issue](https://github.com/openmobilityfoundation/mobility-data-specification/issues/580), [Discussion](https://github.com/openmobilityfoundation/mobility-data-specification/discussions/588)
+
+**_Metrics_**
+
+- [New Agency Metrics API](https://github.com/openmobilityfoundation/mobility-data-specification/issues/485): [Definitions PR](https://github.com/openmobilityfoundation/mobility-data-specification/pull/487), [Spec PR](https://github.com/openmobilityfoundation/mobility-data-specification/pull/486), [Issue](https://github.com/openmobilityfoundation/mobility-data-specification/issues/485)
+
+**_Jurisdiction_**
+
+- [New Jurisdiction API](https://github.com/openmobilityfoundation/mobility-data-specification/pull/593): [Issue](https://github.com/openmobilityfoundation/mobility-data-specification/issues/474)
+
 ## 1.0.0
 
 > Released: 2020-09-16
 
+> [Release Plan](https://github.com/openmobilityfoundation/governance/wiki/Release-1.0.0)
+
 The 1.0.0 release reconciles and aligns many parts of the MDS specification and adds features and updates requested by the community, including many new detailed vehicle states and event types, support for Stops (for docked vehicles, dockless corrals, parking areas), and adding rates (fees/subsidies) to Policy.
 
 ### CHANGES

ReleaseNotes.md

@@ -1,5 +1,7 @@
 # Mobility Data Specification: **Agency**
 
+<a href="/agency/"><img src="https://i.imgur.com/HzMWtaI.png" width="120" align="right" alt="MDS Agency Icon" border="0"></a>
+
 The Agency API endpoints are intended to be implemented by regulatory agencies and consumed by mobility providers. Providers query the Agency API when events (such as a trip start or vehicle status change) occur in their systems.
 
 This specification contains a collection of RESTful APIs used to specify the digital relationship between *mobility as a service* providers and the agencies that regulate them.
@@ -183,7 +185,8 @@ Body Params:
 | `vehicle_state` | Enum                          | Required | see [Vehicle States][vehicle-states] |
 | `event_types`   | Enum[]                        | Required | see [Vehicle Events][vehicle-events] |
 | `timestamp`     | [timestamp][ts]                     | Required | Date of last event update |
-| `telemetry`     | [Telemetry](#telemetry-data)  | Required | Single point of telemetry |
+| `telemetry`     | [Telemetry](#telemetry-data)  | Required | Single point of telemetry. |
+| `event_geographies`  | UUID[] | Optional          | **[Beta feature](/general-information.md#beta-features):** *Yes (as of 1.1.0)*. Array of Geography UUIDs consisting of every Geography that contains the location of the event. See [Geography Driven Events][geography-driven-events]. Required if `telemetry` is not present. |
 | `trip_id`       | UUID                          | Optional | UUID provided by Operator to uniquely identify the trip. Required if `event_types` contains `trip_start`, `trip_end`, `trip_cancel`, `trip_enter_jurisdiction`, or `trip_leave_jurisdiction` |
 
 201 Success Response:
@@ -225,11 +228,12 @@ Body Params:
 
 400 Failure Response:
 
-| `error`         | `error_description`                  | `error_details`[]               |
-| --------------- | ------------------------------------ | ------------------------------- |
-| `bad_param`     | A validation error occurred.         | Array of parameters with errors |
-| `invalid_data`  | None of the provided data was valid. |                                 |
-| `missing_param` | A required parameter is missing.     | Array of missing parameters     |
+| `error`         | `error_description`                  | `error_details`[]                 |
+| --------------- | ------------------------------------ | --------------------------------- |
+| `bad_param`     | A validation error occurred.         | Array of parameters with errors   |
+| `invalid_data`  | None of the provided data was valid. |                                   |
+| `missing_param` | A required parameter is missing.     | Array of missing parameters       |
+| `unregistered`  | Some of the devices are unregistered | Array of unregistered `device_id` |
 
 [Top][toc]
 
@@ -326,8 +330,9 @@ If `stop_id` is specified, `GET` will return an array with a single stop record,
 
 [beta]: /general-information.md#beta-features
 [general]: /general-information.md
+[geography-driven-events]: /general-information.md#geography-driven-events
 [error-messages]: /general-information.md#error-messages
-[hdop]: https://support.esri.com/en/other-resources/gis-dictionary/term/358112bd-b61c-4081-9679-4fca9e3eb926
+[hdop]: https://en.wikipedia.org/wiki/Dilution_of_precision_(navigation)
 [propulsion-types]: /general-information.md#propulsion-types
 [responses]: /general-information.md#responses
 [stops]: /general-information.md#stops