Skip to content

Commit

Permalink
clean up leftover from removing monitoring set a top-level resource
Browse files Browse the repository at this point in the history
  • Loading branch information
caindy committed Feb 4, 2024
1 parent f5ff480 commit 8f379de
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 54 deletions.
4 changes: 1 addition & 3 deletions docs/_data/components/parameters/monitoring-set-filter.yaml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
80 changes: 32 additions & 48 deletions docs/_data/components/schemas/array-max-monitored-elements.yaml
Original file line number Diff line number Diff line change
@@ -1,45 +1,55 @@
# 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:
forecast-rating-proposal:
type: object
properties:
forecast-header:
$ref: ./rating-proposal-header.yaml
ratings:
<<: *max
description: Forecasted Ratings
items:
$ref: 'array-max-forecast-periods.yaml#/forecast-proposal-for-segment'
required:
- forecast-header
- ratings

missing-forecast-rating-set:
<<: *max
description: Set of forecast limits
description: A set of Missing Forecasted Ratings for a Forecast Window
items:
$ref: 'array-max-forecast-periods.yaml#/forecast-limit-item'
$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

realtime-ratings-proposals:
<<: *max
description: Real-Time Ratings Proposals
items:
$ref: 'array-max-forecast-periods.yaml#/realtime-rating-proposal'

seasonal-rating-proposal:
allOf:
- $ref: ./mutable-rating-proposal.yaml
Expand All @@ -49,29 +59,3 @@ seasonal-rating-proposal:
<<: *max
items:
$ref: 'array-max-seasons.yaml#/seasonal-proposals'

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-ratings-proposals:
<<: *max
description: Real-Time Ratings Proposals
items:
$ref: 'array-max-forecast-periods.yaml#/realtime-rating-proposal'

forecast-rating-proposal:
type: object
properties:
forecast-header:
$ref: ./rating-proposal-header.yaml
ratings:
<<: *max
description: Forecasted Ratings
items:
$ref: 'array-max-forecast-periods.yaml#/forecast-proposal-for-segment'
required:
- forecast-header
- ratings
2 changes: 0 additions & 2 deletions docs/_data/openapi-split.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -470,8 +470,6 @@ components:
write:seasonal-proposals: Submit seasonal ratings
write:temporary-aar-exceptions: Write temporary AAR exceptions
write:temporary-seasonal-ratings: Write temporary seasonal ratings
read:monitoring-set: Read monitoring set definitions
write:monitoring-sets: Write monitoring set definitions
read:operating-snapshot: >-
Read the ratings and limits snapshots in-use by the transmission
provider
Expand Down
20 changes: 19 additions & 1 deletion docs/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,22 @@ Proposals are forecasted or real-time ratings values submitted to TROLIE against
As implied above, Snapshots are generated in TROLIE server implementations based on proposals and other inputs to generate in-use ratings for each Transmission Facility. TROLIE allows for ratings providers to fetch the latest snapshot, aka the latest "version" of the ratings data.

## Monitoring Sets
Monitoring Sets are arbitrarily defined sets of transmission facilities that may be used to filter ratings and limits returned by queries against these APIs. Defining the contents of these monitoring sets may vary, and is up to TROLIE server implementations.

Monitoring Sets are named sets of power system objects that may be used to
filter ratings and limits returned by queries against these APIs. How Monitoring
Sets are defined is beyond the scope of the TROLIE specification, and it is
assumed that the sender and receiver have predefined the appropriate Monitoring
Sets.

A typical implementation might define a Monitoring Set for each Ratings
Provider, containing all of the power system objects of interest to that Rating
Provider, such as their owned and/or operated facilities as well as any
additional objects whose limits they might monitor. It is generally assumed that
the Ratings Provider's Monitoring Set would include all of the transmission
facilities or other power system objects for which they have a Ratings
Obligation as well as their so-called "tier 1" monitored elements.

Another typical Monitoring Set would be that which nominates the complete
footprint for the Transmission Provider. A natural choice for the
`monitoring-set` identifier is the NERC id of the entity that defines the
`monitoring-set`, if applicable.

0 comments on commit 8f379de

Please sign in to comment.