2.0.1

2.0.1

Release 2023-12-18

The 2.0.1 release fixes some minor issues and typos to help make the specification clearer.

CHANGES

See the closed PRs tagged with Milestone 2.0.1 and Issues for a full list of changes.

Minor updates

• #879 Clarify which vehicles are included in the MDS 2.0 /vehicles endpoint
• #868 Correction of description vehicle events (car sharing) bug Car Share

Typos and wording clarifications

• #880 Remove word "data" from provider response payload descriptions
• #894 Fixing broken links in data-types markdown document
• #876 Reports endpoint - START_DATE clarification
• #884 Fix JSON key in /vehicles/status example response
• #878 Update "status changes" to "events" in provider

Identifier updates

• #872 Add GBFS endpoint for Whoosh
• #890 Add Nextbike

ACKNOWLEDGEMENTS

Thank you to our current and past steering committee members, GitHub pull request creators (Populus, Ride Report, Transbits, Whoosh), issue creators (City of Bergen, Nextbike, Populus, Ride Report, SFTMA, Transbits) for this release, and for the organizations that participated on our weekly working group calls.

What's Changed

Full Changelog: 2.0.0...2.0.1

2.0.0

The 2.0.0 major release includes support for new mobility modes, enhancements around Policy, and the alignment of the data and structure of Agency and Provider, among many other features.

LICENSE and DISCLAIMER

Use of OMF Releases are bound by the OMF License and Disclaimer.

RELEASE PLAN

Our 2.0.0 Release Plan page has more information about this history of this release, and includes a history of our public meetings with minutes.

UPGRADING

For guidance on when to upgrade and how to discuss MDS versions in city regulations, see our MDS Policy Language Guidance and MDS Version Guidance documents.

CHANGES

See the closed PRs tagged with Milestone 2.0.0 and Issues for a full list of changes.

Admin/General Changes

• Update state machine diagrams and create 3 new diagrams for each new modes
• Remove Schema and instead link to OpenAPI repo
  • OpenAPI support in place of JSON Schema allows easier building of real-time MDS endpoint validation, and interactive documentation on Stoplight.
• Remove Geography from Policy
• Authorization consistency across MDS
• Make GBFS optional for some modes
• Align vehicle types to GBFS
  • Updated MDS alignment with GBFS to include all of their vehicle types (including seated scooter) and the addition of new ones for modes (bus, truck, delivery robot, motorcycle), all propulsion types, and to require GBFS for only micromobility and car share (delivery robots and passenger services are option, but not well supported in GBFS).
• Added maintenance_pick_up event for out of PROW work
• Ability to send tip overs, surface type, and parking validation data if available from sensors
  • New optional fields to include sensors now available and in use in the field by many micromobility companies for tip overs, surface type, and parking validation.
• Vertical accuracy for GPS telemetry
• All vehicle states are now clearly in or out of the right of way, no unknown state
• Many new provider IDs added

Modes Architecture

• Support for multiple modes/services in MDS
  • Updates the base of MDS to have some shared objects and fields, and specific fields as needed for each mode.
  • Adds specific modes to MDS, with help from Member Networks, and existing real world data exchanges between operators, agencies, and solution providers.
  • Operators must register a unique UUID for each mode they operate under.

Passenger Services

• Passenger services/TNC/taxi support

Delivery Robots

• Support for vehicles like delivery robots

Car Share

• Carshare Support

Work to bring modes together

• Add a "Data Provider UUID" to MDS
  • New data provider id allows endpoints to include who is producing and serving up the data. Software companies and solution providers are encouraged to register for their own global UUID now to serve up operator or agency data with MDS.
• Support for Modes in Policy - specify which mode your policy applies to

Policy Reimagining

A reimagining of Policy, including top ten most common policies are clearly defined, edge cases (dwell time, trip definition, rule units, updating/ending policies, lookback periods) are clarified, Stops is out of beta, and Policy feeds are public

• Multimodal support in Policy
• Clarification on dwell time duration
• Clarification on possible values of rule_units
• Move Stops out of beta
• Policy is now public
• Updating and ending policy clarification
• Lookback period clarification

Policy Requirements

Requirements now supports linking to external use cases, and is moved out of beta because of adoption.

• Support to reference external use cases
• Move out of beta

Agency/Provider Unification

The difference between Agency and Provider is that with Agency operators PUSH data to cities, and with Provider cities PULL data from operators. Both share the same data types, referenced in a new file, with the same endpoints and fields available.

• MDS Agency and Provider Unification
  • Endpoints are now identical
  • Data objects are now identical, referenced in new data-type.md file
  • Distinction between Agency and Provider is now simply pushing data to agencies, or pulling data from operators
• Adding trips endpoint to Agency
• Adding trip metadata to Agency
  • Trip telemetry points are no longer in the trips endpoint directly, instead referenced in their own telemetry endpoint. Start and end location only is available in trips.

Provider

Reports have a new adaptive scooter special group type, and improved formatting.

• Updates to provider reports including header, date format, column names, and adaptive scooter special group type

Geography

• Geography is now public, and removed from Policy

Jurisdiction

• Jurisdiction is now public

Technical Updates

As part of the OpenAPI schema work, a number of technical updates were made to ensure the spec was internally consistent. A full list can be found for all issues and PRs in this date range.

• OpenAPI Schema definitions, created in mds-openapi repo
• HTTP error and bulk responses
• Accessibility 'options' renamed to 'attributes' for consistency
• Add missing event types from main list
• Fix car share event types
• Updated fare_attributes.payment_type list
• [Use last_updated consistently](https://github.com/openmobilityfoundation/mobility-data-specifica...

2.0.0 Release Candidate 1

The 2.0.0 major release includes support for new mobility modes, enhancements around Policy, and the alignment of the data and structure of Agency and Provider, among many other features.

LICENSE and DISCLAIMER

Use of OMF Releases are bound by the OMF License and Disclaimer.

RELEASE PLAN

Our 2.0.0 Release Plan page has more information about this history of this release, and includes a history of our public meetings with minutes.

UPGRADING

For guidance on when to upgrade and how to discuss MDS versions in city regulations, see our MDS Policy Language Guidance and MDS Version Guidance documents.

CHANGES

See the closed PRs tagged with Milestone 2.0.0 and Issues for a full list of changes.

Admin/General Changes

• Update state machine diagrams and create 3 new diagrams for each new modes
• Remove Schema and instead link to OpenAPI repo
  • OpenAPI support in place of JSON Schema allows easier building of real-time MDS endpoint validation, and interactive documentation on Stoplight.
• Remove Geography from Policy
• Authorization consistency across MDS
• Make GBFS optional for some modes
• Align vehicle types to GBFS
  • Updated MDS alignment with GBFS to include all of their vehicle types (including seated scooter) and the addition of new ones for modes (bus, truck, delivery robot, motorcycle), all propulsion types, and to require GBFS for only micromobility and car share (delivery robots and passenger services are option, but not well supported in GBFS).
• Added maintenance_pick_up event for out of PROW work
• Ability to send tip overs, surface type, and parking validation data if available from sensors
  • New optional fields to include sensors now available and in use in the field by many micromobility companies for tip overs, surface type, and parking validation.
• Vertical accuracy for GPS telemetry
• All vehicle states are now clearly in or out of the right of way, no unknown state
• Many new provider IDs added

Modes Architecture

• Support for multiple modes/services in MDS
  • Updates the base of MDS to have some shared objects and fields, and specific fields as needed for each mode.
  • Adds specific modes to MDS, with help from Member Networks, and existing real world data exchanges between operators, agencies, and solution providers.
  • Operators must register a unique UUID for each mode they operate under.

Passenger Services

• Passenger services/TNC/taxi support

Delivery Robots

• Support for vehicles like delivery robots

Car Share

• Carshare Support

Work to bring modes together

• Add a "Data Provider UUID" to MDS
  • New data provider id allows endpoints to include who is producing and serving up the data. Software companies and solution providers are encouraged to register for their own global UUID now to serve up operator or agency data with MDS.
• Support for Modes in Policy - specify which mode your policy applies to

Policy Reimagining

A reimagining of Policy, including top ten most common policies are clearly defined, edge cases (dwell time, trip definition, rule units, updating/ending policies, lookback periods) are clarified, Stops is out of beta, and Policy feeds are public

• Multimodal support in Policy
• Clarification on dwell time duration
• Clarification on possible values of rule_units
• Move Stops out of beta
• Policy is now public
• Updating and ending policy clarification
• Lookback period clarification

Policy Requirements

Requirements now supports linking to external use cases, and is moved out of beta because of adoption.

• Support to reference external use cases
• Move out of beta

Agency/Provider Unification

The difference between Agency and Provider is that with Agency operators PUSH data to cities, and with Provider cities PULL data from operators. Both share the same data types, referenced in a new file, with the same endpoints and fields available.

• MDS Agency and Provider Unification
  • Endpoints are now identical
  • Data objects are now identical, referenced in new data-type.md file
  • Distinction between Agency and Provider is now simply pushing data to agencies, or pulling data from operators
• Adding trips endpoint to Agency
• Adding trip metadata to Agency
  • Trip telemetry points are no longer in the trips endpoint directly, instead referenced in their own telemetry endpoint. Start and end location only is available in trips.

Provider

Reports have a new adaptive scooter special group type, and improved formatting.

• Updates to provider reports including header, date format, column names, and adaptive scooter special group type

Geography

• Geography is now public, and removed from Policy

Jurisdiction

• Jurisdiction is now public

ACKNOWLEDGEMENTS

Thank you to our current and past steering committee members, GitHub pull request creators (BCycle, BIRD, Helbiz, Lacuna, Leo&Go, Nicolai Heilbuth, Poppy Mobility, Populus, Ride Report, SFMTA, Tembici, Troopy, Whoosh, Yego, Zig Zag), issue creators (ATOM Mobility, Blue Systems, DB Systel GmbH, Drover, Lacuna, Lime, Miami-Dade, Ning Shi, OpenBikeShare, OpenMobility.be, Populus, Ride Report, San Francisco County Transportation Authority, Telofun, TukTuk) for this release, and for the scores of organizations that participated on our weekly working group calls.

What's Changed

• Release 1.2.0 to dev by @schnuerle in #720
• Added LEO and ATOM by @schnuerle in #725
• Add TukTuk provider by @schnuerle in #730
• Adding Helbiz to providers.csv by @milos-ljubinkovic in #732
• Update providers.csv by @sonnessa in https://...

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. Review the Release Plan, and browse the full specification.

LICENSE and DISCLAIMER

Use of OMF Releases are bound by the OMF License and Disclaimer.

RELEASE PLAN

Our 1.2.0 Release Plan page has more information about this history of this release, and includes a history of our public meetings with minutes.

UPGRADING

For guidance on when to upgrade and how to discuss MDS versions in city regulations, see our MDS Policy Language Guidance and MDS Version Guidance documents. Also see our Upgrading to 1.0.0 guide which may be helpful if you are on an older MDS version.

CHANGES

See the closed PRs tagged with Milestone 1.2.0 and Issues for a full list of changes.

General MDS

• Richer telemetry data, including 616, 73, 51
• Add cargo_bicycle vehicle type

Policy

• Program Requirements - 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
  • Method to Exclude some Provider Fields from Response
  • Retrieve operational zones from operators
  • Make Trip 'route' field optional for privacy

• Multiple options added to Policy

  • Add rate options to other rules types
  • Support parking fees by duration
  • Min and max clarity on Rules
  • Add a "rate applies when" field to Rules

Provider

• Vehicles out of beta
• Clarify use cases between MDS Vehicles and GBFS

Minor Updates

• Clarify single object response on policy/geography
• Schema updates, including 645, 687, 683, 712, 713, 716, 717, 718
• Add VeoRide, Boaz Bikes, and update Superpedestrian provider IDs

ACKNOWLEDGEMENTS

Thank you to GitHub pull request creators (Blue Systems, Compiler, E&A, Populus, Superpedestrian), issue creators (Ride Report, Populus, SPIN, Vianova), and commenters (City of Austin, Blue Systems, Compiler, E&A, Hyperknot, City of Los Angeles, MobilityData, Nivel, Populus, Ride Report, Seattle DOT, SFMTA, SPIN, Superpedestrian, Vianova) for this release, and for the dozens of organizations that participated on our weekly working group calls.

1.2.0 Release Candidate 1

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.

LICENSE and DISCLAIMER

Use of OMF Releases are bound by the OMF License and Disclaimer.

RELEASE PLAN

Our 1.2.0 Release Plan page has more information about this history of this release, and includes a history of our public meetings with minutes.

UPGRADING

For guidance on when to upgrade and how to discuss MDS versions in city regulations, see our MDS Policy Language Guidance and MDS Version Guidance documents. Also see our Upgrading to 1.0.0 guide which may be helpful if you are on an older MDS version.

CHANGES

See the closed PRs tagged with Milestone 1.2.0 and Issues for a full list of changes.

General MDS

• Richer telemetry data, including 616, 73, 51
• Add cargo_bicycle vehicle type

Policy

• Program Requirements - 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
  • Method to Exclude some Provider Fields from Response
  • Retrieve operational zones from operators
  • Make Trip 'route' field optional for privacy

• Multiple options added to Policy

  • Add rate options to other rules types
  • Support parking fees by duration
  • Min and max clarity on Rules
  • Add a "rate applies when" field to Rules

Provider

• Vehicles out of beta
• Clarify use cases between MDS Vehicles and GBFS

Minor Updates

• Clarify single object response on policy/geography
• Schema updates, including 645, 687, 683
• Add VeoRide, Boaz Bikes, and update Superpedestrian provider IDs

ACKNOWLEDGEMENTS

Thank you to GitHub pull request creators (Blue Systems, Compiler, E&A, Populus, Superpedstrian), issue creators (Ride Report, Populus, SPIN, Vianova), and commenters (City of Austin, Blue Systems, Compiler, E&A, Hyperknot, City of Los Angeles, MobilityData, Nivel, Populus, Ride Report, Seattle DOT, SFMTA, SPIN, Superpedestrian, Vianova) for this release, and for the dozens of organizations that participated on our weekly working group calls.

1.1.1

The 1.1.1 support release fixes the version validation for MDS 1.1.0 in the JSON schema, and adds comms_restored to removed state.

CHANGES

• "removed" missing "comms_restored" option in provider schemas
• Version number is 1.0.x for 1.1.0 release

1.1.0

NOTE: See the 1.1.1 support release for the latest code that includes schema fixes.

The 1.1.0 minor release adds new top level APIs (geography, jurisdictions, metrics), privacy options (provider reports, geography-driven events, metrics), and transparency features (public endpoints). Review the Release Plan, browse the full specification, and read our blog post.

LICENSE and DISCLAIMER

Use of OMF Releases are bound by the OMF License and Disclaimer.

RELEASE PLAN

Our 1.1.0 Release Plan page has more information about this history of this release, and includes a history of our public meetings with minutes.

UPGRADING

For guidance on when to upgrade and how to discuss MDS versions in city regulations, see our MDS Policy Language Guidance and MDS Version Guidance documents. Also see our Upgrading to 1.0.0 guide which may be helpful if you are on an older MDS version.

CHANGES

See the closed PRs tagged with Milestone 1.1.0 and Issues for a full list of changes.

MDS

• Policy and Geography can be public
• Geography-Driven Events: Issue

Minor Updates

• Unregistered error
• Geography updates
• Stops updates
• Response time expectations
• Geography publish date field consistency
• Adding more cities using MDS
• Adding more providers using MDS
• Added a section for third party software companies using MDS and cleaned up home page, moving list content to the OMF website
• Update geography_json field type

Provider

• New Reports: Issue

Agency

• N/A

Policy

• Images of Stops
• Clarify update frequency: Issue

Geography

• Elevating Geography to a first class API: PR, Issue
• Geography Types: Issue, Discussion

Metrics

• New Agency Metrics API: Definitions PR, Spec PR, Issue

Jurisdiction

• New Jurisdiction API: Issue

ACKNOWLEDGEMENTS

Thank you to GitHub pull request creators (Blue Systems, E&A, Populus, Ride Report, SFMTA), issue creators (E&A, Nivel, Pixelarbeit, Ride Report, SPIN), and commenters (Austin, Blue Systems, Chicago, DC, Deutsche Bahn DB Systel GmbH, Dott, E&A, Interline, Ride Report, SFMTA, SPIN) for this release, and for the dozens of organizations that participated on our weekly working group calls.

1.1.0 Release Candidate 1

The 1.1.0 minor release adds new top level APIs (Geography, Jurisdiction, Metrics), privacy options (Provider Reports, geography-driven events, Metrics), and transparency features (public endpoints). Review the Release Plan, browse the full specification, and read our blog post.

LICENSE and DISCLAIMER

Use of OMF Releases are bound by the OMF License and Disclaimer.

RELEASE PLAN

Our 1.1.0 Release Plan page has more information about this history of this release, and includes a history of our public meetings with minutes.

UPGRADING

For guidance on when to upgrade and how to discuss MDS versions in city regulations, see our MDS Policy Language Guidance and MDS Version Guidance documents. Also see our Upgrading to 1.0.0 guide which may be helpful if you are on an older MDS version.

CHANGES

See the closed PRs and Issues tagged with "Milestone 1.1.0" for a full list of changes.

MDS

• Policy and Geography can be public
• Geography-Driven Events - Issue

Minor Updates

• Unregistered error
• Stops updates
• Response time expectations
• Geography publish date field consistency
• Adding more cities using MDS
• Adding more providers using MDS
• New API icons

Provider

• New Reports - Issue

Agency

• N/A

Policy

• Images of Stops
• Clarify update frequency - Issue

Geography

• Elevating Geography to a first class API - PR, Issue
• Geography Types - Issue, Discussion

Metrics

• New Agency Metrics API - Definitions PR, Spec PR, Issue, k-value discussion

Jurisdiction

• New Jurisdiction API - Issue

1.0.0

The 1.0.0 release reconciles and aligns many parts of the MDS specification and adds features and updates requested by the community, including many new detailed vehicle states and event types, support for Stops (for docked vehicles, dockless corrals, parking areas), and adding rates (fees/subsidies) to Policy.

LICENSE and DISCLAIMER

Use of OMF Releases are bound by the OMF License and Disclaimer.

RELEASE PLAN

Our 1.0.0 Release Plan page has more information about this history of this release, and includes a history of our public meetings with minutes.

UPGRADING

See our Upgrading to 1.0.0 guide for some on upgrading.

CHANGES

See the closed PRs tagged with Milestone 1.0.0 for a full list of changes.

MDS

• Reconcile the Provider and Agency language differences

  • New State Machine Diagram
  • JSON Schema updates
  • Add 'located' event_type
  • Update Unknown/Unspecified transitions
  • Add 'unspecified' events where needed

• Adding Stops - Beta

• Minor Updates

  • Update cities using MDS
  • Update Austin, Louisville links
  • Add link to State of Practice
  • Update GBFS references and links
  • Move Code of Conduct, Contributing Guide, and Release Guidelines to new Governance repo
  • Updating 'master' to 'main' as default branch name
  • Add Superpedestrian to providers.csv
  • Add Circ to providers.csv
  • Removed Options version negotiation
  • Added 'other' vehicle type

Provider

• Events out of beta

Agency

• Vehicle register: add provider_id field
• Clarify vehicle endpoint requirements
• Vehicle response code should be 200
• Clarify telemetry success response

Policy

• Add Rates (fees + subsidies)
• Rearrange Speed Limit Example
• Added Geography schema
• Add Policy JSON Schema

1.0.0 Release Candidate 1

The 1.0.0 release reconciles many parts of the MDS specification 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.

LICENSE and DISCLAIMER

Use of OMF Releases are bound by the OMF License and Disclaimer.

CHANGES

The 1.0.0 branch is available for review. See Issues and PRs tagged with Milestone 1.0.0 open, closed for a full list of changes.

MDS

• Reconcile the Provider and Agency language differences

  • New State Machine Diagram
  • JSON Schema updates

• Adding Stops - Beta

• Minor Updates

  • Update cities using MDS
  • Update Austin, Louisville links
  • Add link to State of Practice
  • Update GBFS references and links
  • Move Code of Conduct, Contributing Guide, and Release Guidelines to new Governace repo
  • Updating 'master' to 'main' as default branch name
  • Update providers.csv to add Superpedestrian
  • Removed Options version negotiation
  • Added 'other' vechicle type

Provider

• Events out of beta

Agency

• Vehicle register: add provider_id field
• Clarify vehicle endpoint requirements
• Vehicle response code should be 200
• Clarify telemetry success response

Policy

• Add Rates (fees + subsidies)
• Rearrange Speed Limit Example
• Added Geography schema