change segment-id / "primary identifier" -> resource-id for forecasts

trolie · Feb 8, 2024 · 9c125a2 · 9c125a2
1 parent 37906d5
commit 9c125a2
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 21 deletions.
diff --git a/docs/_data/components/schemas/array-max-forecast-periods.yaml b/docs/_data/components/schemas/array-max-forecast-periods.yaml
@@ -21,19 +21,19 @@ forecast-limit-item-detailed:
       items:
         $ref: 'forecast-limit-period.yaml#/forecast-period-snapshot-detailed'
 
-forecast-proposal-for-segment:
+resource-forecast-proposal:
   type: object
   additionalProperties: false
   properties:
-    segment-id:
+    resource-id:
       $ref: ./generic-identifier.yaml
     periods:
       <<: *max
       items:
         $ref: 'forecast-limit-period.yaml#/forecast-period-proposal'
 
   required:
-    - segment-id
+    - resource-id
     - periods
 
 missing-forecast:

diff --git a/docs/_data/components/schemas/array-max-monitored-elements.yaml b/docs/_data/components/schemas/array-max-monitored-elements.yaml
@@ -18,7 +18,7 @@ named-power-system-objects:
   items:
     $ref: ./names.yaml
 
-forecast-rating-proposal:
+forecast-proposal:
   type: object
   properties:
     forecast-header:
@@ -27,7 +27,7 @@ forecast-rating-proposal:
       <<: *max
       description: Forecasted Ratings
       items:
-        $ref: 'array-max-forecast-periods.yaml#/forecast-proposal-for-segment'
+        $ref: 'array-max-forecast-periods.yaml#/resource-forecast-proposal'
   required:
     - forecast-header
     - ratings

diff --git a/docs/_data/components/schemas/names.yaml b/docs/_data/components/schemas/names.yaml
@@ -1,6 +1,6 @@
 type: object
 properties:
-  receiver-primary-identifier:
+  resource-id:
     $ref: ./generic-identifier.yaml
   alternate-identifiers:
     type: array
@@ -19,4 +19,4 @@ properties:
         - name
         - authority
 required:
-  - receiver-primary-identifier
+  - resource-id
diff --git a/docs/_data/paths/rating-proposals_forecasts.yaml b/docs/_data/paths/rating-proposals_forecasts.yaml
@@ -34,7 +34,7 @@ get:
       content:
         application/vnd.trolie.rating-forecast-proposal.v1+json:
           schema: &forecast-rating-proposal
-            $ref: ../components/schemas/array-max-monitored-elements.yaml#/forecast-rating-proposal
+            $ref: ../components/schemas/array-max-monitored-elements.yaml#/forecast-proposal
           example:
             forecast-header:
               last-updated: '2023-07-12T15:05:43.044267100-07:00'
@@ -46,7 +46,7 @@ get:
                 - name: dal
                   duration-minutes: 15
               power-system-objects:
-                - receiver-primary-identifier: 8badf00d
+                - resource-id: 8badf00d
                   alternate-identifiers:
                     - name: segmentX
                       authority: TO-NERC-ID
@@ -55,7 +55,7 @@ get:
                       mrid: 8badf00d
               ratings-provider: UTILITY-X
             ratings:
-              - segment-id: segmentX
+              - resource-id: segmentX
                 periods:
                   - period-start: '2023-07-12T16:00:00-07:00'
                     period-end: '2023-07-12T17:00:00-07:00'
@@ -131,7 +131,7 @@ patch:
                 - name: dal
                   duration-minutes: 15
               power-system-objects:
-                - receiver-primary-identifier: 8badf00d
+                - resource-id: 8badf00d
                   alternate-identifiers:
                     - name: segmentX
                       authority: TO-NERC-ID
@@ -140,7 +140,7 @@ patch:
                       mrid: 8badf00d
               ratings-provider: UTILITY-X
             ratings:
-              - segment-id: segmentX
+              - resource-id: segmentX
                 periods:
                   - period-start: '2023-07-12T16:00:00-07:00'
                     period-end: '2023-07-12T17:00:00-07:00'

diff --git a/docs/_data/paths/rating-proposals_forecasts_{ratings-provider}.yaml b/docs/_data/paths/rating-proposals_forecasts_{ratings-provider}.yaml
@@ -16,7 +16,7 @@ get:
       content:
         application/vnd.trolie.rating-forecast-proposal.v1+json:
           schema: &forecast-rating-proposal
-            $ref: ../components/schemas/array-max-monitored-elements.yaml#/forecast-rating-proposal
+            $ref: ../components/schemas/array-max-monitored-elements.yaml#/forecast-proposal
           example:
             forecast-header:
               last-updated: '2023-07-12T15:05:43.044267100-07:00'
@@ -29,15 +29,15 @@ get:
                 - name: dal
                   duration-minutes: 15
               power-system-objects:
-                - receiver-primary-identifier: 8badf00d
+                - resource-id: 8badf00d
                   alternate-identifiers:
                     - name: segmentX
                       authority: TO-NERC-ID
                     - name: LINE1 SEG-X
                       authority: RC-NERC-ID
                       mrid: 8badf00d
             ratings:
-              - segment-id: segmentX
+              - resource-id: segmentX
                 periods:
                   - period-start: '2023-07-12T16:00:00-07:00'
                     period-end: '2023-07-12T17:00:00-07:00'
@@ -104,15 +104,15 @@ patch:
               - name: dal
                 duration-minutes: 15
             power-system-objects:
-              - receiver-primary-identifier: 8badf00d
+              - resource-id: 8badf00d
                 alternate-identifiers:
                   - name: segmentX
                     authority: TO-NERC-ID
                   - name: LINE1 SEG-X
                     authority: RC-NERC-ID
                     mrid: 8badf00d
           ratings:
-            - segment-id: segmentX
+            - resource-id: segmentX
               periods:
                 - period-start: '2023-07-12T16:00:00-07:00'
                   period-end: '2023-07-12T17:00:00-07:00'
@@ -152,15 +152,15 @@ patch:
                 - name: dal
                   duration-minutes: 15
               power-system-objects:
-                - receiver-primary-identifier: 8badf00d
+                - resource-id: 8badf00d
                   alternate-identifiers:
                     - name: segmentX
                       authority: TO-NERC-ID
                     - name: LINE1 SEG-X
                       authority: RC-NERC-ID
                       mrid: 8badf00d
             ratings:
-              - segment-id: segmentX
+              - resource-id: segmentX
                 periods:
                   - period-start: '2023-07-12T16:00:00-07:00'
                     period-end: '2023-07-12T17:00:00-07:00'

diff --git a/docs/example-narratives/examples/forecast-ratings-proposal-patch.json b/docs/example-narratives/examples/forecast-ratings-proposal-patch.json
@@ -4,7 +4,7 @@
       { "name": "emergency", "duration-minutes": 60}
     ],
     "power-system-objects": [
-      { "receiver-primary-identifier": "8badf00d",
+      { "resource-id": "8badf00d",
         "alternate-identifiers": [
           {"name": "segmentX", "authority": "TO-NERC-ID"},
           {"name": "LINE1 SEG-X", "authority": "RC-NERC-ID", "mrid": "8badf00d"}
@@ -14,7 +14,7 @@
   },
   "ratings": [
     {
-      "segment-id": "segmentX",
+      "resource-id": "segmentX",
       "periods": [
         {
           "period-start": "2025-11-02T01:00:00-05:00",