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: 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
@@ -52,7 +52,7 @@ More than 90 cities and public agencies around the world use MDS, and it has bee
52
52
53
53
***Arlington, VA**: [Shared Micro-Mobility Devices](https://transportation.arlingtonva.us/scooters-and-dockless-bikeshare/) page and [permit application](https://arlingtonva.s3.amazonaws.com/wp-content/uploads/sites/19/2019/12/Micro-Mobility_Permit_Final_191203.pdf).
54
54
***Atlanta, GA**: [Administrative Regulations
55
-
for Shareable Dockless Mobility Device Permit Holders](https://www.atlantaga.gov/home/showdocument?id=44650) from [Department of City Planning](https://www.atlantaga.gov/government/departments/city-planning).
55
+
for Shareable Dockless Mobility Device Permit Holders](https://www.atlantaga.gov/home/showdocument?id=46315) from [Department of City Planning](https://www.atlantaga.gov/government/departments/city-planning).
56
56
***Austin, TX**: The rules and guidelines for Austin's Micromobility Program can be found on Austin's [Shared Mobility Program](https://austintexas.gov/department/shared-mobility-services) website.
57
57
***Calgary, Canada**: Programs for a [Dockless Bike Share Pilot](https://www.calgary.ca/transportation/tp/cycling/cycling-strategy/bike-share-system.html?redirect=/bikeshare) and a [hared electric scooter pilot](https://www.calgary.ca/transportation/tp/cycling/cycling-strategy/shared-electric-scooter-pilot.html) that require [MDS in the application](https://www.calgary.ca/content/dam/www/transportation/tp/documents/cycling/cycling_strategy/framework-for-dockless-bike-share-permit-phase-2.pdf) and programs.
58
58
***Chicago, IL**: [E-Scooter Share Pilot Program](https://www.chicago.gov/city/en/depts/cdot/supp_info/escooter-share-pilot-project.html) information.
Copy file name to clipboardExpand all lines: ReleaseNotes.md
+49Lines changed: 49 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,52 @@
1
+
## 1.0.0
2
+
3
+
> Release Date: TBD
4
+
5
+
> Release Candidate Date: week of June 29, 2020
6
+
7
+
The 1.0.0 release reconciles many parts of the MDS specifiction and adds features and updates requested by the community, including support for Stops (for docked vehicles, dockless corrals, parking areas) and adding rates to Policy.
8
+
9
+
### CHANGES
10
+
11
+
See the PRs tagged with [Milestone 1.0.0](https://github.com/openmobilityfoundation/mobility-data-specification/milestone/9) for a full list of changes.
12
+
13
+
_Here is some of what was added or changed._
14
+
15
+
*_MDS_*
16
+
17
+
*[Reconcile the Provider and Agency language differences](https://github.com/openmobilityfoundation/mobility-data-specification/pull/506)
18
+
*[New State Machine Diagram](https://github.com/openmobilityfoundation/mobility-data-specification/pull/530)
*[Add link to State of Practice](https://github.com/openmobilityfoundation/mobility-data-specification/pull/477)
26
+
*[Update GBFS references and links](https://github.com/openmobilityfoundation/mobility-data-specification/pull/508)
27
+
* Move [Code of Conduct](https://github.com/openmobilityfoundation/mobility-data-specification/pull/514), [Contributing Guide](https://github.com/openmobilityfoundation/mobility-data-specification/pull/513), and [Release Guidelines](https://github.com/openmobilityfoundation/mobility-data-specification/pull/512) to new [Governace repo](https://github.com/openmobilityfoundation/governance)
28
+
*[Updating 'master' to 'main' as default branch name](https://github.com/openmobilityfoundation/mobility-data-specification/pull/522)
29
+
*[Update providers.csv to add Superpedestrian](https://github.com/openmobilityfoundation/mobility-data-specification/pull/535)
30
+
*[Removed Options version negotiation](https://github.com/openmobilityfoundation/mobility-data-specification/pull/536#pullrequestreview-439364663)
Copy file name to clipboardExpand all lines: agency/README.md
+41-10Lines changed: 41 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,7 @@ This specification contains a collection of RESTful APIs used to specify the dig
14
14
*[Vehicle Events](#vehicle---event)
15
15
*[Vehicles Telemetry](#vehicles---telemetry)
16
16
*[Telemetry Data](#telemetry-data)
17
+
*[Stops](#stops)
17
18
18
19
## General information
19
20
@@ -31,11 +32,11 @@ See the [Responses][responses] and [Error Messages][error-messages] sections.
31
32
32
33
### Authorization
33
34
34
-
When making requests, the Agency API expects `provider_id` to be part of the claims in a [JWT](https://jwt.io/)`access_token` in the `Authorization` header, in the form `Authorization: Bearer <access_token>`. The token issuance, expiration and revocation policies are at the discretion of the Agency.
35
+
When making requests, the Agency API expects `provider_id` to be part of the claims in a [JWT](https://jwt.io/)`access_token` in the `Authorization` header, in the form `Authorization: Bearer <access_token>`. The token issuance, expiration and revocation policies are at the discretion of the Agency.
35
36
36
37
## Vehicles
37
38
38
-
The `/vehicles` endpoint returns the specified vehicle (if a device_id is provided) or a list of known vehicles. Providers can only retrieve data for vehicles in their registered fleet.
39
+
The `/vehicles` endpoint returns the specified vehicle (if a device_id is provided) or a list of known vehicles. Providers can only retrieve data for vehicles in their registered fleet.
39
40
40
41
Endpoint: `/vehicles/{device_id}`
41
42
Method: `GET`
@@ -69,13 +70,13 @@ A vehicle record is as follows:
69
70
|`device_id`| UUID | Provided by Operator to uniquely identify a vehicle |
70
71
|`provider_id`| UUID | Issued by Agency and [tracked](../providers.csv)|
71
72
|`vehicle_id`| String | Vehicle Identification Number (vehicle_id) visible on vehicle |
72
-
|`type`| Enum |[Vehicle Type][vehicle-types]|
73
-
|`propulsion`| Enum[]| Array of [Propulsion Type][propulsion-types]; allows multiple values |
@@ -121,7 +122,7 @@ _No content returned on success._
121
122
122
123
## Vehicle - Update
123
124
124
-
The `/vehicles` update endpoint is used to update some mutable aspect of a vehicle. For now, only `vehicle_id`.
125
+
The `/vehicles` update endpoint is used to update some mutable aspect of a vehicle. For now, only `vehicle_id`.
125
126
126
127
Endpoint: `/vehicles/{device_id}`
127
128
Method: `PUT`
@@ -168,7 +169,7 @@ Body Params:
168
169
|`event_types`| Enum[]| Required | see [Vehicle Events][vehicle-events]|
169
170
|`timestamp`|[timestamp][ts]| Required | Date of last event update |
170
171
|`telemetry`|[Telemetry](#telemetry-data)| Required | Single point of telemetry |
171
-
|`trip_id`| UUID | Optional | UUID provided by Operator to uniquely identify the trip. Required for `trip_start`, `trip_end`, `trip_enter`, and `trip_leave` event types|
172
+
|`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`|
172
173
173
174
201 Success Response:
174
175
@@ -231,17 +232,47 @@ A standard point of vehicle telemetry. References to latitude and longitude impl
231
232
|`gps.hdop`| Float | Required if Available | Horizontal GPS or GNSS accuracy value (see [hdop][hdop]) |
232
233
| `gps.satellites` | Integer | Required if Available | Number of GPS or GNSS satellites
233
234
|`charge`| Float | Required if Applicable | Percent battery charge of vehicle, expressed between 0 and 1 |
235
+
|`stop_id`| UUID | Required if Applicable | Stop that the vehicle is currently located at. Only applicable for _docked_ Micromobility. See [Stops][stops]|
236
+
237
+
## Stops
238
+
239
+
The `/stops` endpoint allows an agency to register Stops.
240
+
241
+
**Endpoint:**`/stops`
242
+
**Method:**`POST`
243
+
**[Beta feature][beta]:** Yes (as of 1.0.0)
244
+
**Request Body**: An array of [Stops][stops]
245
+
246
+
**Endpoint:**`/stops`
247
+
**Method:**`PUT`
248
+
**[Beta feature][beta]:** Yes (as of 1.0.0)
249
+
**Request Body**: An array of subsets of [Stop][stops] information, where the permitted subset fields are defined as:
**`data` Payload:**`{ "stops": [] }`, an array of [Stops][stops]
261
+
262
+
In the case that a `stop_id` query parameter is specified, the `stops` array returned will only have one entry. In the case that no `stop_id` query parameter is specified, all stops will be returned.
0 commit comments