Skip to content

Commit 107601d

Browse files
authored
Updates to the API opening text (#561)
Updated the opening text at the top of each of the API pages (Provider, Agency, Policy) using the text on the main readme to give more context for people landing on these pages directly.
1 parent fedbd87 commit 107601d

3 files changed

Lines changed: 8 additions & 2 deletions

File tree

agency/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Mobility Data Specification: **Agency**
22

3-
This specification contains a collection of RESTful APIs used to specify the digital relationship between *mobility as a service* Providers and the Agencies that regulate them.
3+
The Agency API endpoints are intended to be implemented by regulatory agencies and consumed by mobility providers. Providers query the Agency API when events (such as a trip start or vehicle status change) occur in their systems.
4+
5+
This specification contains a collection of RESTful APIs used to specify the digital relationship between *mobility as a service* providers and the agencies that regulate them.
46

57
## Table of Contents
68

policy/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Mobility Data Specification: Policy
22

3-
This specification describes the digital relationship between _mobility as a service_ Providers and the Agencies that regulate them. The Policy specification is meant to communicate municipal policies (such as as vehicle deployment caps and speed limits) in a clear, consistent manner.
3+
The Policy API endpoints are intended to be implemented by regulatory agencies and consumed by mobility providers. Providers query the Policy API to get information about local rules that may affect the operation of their mobility service or which may be used to determine compliance.
4+
5+
This specification describes the digital relationship between _mobility as a service_ providers and the agencies that regulate them. The Policy API communicates municipal policies (such as as vehicle deployment caps and speed limits) in a clear, consistent manner.
46

57
## Table of Contents
68

provider/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Mobility Data Specification: **Provider**
22

3+
The Provider API endpoints are intended to be implemented by mobility providers and consumed by regulatory agencies. When a municipality queries information from a mobility provider, the Provider API has a historical view of operations in a standard format.
4+
35
This specification contains a data standard for *mobility as a service* providers to define a RESTful API for municipalities to access on-demand.
46

57
## Table of Contents

0 commit comments

Comments
 (0)