Skip to content

Commit c334941

Browse files
thekavemanantoinewg
authored andcommitted
add clarity on rule status field
1 parent a26b602 commit c334941

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

policy/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,11 @@ Responses must set the `Content-Type` header, as specified in the [Provider vers
5656

5757
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)
5858

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.
6464

6565
#### Error Responses
6666

@@ -84,7 +84,7 @@ Endpoint: `/policies/{id}`
8484
Method: `GET`
8585
`data` Payload: `{ "policies": [] }`, an array of objects with the structure [outlined below](#policy).
8686

87-
##### Query Parameters:
87+
##### Query Parameters
8888

8989
| Name | Type | Required / Optional | Description |
9090
| ------------ | --------- | --- | ---------------------------------------------- |
@@ -104,7 +104,7 @@ Endpoint: `/geographies/{id}`
104104
Method: `GET`
105105
`data` Payload: `{ geographies: [] }`, an array of GeoJSON `Feature` objects.
106106

107-
##### Query Parameters:
107+
##### Query Parameters
108108

109109
| Name | Type | Required / Optional | Description |
110110
| ------------ | --------- | --- | ---------------------------------------------- |
@@ -114,8 +114,8 @@ Method: `GET`
114114

115115
To use flat files, policies shall be represented in two (2) files:
116116

117-
* `policies.json`
118-
* `geographies.json`
117+
- `policies.json`
118+
- `geographies.json`
119119

120120
The files shall be structured like the output of the [REST endpoints](#rest-endpoints) above.
121121

@@ -207,7 +207,7 @@ An individual `Rule` object is defined by the following fields:
207207
| `name` | String | Required | Name of rule |
208208
| `rule_type` | enum | Required | Type of policy (see [Rule Types](#rule-types)) |
209209
| `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". |
211211
| `rule_units` | enum | Optional | Measured units of policy (see [Rule Units](#rule-units)) |
212212
| `vehicle_types` | `vehicle_type[]` | Optional | Applicable vehicle types, default "all". |
213213
| `propulsion_types` | `propulsion_type[]` | Optional | Applicable vehicle propulsion types, default "all". |

0 commit comments

Comments
 (0)