Merge pull request #208 from trolie/207-rename-transmission-facility-…

…query-parameter-to-resource-id rename facility filter to resource id filter
trolie · Nov 15, 2024 · 0f3860b · 0f3860b
2 parents 0bd8c51 + 5a1e100
commit 0f3860b
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 6 deletions.
diff --git a/...omponents/parameters/facility-filter.yaml → ...onents/parameters/resource-id-filter.yaml b/...omponents/parameters/facility-filter.yaml → ...onents/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
@@ -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
@@ -15,7 +15,7 @@ global:
       - Real-Time
     parameters: &params
       - $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
@@ -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