Skip to content

Commit

Permalink
add some parameter examples
Browse files Browse the repository at this point in the history
  • Loading branch information
caindy authored and catkins-miso committed Mar 27, 2024
1 parent 7e747ad commit 530c682
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 3 deletions.
4 changes: 4 additions & 0 deletions docs/_data/components/parameters/facility-filter.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,7 @@ in: query
required: false
schema:
$ref: ../schemas/generic-identifier.yaml
examples:
circuit-id:
summary: A typical AC line identifier
value: "86753_1"
11 changes: 10 additions & 1 deletion docs/_data/components/parameters/monitoring-set-filter.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
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`. The identifier for a `monitoring-set` is pre-coordinated,
but using the NERC id of the associated Ratings Provider is recommended.
in: query
required: false
schema:
$ref: ../schemas/generic-identifier.yaml
examples:
nerc-id:
summary: A NERC id that nominates a `monitoring-set`.
value: "X-AMPL"
7 changes: 7 additions & 0 deletions docs/_data/components/parameters/segment-filter.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,10 @@ in: query
required: false
schema:
$ref: ../schemas/generic-identifier.yaml
examples:
mrid:
summary: An mrid
value: "3d5e54d7-534e-49f7-9379-98bddacd96a1"
circuit-id:
summary: A typical AC line identifier
value: "86753_1"
4 changes: 2 additions & 2 deletions docs/_data/components/schemas/generic-identifier.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ description: |
Contains a unique identifier for an object.
maxLength: 100
pattern: ^(.){0,500}$
maxLength: 250
pattern: ^(.){0,250}$
example: "//trolie.example.com/limits/forecast-snapshot/2025-07-05T01:00:00-0500"

0 comments on commit 530c682

Please sign in to comment.