-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
clean up resource-id vs origin-id in provenance #194
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,63 +1,75 @@ | ||
| type: object | ||
| description: Given a limit value, a set of data defining the provenance of that limit. | ||
| properties: | ||
| proposals-considered: | ||
| description: | | ||
|
|
||
| The forecast proposals provided by the Ratings Providers during the | ||
| Forecast Window for this limits snapshot. | ||
|
|
||
| type: array | ||
| maxItems: &max-proposals 10 | ||
| items: | ||
| allOf: | ||
| - $ref: 'forecast-limit-period.yaml#/proposal-considered' | ||
| - type: object | ||
| properties: | ||
| resource-id: | ||
| $ref: ./resource-id.yaml | ||
|
|
||
| temporary-aar-exceptions: | ||
| description: | | ||
|
|
||
| The temporary AAR exceptions for the facility that were active when this | ||
| snapshot was generated. | ||
|
|
||
| type: array | ||
| maxItems: *max-proposals | ||
| items: | ||
| $ref: ./resource-id.yaml | ||
|
|
||
| overrides: | ||
| type: array | ||
| minItems: 0 | ||
| maxItems: *max-proposals | ||
| items: | ||
| type: object | ||
| properties: | ||
| override: | ||
| $ref: ./limit-data.yaml | ||
| override-reason: | ||
| type: string | ||
| description: | ||
| forecast: &forecast | ||
| type: object | ||
| description: Contains the provenance data for a given limit. | ||
| properties: &props | ||
| proposals-considered: &considered | ||
| description: | | ||
|
|
||
| The ratings proposals provided by the Ratings Providers that were | ||
| considered when determining the limits of the facility for a specific | ||
| period. | ||
|
|
||
| If `resource-id` is not provided for a proposal, the ratings proposal is | ||
| assumed to be for the overall facility nominated by the `resource-id` of | ||
| this limit. | ||
|
|
||
| If it is provided, it corresponds to the [segment](https://trolie.energy/concepts#segments). | ||
|
|
||
| type: array | ||
| maxItems: &max-proposals 10 | ||
| items: | ||
| $ref: 'proposal-considered.yaml#/forecast' | ||
|
|
||
| temporary-aar-exceptions: | ||
| description: | | ||
|
|
||
| Indicates that this limit was overridden for some reason, the reason | ||
| itself. | ||
| The temporary AAR exceptions for the facility that were active when this | ||
| snapshot was generated. | ||
|
|
||
| format: free-text | ||
| maxLength: 500 | ||
| required: | ||
| - override | ||
| - override-reason | ||
| type: array | ||
| maxItems: *max-proposals | ||
| items: | ||
| $ref: ./resource-id.yaml | ||
|
|
||
| additional-data: | ||
| description: | | ||
| overrides: | ||
| type: array | ||
| minItems: 0 | ||
| maxItems: *max-proposals | ||
| items: | ||
| type: object | ||
| properties: | ||
| override: | ||
| $ref: ./limit-data.yaml | ||
| override-reason: | ||
| type: string | ||
| description: | ||
|
|
||
| Implementors may use this object to provide freeform extensions with | ||
| additional traceability / provenance data to be included with the limit. | ||
| Schema of this object is out of scope of the TROLIE specification. | ||
| Indicates that this limit was overridden for some reason, the reason | ||
| itself. | ||
|
|
||
| format: free-text | ||
| maxLength: 500 | ||
| required: | ||
| - override | ||
| - override-reason | ||
|
|
||
| additional-data: | ||
| description: | | ||
|
|
||
| Implementors may use this object to provide freeform extensions with | ||
| additional traceability / provenance data to be included with the limit. | ||
| Schema of this object is out of scope of the TROLIE specification. | ||
|
|
||
| type: object | ||
|
|
||
| type: object | ||
| required: | ||
| - proposals-considered | ||
|
|
||
| required: | ||
| - proposals-considered | ||
| real-time: | ||
| <<: *forecast | ||
| properties: | ||
| <<: *props | ||
| proposals-considered: | ||
| <<: *considered | ||
| items: | ||
| $ref: 'proposal-considered.yaml#/real-time' | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| provenance: | ||
| type: object | ||
| properties: | ||
| source: | ||
| $ref: ./data-provenance.yaml | ||
| proposal-disposition: | ||
| description: | | ||
|
|
||
| Despite a proposal being accepted by TROLIE, the downstream | ||
| Clearinghouse logic may still disqualify a proposal. This might | ||
| occur if, for example, the upper and lower reasonability limits are | ||
| not aligned between TROLIE and the Clearinghouse. To aid | ||
| troubleshooting, the specification requires that TROLIE instances | ||
| explicitly indicate if the proposal was `Used` in the determination | ||
| of the limit or was `Rejected`. | ||
|
|
||
| type: string | ||
| enum: | ||
| - Used | ||
| - Rejected | ||
| resource-id: | ||
| $ref: ./resource-id.yaml | ||
| required: | ||
| - source | ||
| - proposal-disposition | ||
|
|
||
| forecast: | ||
| description: > | ||
| Details a proposal that was considered by the Clearinghouse run. | ||
| If `resource-id` is not provided, the ratings data is assumed to be for the | ||
| overall facility. | ||
| allOf: | ||
| - $ref: './forecast-limit-period.yaml#/proposal' | ||
| - $ref: '#/provenance' | ||
| real-time: | ||
| allOf: | ||
| - $ref: ./limit-proposal.yaml | ||
| - $ref: '#/provenance' |
4 changes: 0 additions & 4 deletions
4
docs/_data/components/schemas/realtime-limit-item-detailed.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +0,0 @@ | ||
| type: object | ||
| allOf: | ||
| - $ref: ./realtime-limit-item.yaml | ||
| - $ref: ./limit-provenance.yaml | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,16 @@ | ||
| type: object | ||
| allOf: | ||
| - type: object | ||
| properties: | ||
| resource-id: | ||
| $ref: ./resource-id.yaml | ||
| - $ref: ./limit-data.yaml | ||
| required: | ||
| - resource-id | ||
| normal: | ||
| type: object | ||
| allOf: | ||
| - type: object | ||
| properties: | ||
| resource-id: | ||
| $ref: ./resource-id.yaml | ||
| required: | ||
| - resource-id | ||
| - $ref: ./limit-data.yaml | ||
|
|
||
| detailed: | ||
| type: object | ||
| allOf: | ||
| - $ref: '#/normal' | ||
| - $ref: './limit-provenance.yaml#/real-time' |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@getorymckeag this PR is mostly a yaml refactoring so that I could get this text to show up in both Forecast and RT detailed limits snapshots.