diff --git a/docs/_spec/components/parameters/facility-filter.yaml b/docs/_spec/components/parameters/resource-id-filter.yaml similarity index 51% rename from docs/_spec/components/parameters/facility-filter.yaml rename to docs/_spec/components/parameters/resource-id-filter.yaml index 4c30c0dd..a62650eb 100644 --- a/docs/_spec/components/parameters/facility-filter.yaml +++ b/docs/_spec/components/parameters/resource-id-filter.yaml @@ -1,6 +1,6 @@ -name: transmission-facility +name: resource-id description: | - Only return limits for this transmission facility. + Only return limits for this power system resource in: query required: false schema: @@ -9,3 +9,6 @@ examples: circuit-id: summary: A typical AC line identifier value: "86753_1" + mrid: + summary: A unique identifier for a power system resource + value: "123456789012345678" diff --git a/docs/_spec/paths/limits_forecast-snapshot.yaml b/docs/_spec/paths/limits_forecast-snapshot.yaml index 9e77d392..ad259548 100644 --- a/docs/_spec/paths/limits_forecast-snapshot.yaml +++ b/docs/_spec/paths/limits_forecast-snapshot.yaml @@ -8,7 +8,7 @@ current: - $ref: ../components/parameters/offset-period-start.yaml - $ref: ../components/parameters/period-end.yaml - $ref: ../components/parameters/monitoring-set-filter.yaml - - $ref: ../components/parameters/facility-filter.yaml + - $ref: ../components/parameters/resource-id-filter.yaml - $ref: ../components/parameters/static-only.yaml description: | @@ -118,7 +118,7 @@ historical: - $ref: ../components/parameters/offset-period-start.yaml - $ref: ../components/parameters/period-end.yaml - $ref: ../components/parameters/monitoring-set-filter.yaml - - $ref: ../components/parameters/facility-filter.yaml + - $ref: ../components/parameters/resource-id-filter.yaml - $ref: ../components/parameters/static-only.yaml - name: period description: | diff --git a/docs/_spec/paths/limits_realtime-snapshot.yaml b/docs/_spec/paths/limits_realtime-snapshot.yaml index 12cfc8a1..4968ae6b 100644 --- a/docs/_spec/paths/limits_realtime-snapshot.yaml +++ b/docs/_spec/paths/limits_realtime-snapshot.yaml @@ -15,7 +15,7 @@ global: - Real-Time parameters: ¶ms - $ref: ../components/parameters/monitoring-set-filter.yaml - - $ref: ../components/parameters/facility-filter.yaml + - $ref: ../components/parameters/resource-id-filter.yaml responses: &responses '200': description: The System Operating Limits snapshot is returned. diff --git a/docs/_spec/paths/seasonal-ratings-snapshot.yaml b/docs/_spec/paths/seasonal-ratings-snapshot.yaml index edefbe6d..ea0e7d06 100644 --- a/docs/_spec/paths/seasonal-ratings-snapshot.yaml +++ b/docs/_spec/paths/seasonal-ratings-snapshot.yaml @@ -6,7 +6,7 @@ get: - Seasonal parameters: - $ref: ../components/parameters/monitoring-set-filter.yaml - - $ref: ../components/parameters/facility-filter.yaml + - $ref: ../components/parameters/resource-id-filter.yaml responses: '200': description: OK