Skip to content

Commit 8431486

Browse files
authored
Formatting on Policy endpoints
1 parent 8d9babd commit 8431486

1 file changed

Lines changed: 13 additions & 10 deletions

File tree

policy/README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -118,9 +118,10 @@ Authorization is not required. An agency may decide to make this endpoint unauth
118118

119119
### Policies
120120

121-
Endpoint: `/policies/{id}`
122-
Method: `GET`
123-
`data` Payload: `{ "policies": [] }`, an array of objects with the structure [outlined below](#policy).
121+
**Endpoint**: `/policies/{id}`
122+
**Method**: `GET`
123+
**Schema:** [`policy` schema](#policy)
124+
**`data` Payload**: `{ "policies": [] }`, an array of objects with the structure [outlined below](#policy).
124125

125126
#### Query Parameters
126127

@@ -140,9 +141,10 @@ Policies will be returned in order of effective date (see schema below), with pa
140141

141142
**Deprecated:** see the new [Geography API](/geography#transition-from-policy) to understand the transistion away from this endpoint, and how to support both in a MDS 1.x.0 release.
142143

143-
Endpoint: `/geographies/{id}`
144-
Method: `GET`
145-
`data` Payload: `{ geographies: [] }`, an array of GeoJSON `Feature` objects that follow the schema [outlined here](#geography) or in [Geography](/geography#general-information).
144+
**Endpoint**: `/geographies/{id}`
145+
**Method**: `GET`
146+
**Schema:** [`geography` schema](#geography)
147+
**`data` Payload**: `{ geographies: [] }`, an array of GeoJSON `Feature` objects that follow the schema [outlined here](#geography) or in [Geography](/geography#general-information).
146148

147149
#### Query Parameters
148150

@@ -154,10 +156,11 @@ Method: `GET`
154156

155157
### Requirements
156158

157-
Endpoint: `/requirements/`
158-
Method: `GET`
159-
`data` Payload: `{ requirements: [] }`, JSON objects that follow the schema [outlined here](#requirement).
160-
[Beta feature](/general-information.md#beta-features): *Yes (as of 1.2.0)*. [Leave feedback](https://github.com/openmobilityfoundation/mobility-data-specification/issues/682)
159+
**Endpoint**: `/requirements/`
160+
**Method**: `GET`
161+
**[Beta feature](/general-information.md#beta-features)**: *Yes (as of 1.2.0)*. [Leave feedback](https://github.com/openmobilityfoundation/mobility-data-specification/issues/682)
162+
**Schema:** [`requirement` schema](#requirement)
163+
**`data` Payload**: `{ requirements: [] }`, JSON objects that follow the schema [outlined here](#requirement).
161164

162165
See [Policy Requirements Examples](/policy/examples/requirements.md) for how this can be implemented.
163166

0 commit comments

Comments
 (0)