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

Policy Requirements #646

Merged
merged 71 commits into from Sep 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
71 commits
Select commit Hold shift + click to select a range
4402a43
Start of Requirements endpoint
schnuerle May 18, 2021
352d784
Setting up schema parts
schnuerle May 19, 2021
68f6e34
First pass at requirements metadata
schnuerle May 19, 2021
b6818c8
Requirement TOC
schnuerle May 19, 2021
b9d0e53
Added sub section schema definitions
schnuerle May 20, 2021
9c4804a
First 2 examples
schnuerle May 20, 2021
689baae
Added comma
schnuerle May 20, 2021
544e16f
Added links to Req examples
schnuerle May 20, 2021
188691e
Create agencies.csv
schnuerle May 20, 2021
4e47a17
Add agencies.csv mention
schnuerle May 20, 2021
d786abc
Added explainer for Requirement file
schnuerle May 20, 2021
e6015df
Working Group feedback changes
schnuerle May 21, 2021
dd6f4b3
Updated examples based on WG feedback
schnuerle May 22, 2021
e833f57
Special notes about required_fields
schnuerle May 22, 2021
c8b3aa3
Updated mds endpoints to make sense
schnuerle May 24, 2021
a9dea76
Added 3rd example, placeholder for 2 more
schnuerle May 24, 2021
e4c27aa
Added Provider and Other APIs examples
schnuerle May 27, 2021
d682a98
Added Agency example
schnuerle May 28, 2021
cf3bfff
Added Geography Driven Events example
schnuerle May 28, 2021
e868dba
Fixed agency_id location
schnuerle May 28, 2021
f9b7894
Added agency-language
schnuerle Jun 2, 2021
44e27d1
Added language to req examples
schnuerle Jun 2, 2021
d9c0ed4
Changed GBFS to boolean
schnuerle Jun 3, 2021
5da6e87
Updated example booleans and URLs
schnuerle Jun 3, 2021
eb0a6eb
Updated link to Policy section
schnuerle Jun 23, 2021
6c6a89d
Added optional vehicle types
schnuerle Jun 23, 2021
a2262e6
Added update frequency recommendations
schnuerle Jun 24, 2021
da6d8fa
Updated TOC
schnuerle Jun 24, 2021
78506c3
Added vehicle_type to an example
schnuerle Jun 24, 2021
05f5522
Fixed update frequency TOC conflict
schnuerle Jun 24, 2021
eb08091
Added program description and optional policy_id
schnuerle Jun 24, 2021
e3e86ea
Added descriptions and policy_ids to examples
schnuerle Jun 24, 2021
6a309f7
Typo fix
schnuerle Jun 24, 2021
30cfaca
First example converted to Programs format
schnuerle Jul 7, 2021
cbb8c11
Updated all examples with Programs structure
schnuerle Jul 8, 2021
84e86bb
Added new GBFS only example
schnuerle Jul 8, 2021
aa4fef9
Rearranged endpoint based on Programs concept
schnuerle Jul 8, 2021
683ddc6
Updated TOC
schnuerle Jul 8, 2021
5e50cc9
Fixed anchor on policy_id
schnuerle Jul 8, 2021
6ddb0a0
Transportation link updates
schnuerle Jul 8, 2021
91c0974
Renamed fields, remove policy_id
schnuerle Jul 8, 2021
ef98c64
Updated field names and removed policy_id
schnuerle Jul 8, 2021
e7115a0
Added dot notation for fields
schnuerle Jul 8, 2021
bb7d0f9
Updated dot notation in examples
schnuerle Jul 8, 2021
cef25e9
Added available_X to examples
schnuerle Jul 8, 2021
e76ca43
Added concept of available_x apis, endpoints, fields
schnuerle Jul 8, 2021
3bdc034
Updated agency URL example
schnuerle Jul 8, 2021
5589989
Typo fixes
schnuerle Jul 19, 2021
0c7da67
Added link to Agency Requirements repo
schnuerle Jul 29, 2021
380c6ee
Rearranged fields to be alphabetical
schnuerle Aug 5, 2021
2644b4c
Added possibility to support more specs than MDS/GBFS
schnuerle Aug 6, 2021
0b4b04e
Added beta 'requested' language
schnuerle Aug 6, 2021
8cda94c
Added 'disallowed_fields' to spec
schnuerle Aug 6, 2021
49a5b91
Added example for Trips with disallowed fields
schnuerle Aug 6, 2021
6a1a30f
Added an optional field to disallowed example
schnuerle Aug 6, 2021
03d298f
Added language about scaled-down MDS situations
schnuerle Aug 6, 2021
aa40dd2
Added TOC link to hosting
schnuerle Aug 6, 2021
467694c
Typo fixes
schnuerle Aug 12, 2021
0bd8ca2
Added some OMF member cities
schnuerle Aug 12, 2021
09ec011
Shortened some city URLs
schnuerle Aug 12, 2021
89ab2b1
Renamed to agency_state since not all are abbreviations
schnuerle Aug 17, 2021
611e9db
Chaging agency_uuid to agency_id
schnuerle Aug 18, 2021
cc1ec75
Changing to agency_id in examples
schnuerle Aug 18, 2021
1b680f2
Added link to beta feedback
schnuerle Aug 18, 2021
afad95e
Updated TOMP-API name
schnuerle Aug 18, 2021
14ed15b
Clarified unlisted APIs and Endpoints will not be returned
schnuerle Aug 24, 2021
e60dee6
Typo with 'between'
schnuerle Aug 24, 2021
fbf5325
Realistic max_update_interval example
schnuerle Aug 26, 2021
aed2f40
Added link from GDE to example
schnuerle Aug 26, 2021
35d8b8e
Changed all examples to monthly max update interval
schnuerle Sep 1, 2021
648b219
Disallowed fields must return no field/value
schnuerle Sep 1, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Expand Up @@ -138,6 +138,8 @@ More than 115 cities and public agencies around the world use MDS, and it has be

Please let us know [via our website](https://www.openmobilityfoundation.org/get-in-touch/) or in the [public discussion area](https://github.com/openmobilityfoundation/mobility-data-specification/discussions) if you are an agency using MDS so we can add you to the city resource list, especially if you have published your policies or documents publicly.

To add yourself to the [agency list](/agencies.csv) and add your [Policy Requirement link](/provider.md#requirements), please let us know [via our website](https://www.openmobilityfoundation.org/get-in-touch/) or open an [Issue](https://github.com/openmobilityfoundation/mobility-data-specification/issues) or [Pull Request](https://github.com/openmobilityfoundation/mobility-data-specification/pulls).

[Top][toc]

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

**[Beta feature](/general-information.md#beta-features):** *Yes (as of 1.1.0)*

Geography-Driven Events is a new 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.
Geography-Driven Events (GDE) is a new 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.

See [this example](/policy/examples/requirements.md#geography-driven-events) for how to implement GDE using [Policy Requirements](/policy#requirement).

Here's how it works in practice:

Expand All @@ -143,9 +145,9 @@ Here's how it works in practice:

*Agency adds rule disallowing parking on waterfront path, begins receiving data on events within area.*

Agencies that wish to use Geography-Driven Events do so by requiring a new `event_geographies` field in status events. When an Agency is using Geography-Driven Events, Providers must emit a new `changed_geographies` status event whenever a vehicle in a trip enters or leaves a Geography managed by a Policy.
Agencies that wish to use Geography-Driven Events do so by requiring a new `event_geographies` field in status events. When an Agency is using Geography-Driven Events, Providers must emit a new `changed_geographies` status event whenever a vehicle in a trip enters or leaves a Geography managed by a Policy.

During the Beta period for this feature, location and telemtry data remain required fields. This allows Aggencies to test Geography-Driven Events, measuring its accuracy and efficacy against regulatory systems based on precise location data. After the beta period, if Geography-Driven Events is deemed by OMF to be accurate and effective, the specification will evolve to allow cities to use Geography-Driven Events in lieu of location or telemtry data.
During the Beta period for this feature, location and telemetry data remain required fields. This allows Agencies to test Geography-Driven Events, measuring its accuracy and efficacy against regulatory systems based on precise location data. After the beta period, if Geography-Driven Events is deemed by the OMF to be accurate and effective, the specification will evolve to allow cities to use Geography-Driven Events in lieu of location or telemetry data.

[Top][toc]

Expand Down Expand Up @@ -293,7 +295,7 @@ In a multi-jurisdiction environment, the status of a vehicle is per-jurisdiction

### Event Types

Event types are the possible transitions bewteen some vehicle states.
Event types are the possible transitions between some vehicle states.

| `event_type` | Description |
|---|---|
Expand Down