Skip to content

Commit aec7edb

Browse files
committed
minor fixes
1 parent 141fca1 commit aec7edb

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

policy/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,19 @@ An individual `Rule` object is defined by the following fields:
254254
| `mph` | Miles per hour |
255255
| `kph` | Kilometers per hour |
256256

257+
### Geography
258+
| Name | Type | Required / Optional | Description |
259+
| ---------------- | --------- | --- | ----------------------------------------------------------------------------------- |
260+
| `name` | String | R | Name of geography |
261+
| `description` | String | O | Detailed description of geography |
262+
| `geography_id` | UUID | R | Unique ID of geography |
263+
| `geography_json` | UUID | R | The GeoJSON that defines the geographical coordinates.
264+
| `effective_date` | [timestamp][ts] | O | `start_date` for first published policy that uses this geo. Server should set this when policies are published. This may be used on the client to distinguish between “logical” geographies that have the same name. E.g. if a policy publishes a geography on 5/1/2020, and then another policy is published which references that same geography is published on 4/1/2020, the effective_date will be set to 4/1/2020.
265+
| `publish_date` | [timestamp][ts] | R | Timestamp that the policy was published, i.e. made immutable |
266+
| `prev_geographies` | UUID[] | O | Unique IDs of prior geographies replaced by this one |
267+
268+
269+
257270
### Messages
258271

259272
Some Policies as established by the Agency may benefit from rider communication. This optional field contains a map of languages to messages, to be shown to the user.
@@ -295,19 +308,6 @@ If a vehicle is matched with a rule, then it _will not_ be considered in the sub
295308

296309
The internal mechanics of ordering are up to the Policy editing and hosting software.
297310

298-
<a name="geography-fields"></a>
299-
### Geography
300-
| Name | Type | R/O | Description |
301-
| ---------------- | --------- | --- | ----------------------------------------------------------------------------------- |
302-
| `name` | String | R | Name of geography |
303-
| `description` | String | O | Detailed description of geography |
304-
| `geography_id` | UUID | R | Unique ID of geography |
305-
| `geography_json` | UUID | R | The GeoJSON that defines the geographical coordinates.
306-
| `effective_date` | [timestamp][ts] | O | `start_date` for first published policy that uses this geo. Server should set this when policies are published. This may be used on the client to distinguish between “logical” geographies that have the same name. E.g. if a policy publishes a geography on 5/1/2020, and then another policy is published which references that same geography is published on 4/1/2020, the effective_date will be set to 4/1/2020.
307-
| `publish_date` | [timestamp][ts] | R | Timestamp that the policy was published, i.e. made immutable |
308-
| `prev_geographies` | UUID[] | O | Unique IDs of prior geographies replaced by this one |
309-
310-
311311

312312
[Top](#table-of-contents)
313313

0 commit comments

Comments
 (0)