[Admins] Add Area type and allow only Point on Locality

counterexamples/admins/locality/bad-admin-level.json

@@ -8,7 +8,7 @@
     "subType": "administrativeLocality",
     "localityType": "country",
     "adminLevel": 100,
-    "context": "northAmericaId",
+    "contextId": "northAmericaId",
     "names": {
       "common": [
         {

counterexamples/admins/locality/bad-language.json

@@ -11,7 +11,7 @@
     "isoCountryCodeAlpha2": "US",
     "defaultLanguage": "english",
     "drivingSide": "right",
-    "context": "northAmericaId",
+    "contextId": "northAmericaId",
     "names": {
       "common": [
         {

counterexamples/admins/locality/missing-locality-type.json

@@ -7,7 +7,7 @@
     "updateTime": "2023-02-22T23:55:01-08:00",
     "subType": "administrativeLocality",
     "adminLevel": 2,
-    "context": "northAmericaId",
+    "contextId": "northAmericaId",
     "names": {
       "common": [
         {

counterexamples/admins/locality/missing-names.json

@@ -8,7 +8,7 @@
     "subType": "administrativeLocality",
     "localityType": "country",
     "adminLevel": 2,
-    "context": "northAmericaId"
+    "contextId": "northAmericaId"
   },
   "geometry": {
     "type": "Polygon",

counterexamples/admins/locality/missing-sub-type.json

@@ -7,7 +7,7 @@
     "updateTime": "2023-02-22T23:55:01-08:00",
     "localityType": "country",
     "adminLevel": 2,
-    "context": "northAmericaId",
+    "contextId": "northAmericaId",
     "names": {
       "common": [
         {

docusaurus/docs/reference/admins/locality.mdx

@@ -11,10 +11,12 @@ import AdminLocalityExample from '!!raw-loader!@site/docs/_examples/admins/local
 
 Localities are named, and typically populated, areas.
 
+Area polygon of Localities, if known, are given by [Locality Area](localityArea) features.
+
 <table>
   <tr>
     <th>Geometry Type</th>
-    <td><code>Point</code>, <code>Polygon</code> or <code>MultiPolygon</code></td>
+    <td><code>Point</code></td>
   </tr>
   <tr>
     <th>Theme</th>
@@ -44,7 +46,7 @@ subdivisions of countries.
 
 Every Administrative Locality has a valid `adminLevel` property set,
 defining its position in the subdivision hierarchy. All Administrative
-Localities at sub-country level must have a `context` property
+Localities at sub-country level must have a `contextId` property
 containing the GERS ID of the feature's parent Administrative Locality.
 
 The borders of Administrative Localities, if known, are given by

docusaurus/docs/reference/admins/localityArea.mdx

@@ -0,0 +1,48 @@
+import CodeBlock from '@theme/CodeBlock';
+import JSONSchemaViewer from "@theme/JSONSchemaViewer";
+import generateResolverOptions from "@site/src/components/shared-libs/generateResolverOptions"
+import yamlLoad from "@site/src/components/yamlLoad"
+import LocalityAreaSchema from '!!raw-loader!@site/docs/_schema/admins/localityArea.yaml';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import LocalityAreaExample from '!!raw-loader!@site/docs/_examples/admins/localityArea/area-admin-country-no-context.yaml';
+
+# localityArea
+
+Adds land or maritime area polygon to locality.
+
+Property <code>localityId</code> points at [Locality](locality) feature that this area belongs to.
+
+<table>
+  <tr>
+    <th>Geometry Type</th>
+    <td><code>Polygon</code> or <code>MultiPolygon</code></td>
+  </tr>
+  <tr>
+    <th>Theme</th>
+    <td><code>admins</code></td>
+  </tr>
+  <tr>
+    <th>Type</th>
+    <td><code>localityArea</code></td>
+  </tr>
+</table>
+
+## Schema
+
+<Tabs>
+  <TabItem value="browsable" label="Browsable" default>
+    <JSONSchemaViewer schema={ yamlLoad(LocalityAreaSchema) } resolverOptions={ generateResolverOptions({remote: true, yamlBasePath: '/admins'})}/>
+  </TabItem>
+  <TabItem value="yaml" label="YAML" default>
+    <CodeBlock language="jsx">{LocalityAreaSchema}</CodeBlock>
+  </TabItem>
+</Tabs>
+
+## Examples
+
+<Tabs>
+  <TabItem value="localityArea" label="LocalityArea" default>
+    <CodeBlock language="json">{ JSON.stringify(yamlLoad(LocalityAreaExample), null, 2) }</CodeBlock>
+  </TabItem>
+</Tabs>

docusaurus/docs/themes/admins/admins.mdx

@@ -2,11 +2,10 @@
 
 Overture Administrative Boundary (Admins) data includes features that describe named localities in the real world including settlements, cities, regions, provinces, and countries.
 
-The current version of the schema does not support the modeling of disputed boundaries or multiple geo-political views. In future schema versions, we will have support for:
+The current version of the schema does not support the modeling of multiple geo-political views. In future schema versions, we will have support for:
 
-1. Marking a boundary as disputed.
-2. Providing multiple views of a country boundary based on the user's region.
-3. Modeling the relationship between a country and its overseas territories or other disputed territories.
+1. Providing multiple views of a country boundary based on the user's region.
+2. Modeling the relationship between a country and its overseas territories or other disputed territories.
 
 ## Key Schema Design Choices
 
@@ -22,5 +21,6 @@ There are two sub-types:
    - Administrative Localities model countries and their hierarchical subdivisions. Each Administrative Locality has an administrative level indicating its level within a country. Attributes like driving side and default language are also available.
    - Named Localities model named places that are not part of a countries administrative hierarchy.
 
-2. [Administrative Boundary](/reference/admins/administrativeBoundary) provides a boundary line of Administrative Localities. This feature allows for an easy display of country borders and
+2. [LocalityArea](/reference/admins/localityArea) adds land or maritime polygon to [Locality](/reference/admins/locality).
+3. [Administrative Boundary](/reference/admins/administrativeBoundary) provides a boundary line of Administrative Localities. This feature allows for an easy display of country borders and
 administrative subdivisions within countries. Boundaries shared by different Administrative Localities are represented by one line. A maritime attribute supports filtering on boundaries located within seas or oceans.

docusaurus/sidebars.js

@@ -58,6 +58,7 @@ const sidebars = {
           items: [
               'reference/admins/administrativeBoundary',
               'reference/admins/locality',
+              'reference/admins/localityArea',
           ]
         },
         {

examples/admins/administrativeBoundary/administrativeBoundary.yaml

@@ -17,4 +17,4 @@ properties:
   updateTime: '2023-02-22T23:55:01-08:00'
   version: 0
   adminLevel: 2
-  maritime: true
+  isMaritime: true

examples/admins/administrativeBoundary/disputedAdministrativeBoundary.yaml

@@ -17,5 +17,5 @@ properties:
   updateTime: '2023-02-22T23:55:01-08:00'
   version: 0
   adminLevel: 2
-  maritime: true
+  isMaritime: true
   geopolDisplay: disputed

examples/admins/locality/admin-country-no-context.yaml

@@ -1,18 +1,10 @@
 ---
 type: Feature
 geometry:
-  type: MultiPolygon
   coordinates:
-  - - - - -61.8743292
-        - 48.8068635
-      - - -78.4016703
-        - 26.273714
-      - - -120.7749598
-        - 32.2499745
-      - - -126.928757
-        - 49.0378679
-      - - -61.8743292
-        - 48.8068635
+  - -122.3183680
+  - 47.6238307
+  type: Point
 properties:
   theme: admins
   type: locality

examples/admins/locality/admin-named-locality.yaml

@@ -4,7 +4,7 @@ geometry:
   - 47.6238307
   type: Point
 properties:
-  context: seattleId
+  contextId: seattleId
   localityType: neighborhood
   names:
     common:

examples/admins/locality/geometry-point.yaml

@@ -12,7 +12,7 @@ properties:
   version: 0
   subType: administrativeLocality
   adminLevel: 2
-  context: northAmericaId
+  contextId: northAmericaId
   defaultLanguage: en
   drivingSide: right
   isoCountryCodeAlpha2: US

examples/admins/locality/no-optional-properties.yaml

@@ -1,26 +1,18 @@
 ---
 type: Feature
 geometry:
-  type: Polygon
+  type: Point
   coordinates:
-  - - - -61.8743292
-      - 48.8068635
-    - - -78.4016703
-      - 26.273714
-    - - -120.7749598
-      - 32.2499745
-    - - -126.928757
-      - 49.0378679
-    - - -61.8743292
-      - 48.8068635
+  - -61.8743292
+  - 48.8068635
 properties:
   theme: admins
   type: locality
   updateTime: '2023-02-22T23:55:01-08:00'
   version: 0
   subType: administrativeLocality
   adminLevel: 2
-  context: northAmericaId
+  contextId: northAmericaId
   localityType: country
   names:
     alternate:

examples/admins/localityArea/area-admin-country-no-context.yaml

@@ -0,0 +1,21 @@
+---
+type: Feature
+geometry:
+  type: MultiPolygon
+  coordinates:
+  - - - - -61.8743292
+        - 48.8068635
+      - - -78.4016703
+        - 26.273714
+      - - -120.7749598
+        - 32.2499745
+      - - -126.928757
+        - 49.0378679
+      - - -61.8743292
+        - 48.8068635
+properties:
+  theme: admins
+  type: localityArea
+  updateTime: '2023-02-22T23:55:01-08:00'
+  version: 0
+  localityId: unitedStates

schema/admins/administrativeBoundary.yaml

@@ -19,9 +19,7 @@ properties:
       - "$ref": ../defs.yaml#/$defs/propertyContainers/overtureFeaturePropertiesContainer
     properties:
       adminLevel: { "$ref": "./defs.yaml#/$defs/propertyDefinitions/adminLevel" }
-      maritime:
-        description: Flag that specifies if the boundary is maritime (i.e., a boundary at a particular distance from a jurisdiction's coastline)
-        type: boolean
+      isMaritime: { "$ref": "./defs.yaml#/$defs/propertyDefinitions/isMaritime" }
       geopolDisplay:
         description: Optional value that indicates if the boundary needs special rendering logic
         type: string

schema/admins/defs.yaml

@@ -83,6 +83,9 @@ description: Common schema definitions for admins theme
       description: Left-hand traffic (LHT) or right-hand traffic (RHT).
       type: string
       enum: [left, right]
+    isMaritime:
+      description: Flag that specifies if feature is maritime (i.e., a boundary at a particular distance from a jurisdiction's coastline)
+      type: boolean
   propertyContainers:
     adminPropertiesContainer:
       title: "Administrative Properties"

schema/admins/locality.yaml

@@ -12,8 +12,6 @@ properties:
     unevaluatedProperties: false
     oneOf:
       - "$ref": https://geojson.org/schema/Point.json
-      - "$ref": https://geojson.org/schema/Polygon.json
-      - "$ref": https://geojson.org/schema/MultiPolygon.json
   properties:
     unevaluatedProperties: false
     required: [subType, localityType, names]
@@ -26,7 +24,7 @@ properties:
           - title: "Conditional Properties"
             if: {properties: {adminLevel: { minimum: 3 }}}
             then:
-              required: [context]
+              required: [contextId]
       - "$ref": ../defs.yaml#/$defs/propertyContainers/overtureFeaturePropertiesContainer
     properties:
       subType:
@@ -35,6 +33,6 @@ properties:
         enum: [administrativeLocality, namedLocality]
       localityType: { "$ref": "./defs.yaml#/$defs/propertyDefinitions/localityType" }
       names: { "$ref": "../defs.yaml#/$defs/propertyDefinitions/names" }
-      context:
+      contextId:
         description: Context entity is the most granular entity that logically contains given entity (but doesn't have to contain it spatially due to minor discrepancies in geometries)
         type: string