Skip to content

Commit e589afc

Browse files
committed
Add Geography schema to Policy
1 parent 61dc82f commit e589afc

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

policy/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,20 @@ If a vehicle is matched with a rule, then it _will not_ be considered in the sub
295295

296296
The internal mechanics of ordering are up to the Policy editing and hosting software.
297297

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 | 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 | 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+
311+
298312
[Top](#table-of-contents)
299313

300314
[general-information/versioning]: /general-information.md#versioning

0 commit comments

Comments
 (0)