Skip to content

Commit 2670581

Browse files
schnuerleschnuerle
authored
Merge pull request #702 from openmobilityfoundation/release-1.2.0
Release 1.2.0
2 parents 349e9c0 + b687433 commit 2670581

66 files changed

Lines changed: 3191 additions & 1677 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/ISSUE_TEMPLATE/add-agency-id.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Add Agency ID
3+
about: Create Agency ID for use in MDS
4+
title: 'Add Agency ID: [Agency Name]'
5+
labels: admin
6+
assignees: ''
7+
8+
---
9+
10+
**Note:** See the [Adding an MDS Agency ID](https://github.com/openmobilityfoundation/mobility-data-specification/wiki/Adding-an-MDS-Agency-ID) page for more help.
11+
12+
Opening this issue will allow you as a city or governmental agency get an official agency ID for use across MDS globally, and include in your Requirements URL.
13+
14+
**Fields needed from you for the [agencies.csv file](https://github.com/openmobilityfoundation/mobility-data-specification/blob/main/agencies.csv).**
15+
16+
_All fields are required._
17+
18+
1. **agency_country_iso_code** - Two letter ISO country code where your agency is located.
19+
- ...
20+
1. **agency_state** - Geographic abbreviation or name of the state where your agency is located.
21+
- ...
22+
1. **agency_city** - Geographic name of the city where your agency is located.
23+
- ...
24+
1. **agency_name** - Full name of your governmental city/agency.
25+
- ...
26+
1. **agency_id** - A random UUID version 4. There are lots of way to generate a unique UUID, like using this website.
27+
- ...
28+
1. **department_url** - URL to the home page of your agency's department.
29+
- ...
30+
1. **requirement_url** - Full https:// URL where your current Policy Requirements endpoint is located.
31+
- ...
32+
33+
Additionally, please provide your name and role within your agency to help with verification.

‎.github/ISSUE_TEMPLATE/add-provider-id.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Add Provider ID
3+
about: Create Provider ID for use in MDS
4+
title: 'Add Provider ID: [Provider Name]'
5+
labels: admin
6+
assignees: ''
7+
8+
---
9+
10+
**Note:** See the [Adding an MDS Provider ID](https://github.com/openmobilityfoundation/mobility-data-specification/wiki/Adding-an-MDS-Provider-ID) page for more help.
11+
12+
Opening this issue will allow you as a mobility service provider get an official provider ID for use across MDS globally.
13+
14+
**Fields needed from you for the [providers.csv file](https://github.com/openmobilityfoundation/mobility-data-specification/blob/main/providers.csv).**
15+
16+
_All fields are required._
17+
18+
1. **provider_name** - Short name of your company.
19+
- ...
20+
1. **provider_id** - A random UUID version 4. There are lots of way to generate a unique UUID, like using this [website](https://www.uuidgenerator.net/version4).
21+
- ...
22+
1. **url** - URL to the home page of your company.
23+
- ...
24+
1. **mds_api_url** - Full https:// URL where your root MDS feeds are located.
25+
- ...
26+
1. **gbfs_api_url** - Full https:// URL where your public GBFS feeds are located.
27+
- ...
28+
29+
Additionally, please provide your name and role within your agency to help with verification.

‎CODEOWNERS‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,5 @@
33
## All MDS approvals
44
* @openmobilityfoundation/omf-admin
55

6-
## Provider Services Working Group
7-
/provider/* @openmobilityfoundation/provider-maintainers @openmobilityfoundation/omf-admin
8-
9-
## City Services Working Group Specific, also JSON Schema
10-
/agency/* @openmobilityfoundation/city-services-maintainers @openmobilityfoundation/omf-admin
11-
/policy/* @openmobilityfoundation/city-services-maintainers @openmobilityfoundation/omf-admin
12-
13-
## schema is changed by provider and city services working group
14-
/schema/* @openmobilityfoundation/provider-maintainers @openmobilityfoundation/city-services-maintainers @openmobilityfoundation/omf-admin
6+
## MDS Working Group
7+
* @openmobilityfoundation/mds-maintainers @openmobilityfoundation/omf-admin

‎README.md‎

Lines changed: 43 additions & 24 deletions
Large diffs are not rendered by default.

‎ReleaseNotes.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,45 @@
1+
## 1.2.0
2+
3+
> Released: 2021-11-04
4+
5+
> [Release Plan](https://github.com/openmobilityfoundation/governance/wiki/Release-1.2.0)
6+
7+
The 1.2.0 minor release adds digital program Requirements, new options for policies, better GPS telemetry data, and moves Provider Vehicles out of beta.
8+
9+
### CHANGES
10+
11+
See the closed PRs tagged with [Milestone 1.2.0](https://github.com/openmobilityfoundation/mobility-data-specification/pulls?q=is%3Apr+is%3Aclosed+milestone%3A1.2.0) and [Issues](https://github.com/openmobilityfoundation/mobility-data-specification/issues?q=is%3Aissue+milestone%3A1.2.0+is%3Aclosed) for a full list of changes.
12+
13+
**_General MDS_**
14+
15+
- [Richer telemetry data](https://github.com/openmobilityfoundation/mobility-data-specification/issues/589), including [616](https://github.com/openmobilityfoundation/mobility-data-specification/issues/616), [73](https://github.com/openmobilityfoundation/mobility-data-specification/pull/73), [51](https://github.com/openmobilityfoundation/mobility-data-specification/pull/51)
16+
- [Add cargo_bicycle vehicle type](https://github.com/openmobilityfoundation/mobility-data-specification/pull/698)
17+
18+
**_Policy_**
19+
20+
- [Program Requirements](https://github.com/openmobilityfoundation/mobility-data-specification/issues/646) - For agencies to describe program requirements digitally to allow providers and the public to see what MDS and GBFS versions, APIs, endpoints, and fields are required, and communicate available MDS agency information to providers.
21+
- [Ability to express data sharing requirements in Policy](https://github.com/openmobilityfoundation/mobility-data-specification/issues/608)
22+
- [Method to Exclude some Provider Fields from Response](https://github.com/openmobilityfoundation/mobility-data-specification/issues/507)
23+
- [Retrieve operational zones from operators](https://github.com/openmobilityfoundation/mobility-data-specification/issues/639)
24+
- [Make Trip 'route' field optional for privacy](https://github.com/openmobilityfoundation/mobility-data-specification/issues/504)
25+
26+
- [Multiple options added to Policy](https://github.com/openmobilityfoundation/mobility-data-specification/pull/658)
27+
- [Add rate options to other rules types](https://github.com/openmobilityfoundation/mobility-data-specification/issues/633)
28+
- [Support parking fees by duration](https://github.com/openmobilityfoundation/mobility-data-specification/issues/631)
29+
- [Min and max clarity on Rules](https://github.com/openmobilityfoundation/mobility-data-specification/issues/689)
30+
- [Add a "rate applies when" field to Rules](https://github.com/openmobilityfoundation/mobility-data-specification/issues/666)
31+
32+
**_Provider_**
33+
34+
- [Vehicles out of beta](https://github.com/openmobilityfoundation/mobility-data-specification/issues/637)
35+
- [Clarify use cases between MDS Vehicles and GBFS](https://github.com/openmobilityfoundation/mobility-data-specification/issues/641)
36+
37+
_Minor Updates_
38+
39+
- [Clarify single object response on policy/geography](https://github.com/openmobilityfoundation/mobility-data-specification/issues/599)
40+
- [Schema updates](https://github.com/openmobilityfoundation/mobility-data-specification/issues/693), including [645](https://github.com/openmobilityfoundation/mobility-data-specification/issues/645), [687](https://github.com/openmobilityfoundation/mobility-data-specification/issues/687), [683](https://github.com/openmobilityfoundation/mobility-data-specification/issues/683)
41+
- Add VeoRide, Boaz Bikes, and update Superpedestrian provider IDs
42+
143
## 1.1.1
244

345
> Released: 2021-09-24

‎agencies.csv‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
agency_country_iso_code,agency_state,agency_city,agency_name,agency_id,department_url,requirement_url
2+
CA,British Columbia,Kelowna,City of Kelowna,31e836fc-72da-4b2e-b553-8227d77a9b7a,https://www.kelowna.ca/roads-transportation/active-transportation/cycling/bikeshare-permit-program,
3+
CO,Cundinamarca,Bogotá,Bogotá,85eac875-ab70-469f-8a85-cc5ef22e78d0,https://www.movilidadbogota.gov.co/web/,
4+
DE,Baden-Württemberg,Ulm,Stadt Ulm,68f28fb8-d177-43f4-b7e8-a286fe0ddca0,https://www.ulm.de/de-de,
5+
US,CA,Long Beach,City of Long Beach,188ed65d-a81e-40b9-b0b2-aeb85436610a,https://www.longbeach.gov/goactivelb/,
6+
US,CA,Los Angeles,Los Angeles,d82d8584-dfa6-4396-93f0-5a36288b9eb1,https://ladot.lacity.org/projects/transportation-services/shared-mobility/micromobility,
7+
US,CA,San Francisco,San Francisco,8e03693b-0153-446c-8bc0-c31f8a5a7ed8,https://www.sfmta.com/projects/powered-scooter-share-permit-and-pilot-program,
8+
US,CA,San Jose,San Jose,801cb4b8-8725-449c-bdb9-7e9ac0e10b5b,https://www.sanjoseca.gov/your-government/departments-offices/transportation/micro-mobility,
9+
US,CA,Santa Monica,Santa Monica,e4e7c0f6-c6aa-4919-a4de-565e4fe9fa57,https://www.smgov.net/Departments/PCD/Transportation/Shared-Mobility-Services/,
10+
US,CO,Denver,Denver,c3d07b63-f602-4837-9525-7285f5ef286b,https://www.denvergov.org/content/denvergov/en/transportation-infrastructure/programs-services/dockless-mobility.html,
11+
US,DC,Washington,District of Columbia,8aca1cf2-ffa5-46d8-b747-20cf00a7c7f1,https://ddot.dc.gov/page/dockless-vehicle-permits-district,
12+
US,FL,Miami,City of Miami,5b36be11-7d5d-45ab-9c89-105cf6aa8645,https://www.miamigov.com/Services/Transportation/Miami-Scooter-Pilot-Program,
13+
US,IL,Chicago,Chicago,d2ed9de6-2d2d-477c-a843-7d150d2310ed,https://www.chicago.gov/city/en/depts/cdot/supp_info/escooter-share-pilot-project.html,
14+
US,KY,Louisville,Louisville Metro,44bc31a7-464b-4ed9-b52e-8e74630826bd,https://louisvilleky.gov/government/public-works/dockless-find-and-ride-vehicles,
15+
US,MI,Detroit,Detroit,5814742e-78ba-4ac1-a628-c414ecc45448,https://detroitmi.gov/departments/department-public-works/complete-streets/scooters,
16+
US,MN,Minneapolis,Minneapolis,88303227-48d6-4088-a690-65b4dcf381f7,http://www.minneapolismn.gov/publicworks/trans/WCMSP-212816,
17+
US,OR,Portland,Portland,7d600eb6-f967-40ea-a212-33917f9b48ae,https://www.portlandoregon.gov/transportation/,
18+
US,PA,Philadelphia,Philadelphia,fa2d0c5a-a716-473c-808b-be3b23e022ee,http://www.phillyotis.com/portfolio-item/dockless-bike-share-pilot/,
19+
US,PA,Pittsburgh,Pittsburgh,f3c50422-7e3e-4efe-88c7-99da3b36c24d,https://pittsburghpa.gov/domi/bikeplan,
20+
US,TX,Austin,City of Austin,296220ae-c90a-4383-9a97-0bc6cf1adf18,https://austintexas.gov/department/shared-mobility-services,
21+
US,WA,Seattle,City of Seattle,9acf6e41-f145-49ad-be7f-d910e978fc36,https://www.seattle.gov/transportation/projects-and-programs/programs/bike-program/bike-share,

‎agency/README.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -184,9 +184,9 @@ Body Params:
184184
| ----------- | ----------------------------- | -------- | -------------------------------------------------------------------------------- |
185185
| `vehicle_state` | Enum | Required | see [Vehicle States][vehicle-states] |
186186
| `event_types` | Enum[] | Required | see [Vehicle Events][vehicle-events] |
187-
| `timestamp` | [timestamp][ts] | Required | Date of last event update |
187+
| `timestamp` | [timestamp][ts] | Required | Date of last event update |
188188
| `telemetry` | [Telemetry](#telemetry-data) | Required | Single point of telemetry. |
189-
| `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. |
189+
| `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. |
190190
| `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` |
191191

192192
201 Success Response:
@@ -223,7 +223,7 @@ Body Params:
223223
| Field | Type | Field Description |
224224
| ---------- | ------------------------------ | ------------------------------------------------------------------------------------------------------- |
225225
| `success` | Integer | Number of successfully written telemetry data points. |
226-
| `total` | Integer | Ttotal number of provided points. |
226+
| `total` | Integer | Total number of provided points. |
227227
| `failures` | [Telemetry](#telemetry-data)[] | Array of failed telemetry for zero or more vehicles (empty if all successful). |
228228

229229
400 Failure Response:
@@ -244,14 +244,14 @@ A standard point of vehicle telemetry. References to latitude and longitude impl
244244
| Field | Type | Required/Optional | Field Description |
245245
| -------------- | -------------- | --------------------- | ------------------------------------------------------------ |
246246
| `device_id` | UUID | Required | ID used in [Register](#vehicle---register) |
247-
| `timestamp` | [timestamp][ts] | Required | Date/time that event occurred. Based on GPS or GNSS clock |
247+
| `timestamp` | [timestamp][ts]| Required | Date/time that event occurred. Based on GPS or GNSS clock |
248248
| `gps` | Object | Required | Telemetry position data |
249249
| `gps.lat` | Double | Required | Latitude of the location |
250250
| `gps.lng` | Double | Required | Longitude of the location |
251251
| `gps.altitude` | Double | Required if Available | Altitude above mean sea level in meters |
252252
| `gps.heading` | Double | Required if Available | Degrees - clockwise starting at 0 degrees at true North |
253-
| `gps.speed` | Float | Required if Available | Speed in meters / sec |
254-
| `gps.accuracy` | Float | Required if Available | Accuracy in meters |
253+
| `gps.speed` | Float | Required if Available | Estimated speed in meters / sec as reported by the GPS chipset |
254+
| `gps.accuracy` | Float | Required if Available | Horizontal accuracy, in meters |
255255
| `gps.hdop` | Float | Required if Available | Horizontal GPS or GNSS accuracy value (see [hdop][hdop]) |
256256
| `gps.satellites` | Integer | Required if Available | Number of GPS or GNSS satellites
257257
| `charge` | Float | Required if Applicable | Percent battery charge of vehicle, expressed between 0 and 1 |
@@ -265,7 +265,7 @@ The `/stops` endpoint allows an agency to register city-managed Stops, or a prov
265265

266266
**Endpoint:** `/stops`
267267
**Method:** `POST`
268-
**[Beta feature][beta]:** Yes (as of 1.0.0)
268+
**[Beta feature][beta]:** Yes (as of 1.0.0). [Leave feedback](https://github.com/openmobilityfoundation/mobility-data-specification/issues/638)
269269
**Request Body**: An array of [Stops][stops]
270270

271271
201 Success Response:
@@ -287,7 +287,7 @@ _No content returned on success._
287287

288288
**Endpoint:** `/stops`
289289
**Method:** `PUT`
290-
**[Beta feature][beta]:** Yes (as of 1.0.0)
290+
**[Beta feature][beta]:** Yes (as of 1.0.0). [Leave feedback](https://github.com/openmobilityfoundation/mobility-data-specification/issues/638)
291291
**Request Body**: An array of subsets of [Stop][stops] information, where the permitted subset fields are defined as:
292292

293293
| Field | Required/Optional | Description |
@@ -313,7 +313,7 @@ _No content returned if no vehicle matching `stop_id` is found._
313313

314314
**Endpoint:** `/stops/:stop_id`
315315
**Method:** `GET`
316-
**[Beta feature][beta]:** Yes (as of 1.0.0)
316+
**[Beta feature][beta]:** Yes (as of 1.0.0). [Leave feedback](https://github.com/openmobilityfoundation/mobility-data-specification/issues/638)
317317
**Payload:** `{ "stops": [] }`, an array of [Stops][stops]
318318

319319
Path Params:

‎agency/get_stops.json‎

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@
156156
"type": "number",
157157
"description": "Integer milliseconds since Unix epoch",
158158
"multipleOf": 1.0,
159-
"minimum": 0
159+
"minimum": 1514764800000
160160
},
161161
"uuid": {
162162
"$id": "#/definitions/uuid",
@@ -186,6 +186,11 @@
186186
"type": "integer",
187187
"minimum": 0
188188
},
189+
"cargo_bicycle": {
190+
"$id": "#/definitions/vehicle_type_counts/properties/cargo_bicycle",
191+
"type": "integer",
192+
"minimum": 0
193+
},
189194
"car": {
190195
"$id": "#/definitions/vehicle_type_counts/properties/car",
191196
"type": "integer",
@@ -225,6 +230,16 @@
225230
"Feature"
226231
]
227232
},
233+
"id": {
234+
"oneOf": [
235+
{
236+
"type": "number"
237+
},
238+
{
239+
"type": "string"
240+
}
241+
]
242+
},
228243
"properties": {
229244
"type": "object",
230245
"required": [
@@ -236,6 +251,30 @@
236251
},
237252
"stop_id": {
238253
"$ref": "#/definitions/uuid"
254+
},
255+
"altitude": {
256+
"type": "number",
257+
"description": "Altitude above mean sea level in meters"
258+
},
259+
"heading": {
260+
"type": "number",
261+
"description": "Degrees - clockwise starting at 0 degrees at true North"
262+
},
263+
"speed": {
264+
"type": "number",
265+
"description": "Estimated speed in meters / sec as reported by the GPS chipset"
266+
},
267+
"accuracy": {
268+
"type": "number",
269+
"description": "Horizontal accuracy, in meters"
270+
},
271+
"hdop": {
272+
"type": "number",
273+
"description": "Horizontal GPS or GNSS accuracy value"
274+
},
275+
"satellites": {
276+
"type": "integer",
277+
"description": "Number of GPS or GNSS satellites"
239278
}
240279
}
241280
},

‎agency/get_vehicle.json‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,15 @@
3030
"type": "number",
3131
"description": "Integer milliseconds since Unix epoch",
3232
"multipleOf": 1.0,
33-
"minimum": 0
33+
"minimum": 1514764800000
3434
},
3535
"vehicle_type": {
3636
"$id": "#/definitions/vehicle_type",
3737
"type": "string",
3838
"description": "The type of vehicle",
3939
"enum": [
4040
"bicycle",
41+
"cargo_bicycle",
4142
"car",
4243
"scooter",
4344
"moped",
@@ -280,6 +281,7 @@
280281
"contains": {
281282
"enum": [
282283
"agency_pick_up",
284+
"comms_restored",
283285
"compliance_pick_up",
284286
"decommissioned",
285287
"located",

0 commit comments

Comments
 (0)