Skip to content

Commit

Permalink
require all fields in limit types
Browse files Browse the repository at this point in the history
  • Loading branch information
catkins-miso committed Oct 11, 2024
1 parent f334973 commit 76232ed
Show file tree
Hide file tree
Showing 8 changed files with 84 additions and 30 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
type: object
title: Active Power and Power Factor
additionalProperties: false
properties:
mw:
type: number
description: Active Power in megawatts
format: float
minimum: 1
maximum: 10000
pf:
type: number
description: |
Assumed power factor.
N.b. power factor is optional in the spec though it may be required in a
particular exchange.
format: float
minimum: 0
maximum: 1
required:
- mw
- pf
11 changes: 1 addition & 10 deletions docs/_data/components/schemas/limit-types/active-power.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
type: object
title: Active Power
additionalProperties: false
properties:
mw:
Expand All @@ -7,15 +8,5 @@ properties:
format: float
minimum: 1
maximum: 10000
pf:
type: number
description: |
Assumed power factor.
N.b. power factor is optional in the spec though it may be required in a
particular exchange.
format: float
minimum: 0
maximum: 1
required:
- mw
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
type: object
title: Apparent Power
additionalProperties: false
properties:
mva:
Expand Down
14 changes: 14 additions & 0 deletions docs/_data/components/schemas/limit-types/current-with-kV.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
type: object
title: Current (nominal voltage assumed)
description: >-
Representation of a limit in amperes. Assumes that Clearinghouse Provider
has the nominal voltage in its model.
additionalProperties: false
properties:
amps:
type: number
format: float
minimum: 1
maximum: 100000
required:
- amps
7 changes: 4 additions & 3 deletions docs/_data/components/schemas/limit-types/current.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
type: object
title: Current (nominal voltage assumed)
description: >-
Representation of a limit in amperes. Assumes that Clearinghouse Provider
has the nominal voltage in its model.
additionalProperties: false
properties:
amps:
type: number
description: >-
Representation of a limit in amperes. Assumes that Clearinghouse Provider
has the nominal voltage in its model.
format: float
minimum: 1
maximum: 100000
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
type: object
title: Reactive Power
description: Representation of a limit in megavolt-amperes reactive (MVAR).
additionalProperties: false
properties:
mvar:
type: number
description: Representation of a limit in megavolt-amperes reactive (MVAR).
format: float
minimum: -10000
maximum: 10000
Expand Down
53 changes: 37 additions & 16 deletions docs/_data/components/schemas/limit-types/voltage.yaml
Original file line number Diff line number Diff line change
@@ -1,52 +1,73 @@
overvoltage-threshold-pu:
type: object
title: Overvoltage Threshold per unit (nominal voltage assumed)
description: >
An upper limit to voltage for a transmission facility in per unit with
the base voltage assumed to be the nominal voltage.
additionalProperties: false
properties:
voltage-pu-max: &pu
type: number
description: >
An upper limit to voltage for a transmission facility in per unit.
format: float
minimum: 0
maximum: 2
base-kV: &voltage
type: number
description: >
The base voltage in kilovolts for the per unit voltage.
format: int32
minimum: 0
maximum: 1100
required:
- voltage-pu-max

overvoltage-threshold:
type: object
title: Overvoltage Threshold
description: An upper limit to voltage for a transmission facility in kilovolts.
additionalProperties: false
properties:
kV-max:
<<: *voltage
description: >
An upper limit to voltage for a transmission facility in kilovolts.
kV-max: &voltage
type: number
format: int32
minimum: 0
maximum: 1100
required:
- kV-max

undervoltage-threshold-pu:
type: object
title: Undervoltage Threshold per unit (nominal voltage assumed)
description: >
An lower limit to voltage for a transmission facility in per unit
with the nominal voltage assumed to be the base voltage.
additionalProperties: false
properties:
voltage-pu-min:
<<: *pu
description: An lower limit to voltage for a transmission facility in per unit.
base-kV: *voltage
required:
- voltage-pu-min

undervoltage-threshold:
type: object
title: Undervoltage Threshold
description: A lower limit to voltage for a transmission facility in kilovolts.
additionalProperties: false
properties:
kV-min:
<<: *voltage
description: A lower limit to voltage for a transmission facility in kilovolts.
required:
- kV-min

current-with-kV:
type: object
title: Current
description: >-
Representation of a limit in amperes. Assumes that Clearinghouse Provider
has the nominal voltage in its model.
additionalProperties: false
properties:
amps:
type: number
format: float
minimum: 1
maximum: 100000
kV:
<<: *voltage
description: The voltage in kilovolts for the current limit.
required:
- amps
- kV
2 changes: 2 additions & 0 deletions docs/_data/components/schemas/limit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,10 @@ description: |
oneOf:
- $ref: './limit-types/active-power.yaml'
- $ref: './limit-types/active-power-with-power-factor.yaml'
- $ref: './limit-types/apparent-power.yaml'
- $ref: './limit-types/current.yaml'
- $ref: './limit-types/voltage.yaml#/current-with-kV'
- $ref: './limit-types/reactive-power.yaml'
- $ref: './limit-types/voltage.yaml#/overvoltage-threshold-pu'
- $ref: './limit-types/voltage.yaml#/overvoltage-threshold'
Expand Down

0 comments on commit 76232ed

Please sign in to comment.