Skip to content

Commit 26a24ff

Browse files
committed
Policy response codes
1 parent cba4a99 commit 26a24ff

1 file changed

Lines changed: 32 additions & 7 deletions

File tree

policy/README.md

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ To revoke or end a policy, create a new policy with empty rules, and list the en
100100

101101
### Versioning
102102

103-
`policy` APIs must handle requests for specific versions of the specification from clients.
103+
`Policy` APIs must handle requests for specific versions of the specification from clients.
104104

105105
[Top][toc]
106106

@@ -114,8 +114,8 @@ Geographical data shall be represented as GeoJSON `Feature` objects. No part of
114114

115115
Policies should be re-fetched whenever:
116116

117-
1) a policy expires (via its `end_date`), or
118-
2) at an interval specified by the regulatory body, e.g. "daily at midnight".
117+
1. a policy expires (via its `end_date`), or
118+
2. at an interval specified by the regulatory body, e.g. "daily at midnight".
119119

120120
Flat files have an optional `end_date` field that will apply to the file as a whole.
121121

@@ -125,10 +125,10 @@ Flat files have an optional `end_date` field that will apply to the file as a wh
125125

126126
Among other use-cases, configuring a REST API allows an Agency to:
127127

128-
1) Dynamically adjust caps
129-
2) Set Provider specific policies
130-
3) Adjust other attributes in closer to real time
131-
4) Enumerate when policies are set to change
128+
1. Dynamically adjust caps
129+
2. Set Provider specific policies
130+
3. Adjust other attributes in closer to real time
131+
4. Enumerate when policies are set to change
132132

133133
Responses must set the `Content-Type` header, as specified in the [versioning][versioning] section.
134134

@@ -183,6 +183,17 @@ Policies will be returned in order of effective date (see schema below), with pa
183183

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

186+
#### Responses
187+
188+
_Possible HTTP Status Codes_:
189+
200,
190+
400 (with parameter),
191+
404,
192+
406,
193+
500
194+
195+
See [Responses][responses], [Bulk Responses][bulk-responses], and [schema][schema] for details.
196+
186197
[Top][toc]
187198

188199
## Flat Files
@@ -721,15 +732,29 @@ You may also show which APIs, endpoints, and fields your agency is serving to pr
721732

722733
[Top][toc]
723734

735+
### Responses
736+
737+
_Possible HTTP Status Codes_:
738+
200,
739+
404,
740+
406,
741+
500
742+
743+
See [Responses][responses], [Bulk Responses][bulk-responses], and [schema][schema] for details.
744+
745+
[Top][toc]
746+
724747
[accessibility-options]: /general-information.md#accessibility-options
725748
[beta]: /general-information.md#beta
749+
[bulk-responses]: /general-information.md#bulk-responses
726750
[error-messages]: /general-information.md#error-messages
727751
[iana]: https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
728752
[json-schema]: #json-schema
729753
[modes]: /modes/README.md
730754
[muni-boundary]: /provider/README.md#municipality-boundary
731755
[propulsion-types]: /general-information.md#propulsion-types
732756
[responses]: /general-information.md#responses
757+
[schema]: /schema/
733758
[ts]: /general-information.md#timestamps
734759
[toc]: #table-of-contents
735760
[vehicle-events]: /modes#event-types

0 commit comments

Comments
 (0)