Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 1.2.0 to dev #720

Merged
merged 90 commits into from
Nov 4, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
90 commits
Select commit Hold shift + click to select a range
349e9c0
Merge pull request #699 from openmobilityfoundation/ms-1.1.0-fixes
schnuerle Sep 24, 2021
a32266a
Release notes for 1.2.0
schnuerle Sep 29, 2021
b33dbf2
Tweaks to release notes
schnuerle Sep 29, 2021
abccb73
Notes typo in requirements
schnuerle Sep 29, 2021
01ae6d2
Added Version Tracking section to Reqs
schnuerle Oct 4, 2021
345e805
Fixed bold/quote formatting
schnuerle Oct 4, 2021
f11c2ce
Added note about version tracking to metadata
schnuerle Oct 4, 2021
e6392fd
Updated link to version-tracking
schnuerle Oct 4, 2021
9b48393
Updated hosting guidance links
schnuerle Oct 4, 2021
4b8bb81
New Req endpoint in image
schnuerle Oct 6, 2021
7280345
pluralize policies in required properties array
thekaveman Oct 17, 2021
1ea89d9
pluralize policies in property $ids
thekaveman Oct 17, 2021
e441008
update policies array title
thekaveman Oct 17, 2021
dfba163
pluralize prop in the schema document
thekaveman Oct 17, 2021
4c66327
Clarified /vehicles is near-realtime
schnuerle Oct 18, 2021
f6466c7
Minor formatting and typo
schnuerle Oct 19, 2021
4fdb628
apply formatting for readability
thekaveman Oct 17, 2021
074eebc
wrap example policy in full payload body
thekaveman Oct 17, 2021
7263398
regenerate agency schemas with cargo_bicycle
thekaveman Oct 20, 2021
080ea53
regenerate policy schema with cargo_bicycle
thekaveman Oct 20, 2021
b83ddb9
regenerate provider schemas with cargo_bicycle
thekaveman Oct 20, 2021
b6caa1f
update geojson feature in agency schemas
thekaveman Oct 20, 2021
8c4b417
update geojson feature in provider schemas
thekaveman Oct 20, 2021
fd321ab
refactor telemetry props from vehicle props
thekaveman Oct 25, 2021
64bae6f
refactor feature point creation
thekaveman Oct 25, 2021
3ee2e3d
refactor definition name to module-level variable
thekaveman Oct 25, 2021
cf9493d
merge telemetry props into Feature props
thekaveman Oct 25, 2021
6d53528
update agency schemas with new telemetry defs
thekaveman Oct 26, 2021
215d3ad
update provider schemas with new telemetry defs
thekaveman Oct 26, 2021
664d9c4
add comms_restored event for the removed state
thekaveman Oct 26, 2021
48d329e
update agency schemas with removed:comms_restored
thekaveman Oct 26, 2021
6f327e2
update provider schemas with removed:comms_restored
thekaveman Oct 26, 2021
ad8e96f
Merge pull request #709 from compilerla/schemas/cargo_bicycle
schnuerle Oct 26, 2021
b1e8c0d
Merge pull request #710 from compilerla/schemas/pluralize-policies
schnuerle Oct 26, 2021
bfafe12
Merge pull request #712 from compilerla/schemas/mds-feature-point
schnuerle Oct 26, 2021
eb77fff
Merge pull request #713 from compilerla/schemas/comms_restored
schnuerle Oct 26, 2021
d2d7514
Updated working group info
schnuerle Oct 27, 2021
afc1d70
Link to help on provider/agency IDs
schnuerle Oct 27, 2021
8b7154d
Revised Membership section
schnuerle Oct 28, 2021
8d9babd
Added governance links
schnuerle Oct 28, 2021
8431486
Formatting on Policy endpoints
schnuerle Oct 28, 2021
e3b5b41
Added beta feedback to Rates
schnuerle Oct 28, 2021
d278eac
Stops: beta feedback and schema link
schnuerle Oct 28, 2021
5fedd72
Links to general policy schema
schnuerle Oct 28, 2021
ad39b98
Added beta feedback for Agency stops
schnuerle Oct 28, 2021
6c55755
Feedback link for GDEs
schnuerle Oct 28, 2021
e7ad290
Added links to beta feedback
schnuerle Oct 28, 2021
af81074
Metrics beta feedback link
schnuerle Oct 28, 2021
fa29a02
Jurisdiction beta feedback link
schnuerle Oct 28, 2021
e0f0ca2
single geography template and generator
thekaveman Oct 28, 2021
9a6eeec
geographies array template and generator
thekaveman Oct 28, 2021
1e75794
generator dict and wrapper function
thekaveman Oct 28, 2021
a8ac004
expose geography in generate_schemas.py entrypoint
thekaveman Oct 28, 2021
aed2e57
generate the single geography schema document
thekaveman Oct 28, 2021
0fe9bd5
generate the geographies array schema document
thekaveman Oct 28, 2021
b4e8b40
add links to new schema documents
thekaveman Oct 28, 2021
107e349
remove old schema document
thekaveman Oct 28, 2021
82180e9
formatting/markdown cleanup
thekaveman Oct 28, 2021
8f65f3e
update version in examples
thekaveman Oct 28, 2021
42a6e35
update version in jurisdiction examples
thekaveman Oct 28, 2021
1fed1aa
update version in policy examples
thekaveman Oct 28, 2021
1ac5695
Update issue templates for provider/agency IDs
schnuerle Oct 29, 2021
efbbaf5
Update add-agency-id.md
schnuerle Oct 29, 2021
7c96d94
Update add-provider-id.md
schnuerle Oct 29, 2021
633a784
Update add-agency-id.md
schnuerle Oct 29, 2021
9544676
Merge pull request #719 from openmobilityfoundation/ms-agency-provide…
schnuerle Oct 29, 2021
baecd67
Merge pull request #716 from compilerla/schemas/jurisdiction-version
schnuerle Oct 29, 2021
70e36a1
Merge pull request #717 from compilerla/schemas/policy-version
schnuerle Oct 29, 2021
afaaedb
Merge pull request #718 from compilerla/schemas/geography
schnuerle Oct 29, 2021
f1ceea8
Added Ryde Technology provider
schnuerle Oct 29, 2021
8b4f0fc
Removed Ryde since no MDS or GBFS URLs
schnuerle Oct 29, 2021
3882e93
Formatting on agency issue
schnuerle Oct 29, 2021
7dae60d
Formatting on Provider issue
schnuerle Oct 29, 2021
13729e5
Header on Agency issue
schnuerle Oct 29, 2021
bf1d150
Header on provider issue
schnuerle Oct 29, 2021
8a31bda
Update cities using MDS
schnuerle Oct 29, 2021
89dee08
Update version number on home
schnuerle Oct 29, 2021
3cadaef
Minor updates for Requirements
schnuerle Nov 1, 2021
e07d7c3
Clarified optionally authenticated in Jursidictions
schnuerle Nov 1, 2021
cd64ca6
Added Jurisdictions to list of optionally auth APIs
schnuerle Nov 1, 2021
d69fc30
Some Gen Info formatting cleanup
schnuerle Nov 1, 2021
d389db6
Clarified UUID default/usage
schnuerle Nov 1, 2021
9ec2023
Updated to reflect single MDS WG
schnuerle Nov 1, 2021
8e0a9bd
Simplified MDS owners
schnuerle Nov 2, 2021
c118e96
Add Data Privacy section
schnuerle Nov 2, 2021
f0ebd72
Add Data Privacy to TOC
schnuerle Nov 2, 2021
4189d05
Tweaks to privacy area
schnuerle Nov 3, 2021
34b9e33
Revised Get Involved section
schnuerle Nov 4, 2021
a3e8a32
Language pass on homepage
schnuerle Nov 4, 2021
b687433
Update release date
schnuerle Nov 4, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/add-agency-id.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Add Agency ID
about: Create Agency ID for use in MDS
title: 'Add Agency ID: [Agency Name]'
labels: admin
assignees: ''

---

**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.

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.

**Fields needed from you for the [agencies.csv file](https://github.com/openmobilityfoundation/mobility-data-specification/blob/main/agencies.csv).**

_All fields are required._

1. **agency_country_iso_code** - Two letter ISO country code where your agency is located.
- ...
1. **agency_state** - Geographic abbreviation or name of the state where your agency is located.
- ...
1. **agency_city** - Geographic name of the city where your agency is located.
- ...
1. **agency_name** - Full name of your governmental city/agency.
- ...
1. **agency_id** - A random UUID version 4. There are lots of way to generate a unique UUID, like using this website.
- ...
1. **department_url** - URL to the home page of your agency's department.
- ...
1. **requirement_url** - Full https:// URL where your current Policy Requirements endpoint is located.
- ...

Additionally, please provide your name and role within your agency to help with verification.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/add-provider-id.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Add Provider ID
about: Create Provider ID for use in MDS
title: 'Add Provider ID: [Provider Name]'
labels: admin
assignees: ''

---

**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.

Opening this issue will allow you as a mobility service provider get an official provider ID for use across MDS globally.

**Fields needed from you for the [providers.csv file](https://github.com/openmobilityfoundation/mobility-data-specification/blob/main/providers.csv).**

_All fields are required._

1. **provider_name** - Short name of your company.
- ...
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).
- ...
1. **url** - URL to the home page of your company.
- ...
1. **mds_api_url** - Full https:// URL where your root MDS feeds are located.
- ...
1. **gbfs_api_url** - Full https:// URL where your public GBFS feeds are located.
- ...

Additionally, please provide your name and role within your agency to help with verification.
11 changes: 2 additions & 9 deletions CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,5 @@
## All MDS approvals
* @openmobilityfoundation/omf-admin

## Provider Services Working Group
/provider/* @openmobilityfoundation/provider-maintainers @openmobilityfoundation/omf-admin

## City Services Working Group Specific, also JSON Schema
/agency/* @openmobilityfoundation/city-services-maintainers @openmobilityfoundation/omf-admin
/policy/* @openmobilityfoundation/city-services-maintainers @openmobilityfoundation/omf-admin

## schema is changed by provider and city services working group
/schema/* @openmobilityfoundation/provider-maintainers @openmobilityfoundation/city-services-maintainers @openmobilityfoundation/omf-admin
## MDS Working Group
* @openmobilityfoundation/mds-maintainers @openmobilityfoundation/omf-admin
67 changes: 42 additions & 25 deletions README.md

Large diffs are not rendered by default.

42 changes: 42 additions & 0 deletions ReleaseNotes.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,45 @@
## 1.2.0

> Released: 2021-11-04

> [Release Plan](https://github.com/openmobilityfoundation/governance/wiki/Release-1.2.0)

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.

### CHANGES

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.

**_General MDS_**

- [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)
- [Add cargo_bicycle vehicle type](https://github.com/openmobilityfoundation/mobility-data-specification/pull/698)

**_Policy_**

- [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.
- [Ability to express data sharing requirements in Policy](https://github.com/openmobilityfoundation/mobility-data-specification/issues/608)
- [Method to Exclude some Provider Fields from Response](https://github.com/openmobilityfoundation/mobility-data-specification/issues/507)
- [Retrieve operational zones from operators](https://github.com/openmobilityfoundation/mobility-data-specification/issues/639)
- [Make Trip 'route' field optional for privacy](https://github.com/openmobilityfoundation/mobility-data-specification/issues/504)

- [Multiple options added to Policy](https://github.com/openmobilityfoundation/mobility-data-specification/pull/658)
- [Add rate options to other rules types](https://github.com/openmobilityfoundation/mobility-data-specification/issues/633)
- [Support parking fees by duration](https://github.com/openmobilityfoundation/mobility-data-specification/issues/631)
- [Min and max clarity on Rules](https://github.com/openmobilityfoundation/mobility-data-specification/issues/689)
- [Add a "rate applies when" field to Rules](https://github.com/openmobilityfoundation/mobility-data-specification/issues/666)

**_Provider_**

- [Vehicles out of beta](https://github.com/openmobilityfoundation/mobility-data-specification/issues/637)
- [Clarify use cases between MDS Vehicles and GBFS](https://github.com/openmobilityfoundation/mobility-data-specification/issues/641)

_Minor Updates_

- [Clarify single object response on policy/geography](https://github.com/openmobilityfoundation/mobility-data-specification/issues/599)
- [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)
- Add VeoRide, Boaz Bikes, and update Superpedestrian provider IDs

## 1.1.1

> Released: 2021-09-24
Expand Down
14 changes: 7 additions & 7 deletions agency/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,9 +184,9 @@ 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 |
| `timestamp` | [timestamp][ts] | Required | Date of last event update |
| `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. |
| `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:
Expand Down Expand Up @@ -223,7 +223,7 @@ Body Params:
| Field | Type | Field Description |
| ---------- | ------------------------------ | ------------------------------------------------------------------------------------------------------- |
| `success` | Integer | Number of successfully written telemetry data points. |
| `total` | Integer | Ttotal number of provided points. |
| `total` | Integer | Total number of provided points. |
| `failures` | [Telemetry](#telemetry-data)[] | Array of failed telemetry for zero or more vehicles (empty if all successful). |

400 Failure Response:
Expand All @@ -244,7 +244,7 @@ A standard point of vehicle telemetry. References to latitude and longitude impl
| Field | Type | Required/Optional | Field Description |
| -------------- | -------------- | --------------------- | ------------------------------------------------------------ |
| `device_id` | UUID | Required | ID used in [Register](#vehicle---register) |
| `timestamp` | [timestamp][ts] | Required | Date/time that event occurred. Based on GPS or GNSS clock |
| `timestamp` | [timestamp][ts]| Required | Date/time that event occurred. Based on GPS or GNSS clock |
| `gps` | Object | Required | Telemetry position data |
| `gps.lat` | Double | Required | Latitude of the location |
| `gps.lng` | Double | Required | Longitude of the location |
Expand All @@ -265,7 +265,7 @@ The `/stops` endpoint allows an agency to register city-managed Stops, or a prov

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

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

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

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

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

Path Params:
Expand Down
39 changes: 39 additions & 0 deletions agency/get_stops.json
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,11 @@
"type": "integer",
"minimum": 0
},
"cargo_bicycle": {
"$id": "#/definitions/vehicle_type_counts/properties/cargo_bicycle",
"type": "integer",
"minimum": 0
},
"car": {
"$id": "#/definitions/vehicle_type_counts/properties/car",
"type": "integer",
Expand Down Expand Up @@ -225,6 +230,16 @@
"Feature"
]
},
"id": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"properties": {
"type": "object",
"required": [
Expand All @@ -236,6 +251,30 @@
},
"stop_id": {
"$ref": "#/definitions/uuid"
},
"altitude": {
"type": "number",
"description": "Altitude above mean sea level in meters"
},
"heading": {
"type": "number",
"description": "Degrees - clockwise starting at 0 degrees at true North"
},
"speed": {
"type": "number",
"description": "Estimated speed in meters / sec as reported by the GPS chipset"
},
"accuracy": {
"type": "number",
"description": "Horizontal accuracy, in meters"
},
"hdop": {
"type": "number",
"description": "Horizontal GPS or GNSS accuracy value"
},
"satellites": {
"type": "integer",
"description": "Number of GPS or GNSS satellites"
}
}
},
Expand Down
2 changes: 2 additions & 0 deletions agency/get_vehicle.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
"description": "The type of vehicle",
"enum": [
"bicycle",
"cargo_bicycle",
"car",
"scooter",
"moped",
Expand Down Expand Up @@ -280,6 +281,7 @@
"contains": {
"enum": [
"agency_pick_up",
"comms_restored",
"compliance_pick_up",
"decommissioned",
"located",
Expand Down
39 changes: 39 additions & 0 deletions agency/post_stops.json
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,11 @@
"type": "integer",
"minimum": 0
},
"cargo_bicycle": {
"$id": "#/definitions/vehicle_type_counts/properties/cargo_bicycle",
"type": "integer",
"minimum": 0
},
"car": {
"$id": "#/definitions/vehicle_type_counts/properties/car",
"type": "integer",
Expand Down Expand Up @@ -225,6 +230,16 @@
"Feature"
]
},
"id": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"properties": {
"type": "object",
"required": [
Expand All @@ -236,6 +251,30 @@
},
"stop_id": {
"$ref": "#/definitions/uuid"
},
"altitude": {
"type": "number",
"description": "Altitude above mean sea level in meters"
},
"heading": {
"type": "number",
"description": "Degrees - clockwise starting at 0 degrees at true North"
},
"speed": {
"type": "number",
"description": "Estimated speed in meters / sec as reported by the GPS chipset"
},
"accuracy": {
"type": "number",
"description": "Horizontal accuracy, in meters"
},
"hdop": {
"type": "number",
"description": "Horizontal GPS or GNSS accuracy value"
},
"satellites": {
"type": "integer",
"description": "Number of GPS or GNSS satellites"
}
}
},
Expand Down
1 change: 1 addition & 0 deletions agency/post_vehicle.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
"description": "The type of vehicle",
"enum": [
"bicycle",
"cargo_bicycle",
"car",
"scooter",
"moped",
Expand Down
Loading