Extract Geography API from the Policy API #499
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| # Mobility Data Specification: Geography | ||
|
|
||
| This specification contains a collection of RESTful APIs used to read Geographies (descriptions of geographical information, e.g. multi-polygons, currently represented via GeoJSON). | ||
|
Member
There was a problem hiding this comment. Are geographies always single or multi polygons? They will never be a line or point right? Either way we should clarify this somewhere in the spec. For an example, #480 assumes only polygons.
Collaborator
There was a problem hiding this comment.
|
||
|
|
||
| Geographical data has many applications in the context of mobility, such as the description of municipal boundaries, locations for pick-up and drop-off zones, and areas of temporary closure for special events or emergencies. This API is intended to support a variety of other APIs, including the Policy API. | ||
|
|
||
| Geographical data will be stored as GeoJSON and read from either `geographies.json` or the `/geographies` endpoint, referenced by UUID. Geography data once published through this API shall be treated as immutable, to ensure that any rules or regulations referring to the boundaries cannot be retroactively changed. A Geography may be deprecated and replaced by updated version with a new UUID. | ||
| Obsoleting or otherwise changing a geography is accomplished by publishing a new geography with a field named `prev_geographies`, a list of UUID references to the geography or geographies superseded by the new geography. | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| * [General Information](#general-information) | ||
| * [Versioning](#versioning) | ||
| * [Response Format](#repsonse-format) | ||
| * [Authorization](#authorization) | ||
| * [Distribution](#distribution) | ||
| * [Schema](#schema) | ||
| * [Geography Fields](#geography-fields) | ||
| * [File Format](#file-format) | ||
| * [Endpoints](#endpoints) | ||
|
|
||
| ## General Information | ||
|
|
||
| ### Versioning | ||
|
|
||
| MDS APIs must handle requests for specific versions of the specification from clients. | ||
|
|
||
| Versioning must be implemented as specified in the [Versioning section][versioning]. | ||
|
|
||
| ### Response Format | ||
|
|
||
| See the [Responses][responses] and [Error Messages][error-messages] sections. | ||
|
|
||
| ### Authorization | ||
|
|
||
| When making requests, the Geography API expects `provider_id` to be part of the claims in a [JWT](https://jwt.io/) `access_token` in the `Authorization` header, in the form `Authorization: Bearer <access_token>`. The token issuance, expiration and revocation policies are at the discretion of the Agency. | ||
|
|
||
| <a name="schema"></a> | ||
|
|
||
| ## Schema | ||
|
|
||
| Placeholder -- schema to be added. | ||
|
|
||
| ### Geography Fields | ||
|
|
||
| | Name | Type | Required/Optional | Description | | ||
| | ---------------- | --------- | --- | ----------------------------------------------------------------------------------- | | ||
| | `name` | String | Required | Name of geography | | ||
| | `description` | String | Optional | Detailed description of geography | | ||
| | `geography_id` | UUID | Required | Unique ID of geography | | ||
| | `geography_json` | UUID | Required | The GeoJSON that defines the geographical coordinates. | ||
| | `effective_date` | [timestamp][ts] | Optional | The date at which a Geography is considered "live". Must be at or after `publish_date`. | ||
| | `publish_date` | [timestamp][ts] | Required | Timestamp that the policy was published, i.e. made immutable | | ||
| | `prev_geographies` | UUID[] | Optional | Unique IDs of prior geographies replaced by this one | | ||
|
|
||
| <a name="file-format"></a> | ||
|
|
||
| ## File format | ||
|
|
||
| To use flat files rather than REST endpoints, Geography objects should be stored in `geographies.json`. The `geographies.json` file will look like the output of `GET /geographies`. | ||
|
|
||
| Example `geographies.json` | ||
| ```json | ||
| { | ||
| "version": "0.4.0", | ||
| "updated:" "1570035222868", | ||
| "geographies": [ | ||
| { | ||
| // GeoJSON 1 | ||
| }, | ||
| { | ||
| // GeoJSON 2 | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| <a name="endpoints"></a> | ||
|
|
||
| ## REST Endpoints | ||
|
|
||
| Responses must set the `Content-Type` header, as specified in the [Provider versioning](../provider/README.md#versioning) section. They must also specify the API version in the JSON-formatted response body, under the `version` key. | ||
|
|
||
| The Geography Author API consists of the following endpoints: | ||
|
|
||
| **Endpoint**: `/geographies/{geography_id}` | ||
|
|
||
| **Method**: `GET` | ||
|
|
||
| Path Params: | ||
|
|
||
| | Name | Type | Required/Optional | Description | | ||
| | ------------- | ---- | --- | --------------------------------------------------- | | ||
| | geography_id | UUID | Required | Unique identifier for a single specific Geography | | ||
|
|
||
| Returns: A single Geography. | ||
|
|
||
| Response body: | ||
| ```js | ||
| { | ||
| version: '1.0.0', | ||
| geography: { | ||
| geography_id: UUID, | ||
| geography_json: GeoJSON FeatureCollection, | ||
| prev_geographies: UUID[], | ||
| name: string, | ||
| publish_date: timestamp | ||
| effective_date: timestamp | ||
| description: string | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Response codes: | ||
| - 200 - success | ||
| - 401 - unauthorized | ||
| - 404 - no geography found | ||
| - 403 - user is attempting to read an unpublished geography, but only has the `geographies:read:published` scope. | ||
|
|
||
| **Endpoint**: `/geographies` | ||
| **Method**: `GET` | ||
|
|
||
| Path Params: | ||
|
|
||
| | Name | Type | Required/Optional | Description | | ||
| | ------------ | --------- | --- | ---------------------------------------------- | | ||
| | `summary` | string | Optional | Return geographies, minus the GeoJSON in each geography object | | ||
|
|
||
| Returns: All non-deprecated geography objects | ||
|
|
||
| Response body: | ||
| ```js | ||
| { | ||
| version: '0.1.0', | ||
| geographies: { | ||
| Geography[] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Response codes: | ||
| - 200 - success | ||
| - 401 - unauthorized | ||
|
|
||
| [error-messages]: /general-information.md#error-messages | ||
| [responses]: /general-information.md#responses | ||
| [ts]: /general-information.md#timestamps | ||
| [versioning]: /general-information.md#versioning | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With the new endpoint, the title line should now be "MDS is currently comprised of four distinct components"
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. Good catch. Fixed.