Merge pull request #187 from trolie/151-ratings-proposal-source

ratings proposal source

cspell.json

@@ -38,6 +38,7 @@
         ,"Redocly"
         ,"ruleset"
         ,"SCADA"
+        ,"Telemetered"
         ,"TROLIE"
         ,"undervoltage"
         ,"Vernova"

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

@@ -254,7 +254,7 @@ realtime-proposal-slim:
   description: Used to propose real-time ratings for a set of resources.
   properties:
     proposal-header:
-      $ref: ./headers.yaml#/real-time-proposal-header
+      $ref: ./headers.yaml#/real-time-proposal-slim-header
     ratings:
       <<: *max
       description: Real-Time Ratings Proposals

docs/_data/components/schemas/headers.yaml

@@ -16,7 +16,7 @@ common-header: &common-header
     - power-system-resources
   additionalProperties: false
 
-real-time-proposal-header:
+real-time-proposal-header: &forecast-proposal-header
   <<: *common-header
   description: |
 
@@ -26,6 +26,13 @@ real-time-proposal-header:
     appropriate metadata from the
     Clearinghouse Provider's perspective.
 
+real-time-proposal-slim-header:
+  <<: *forecast-proposal-header
+  properties:
+    <<: *common-header-props
+    current-source:
+      $ref: ./quality-class-current-source.yaml
+
 forecast-proposal-header: &forecast-proposal-header
   <<: *common-header
   description: |
@@ -68,6 +75,9 @@ forecast-proposal-slim-header:
         RFC 3339 date-time string with *no fractional seconds component* that
         indicates that last period for each individual resource proposal,
         identifying the appropriate operational window for this proposal.
+    current-source:
+      $ref: ./quality-class-current-source.yaml
+
 
   required:
     - begins

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

@@ -3,6 +3,8 @@ allOf:
   - $ref: ./limit-data.yaml
   - type: object
     properties:
+      current-source:
+        $ref: ./quality-class-current-source.yaml
       inputs-used:
         description: |
 

docs/_data/components/schemas/quality-class-current-source.yaml

@@ -0,0 +1,21 @@
+type: string
+description: |
+
+  This property is modeled after the Quality Class called "Current Source"
+  in ICCP. It is used to indicate the source of the current value of the
+  proposed rating. The natural mapping of this property to the kinds of ratings
+  or rating sources described in Order 881 is as follows.
+
+  | ICCP        | TROLIE            |
+  --------------|--------------------
+  | telemetered | DLR               |
+  | calculated  | AAR               |
+  | estimated   | Recourse Rating  / time-bound static rating |
+  | manual      | Operator Override |
+
+enum:
+  - Telemetered
+  - Calculated
+  - Estimated
+  - Manual
+default: Calculated