Rename connectors to connector_ids (#137)

* Rename connectors to connector_ids * Update description --------- Co-authored-by: Brad Richardson <[email protected]> Co-authored-by: Victor Schappert <[email protected]>
OvertureMaps · Jul 12, 2024 · b0b73e5 · b0b73e5
1 parent 4e578da
commit b0b73e5
Show file tree

Hide file tree

Showing 34 changed files with 43 additions and 44 deletions.
diff --git a/counterexamples/transportation/segment/bad-connector-duplicate.json b/counterexamples/transportation/segment/bad-connector-duplicate.json
@@ -1,5 +1,5 @@
 {
-  "id": "segment with an invalid entry in the connectors array",
+  "id": "segment with an invalid entry in the connector_ids array",
   "type": "Feature",
   "geometry": {
     "type": "LineString",
@@ -14,6 +14,6 @@
     "version": 4,
     "update_time": "2023-02-23T00:04:00-08:00",
     "subtype": "rail",
-    "connectors": ["fooConnector", "bazConnector", "fooConnector"]
+    "connector_ids": ["fooConnector", "bazConnector", "fooConnector"]
   }
 }
diff --git a/counterexamples/transportation/segment/bad-connector.json b/counterexamples/transportation/segment/bad-connector.json
@@ -1,5 +1,5 @@
 {
-  "id": "segment with an invalid entry in the connectors array",
+  "id": "segment with an invalid entry in the connector_ids array",
   "type": "Feature",
   "geometry": {
     "type": "LineString",
@@ -15,6 +15,6 @@
     "version": 3,
     "update_time": "2023-02-23T00:04:00-08:00",
     "subtype": "rail",
-    "connectors": ["bazConnector", "qux", 1, false]
+    "connector_ids": ["bazConnector", "qux", 1, false]
   }
 }
diff --git a/counterexamples/transportation/segment/road/restrictions/bad-access-mode-not.yaml b/counterexamples/transportation/segment/road/restrictions/bad-access-mode-not.yaml
@@ -15,7 +15,7 @@ properties:
   subtype: road
   level: -1
   width: 10
-  connectors: [fooConnector, barConnector]
+  connector_ids: [fooConnector, barConnector]
   road:
     class: secondary
     surface: gravel

diff --git a/counterexamples/transportation/segment/road/restrictions/bad-access-mode.yaml b/counterexamples/transportation/segment/road/restrictions/bad-access-mode.yaml
@@ -17,7 +17,7 @@ properties:
   subtype: road
   level: -1
   width: 10
-  connectors: [fooConnector, barConnector]
+  connector_ids: [fooConnector, barConnector]
   road:
     class: secondary
     surface: gravel

diff --git a/...terexamples/transportation/segment/road/restrictions/bad-access-restrictions-vehicle.yaml b/...terexamples/transportation/segment/road/restrictions/bad-access-restrictions-vehicle.yaml
@@ -15,7 +15,7 @@ properties:
   subtype: road
   level: -1
   widthMeters: 10
-  connectors: [fooConnector, barConnector]
+  connector_ids: [fooConnector, barConnector]
   road:
     class: secondary
     surface: gravel

diff --git a/counterexamples/transportation/segment/road/restrictions/bad-speed-limits-mode.yaml b/counterexamples/transportation/segment/road/restrictions/bad-speed-limits-mode.yaml
@@ -15,7 +15,7 @@ properties:
   subtype: road
   level: -1
   width: 10
-  connectors: [fooConnector, barConnector]
+  connector_ids: [fooConnector, barConnector]
   road:
     class: secondary
     surface: gravel

diff --git a/...xamples/transportation/segment/road/restrictions/turns/bad-access-restrictions-modes.yaml b/...xamples/transportation/segment/road/restrictions/turns/bad-access-restrictions-modes.yaml
@@ -15,7 +15,7 @@ properties:
   subtype: road
   level: -1
   width: 10
-  connectors: [fooConnector, barConnector]
+  connector_ids: [fooConnector, barConnector]
   road:
     class: secondary
     surface: gravel

diff --git a/...les/transportation/segment/road/restrictions/turns/bad-access-restrictions-not-modes.yaml b/...les/transportation/segment/road/restrictions/turns/bad-access-restrictions-not-modes.yaml
@@ -15,7 +15,7 @@ properties:
   subtype: road
   level: -1
   width: 10
-  connectors: [fooConnector, barConnector]
+  connector_ids: [fooConnector, barConnector]
   road:
     class: secondary
     surface: gravel

diff --git a/...es/transportation/segment/road/restrictions/turns/bad-access-restrictions-recognized.yaml b/...es/transportation/segment/road/restrictions/turns/bad-access-restrictions-recognized.yaml
@@ -15,7 +15,7 @@ properties:
   subtype: road
   level: -1
   width: 10
-  connectors: [fooConnector, barConnector]
+  connector_ids: [fooConnector, barConnector]
   road:
     class: secondary
     surface: gravel

diff --git a/...xamples/transportation/segment/road/restrictions/turns/bad-access-restrictions-using.yaml b/...xamples/transportation/segment/road/restrictions/turns/bad-access-restrictions-using.yaml
@@ -15,7 +15,7 @@ properties:
   subtype: road
   level: -1
   width: 10
-  connectors: [fooConnector, barConnector]
+  connector_ids: [fooConnector, barConnector]
   road:
     class: secondary
     surface: gravel

diff --git a/...mples/transportation/segment/road/restrictions/turns/bad-access-restrictions-vehicle.yaml b/...mples/transportation/segment/road/restrictions/turns/bad-access-restrictions-vehicle.yaml
@@ -15,7 +15,7 @@ properties:
   subtype: road
   level: -1
   width: 10
-  connectors: [fooConnector, barConnector]
+  connector_ids: [fooConnector, barConnector]
   road:
     class: secondary
     surface: gravel

diff --git a/counterexamples/transportation/segment/road/restrictions/turns/bad-turns-duplicate-via.yaml b/counterexamples/transportation/segment/road/restrictions/turns/bad-turns-duplicate-via.yaml
@@ -15,7 +15,7 @@ properties:
   subtype: road
   level: -1
   width: 10
-  connectors: [fooConnector, barConnector]
+  connector_ids: [fooConnector, barConnector]
   road:
     class: secondary
     surface: gravel

diff --git a/counterexamples/transportation/segment/road/restrictions/turns/bad-turns-no-turn-target.yaml b/counterexamples/transportation/segment/road/restrictions/turns/bad-turns-no-turn-target.yaml
@@ -15,7 +15,7 @@ properties:
   subtype: road
   level: -1
   width: 10
-  connectors: [fooConnector, barConnector]
+  connector_ids: [fooConnector, barConnector]
   road:
     class: secondary
     surface: gravel

diff --git a/counterexamples/transportation/segment/road/restrictions/turns/bad-turns-no-via-target.yaml b/counterexamples/transportation/segment/road/restrictions/turns/bad-turns-no-via-target.yaml
@@ -15,7 +15,7 @@ properties:
   subtype: road
   level: -1
   width: 10
-  connectors: [fooConnector, barConnector]
+  connector_ids: [fooConnector, barConnector]
   road:
     class: secondary
     surface: gravel

diff --git a/counterexamples/transportation/segment/road/restrictions/turns/bad-turns-reason.yaml b/counterexamples/transportation/segment/road/restrictions/turns/bad-turns-reason.yaml
@@ -15,7 +15,7 @@ properties:
   subtype: road
   level: -1
   width: 10
-  connectors: [fooConnector, barConnector]
+  connector_ids: [fooConnector, barConnector]
   road:
     class: secondary
     surface: gravel

diff --git a/examples/transportation/docusaurus/access-restriction.yaml b/examples/transportation/docusaurus/access-restriction.yaml
@@ -16,7 +16,7 @@ properties:
   version: 3
   update_time: "2023-06-06T16:42:00-06:00"
   subtype: road
-  connectors:
+  connector_ids:
     - overture:transportation:example:simple-road-connector-1
     - overture:transportation:example:simple-road-connector-2
   names:

diff --git a/examples/transportation/docusaurus/lanes-resolution-segment-01.yaml b/examples/transportation/docusaurus/lanes-resolution-segment-01.yaml
@@ -11,7 +11,7 @@ properties:
   type: segment
   version: 0
   update_time: "2023-06-20T13:51:00-06:00"
-  connectors: [lanes-resolution-example-connector]
+  connector_ids: [lanes-resolution-example-connector]
   subtype: road
   road:
     lanes: # A list of two geometrically-scoped rules for resolving the lane block.

diff --git a/examples/transportation/docusaurus/lanes-resolution-segment-02.yaml b/examples/transportation/docusaurus/lanes-resolution-segment-02.yaml
@@ -11,7 +11,7 @@ properties:
   type: segment
   version: 0
   update_time: "2023-06-20T13:51:00-06:00"
-  connectors: [lanes-resolution-example-connector]
+  connector_ids: [lanes-resolution-example-connector]
   subtype: road
   road:
     lanes: # One static, unchanging lane block.

diff --git a/examples/transportation/docusaurus/simple-road.yaml b/examples/transportation/docusaurus/simple-road.yaml
@@ -13,7 +13,7 @@ properties:
   version: 3
   update_time: "2023-06-01T16:42:00-06:00"
   subtype: road
-  connectors:
+  connector_ids:
     - overture:transportation:example:simple-road-connector-1
     - overture:transportation:example:simple-road-connector-2
   names:

diff --git a/examples/transportation/docusaurus/turn-restriction-01-exit.yaml b/examples/transportation/docusaurus/turn-restriction-01-exit.yaml
@@ -15,6 +15,6 @@ properties:
   version: 0
   update_time: "2023-06-21T14:12:56-07:00"
   subtype: road
-  connectors:
+  connector_ids:
     - overture:transportation:example:simple-turn-restriction-connector1
     - overture:transportation:example:simple-turn-restriction-connector3
diff --git a/examples/transportation/docusaurus/turn-restriction-01-source.yaml b/examples/transportation/docusaurus/turn-restriction-01-source.yaml
@@ -13,14 +13,14 @@ properties:
   version: 4
   update_time: "2023-08-21T16:23:13-06:00"
   subtype: road
-  connectors:
+  connector_ids:
     - overture:transportation:example:simple-turn-restriction-connector1
     - overture:transportation:example:simple-turn-restriction-connector2
   road:
     restrictions:
       prohibited_transitions:
-         - sequence:  
+         - sequence:
            - segment_id: overture:transportation:example:simple-turn-restriction-target
              connector_id: overture:transportation:example:simple-turn-restriction-connector2
            final_heading: forward
-           when: {heading: forward} 
+           when: {heading: forward}
diff --git a/examples/transportation/docusaurus/turn-restriction-01-target.yaml b/examples/transportation/docusaurus/turn-restriction-01-target.yaml
@@ -15,6 +15,6 @@ properties:
   version: 0
   update_time: "2023-06-21T13:42:35-07:00"
   subtype: road
-  connectors:
+  connector_ids:
     - overture:transportation:example:simple-turn-restriction-connector2
     - overture:transportation:example:simple-turn-restriction-connector3
diff --git a/examples/transportation/docusaurus/turn-restriction-02-source.yaml b/examples/transportation/docusaurus/turn-restriction-02-source.yaml
@@ -19,7 +19,7 @@ properties:
   version: 4
   update_time: "2023-08-18T11:05:03-07:00"
   subtype: road
-  connectors:
+  connector_ids:
     - overture:transportation:example:via-turn-restriction-connector1
   names:
     primary: Arborway

diff --git a/examples/transportation/docusaurus/turn-restriction-02-target.yaml b/examples/transportation/docusaurus/turn-restriction-02-target.yaml
@@ -17,7 +17,7 @@ properties:
   version: 4
   update_time: "2023-08-18T11:22:00-06:00"
   subtype: road
-  connectors:
+  connector_ids:
     - overture:transportation:example:via-turn-restriction-connector2
   names:
     primary: Arborway

diff --git a/examples/transportation/docusaurus/turn-restriction-02-via.yaml b/examples/transportation/docusaurus/turn-restriction-02-via.yaml
@@ -14,7 +14,7 @@ properties:
   version: 4
   update_time: "2023-08-18T11:22:30-06:00"
   subtype: road
-  connectors:
+  connector_ids:
     - overture:transportation:example:via-turn-restriction-connector1
     - overture:transportation:example:via-turn-restriction-connector2
   names:

diff --git a/examples/transportation/segment/road/lanes/lanes-flow-reversible.yaml b/examples/transportation/segment/road/lanes/lanes-flow-reversible.yaml
@@ -10,7 +10,7 @@ properties:
   update_time: "2023-02-23T00:03:45-08:00"
   version: 3
   subtype: road
-  connectors: [fooConnector, barConnector]
+  connector_ids: [fooConnector, barConnector]
   road:
     class: primary
     surface:

diff --git a/examples/transportation/segment/road/road-flow-alternating.yaml b/examples/transportation/segment/road/road-flow-alternating.yaml
@@ -10,7 +10,7 @@ properties:
   update_time: "2023-02-23T00:03:40-08:00"
   version: 2
   subtype: road
-  connectors: [fooConnector, barConnector]
+  connector_ids: [fooConnector, barConnector]
   road:
     class: primary
     surface:

diff --git a/examples/transportation/segment/road/road-oneway-no-lanes.yaml b/examples/transportation/segment/road/road-oneway-no-lanes.yaml
@@ -10,7 +10,7 @@ properties:
   update_time: "2023-05-11T00:03:50-08:00"
   version: 4
   subtype: road
-  connectors: [fooConnector, barConnector]
+  connector_ids: [fooConnector, barConnector]
   road:
     class: secondary
     # one way road in backward direction (forward access is denied)

diff --git a/examples/transportation/segment/road/road-oneway-with-lanes.yaml b/examples/transportation/segment/road/road-oneway-with-lanes.yaml
@@ -10,7 +10,7 @@ properties:
   update_time: "2023-05-11T00:03:50-08:00"
   version: 4
   subtype: road
-  connectors: [fooConnector, barConnector]
+  connector_ids: [fooConnector, barConnector]
   road:
     class: secondary
     # one way road in forward direction (lanes only in forward direction)

diff --git a/examples/transportation/segment/road/road-with-lr-name.yaml b/examples/transportation/segment/road/road-with-lr-name.yaml
@@ -14,7 +14,7 @@ properties:
   version: 0
   subtype: road
   level: 1
-  connectors: [fooConnector, barConnector] # Topology: To discuss further.
+  connector_ids: [fooConnector, barConnector] # Topology: To discuss further.
   names:
     primary: Common Road Name 1
     rules:

diff --git a/examples/transportation/segment/road/road-with-lr-width.yaml b/examples/transportation/segment/road/road-with-lr-width.yaml
@@ -14,7 +14,7 @@ properties:
   version: 0
   subtype: road
   level: 1
-  connectors: [fooConnector, barConnector]
+  connector_ids: [fooConnector, barConnector]
   road:
     class: secondary
     width:

diff --git a/examples/transportation/segment/road/road.yaml b/examples/transportation/segment/road/road.yaml
@@ -14,7 +14,7 @@ properties:
   version: 0
   subtype: road
   level: -1
-  connectors: [fooConnector, barConnector] # Topology: To discuss further.
+  connector_ids: [fooConnector, barConnector] # Topology: To discuss further.
   names:
     primary: Common Road Name
   road:

diff --git a/examples/transportation/segment/road/sidewalk.yaml b/examples/transportation/segment/road/sidewalk.yaml
@@ -10,7 +10,7 @@ properties:
   update_time: "2023-11-13T00:02:30-08:00"
   version: 0
   subtype: road
-  connectors: [fooConnector, barConnector]
+  connector_ids: [fooConnector, barConnector]
   road:
     class: sidewalk
     surface:

diff --git a/schema/transportation/segment.yaml b/schema/transportation/segment.yaml
@@ -35,13 +35,12 @@ properties:
         "$comment": >-
           Should not be confused with a transport mode. A segment
           kind has an (implied) set of default transport modes.
-      connectors:
-        "$comment": 'FIXME: Must rename to connectorIds to meet schema standard'
+      connector_ids:
         description: >-
-          List of connectors this segment is physically connected to.
-          Each connector is a possible routing decision point meaning it
-          defines place along segment in which there is possibility to
-          transition to other segments which share same connector.
+          List of connector IDs identifying the connectors this segment is physically
+          connected to. Each connector is a possible routing decision point, meaning
+          it defines a place along the segment in which there is possibility to
+          transition to other segments which share the same connector.
         type: array
         items:
           type: string
@@ -182,7 +181,7 @@ properties:
           description: >-
             Edge-to-edge width of the road modeled by this segment, in
             meters.
-    
+
             Examples: (1) If this segment models a carriageway without
             sidewalk, this value represents the edge-to-edge width of the
             carriageway, inclusive of any shoulder. (2) If this segment