ReleaseNotes.md

2.0.0

Released 2023-05-09

Release Plan

The 2.0.0 major release includes support for new mobility modes, clarity around Policy, and the alignment of the data and structure of Agency and Provider.

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 4 new diagrams for each mode
• 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 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 data to Agency (openmobilityfoundation#770)
  • 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 across responses
• Remove extra 'data' hierarchy in responses in some endpoints

1.2.0

Released: 2021-11-04

Release Plan

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

1.1.1

Released: 2021-09-24

The 1.1.1 support release fixes the version validation for 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

Released: 2021-03-30

Release Plan

The 1.1.0 minor release adds new top level APIs (geography, jurisdictions), privacy options (provider reports, geography-driven events, metrics), and transparency features (public endpoints).

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

1.0.0

Released: 2020-09-16

Release Plan

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.

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

0.4.1

Released 2020-05-15

0.4.1 is the first release of the Mobility Data Specification under the guidance and stewardship of the Open Mobility Foundation. As such, this release includes a number of administrative and documentation changes, including to the licensing and release process. This release also brings a number of language clarifications from 0.4.0 and new features across the various APIs, including the much anticipated /vehicles endpoint in Provider.

CHANGES

MDS

• MDS officially transferred from LADOT to OMF:
  • Update license from CC0 to CC-BY
  • Updates to various documentation to support code transfer from LADOT to OMF
  • Switch CODEOWNERS to use OMF teams
  • Add documentation around currently Supported MDS versions
  • Add documentation around Understanding MDS APIs
  • ReleaseGuidelines updates to reflect OMF process and 12 week dev cycle
• Added "moped" vehicle type

Provider

• Mention ambiguity for event_type reserved
• Clarify no pagination on /trips and /status_changes
• Make required/optional endpoints more explicit
• Adding a /vehicles endpoint
• JSON Schema fixes/updates

Agency

• Add decommissioned event type reason
• Add versioning

Policy

• Update documentation to use correct field name
• Add missing rule_id
• Add versioning

0.4.0

Release 2019-10-31

The 0.4.0 release represents a major step forward in the Mobility Data Specification. The provider endpoints have been refactored to allow static file backed API servers which should improve uptime, reliability and the ability to backfill what is now growing to years of data. There is a new policy API endpoint, designed to be implemented by Agencies, that allows for clearer communication of geofencing, vehicle caps and more. A full list of changes is below. Many thanks to all the contributors who helped on this release.

CHANGES

Provider

• Improved Handling of Cost Data
• Allow static file storage backed API Endpoints
• Cleanup Provider README
• Legacy Version Header Cleanup
• Internationalization of Currency data
• Specify Types for Query Params
• Clarify the definition of Municipal Boundary
• Update Status Change JSON Schema to include Associated Trip properly

Agency

• Add Accuracy Field for GPS Telemetry Data
• String Limit to 255 Characters
• Remove SLA from /telemetry
• Update State Machine Diagram

Misc

• New Policy API Endpoint
• Improved README for Schema Directory
• Add Car Vehicle Type
• Unify Error Responses between Provider / Agency
• Improvements to Release Process

0.3.2

Released 2019-06-13

This release is a series of non breaking and minor changes for provider, along with JSON Schema for agency.

CHANGES

Provider

• Add an optional recorded field to provider
• Ordering Definitions
• 406 response - version negiotation

Agency

• JSON Schema for Agency

Misc

• Schema Folder Cleanup
• Global GNSS Support

0.3.1

Released 2019-04-30

This release represents a series of non-breaking changes and clarifications for provider, along with a number of agency bugfixes / changes.

CHANGES

Provider

• MDS Schema version fix.
• New release process. Thanks @jfh for documenting, all for participating
• Additional documentation around what is considered Breaking / Non-Breaking. Thanks @rf-
• OPTIONS for version negotiation. Thanks @billdirks
• Add Agency Drop off / pick up. Thanks @margodawes
• Explicitly allow associated_trip for any event type

Agency

• Change from UUIDv4 to just UUID. Thanks @karcass
• Change Error Messages for State Machine validation.
• Update Pagination Rules
• Add Unregistered event.
• Add Event Diagram. Thanks @whereissean
• Removing 412 Responses
• Add deregister and decomissioned events. Thanks @dirkdk
• Remove 5 second Telemetry requirement
• Improve failure and error handling around Telemetry Data

0.3.0

Released 2019-02-15

This release is the first minor version release of MDS with breaking changes for deployed provider API instances.

CHANGES

• Improved Time Based Filtering Query Parameters. #139. Thanks @babldev
• Changes in Service Area for Agency API.
• Switch timestamps to Integer milliseconds since Epoch rather then seconds. #179
• Removed unused bbox query parameter. #183
• Add GBFS discovery URL to /providers.csv. #205. Thanks @asadowns
• Associated Trips -> Associated Trip, no longer an array. #88, #202, #217. Thanks @black-tea, @oderby
• Version Requirements and documentation. #152, #216, and #114
• Agency API refactors to support launch of ladot.io sandbox. #193, #194. Thanks @toddapetersen, @sebdiem, @cttengsfmta.
• Clarification on Service Starts, Service Ends and Municipal Boundaries. #211, #226
• Documentation on how to implement truncate to save on payload size.

0.2.1

Released 2018-12-03

This release is the first patch release of MDS 0.2.

We did not chose to include the timestamp change, as discussed in issue #104, because it is breaking. Early versions of this branch included that change. The change will be made in MDS 0.3.0.

CHANGES

• Release Guidelines. Ref #147 #129
• Many Validator Fixes/Null Fixes. Ref #166 #165 #128
• Many Clarifications / Cleanup to make the spec easier to read.
• JSON Schema is now much closer to the written spec, fails on Null if required, doesn't fail if field is not required.

Thanks to all contributors.

0.1.1

Released 2018-10-15

This release backports two features from 0.2.0:

• Clarifying Location Types as GeoJSON #94

• Adding electric-assist as a propulsion type #48

This makes MDS 0.1.x series more usable for Mobility Providers.

0.2.0

Released 2018-10-01

This release includes a number of enhancements and clarifications to the provider spec:

• Introduce JSON Schema for Trips and Status Changes #53

• Clarify query params for API endpoints #64

• Clarify API authentication method #81

• Clarify location formatting #94

• Clarify timestamp formatting #93

• Clarify the associated_trips field in Status Changes #96

0.1.0

Released 2018-09-11

• Initial release!

• MDS is under active development. As such, pre-1.0 versions may introduce breaking changes until things stabilize. Every effort will be made to ensure that any breaking change is well documented and that appropriate workarounds are suggested.