add header to seasonal snapshot

trolie · Feb 15, 2024 · 152c661 · 152c661
1 parent 23b10b1
commit 152c661
Show file tree

Hide file tree

Showing 4 changed files with 84 additions and 19 deletions.
diff --git a/docs/_data/components/schemas/array-max-monitored-elements.yaml b/docs/_data/components/schemas/array-max-monitored-elements.yaml
@@ -95,8 +95,15 @@ seasonal-rating-proposal:
           <<: *max
           items:
             $ref: 'array-max-seasons.yaml#/seasonal-proposals'
+
 seasonal-rating-snapshot:
-  <<: *max
-  description: Seasonal rating snapshot
-  items:
-    $ref: ./array-max-seasons.yaml#/seasonal-rating-snapshot-item
+  type: object
+  description: A snapshot of the realtime limits for a monitoring set.
+  properties:
+    snapshot-header:
+      $ref: ./headers.yaml#/snapshot-header
+    limits:
+      <<: *max
+      description: Seasonal rating snapshot
+      items:
+        $ref: ./array-max-seasons.yaml#/seasonal-rating-snapshot-item
diff --git a/docs/_data/components/schemas/array-max-seasons.yaml b/docs/_data/components/schemas/array-max-seasons.yaml
@@ -14,9 +14,9 @@ seasonal-rating-snapshot-item:
   type: object
   additionalProperties: false
   properties:
-    transmission-facility-id:
+    resource-id:
       $ref: ./generic-identifier.yaml
     seasons:
       <<: *max
       items:
-        $ref: ./seasonal-rating-snapshot-value.yaml
+        $ref: ./seasonal-rating-snapshot-value.yaml
diff --git a/docs/_data/paths/seasonal-ratings_snapshot.yaml b/docs/_data/paths/seasonal-ratings_snapshot.yaml
@@ -29,19 +29,7 @@ get:
           schema: &seasonal-rating-snapshot
             $ref: ../components/schemas/array-max-monitored-elements.yaml#/seasonal-rating-snapshot
           example:
-            - transmission-facility-id: line2
-              seasons:
-                - season-instance: fall-2023
-                  effective-date: '2023-09-01T00:00:00-07:00'
-                  continuous-operating-limit:
-                    mva: 160
-                  emergency-operating-limits:
-                    - duration-name: emergency
-                      limit:
-                        mva: 165
-                    - duration-name: load-shed
-                      limit:
-                        mva: 170
+            $ref: '../../example-narratives/examples/seasonal-limits-snapshot.json'
         application/json:
           schema: *seasonal-rating-snapshot
       headers:

diff --git a/docs/example-narratives/examples/seasonal-limits-snapshot.json b/docs/example-narratives/examples/seasonal-limits-snapshot.json
@@ -0,0 +1,70 @@
+{
+    "snapshot-header": {
+        "last-updated": "2023-07-12T16:00:00-07:00",
+        "snapshot-provider": "X-RC",
+        "default-emergency-durations": [
+            {
+                "name": "lte",
+                "duration-minutes": 240
+            },
+            {
+                "name": "ste",
+                "duration-minutes": 30
+            },
+            {
+                "name": "dal",
+                "duration-minutes": 15
+            }
+        ],
+        "power-system-objects": [
+            {
+                "resource-id": "8badf00d",
+                "alternate-identifiers": [
+                    {
+                        "name": "segmentX",
+                        "authority": "TO-NERC-ID"
+                    },
+                    {
+                        "name": "LINE1 SEG-X",
+                        "authority": "RC-NERC-ID",
+                        "mrid": "8badf00d"
+                    }
+                ]
+            }
+        ]
+    },
+    "limits": [
+        {
+            "resource-id": "segmentX",
+            "seasons": [
+                {
+                    "season-instance": "fall",
+                    "effective-date": "2024-04-04T01:00:00Z",
+                    "continuous-operating-limit": {
+                        "mva": 160
+                    },
+                    "emergency-operating-limits": [
+                        {
+                            "duration-name": "ste",
+                            "limit": {
+                                "mva": 165
+                            }
+                        },
+                        {
+                            "duration-name": "lte",
+                            "limit": {
+                                "mva": 170
+                            }
+                        },
+                        {
+                            "duration-name": "dal",
+                            "limit": {
+                                "mva": 170
+                            }
+                        }
+                    ]
+                }
+            ]
+        }
+    ]
+}