-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor to simplify resource-id vs origin-id in provenance
- Loading branch information
1 parent
0d1d7df
commit 7fcacee
Showing
7 changed files
with
150 additions
and
92 deletions.
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,71 @@ | ||
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: | ||
description: | | ||
The ratings proposals provided by the Ratings Providers that were | ||
considered when determining the limits of the facility for a specific | ||
period. | ||
type: array | ||
maxItems: &max-proposals 10 | ||
items: | ||
$ref: 'proposal-considered.yaml#/forecast' | ||
|
||
temporary-aar-exceptions: | ||
description: | | ||
The temporary AAR exceptions for the facility that were active when this | ||
snapshot was generated. | ||
Indicates that this limit was overridden for some reason, the reason | ||
itself. | ||
type: array | ||
maxItems: *max-proposals | ||
items: | ||
$ref: ./resource-id.yaml | ||
|
||
format: free-text | ||
maxLength: 500 | ||
required: | ||
- override | ||
- override-reason | ||
overrides: | ||
type: array | ||
minItems: 0 | ||
maxItems: *max-proposals | ||
items: | ||
type: object | ||
properties: | ||
override: | ||
$ref: ./limit-data.yaml | ||
override-reason: | ||
type: string | ||
description: | ||
|
||
additional-data: | ||
description: | | ||
Indicates that this limit was overridden for some reason, the reason | ||
itself. | ||
|
||
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. | ||
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: | ||
description: RT proposals | ||
type: array | ||
maxItems: *max-proposals | ||
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,39 @@ | ||
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 | ||
- resource-id | ||
|
||
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: 'realtime-limit-period.yaml#/proposal' | ||
- $ref: '#/provenance' |
2 changes: 1 addition & 1 deletion
2
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 +1,4 @@ | ||
type: object | ||
allOf: | ||
- $ref: ./realtime-limit-item.yaml | ||
- $ref: ./limit-provenance.yaml | ||
- $ref: './limit-provenance.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
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