Skip to content

Commit 5cce620

Browse files
authored
Fixed link to geography types, public Geography
1 parent f264942 commit 5cce620

1 file changed

Lines changed: 3 additions & 12 deletions

File tree

geography/README.md

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ Geographical data will be stored as GeoJSON and read from either `geographies.js
1212

1313
* [General Information](#general-information)
1414
* [Versioning](#versioning)
15-
* [Transition from Policy](#transition-from-policy)
1615
* [Distribution](#distribution)
1716
* [Flat Files](#flat-files)
1817
* [Response Format](#response-format)
@@ -41,14 +40,6 @@ Versioning must be implemented as specified in the [Versioning section][versioni
4140

4241
[Top][toc]
4342

44-
### Transition from Policy
45-
46-
To ensure this Geography API is not creating a breaking change for the 1.1.0 release, it's expected that the data contained in the [`/geographies`](/policy#geography) endpoint in the Policy API is identical to this Geography API. This will ensure that when a Geography ID is used anywhere in this release, the data could be retrieved from either location.
47-
48-
This temporary requirement is to ensure backwards compatibility, but the overall intent is to remove the /policy/geographies endpoint at the next major MDS release.
49-
50-
[Top][toc]
51-
5243
## Distribution
5344

5445
Geographies shall be published by regulatory agencies or their authorized delegates as JSON objects. These JSON objects shall be served by either [flat files](#flat-files) or via [REST API endpoints](#rest-endpoints). In either case, geography data shall follow the [schema](#schema) outlined below.
@@ -65,7 +56,7 @@ Geographies should be re-fetched at an agreed upon interval between providers an
6556

6657
To use a flat file, geographies shall be represented in one (1) file equivalent to the /geographies endpoint:
6758

68-
* `geographies.json`
59+
* `geographies.json` in Geography API
6960

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

@@ -83,7 +74,7 @@ See the [Responses][responses] and [Error Messages][error-messages] sections.
8374

8475
### Authorization
8576

86-
Authorization is not required. An agency may decide to make this endpoint unauthenticated and public. See [Optional Authentication](/general-information.md#optional-authentication) for details.
77+
This endpoint should be made public. Authorization is not required.
8778

8879
[Top][toc]
8980

@@ -99,7 +90,7 @@ See the [Endpoints](#endpoints) below for links to their specific JSON Schema do
9990
| ---------------- | --------- | --- | --------------------------------------------------------------------------------------------- |
10091
| `name` | String | Required | Name of geography |
10192
| `description` | String | Optional | Detailed description of geography |
102-
| `geography_type` | String | Optional | Type of geography, e.g. `municipal_boundary` or `council_district` or custom text. See [Geography Types](#geography-types). |
93+
| `geography_type` | String | Optional | Type of geography, e.g. `municipal_boundary` or `council_district` or custom text. See [Geography Type](#geography-type). |
10394
| `geography_id` | UUID | Required | Unique ID of geography |
10495
| `geography_json` | JSON | Required | The GeoJSON that defines the geographical coordinates. |
10596
| `effective_date` | [timestamp][ts] | Optional | The date at which a Geography is considered "live". Must be at or after `published_date`. |

0 commit comments

Comments
 (0)