You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@
16
16
-[Use Cases](#use-cases)
17
17
-[Related Projects](#related-projects)
18
18
19
-
##About
19
+
# About
20
20
21
21
The Mobility Data Specification (**MDS**), a project of the [Open Mobility Foundation](http://www.openmobilityfoundation.org) (OMF), is a set of Application Programming Interfaces (APIs) focused on dockless e-scooters, bicycles, mopeds and carshare. Inspired by projects like [GTFS](https://developers.google.com/transit/gtfs/reference/) and [GBFS](https://github.com/NABSA/gbfs), the goals of MDS are to provide a standardized way for municipalities or other regulatory agencies to ingest, compare and analyze data from mobility service providers, and to give municipalities the ability to express regulation in machine-readable formats.
22
22
@@ -28,7 +28,7 @@ The Mobility Data Specification (**MDS**), a project of the [Open Mobility Found
28
28
29
29
[Top][toc]
30
30
31
-
##Endpoints
31
+
# Endpoints
32
32
33
33
**MDS** is comprised of six distinct APIs, with multiple endpoints under each API:
34
34
@@ -68,7 +68,7 @@ The [`metrics`](/metrics) API endpoints are intended to be implemented by regula
68
68
69
69
---
70
70
71
-
###Modularity
71
+
## Modularity
72
72
73
73
MDS is designed to be a modular kit-of-parts. Regulatory agencies can use the components of the API that are appropriate for their needs. An agency may choose to use only `agency`, `provider`, or `policy`. Other APIs like `geography`, `jurisdiction`, and `metrics` can be used in coordination as described with these APIs or sometimes on their own. Or agencies may select specific elements (endpoints) from each API to help them implement their goals. Development of the APIs takes place under the guidance of either the OMF's [City Services](https://github.com/openmobilityfoundation/mobility-data-specification/wiki/MDS-City-Services-Working-Group) or [Provider Services](https://github.com/openmobilityfoundation/mobility-data-specification/wiki/MDS-Provider-Services-Working-Group) Working Groups.
74
74
@@ -78,13 +78,13 @@ You can read more in our **[Understanding the different MDS APIs](https://github
78
78
79
79

80
80
81
-
###GBFS Requirement
81
+
## GBFS Requirement
82
82
83
83
All MDS compatible Provider feeds [must also expose](/provider/README.md#gbfs) a public [GBFS](https://github.com/NABSA/gbfs) feed. Compatibility with [GBFS 2.0](https://github.com/NABSA/gbfs/blob/v2.0/gbfs.md) or greater is advised due to privacy concerns and support for micromobility. See our [MDS Vehicles Guide](https://github.com/openmobilityfoundation/mobility-data-specification/wiki/MDS-Vehicles) for how MDS Provider `/vehicles` can be used by regulators instead of the public GBFS `/free_bike_status`. Additional information on MDS and GBFS can be found in this [guidance document](https://github.com/openmobilityfoundation/governance/blob/main/technical/GBFS_and_MDS.md).
84
84
85
85
[Top][toc]
86
86
87
-
##Get Involved
87
+
# Get Involved
88
88
89
89
To stay up to date on MDS releases, meetings, and events, please **subscribe to the [mds-announce](https://groups.google.com/a/groups.openmobilityfoundation.org/forum/#!forum/mds-announce) mailing list** and read our **[Community Wiki](https://github.com/openmobilityfoundation/mobility-data-specification/wiki)**.
90
90
@@ -103,21 +103,21 @@ You can view info about current and past releases, the public OMF calendar, and
103
103
104
104
For questions about MDS please contact by email at [info@openmobilityfoundation.org](mailto:info@openmobilityfoundation.org) or [on our website](https://www.openmobilityfoundation.org/get-in-touch/). Media inquiries to [media@openmobilityfoundation.org](mailto:media@openmobilityfoundation.org).
105
105
106
-
###Membership
106
+
## Membership
107
107
108
108
OMF Members (public agencies and commercial companies) have additional participation opportunities with leadership roles on our [Board of Directors](https://www.openmobilityfoundation.org/about/), [Privacy, Security, and Transparency Committee](https://github.com/openmobilityfoundation/privacy-committee), [Technology Council](https://github.com/openmobilityfoundation/governance/wiki/Technology-Council), and [Strategy Committee](https://github.com/openmobilityfoundation/governance/wiki/Strategy-Committee), as well as the steering committees of all [Working Groups](https://github.com/openmobilityfoundation/mobility-data-specification/wiki#omf-meetings).
109
109
110
110
Read about [how to become an OMF member](https://www.openmobilityfoundation.org/how-to-become-a-member/) and [contact us](https://mailchi.mp/openmobilityfoundation/membership) for more details.
111
111
112
112
[Top][toc]
113
113
114
-
##Versions
114
+
# Versions
115
115
116
116
MDS has a **current release** (version 1.1.0), **previous releases** (both recommended and longer recommended for use), and **upcoming releases** in development. For a full list of releases, their status, recommended versions, and timelines, see the [Official MDS Releases](https://github.com/openmobilityfoundation/governance/wiki/Releases) page.
117
117
118
118
The OMF provides guidance on upgrading for cities, providers, and software companies, and sample permit language for cities. See our [MDS Version Guidance](https://github.com/openmobilityfoundation/governance/blob/main/technical/OMF-MDS-Version-Guidance.md) for best practices on how and when to upgrade MDS as new versions become available. Our complimentary [MDS Policy Language Guidance](https://github.com/openmobilityfoundation/governance/blob/main/technical/OMF-MDS-Policy-Language-Guidance.md) document is for cities writing MDS into their operating policy and includes sample policy language.
119
119
120
-
###Technical Information
120
+
## Technical Information
121
121
122
122
The latest MDS release is in the [`main`](https://github.com/openmobilityfoundation/mobility-data-specification/tree/main) branch, and development for the next release occurs in the [`dev`](https://github.com/openmobilityfoundation/mobility-data-specification/tree/dev) branch.
123
123
@@ -131,23 +131,23 @@ The MDS specification is versioned using Git tags and [semantic versioning](http
131
131
132
132
[Top][toc]
133
133
134
-
##Cities Using MDS
134
+
# Cities Using MDS
135
135
136
136
More than 115 cities and public agencies around the world use MDS, and it has been implemented by most major [mobility service providers](#providers-using-mds). See our webpage for a list of known [cities using MDS](https://www.openmobilityfoundation.org/about-mds/mds-users/#cities-using-mds) with links to public mobility websites and policy/permit documents.
137
137
138
138
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, especially if you have published your policies or documents publicly, so we can add you to the city resource list.
139
139
140
140
[Top][toc]
141
141
142
-
##Providers Using MDS
142
+
# Providers Using MDS
143
143
144
144
Over two dozen mobility service providers (MSPs) around the world use MDS, allowing them to create tools around a single data standard for multiple cities. See our webpage for a [list of known MSPs](https://www.openmobilityfoundation.org/about-mds/mds-users/#mobility-providers-using-mds). For a table list with unique IDs, see the MDS [provider list](/providers.csv).
145
145
146
146
To add yourself to the provider list, 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).
147
147
148
148
[Top][toc]
149
149
150
-
##Software Companies Using MDS
150
+
# Software Companies Using MDS
151
151
152
152
An open source approach to data specifications benefits cities and companies by creating a space for collaborative development, reducing costs, and nurturing a healthy, competitive ecosystem for mobility services and software tools. The open model promotes a competitive ecosystem for software tools built by dozens of software companies providing their servives to cities, agencies, and providers.
153
153
@@ -157,7 +157,7 @@ Please [let us know](https://www.openmobilityfoundation.org/get-in-touch/) if yo
157
157
158
158
[Top][toc]
159
159
160
-
##Use Cases
160
+
# Use Cases
161
161
162
162
How cities use MDS depends on a variety of factors: their transportation goals, existing services and infrastructure, and the unique needs of their communities. Cities are using MDS to create policy, enforce rules, manage hundreds of devices, and ensure the safe operation of vehicles in the public right of way. Some examples of how cities are using MDS in practice are:
163
163
@@ -174,7 +174,7 @@ Please [let us know](https://www.openmobilityfoundation.org/get-in-touch/) if yo
174
174
175
175
[Top][toc]
176
176
177
-
##Related Projects
177
+
# Related Projects
178
178
179
179
Community projects are those efforts by individual contributors or informal groups that take place outside Open Mobility Foundation’s formalized process, complementing MDS. These releated projects often push new ideas forward through experimental or locally-focused development, and are an important part of a thriving open source community. Some of these projects may eventually be contributed to and managed by the Open Mobility Foundation.
0 commit comments