You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: data-types.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ A vehicle record is as follows:
26
26
|`device_id`| UUID | Required | A unique device ID in UUID format, should match this device in Provider |
27
27
|`provider_id`| UUID | Required | A UUID for the Provider, unique within MDS. See MDS [provider list](/providers.csv). |
28
28
|`data_provider_id`| UUID | Optional | If different than `provider_id`, a UUID for the data solution provider managing the data feed in this endpoint. See MDS [provider list](/providers.csv) which includes both service operators and data solution providers. |
29
-
|`vehicle_id`| String | Required | A unique vehicle identifier (visible code, licence plate, etc), visible on the vehicle itself |
29
+
|`vehicle_id`| String | Required | A unique vehicle identifier (visible code, license plate, etc), visible on the vehicle itself |
30
30
|`vehicle_type`| Enum | Required | The [vehicle type][vehicle-types]|
31
31
|`vehicle_attributes`| Array | Optional |**[Mode][modes]-Specific**[vehicle attributes](/modes#vehicle-attributes) given as mode-specific unordered key-value pairs |
@@ -93,7 +93,7 @@ Events represent changes in vehicle status.
93
93
|`device_id`| UUID | Required | A unique device ID in UUID format |
94
94
|`provider_id`| UUID | Required | A UUID for the Provider, unique within MDS. See MDS [provider list](/providers.csv). |
95
95
|`data_provider_id`| UUID | Optional | If different than `provider_id`, a UUID for the data solution provider managing the data feed in this endpoint. See MDS [provider list](/providers.csv) which includes both service operators and data solution providers. |
96
-
|`vehicle_id`| String | Required | A unique vehicle identifier (visible code, licence plate, etc), visible on the vehicle itself |
96
+
|`vehicle_id`| String | Required | A unique vehicle identifier (visible code, license plate, etc), visible on the vehicle itself |
97
97
|`vehicle_state`| Enum | Required | See [vehicle state][vehicle-states] table |
98
98
|`event_types`| Enum[]| Required | Vehicle [event types][vehicle-events] for state change, with allowable values determined by `vehicle_state`|
99
99
|`event_time`|[Timestamp][ts]| Required | Date/time that event occurred at. See [Event Times][event-times]|
Copy file name to clipboardExpand all lines: general-information.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -84,7 +84,7 @@ For the purposes of this specification, the intersection of two geographic datat
84
84
85
85
## Geography-Driven Events
86
86
87
-
**[Beta feature](/general-information.md#beta-features):***Yes (as of 2.0.0)*. [Leave feedback](https://github.com/openmobilityfoundation/mobility-data-specification/issues/670)
87
+
**[Beta feature](/general-information.md#beta-features):***Yes (as of 1.1.0)*. [Leave feedback](https://github.com/openmobilityfoundation/mobility-data-specification/issues/670)
88
88
89
89
Geography-Driven Events (GDE) is an MDS feature for Agencies to perform complete Policy compliance monitoring without precise location data. Geography-Driven Events describe individual vehicles in realtime – not just aggregate data. However, rather than receiving the exact location of a vehicle, Agencies receive information about the vehicle's current geographic region. The regions used for Geography-Driven Events correspond to the Geographies in an Agency's current Policy. In this way, the data-shared using Geography-Driven Events is matched to an Agency's particular regulatory needs.
90
90
@@ -112,7 +112,7 @@ During the Beta period for this feature, location and telemetry data remain requ
112
112
113
113
## Optional Authentication
114
114
115
-
Authorization of the Policy and Geography APIs is no longer required and will be deprecated in next major release with these endpoints (plus Jursidictions) becoming 'optionally private' instead of 'optionally public'. An agency may optionally decide to make the Policy and Geography endpoints, as well as Jursidictions, unauthenticated and public. This allows transparency for the public to see how the city is regulating, holds the city accountable for their policy decisions, and reduces the technical burden on providers to use these endpoints. A side benefit is that this allows third parties to ingest this information into their applications and services for public benefit.
115
+
Authorization of the Policy and Geography APIs is no longer required and will be deprecated in next major release with these endpoints (plus Jurisdictions) becoming 'optionally private' instead of 'optionally public'. An agency may optionally decide to make the Policy and Geography endpoints, as well as Jurisdictions, unauthenticated and public. This allows transparency for the public to see how the city is regulating, holds the city accountable for their policy decisions, and reduces the technical burden on providers to use these endpoints. A side benefit is that this allows third parties to ingest this information into their applications and services for public benefit.
116
116
117
117
Note if implementing the beta feature [Geography Driven Events](/general-information.md#geography-driven-events), both Policy and Geography must be public.
Copy file name to clipboardExpand all lines: policy/README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -149,7 +149,7 @@ Policies will be returned in order of effective date (see schema below), with pa
149
149
150
150
### Geographies
151
151
152
-
**Deprecated:** see the new [Geography API](/geography#transition-from-policy) to understand the transistion away from this endpoint, and how to support both in MDS 1.x.0 releases.
152
+
**Deprecated:** see the new [Geography API](/geography#transition-from-policy) to understand the transition away from this endpoint, and how to support both in MDS 1.x.0 releases.
153
153
154
154
**Endpoint**: `/geographies/{id}`
155
155
**Method**: `GET`
@@ -337,7 +337,7 @@ An individual `Rule` object is defined by the following fields:
337
337
338
338
### Geography
339
339
340
-
**Deprecated:** see the new [Geography API](/geography#transition-from-policy) to understand the transistion away from this endpoint, and how to support both in a MDS 1.x.0 release.
340
+
**Deprecated:** see the new [Geography API](/geography#transition-from-policy) to understand the transition away from this endpoint, and how to support both in a MDS 1.x.0 release.
341
341
342
342
| Name | Type | Required / Optional | Description |
@@ -493,7 +493,7 @@ An agency's program [Requirements](#requirements) endpoint contains a number of
493
493
// other data specs per the "Requirement Data Specs" section
494
494
]
495
495
},
496
-
// other MDS versions per the "Requriement MDS Version" section
496
+
// other MDS versions per the "Requirement MDS Version" section
497
497
}
498
498
}
499
499
```
@@ -707,8 +707,8 @@ You may also show which APIs, endpoints, and fields your agency is serving to pr
707
707
- All fields marked 'Required' in MDS are still included by default and should not be enumerated in `required_fields`. They are not affected by the Requirements endpoint, unless explicitly listed in `disallowed_fields`.
708
708
- Fields in MDS marked 'Required if available' are still returned if available, and are not affected by the Requirements endpoint, unless explicitly listed in `disallowed_fields`.
709
709
- If a 'Required' or 'Required if available' or 'Optional' field in MDS is listed in `disallowed_fields`, those fields should not be returned by the provider in the endpoint. The field (and therefore its value) must be completely removed from the response. If used, [schema](/schema) validation may fail on missing required fields.
710
-
- To reference fields that are lower in a heirarchy, use [dot separated notation](https://docs.oracle.com/en/database/oracle/oracle-database/18/adjsn/simple-dot-notation-access-to-json-data.html#GUID-7249417B-A337-4854-8040-192D5CEFD576), where a dot between field names represents one nested level deeper into the data structure. E.g. 'gps.heading' or 'features.properties.rules.vehicle_type_id'.
711
-
- To require [Greography Driven Events](/general-information.md#geography-driven-events), simply include the `event_geographies` field for either the Agency or Provider API `api_name`. Per how GDEs work, `event_location` will then not be returned, and the `changed_geographies` vehicle state `event_type` will be used.
710
+
- To reference fields that are lower in a hierarchy, use [dot separated notation](https://docs.oracle.com/en/database/oracle/oracle-database/18/adjsn/simple-dot-notation-access-to-json-data.html#GUID-7249417B-A337-4854-8040-192D5CEFD576), where a dot between field names represents one nested level deeper into the data structure. E.g. 'gps.heading' or 'features.properties.rules.vehicle_type_id'.
711
+
- To require [Geography Driven Events](/general-information.md#geography-driven-events), simply include the `event_geographies` field for either the Agency or Provider API `api_name`. Per how GDEs work, `event_location` will then not be returned, and the `changed_geographies` vehicle state `event_type` will be used.
712
712
-[While in beta](#beta-limitations), items marked as required or disallowed will only be considered a 'request' by providers, unless agencies have communicated with providers outside of MDS.
Copy file name to clipboardExpand all lines: policy/examples/requirements.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -193,7 +193,7 @@ Version 1.1.0 for one provider with scooters, and 1.0.0 for another provider for
193
193
194
194
## Trips Only
195
195
196
-
Version 1.1.0 for 2 providers requiring only historic Provider `/trips` with the optional `parking_verificaiton_url` field, linked to a specific MDS Policy.
196
+
Version 1.1.0 for 2 providers requiring only historic Provider `/trips` with the optional `parking_verification_url` field, linked to a specific MDS Policy.
Copy file name to clipboardExpand all lines: provider/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -532,7 +532,7 @@ Should the requested time range exceed 2 weeks, `/telemetry` shall return a `400
532
532
533
533
The `/vehicles` is a near-realtime endpoint and returns the current status of vehicles in an agency's [Jurisdiction](/general-information.md#definitions) and/or area of agency responsibility. All vehicles that are currently in any [`vehicle_state`][vehicle-states] should be returned in this payload. Since all states are returned, care should be taken to filter out states not in the [PROW](/general-information.md#definitions) if doing vehicle counts. For the states `elsewhere` and `removed` which include vehicles not in the [PROW](/general-information.md#definitions) but provide some operational clarity for agencies, these must only persist in the feed for 90 minutes before being removed.
534
534
535
-
Data in this endpoint should reconcile with data from the historic [`/status_changes`](/provider#events)enpdoint, though `/events` is the source of truth if there are discrepancies.
535
+
Data in this endpoint should reconcile with data from the historic [`/status_changes`](/provider#events)endpoint, though `/events` is the source of truth if there are discrepancies.
536
536
537
537
As with other MDS APIs, `/vehicles` is intended for use by regulators, not by the general public. `/vehicles` can be deployed by providers as a standalone MDS endpoint for agencies without requiring the use of other endpoints, due to the [modularity](/README.md#modularity) of MDS. See our [MDS Vehicles Guide](https://github.com/openmobilityfoundation/mobility-data-specification/wiki/MDS-Vehicles) for how this compares to GBFS `/free_bike_status`. Note that using authenticated `/vehicles` does not replace the role of a public [GBFS][gbfs] feed in enabling consumer-facing applications. If a provider is using both `/vehicles` and GBFS endpoints, the `/vehicles` endpoint should be considered source of truth regarding an agency's compliance checks.
0 commit comments