diff --git a/docs/_data/components/schemas/array-max-monitored-elements.yaml b/docs/_data/components/schemas/array-max-monitored-elements.yaml index 22b68a2..ebc9a0b 100644 --- a/docs/_data/components/schemas/array-max-monitored-elements.yaml +++ b/docs/_data/components/schemas/array-max-monitored-elements.yaml @@ -1,25 +1,16 @@ -forecast-limit-set: &max - type: array - minItems: 0 - maxItems: 50000 - description: Set of forecast limits - items: - $ref: 'array-max-forecast-periods.yaml#/forecast-limit-item' - forecast-limits-snapshot: type: object description: A snapshot of the forecast for a monitoring set. properties: snapshot-header: $ref: ./headers.yaml#/snapshot-header - limits: - $ref: '#/forecast-limit-set' - -forecast-limit-set-detailed: - <<: *max - description: Forecast including provenance information. - items: - $ref: 'array-max-forecast-periods.yaml#/forecast-limit-item-detailed' + limits: &max + type: array + minItems: 0 + maxItems: 50000 + description: Set of forecast limits + items: + $ref: 'array-max-forecast-periods.yaml#/forecast-limit-item' forecast-limits-detailed-snapshot: type: object @@ -28,7 +19,10 @@ forecast-limits-detailed-snapshot: snapshot-header: $ref: ./headers.yaml#/snapshot-header limits: - $ref: '#/forecast-limit-set-detailed' + <<: *max + description: Forecast including provenance information. + items: + $ref: 'array-max-forecast-periods.yaml#/forecast-limit-item-detailed' named-power-system-objects: <<: *max @@ -56,17 +50,29 @@ missing-forecast-rating-set: items: $ref: 'array-max-forecast-periods.yaml#/missing-forecast' -realtime-limit-set: - <<: *max - description: Real-time limits - items: - $ref: ./realtime-limit-item.yaml +realtime-limits-snapshot: + type: object + description: A snapshot of the realtime limits for a monitoring set. + properties: + snapshot-header: + $ref: ./headers.yaml#/snapshot-header + limits: + <<: *max + description: Real-time limits + items: + $ref: ./realtime-limit-item.yaml -realtime-limit-set-detailed: - <<: *max - description: Real-time limits including provenance. - items: - $ref: ./realtime-limit-item-detailed.yaml +realtime-limits-detailed-snapshot: + type: object + description: A snapshot of the realtime limits for a monitoring set. + properties: + snapshot-header: + $ref: ./headers.yaml#/snapshot-header + limits: + <<: *max + description: Real-time limits including provenance. + items: + $ref: ./realtime-limit-item-detailed.yaml realtime-proposal: type: object diff --git a/docs/_data/paths/limits_realtime-snapshot.yaml b/docs/_data/paths/limits_realtime-snapshot.yaml index ef33898..9e94ad5 100644 --- a/docs/_data/paths/limits_realtime-snapshot.yaml +++ b/docs/_data/paths/limits_realtime-snapshot.yaml @@ -27,19 +27,16 @@ get: '200': description: The System Operating Limits snapshot is returned. content: - application/vnd.trolie.realtime-limit-set-slim.v1+json: + application/vnd.trolie.realtime-limits-snapshot.v1+json: schema: - $ref: "../components/schemas/array-max-monitored-elements.yaml#/realtime-limit-set" + $ref: "../components/schemas/array-max-monitored-elements.yaml#/realtime-limits-snapshot" example: $ref: '../../example-narratives/examples/realtime-limit-set-slim.json' - application/vnd.trolie.realtime-limit-set-detailed.v1+json: + application/vnd.trolie.realtime-limits-detailed-snapshot.v1+json: schema: - $ref: "../components/schemas/array-max-monitored-elements.yaml#/realtime-limit-set-detailed" + $ref: "../components/schemas/array-max-monitored-elements.yaml#/realtime-limits-detailed-snapshot" example: $ref: '../../example-narratives/examples/realtime-limit-set-detailed.json' - application/json: - schema: - $ref: "../components/schemas/array-max-monitored-elements.yaml#/realtime-limit-set" headers: $ref: '../openapi-split.yaml#/components/responses/200/headers' '304': diff --git a/docs/example-narratives/examples/realtime-limit-set-detailed.json b/docs/example-narratives/examples/realtime-limit-set-detailed.json index 1c67225..8e0f0ba 100644 --- a/docs/example-narratives/examples/realtime-limit-set-detailed.json +++ b/docs/example-narratives/examples/realtime-limit-set-detailed.json @@ -1,32 +1,70 @@ -[ - { - "transmission-facility-id": "line2", - "proposals-considered": [ - "c386503e-ae8f-46e7-8fcf-bdee30f4f56b" +{ + "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 + } ], - "temporary-aar-exceptions": [ - "2d8c80e8-f533-4be9-85bf-f7f81eb73d67" - ], - "limiting-segment": "segmentX", - "override-reason": "Any reason entered by the operator for an override.", - "additional-data": { - "vendor-specific-data": {} - }, - "updated-time": "2023-07-12T13:05:43.044267100-07:00", - "continuous-operating-limit": { "mva": 160 }, - "emergency-operating-limits": [ + "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": [ + { + "transmission-facility-id": "line2", + "proposals-considered": [ + "c386503e-ae8f-46e7-8fcf-bdee30f4f56b" + ], + "temporary-aar-exceptions": [ + "2d8c80e8-f533-4be9-85bf-f7f81eb73d67" + ], + "limiting-segment": "segmentX", + "override-reason": "Any reason entered by the operator for an override.", + "additional-data": { + "vendor-specific-data": {} + }, + "updated-time": "2023-07-12T13:05:43.044267100-07:00", + "continuous-operating-limit": { + "mva": 160 + }, + "emergency-operating-limits": [ { - "duration-name": "emergency", - "limit": { - "mva": 165 - } + "duration-name": "emergency", + "limit": { + "mva": 165 + } }, { - "duration-name": "load-shed", - "limit": { - "mva": 170 - } + "duration-name": "load-shed", + "limit": { + "mva": 170 + } } - ] - } -] + ] + } + ] +} \ No newline at end of file diff --git a/docs/example-narratives/examples/realtime-limit-set-slim.json b/docs/example-narratives/examples/realtime-limit-set-slim.json index d08ae0b..65759c5 100644 --- a/docs/example-narratives/examples/realtime-limit-set-slim.json +++ b/docs/example-narratives/examples/realtime-limit-set-slim.json @@ -1,21 +1,59 @@ -[ - { - "transmission-facility-id": "line2", - "updated-time": "2023-07-12T13:05:43.044267100-07:00", - "continuous-operating-limit": { "mva": 160 }, - "emergency-operating-limits": [ - { - "duration-name": "emergency", - "limit": { - "mva": 165 +{ + "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 } - }, - { - "duration-name": "load-shed", - "limit": { - "mva": 170 + ], + "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": [ + { + "transmission-facility-id": "8badf00d", + "updated-time": "2023-07-12T13:05:43.044267100-07:00", + "continuous-operating-limit": { + "mva": 160 + }, + "emergency-operating-limits": [ + { + "duration-name": "emergency", + "limit": { + "mva": 165 + } + }, + { + "duration-name": "load-shed", + "limit": { + "mva": 170 + } + } + ] } ] - } -] \ No newline at end of file +} \ No newline at end of file