Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add optional inputs-used property #63

Merged
merged 3 commits into from
Mar 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 0 additions & 18 deletions docs/_data/components/schemas/array-max-forecast-periods.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -46,21 +46,3 @@ missing-forecast:
<<: *max
items:
$ref: ./period-start.yaml

resource-realtime-proposal:
<<: *max
items:
type: object
additionalProperties: false
description: >
Real-time ratings data for a segment. Includes status of the proposal
relative to this data, as well as rating values.
properties:
resource-id:
$ref: ./generic-identifier.yaml
status:
$ref: ./proposal-status.yaml
continuous-operating-limit:
$ref: ./limit.yaml
emergency-operating-limits:
$ref: ./array-max-emergency-durations.yaml#/limit-value-set
14 changes: 13 additions & 1 deletion docs/_data/components/schemas/array-max-monitored-elements.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,19 @@ realtime-proposal:
<<: *max
description: Real-Time Ratings Proposals
items:
$ref: 'array-max-forecast-periods.yaml#/resource-realtime-proposal'
type: object
additionalProperties: false
description: >
Real-time ratings data for a segment. Includes status of the proposal
relative to this data, as well as rating values.
allOf:
- type: object
properties:
resource-id:
$ref: ./generic-identifier.yaml
status:
$ref: ./proposal-status.yaml
- $ref: ./limit-data.yaml

seasonal-rating-proposal:
description: Seasonal rating proposal
Expand Down
28 changes: 14 additions & 14 deletions docs/_data/components/schemas/forecast-limit-period.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
period:
type: object
properties:
period-end:
$ref: ./period-start.yaml
period-start:
$ref: ./period-start.yaml
required:
- period-start
- period-end

forecast-period-proposal:
type: object
title: Forecasted Period
Expand All @@ -8,20 +19,9 @@ forecast-period-proposal:
in a Forecast Window. The status of the proposal as determined by the
Clearinghouse is also included.

properties:
period-start:
$ref: ./period-start.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
allOf:
- $ref: '#/period'
- $ref: ./limit-data.yaml

forecast-period-snapshot-slim:
allOf:
Expand Down
45 changes: 45 additions & 0 deletions docs/_data/components/schemas/limit-data.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
type: object
properties:
continuous-operating-limit:
$ref: ./limit.yaml
emergency-operating-limits:
$ref: ./array-max-emergency-durations.yaml#/limit-value-set
inputs-used:
description: |

Optional list of quantities used as input to the ratings determination.
The particular information exchange determines which values may be expected
as well as the conventions used to represent those values. This property
is included to prescribe a way to include these inputs but

type: array
minItems: 1
maxItems: 50
items:
type: object
properties:
name:
type: string
format: free-text
maxLength: 50
value:
type: object
description: >
This could be any value: a bit, float, integer, string, etc.
unit:
type: string
description: |
If the `value` is dimensionless, this property should not be
provided. Since we are not specifying which inputs shall be
provided, we cannot specify a definitive list of units, but
implementors are encouraged to use UnitSymbol from CIM when
appropriate: The CIM may not include appropriate units for
all inputs, e.g., wind speed.
format: unit
maxLength: 50
required:
- name
- value
required:
- continuous-operating-limit
- emergency-operating-limits
19 changes: 10 additions & 9 deletions docs/_data/components/schemas/realtime-limit-item.yaml
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
type: object
properties:
transmission-facility-id:
$ref: ./generic-identifier.yaml
updated-time:
$ref: ./timestamp.yaml
continuous-operating-limit:
$ref: ./limit.yaml
emergency-operating-limits:
$ref: ./array-max-emergency-durations.yaml#/limit-value-set
allOf:
- type: object
properties:
transmission-facility-id:
$ref: ./generic-identifier.yaml
updated-time:
$ref: ./timestamp.yaml
- $ref: ./limit-data.yaml
required:
- transmission-facility-id