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: policy/README.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,11 +56,11 @@ Responses must set the `Content-Type` header, as specified in the [Provider vers
56
56
57
57
The response to a client request must include a valid HTTP status code defined in the [IANA HTTP Status Code Registry](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml)
58
58
59
-
***200:** OK: operation successful.
60
-
***400:** Bad request.
61
-
***401:** Unauthorized: Invalid, expired, or insufficient scope of token.
62
-
***404:** Not Found: Object(s) do not exist.
63
-
***500:** Internal server error.
59
+
-**200:** OK: operation successful.
60
+
-**400:** Bad request.
61
+
-**401:** Unauthorized: Invalid, expired, or insufficient scope of token.
62
+
-**404:** Not Found: Object(s) do not exist.
63
+
-**500:** Internal server error.
64
64
65
65
#### Error Responses
66
66
@@ -84,7 +84,7 @@ Endpoint: `/policies/{id}`
84
84
Method: `GET`
85
85
`data` Payload: `{ "policies": [] }`, an array of objects with the structure [outlined below](#policy).
86
86
87
-
##### Query Parameters:
87
+
##### Query Parameters
88
88
89
89
| Name | Type | Required / Optional | Description |
To use flat files, policies shall be represented in two (2) files:
116
116
117
-
*`policies.json`
118
-
*`geographies.json`
117
+
-`policies.json`
118
+
-`geographies.json`
119
119
120
120
The files shall be structured like the output of the [REST endpoints](#rest-endpoints) above.
121
121
@@ -207,7 +207,7 @@ An individual `Rule` object is defined by the following fields:
207
207
|`name`| String | Required | Name of rule |
208
208
|`rule_type`| enum | Required | Type of policy (see [Rule Types](#rule-types)) |
209
209
|`geographies`| UUID[]| Required | List of Geography UUIDs (non-overlapping) specifying the covered geography |
210
-
|`statuses`|{ Status: Vehicle Event[] } | Required | Vehicle `statuses` to which this rule applies. Optionally, you may provide specific `event_type`'s for the rule to apply to as a subset of a given status. An empty list or `null`/absent defaults to "all". |
210
+
|`statuses`|`{ status: vehicle event[] }`| Required | Vehicle `statuses` to which this rule applies, either from [Provider](../provider/README.md#event-types) or [Agency](../agency/README.md#vehicle-events). Optionally provide a list of specific `event_type`'s as a subset of a given status for the rule to apply to. An empty list or `null`/absent defaults to "all". |
211
211
|`rule_units`| enum | Optional | Measured units of policy (see [Rule Units](#rule-units)) |
0 commit comments