Skip to content

Commit

Permalink
use "source" as element name for all uses of data-provenance.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
catkins-miso committed Oct 11, 2024
1 parent 4bb61a2 commit 2f39c42
Show file tree
Hide file tree
Showing 23 changed files with 85 additions and 106 deletions.
7 changes: 0 additions & 7 deletions docs/_data/components/parameters/ratings-provider.yaml

This file was deleted.

14 changes: 7 additions & 7 deletions docs/_data/components/schemas/array-max-monitored-elements.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -169,13 +169,13 @@ forecast-proposal-status:
properties:
<<: *common-proposal-status-props
forecast-provider:
source:
$ref: ./data-provenance.yaml
begins: # nominates the forecast window
$ref: ./period-start.yaml

required:
- forecast-provider
- source
- begins
- incomplete-obligation-count
- incomplete-obligations
Expand All @@ -189,10 +189,10 @@ real-time-proposal-status:
Includes any validation errors encountered while processing proposals.
properties:
<<: *common-proposal-status-props
ratings-provider:
source:
$ref: ./data-provenance.yaml
required:
- ratings-provider
- source
- incomplete-obligation-count
- incomplete-obligations
- invalid-proposal-count
Expand Down Expand Up @@ -306,10 +306,10 @@ seasonal-ratings-proposal-status:
unfulfilled Obligations indicated in `incomplete-obligation-count`.
items:
$ref: ./array-max-seasons.yaml#/missing-seasonal-obligation
provider-info:
source:
$ref: ./data-provenance.yaml
required:
- provider-info
- source
- incomplete-obligation-count
- invalid-proposal-count

Expand Down Expand Up @@ -345,4 +345,4 @@ seasonal-override-set:
minItems: 0
maxItems: *max-facilities
items:
$ref: ./time-bound-static-ratings.yaml#/seasonal-override
$ref: ./time-bound-static-ratings.yaml#/seasonal-override
11 changes: 5 additions & 6 deletions docs/_data/components/schemas/headers.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -86,15 +86,15 @@ forecast-snapshot-header: &forecast-snapshot-header
RFC 3339 date-time string with *no fractional seconds component* that
Nominates the operational window of this snapshot.
snapshot-provenance:
source:
$ref: ./data-provenance.yaml
power-system-resources:
$ref: ./array-max-monitored-elements.yaml#/named-power-system-resources
default-emergency-durations:
$ref: ./array-max-emergency-durations.yaml#/emergency-durations
required:
- begins
- snapshot-provenance
- source
- power-system-resources
- default-emergency-durations

Expand All @@ -113,21 +113,21 @@ forecast-snapshot-slim-header:
required:
- begins
- ends
- snapshot-provenance
- source
- power-system-resources
- default-emergency-durations

real-time-snapshot-header:
description: Details about the snapshot provided by the Clearinghouse provider.
properties:
snapshot-provenance:
source:
$ref: ./data-provenance.yaml
power-system-resources:
$ref: ./array-max-monitored-elements.yaml#/named-power-system-resources
default-emergency-durations:
$ref: ./array-max-emergency-durations.yaml#/emergency-durations
required:
- snapshot-provenance
- source
- power-system-resources

seasonal-proposal-header:
Expand All @@ -136,7 +136,6 @@ seasonal-proposal-header:
Describes the contents of this seasonal ratings proposal.
seasonal-proposal-header-slim:
<<: *common-header
description: |
Expand Down
11 changes: 0 additions & 11 deletions docs/_data/components/schemas/mutable-rating-proposal.yaml

This file was deleted.

62 changes: 25 additions & 37 deletions docs/_data/components/schemas/time-bound-static-ratings.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
temporary-aar-exception-request:
temporary-aar-exception-request: &time-bound-static-rating
type: object
description: |
Represents a temporary AAR Exception against a resource.
Includes a start and (optional) end time, and a reason.
Includes a start and (optional) end time, and a reason.
May or may not include a set of values, depending on the business
context in which the temporary AAR exception is used.
properties: &time-bound-static-rating
provenance:
context in which the temporary AAR exception is used.
properties: &time-bound-static-rating-props
source:
$ref: ./data-provenance.yaml
resource:
$ref: ./names.yaml
Expand All @@ -25,56 +25,44 @@ temporary-aar-exception-request:
type: string
format: free-form
maxLength: 4000
additionalProperties: false
required:
- source
- resource
- start-time
- continuous-operating-limit
- emergency-operating-limits

temporary-aar-exception:
type: object
temporary-aar-exception: &time-bound-static-limit
<<: *time-bound-static-rating
description: |
Data structure for a temporary AAR Exception against a resource.
Includes a unique ID, start and (optional) end time, and a reason.
May or may not include a set of values, depending on the business
context in which the temporary AAR exception is used.
allOf:
- $ref: '#/temporary-aar-exception-request'
- type: object
properties:
id:
$ref: ./server-generated-id.yaml
required:
- id

seasonal-override-request:
type: object
description: |
Data structure for a seasonal override against a resource.
Includes a unique ID, start and (optional) end time, and a reason.
Must also include a set of values.
properties:
<<: *time-bound-static-rating
properties:
<<: *time-bound-static-rating-props
id:
$ref: ./server-generated-id.yaml
additionalProperties: false
required:
- source
- id
- resource
- start-time
- continuous-operating-limit
- emergency-operating-limits

seasonal-override:
type: object
seasonal-override-request:
<<: *time-bound-static-rating
description: |
Data structure for a seasonal override against a resource.
Includes a unique ID, start and (optional) end time, and a reason.
Must also include a set of values.
allOf:
- $ref: '#/seasonal-override-request'
- type: object
properties:
id:
$ref: ./server-generated-id.yaml
required:
- id
seasonal-override:
<<: *time-bound-static-limit
description: |
Data structure for a seasonal override against a resource. Includes a
unique ID, start and (optional) end time, and a reason. Must also include a
set of values.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"snapshot-header": {
"begins": "2023-07-12T16:00:00-07:00",
"snapshot-provenance": {
"source": {
"provider":"X-AMPL-RC",
"last-updated": "2023-07-12T16:00:00-07:00",
"origin-id": "//trolie.example.com/snapshots/2024-08-05T11%3a00%3a00-07%3a00"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"snapshot-header": {
"begins": "2023-07-12T16:00:00-07:00",
"ends": "2023-07-12T18:00:00-07:00",
"snapshot-provenance": {
"source": {
"provider":"X-AMPL",
"last-updated": "2023-07-12T16:00:00-07:00",
"origin-id": "//trolie.example.com/snapshots/2024-08-05T11%3a00%3a00-07%3a00"
Expand Down
2 changes: 1 addition & 1 deletion docs/example-narratives/examples/forecast-limits.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"snapshot-header": {
"begins": "2023-07-12T16:00:00-07:00",
"snapshot-provenance": {
"source": {
"provider":"X-AMPL",
"last-updated": "2023-07-12T16:00:00-07:00",
"origin-id": "//trolie.example.com/snapshots/2024-08-05T11%3a00%3a00-07%3a00"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"forecast-provider": {
"source": {
"provider": "UTILITY-A",
"last-updated": "2023-07-12T15:05:43.044267100-07:00",
"origin-id": "5aeacb25-9b65-4738-8a00-ac10afa63640"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"forecast-provider": {
"source": {
"provider": "UTILITY-A",
"last-updated": "2023-07-12T15:05:43.044267100-07:00",
"origin-id": "5aeacb25-9b65-4738-8a00-ac10afa63640"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"snapshot-header": {
"snapshot-provenance": {
"source": {
"provider": "X-AMPL-RC",
"last-updated": "2023-07-12T15:05:43.044267100-07:00",
"origin-id": "//trolie.example.com/snapshots/2024-08-05T11%3a00%3a00-07%3a00"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"snapshot-header": {
"snapshot-provenance": {
"source": {
"provider": "X-AMPL",
"last-updated": "2023-07-12T15:05:43.044267100-07:00",
"origin-id": "//trolie.example.com/snapshots/2024-08-05T11%3a00%3a00-07%3a00"
Expand Down
2 changes: 1 addition & 1 deletion docs/example-narratives/examples/realtime-limit-set.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"snapshot-header": {
"snapshot-provenance": {
"source": {
"provider":"X-AMPL",
"last-updated": "2023-07-12T15:05:43.044267100-07:00",
"origin-id": "//trolie.example.com/snapshots/2024-08-05T11%3a00%3a00-07%3a00"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"ratings-provider": {
"source": {
"provider": "UTILITY-A",
"last-updated": "2023-07-12T15:05:43.044267100-07:00",
"origin-id": "5aeacb25-9b65-4738-8a00-ac10afa63640"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"ratings-provider": {
"source": {
"provider": "UTILITY-A",
"last-updated": "2023-07-12T15:05:43.044267100-07:00",
"origin-id": "5aeacb25-9b65-4738-8a00-ac10afa63640"
Expand Down
10 changes: 5 additions & 5 deletions docs/example-narratives/examples/seasonal-override-get.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"provenance": {
"source": {
"provider":"X-AMPL",
"last-updated": "2023-07-12T15:05:43.044267100-07:00",
"origin-id": "//trolie.example.com/seasonal-overrides/513a7cb3-5d3c-4b7e-849c-e4015846db53"
Expand All @@ -25,18 +25,18 @@
"mva": 160
},
"emergency-operating-limits": [
{
{
"duration-name": "emergency",
"limit": {
"mva": 165
}
},
{
{
"duration-name": "load-shed",
"limit": {
"mva": 170
}
}
}
],
"reason": "Increased vegetation proximity"
}
}
10 changes: 5 additions & 5 deletions docs/example-narratives/examples/seasonal-override-list.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[
{
"provenance": {
"source": {
"provider":"X-AMPL",
"last-updated": "2023-07-12T15:05:43.044267100-07:00",
"origin-id": "//trolie.example.com/seasonal-overrides/513a7cb3-5d3c-4b7e-849c-e4015846db53"
Expand All @@ -26,19 +26,19 @@
"mva": 160
},
"emergency-operating-limits": [
{
{
"duration-name": "emergency",
"limit": {
"mva": 165
}
},
{
{
"duration-name": "load-shed",
"limit": {
"mva": 170
}
}
}
],
"reason": "Increased vegetation proximity"
}
]
]
13 changes: 9 additions & 4 deletions docs/example-narratives/examples/seasonal-override-post.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
{
"source": {
"provider":"X-AMPL",
"last-updated": "2023-07-12T15:05:43.044267100-07:00",
"origin-id": "513a7cb3-5d3c-4b7e-849c-e4015846db53"
},
"resource": {
"resource-id": "8badf00d",
"alternate-identifiers": [
Expand All @@ -19,18 +24,18 @@
"mva": 160
},
"emergency-operating-limits": [
{
{
"duration-name": "emergency",
"limit": {
"mva": 165
}
},
{
{
"duration-name": "load-shed",
"limit": {
"mva": 170
}
}
}
],
"reason": "Increased vegetation proximity"
}
}
Loading

0 comments on commit 2f39c42

Please sign in to comment.