implement changes proposed in #44

cspell.json

@@ -10,6 +10,7 @@
         ,"excalidraw"
         ,"FERC"
         ,"ICCP"
+        ,"mrid"
         ,"NERC"
         ,"openapi"
         ,"owasp"

docs/Gemfile.lock

@@ -228,7 +228,7 @@ GEM
     mutex_m (0.2.0)
     net-http (0.4.1)
       uri
-    nokogiri (1.16.0-x86_64-linux)
+    nokogiri (1.16.2-x86_64-linux)
       racc (~> 1.4)
     octokit (4.25.1)
       faraday (>= 1, < 3)

docs/_data/components/parameters/monitoring-set-filter.yaml

@@ -1,7 +1,5 @@
 name: monitoring-set
-description: >
-  Only return ratings or limits for facilities of the associated
-  `monitoring-set`
+description: Only return ratings or limits for facilities of the associated `monitoring-set`.
 in: query
 required: false
 schema:

docs/_data/components/schemas/array-max-emergency-durations.yaml

@@ -0,0 +1,39 @@
+emergency-durations: &max
+  type: array
+  description: Defines the durations in minutes used for emergency limits.
+  minItems: 1
+  maxItems: 10
+  items:
+    type: object
+    properties:
+      name:
+        $ref: ./limit-type.yaml
+      duration-minutes:
+        type: integer
+        format: int32
+        minimum: 0
+        maximum: 1440
+
+
+limit-value-set:
+  <<: *max
+  description: >
+    A set of general limit or rating values, each mapped to the various limit
+    bands defined by the Transmission Provider's 
+
+    operating manual.  This typically consists of a "normal" limit, as well as
+    limits for various levels of emergency conditions
+
+    (typically 2-4) defined in the operations manual.  The list of supported limit
+    types may be fetched from getSupportedLimitTypes.  
+
+    The value of the limits are in units as defined by the X-TROLIE-Limit-Units
+    header.
+  items:
+    type: object
+    description: Operating Limit
+    properties:
+        duration-name:
+          $ref: ./limit-type.yaml
+        limit:
+          $ref: ./limit.yaml

docs/_data/components/schemas/array-max-forecast-periods.yaml

@@ -8,7 +8,7 @@ forecast-limit-item:
       type: array
       maxItems: 240
       items:
-        $ref: 'forecast-limit-period.yaml#/slim'
+        $ref: 'forecast-limit-period.yaml#/forecast-period-snapshot-slim'
 
 forecast-limit-item-detailed:
   type: object
@@ -19,20 +19,24 @@ forecast-limit-item-detailed:
     periods:
       <<: *max
       items:
-        $ref: 'forecast-limit-period.yaml#/detailed'
+        $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-rating-period.yaml
+        $ref: 'forecast-limit-period.yaml#/forecast-period-proposal'
+
+  required:
+    - resource-id
+    - periods
 
-missing-forecast-rating-for-segment:
+missing-forecast:
   type: object
   additionalProperties: false
   properties:

docs/_data/components/schemas/array-max-monitored-elements.yaml

@@ -1,51 +1,73 @@
-# TODO: monitoring-set is no longer referenced
-monitoring-set:
-  description: |
-    Set of transmission facilities noteworthy to reference in queries in TROLIE.  
-    The set of segments included in the monitoring set is implied by their
-    inclusion in the transmission facilities within the monitoring set.  
-  type: object
-  additionalProperties: false
-  properties:
-    id:
-      $ref: ./generic-identifier.yaml
-    description:
-      $ref: '../../openapi-split.yaml#/components/schemas/description'
-    transmission-facilities: &max
-      type: array
-      minItems: 0
-      maxItems: 50000
-      items:
-        $ref: ./generic-identifier.yaml
+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-limit-set-detailed:
   <<: *max
   description: Forecast including provenance information.
   items:
     $ref: 'array-max-forecast-periods.yaml#/forecast-limit-item-detailed'
 
-forecast-limit-set:
+named-power-system-objects:
   <<: *max
-  description: Set of forecast limits
+  description: Collection of power system object names
   items:
-    $ref: 'array-max-forecast-periods.yaml#/forecast-limit-item'
+    $ref: ./names.yaml
+
+forecast-proposal:
+  type: object
+  properties:
+    forecast-header:
+      $ref: ./rating-proposal-header.yaml
+    ratings:
+      <<: *max
+      description: Forecasted Ratings
+      items:
+        $ref: 'array-max-forecast-periods.yaml#/resource-forecast-proposal'
+  required:
+    - forecast-header
+    - ratings
+
+missing-forecast-rating-set:
+  <<: *max
+  description: A set of Missing Forecasted Ratings for a Forecast Window
+  items:
+    $ref: 'array-max-forecast-periods.yaml#/missing-forecast'
 
 realtime-limit-set:
   <<: *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
 
-rating-proposal:
+realtime-ratings-proposals:
+  <<: *max
+  description: Real-Time Ratings Proposals
+  items:
+    $ref: 'array-max-forecast-periods.yaml#/realtime-rating-proposal'
+
+seasonal-rating-proposal:
+  description: Seasonal rating proposal
   allOf:
     - $ref: ./mutable-rating-proposal.yaml
     - type: object
       properties:
         ratings:
           <<: *max
           items:
-            $ref: 'array-max-seasons.yaml#/seasonal-proposals'
+            $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

docs/_data/components/schemas/array-max-seasons.yaml

@@ -4,8 +4,19 @@ seasonal-proposals:
   properties:
     segment-id:
       $ref: ./generic-identifier.yaml
-    seasons:
+    seasons: &max
       type: array
-      maxItems: 20 # max seasons
+      maxItems: 20
+      minItems: 0
       items:
         $ref: ./seasonal-proposal-season.yaml
+seasonal-rating-snapshot-item:
+  type: object
+  additionalProperties: false
+  properties:
+    transmission-facility-id:
+      $ref: ./generic-identifier.yaml
+    seasons:
+      <<: *max
+      items:
+        $ref: ./seasonal-rating-snapshot-value.yaml

docs/_data/components/schemas/conditional-value-set.yaml

@@ -8,5 +8,7 @@ items:
   properties:
     condition:
       $ref: ./network-component-name.yaml
-    values:
-      $ref: ./limit-value-set.yaml
+    continuous-operating-limit:
+      $ref: ./limit.yaml
+    emergency-operating-limits:
+      $ref: ./array-max-emergency-durations.yaml#/limit-value-set

docs/_data/components/schemas/forecast-limit-period.yaml

@@ -1,16 +1,41 @@
-slim:
+forecast-period-proposal:
   type: object
+  title: Forecasted Period
+  description: |
+
+    A Forecasted Period contains proposed limits for a power system
+    object, e.g., a segment, that were forecasted for a particular Period
+    in a Forecast Window. The status of the proposal as determined by the
+    Clearinghouse is also included.
+
   properties:
     period-start:
       $ref: ./period-start.yaml
-    updated-time:
-      $ref: ./timestamp.yaml
-    values:
-      $ref: ./limit-value-set.yaml
+    period-end:
+      $ref: ./period-start.yaml
+    continuous-operating-limit:
+      $ref: ./limit.yaml
+    emergency-operating-limits:
+      $ref: ./array-max-emergency-durations.yaml#/limit-value-set
+  required:
+    - period-start
+    - period-end
+    - continuous-operating-limit
+    - emergency-operating-limits
+
+forecast-period-snapshot-slim:
+  allOf:
+    - $ref: '#/forecast-period-proposal'
+    - type: object
+      properties:
+        updated-time:
+          $ref: ./timestamp.yaml
+      required:
+        - updated-time
 
-detailed:
+forecast-period-snapshot-detailed:
   type: object
   description: Period detailed limits including provenance
   allOf:
-    - $ref: '#/slim'
+    - $ref: '#/forecast-period-snapshot-slim'
     - $ref: ./limit-provenance.yaml

docs/_data/components/schemas/forecast-rating-period.yaml → docs/_data/components/schemas/forecast-rating-period-deprecated.yaml

@@ -30,7 +30,9 @@ properties:
     $ref: ./period-start.yaml
   status:
     $ref: ./proposal-status.yaml
-  values:
-    $ref: ./limit-value-set.yaml
+  continuous-operating-limit:
+    $ref: ./limit.yaml
+  emergency-operating-limits:
+    $ref: ./array-max-emergency-durations.yaml#/limit-value-set
   branch-only-values:
-    $ref: ./limit-value-set.yaml
+    $ref: ./array-max-emergency-durations.yaml#/limit-value-set

docs/_data/components/schemas/limit-provenance.yaml

@@ -33,3 +33,6 @@ properties:
 
       Schema of this object is out of scope of the TROLIE specification.  
     type: object
+required:
+  - proposals-considered
+  - limiting-segment