You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: geography/README.md
+3-12Lines changed: 3 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,6 @@ Geographical data will be stored as GeoJSON and read from either `geographies.js
12
12
13
13
*[General Information](#general-information)
14
14
*[Versioning](#versioning)
15
-
*[Transition from Policy](#transition-from-policy)
16
15
*[Distribution](#distribution)
17
16
*[Flat Files](#flat-files)
18
17
*[Response Format](#response-format)
@@ -41,14 +40,6 @@ Versioning must be implemented as specified in the [Versioning section][versioni
41
40
42
41
[Top][toc]
43
42
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
-
52
43
## Distribution
53
44
54
45
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
65
56
66
57
To use a flat file, geographies shall be represented in one (1) file equivalent to the /geographies endpoint:
67
58
68
-
*`geographies.json`
59
+
*`geographies.json` in Geography API
69
60
70
61
The files shall be structured like the output of the [REST endpoints](#rest-endpoints) above.
71
62
@@ -83,7 +74,7 @@ See the [Responses][responses] and [Error Messages][error-messages] sections.
83
74
84
75
### Authorization
85
76
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.
87
78
88
79
[Top][toc]
89
80
@@ -99,7 +90,7 @@ See the [Endpoints](#endpoints) below for links to their specific JSON Schema do
|`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). |
103
94
|`geography_id`| UUID | Required | Unique ID of geography |
104
95
|`geography_json`| JSON | Required | The GeoJSON that defines the geographical coordinates. |
105
96
|`effective_date`|[timestamp][ts]| Optional | The date at which a Geography is considered "live". Must be at or after `published_date`. |
0 commit comments