-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #959 from w3c-ccg/add_monthly_aggregate_delivery_s…
…tatements adds monthly aggregate delivery statement
- Loading branch information
Showing
4 changed files
with
173 additions
and
2 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
155 changes: 155 additions & 0 deletions
155
docs/openapi/components/schemas/credentials/MonthlyAggregateDeliveryStatements.yml
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,155 @@ | ||
| $linkedData: | ||
| term: MonthlyAggregateDeliveryStatementCredential | ||
| '@id': https://w3id.org/traceability#MonthlyAggregateDeliveryStatementCredential | ||
| title: Monthly Aggregate Delivery Statement Credential | ||
| tags: | ||
| - Oil and Gas | ||
| description: >- | ||
| Credential containing aggregate statements indicating item(s) delivered during the month | ||
| type: object | ||
| properties: | ||
| '@context': | ||
| type: array | ||
| readOnly: true | ||
| const: | ||
| - https://www.w3.org/2018/credentials/v1 | ||
| - https://w3id.org/traceability/v1 | ||
| default: | ||
| - https://www.w3.org/2018/credentials/v1 | ||
| - https://w3id.org/traceability/v1 | ||
| items: | ||
| type: string | ||
| enum: | ||
| - https://www.w3.org/2018/credentials/v1 | ||
| - https://w3id.org/traceability/v1 | ||
| type: | ||
| type: array | ||
| readOnly: true | ||
| const: | ||
| - VerifiableCredential | ||
| - MonthlyAggregateDeliveryStatementCredential | ||
| default: | ||
| - VerifiableCredential | ||
| - MonthlyAggregateDeliveryStatementCredential | ||
| items: | ||
| type: string | ||
| enum: | ||
| - VerifiableCredential | ||
| - MonthlyAggregateDeliveryStatementCredential | ||
| id: | ||
| type: string | ||
| name: | ||
| type: string | ||
| description: | ||
| type: string | ||
| issuanceDate: | ||
| type: string | ||
| issuer: | ||
| $ref: ../common/Organization.yml | ||
| credentialSchema: | ||
| type: object | ||
| properties: | ||
| id: | ||
| title: Id | ||
| description: The URL of the schema file to use to validate the shape of the JSON object | ||
| type: string | ||
| format: uri | ||
| example: https://w3id.org/traceability/openapi/components/schemas/credentials/MonthlyAggregateDeliveryStatementCredential.yml | ||
| default: https://w3id.org/traceability/openapi/components/schemas/credentials/MonthlyAggregateDeliveryStatementCredential.yml | ||
| readonly: true | ||
| type: | ||
| title: Type | ||
| description: The type of validation to be run against the defined schema | ||
| const: OpenApiSpecificationValidator2022 | ||
| credentialSubject: | ||
| properties: | ||
| type: | ||
| type: array | ||
| readOnly: true | ||
| const: | ||
| - MonthlyAggregateDeliveryStatement | ||
| default: | ||
| - MonthlyAggregateDeliveryStatement | ||
| deliveryStatements: | ||
| type: array | ||
| readOnly: true | ||
| items: | ||
| $ref: ../common/DeliveryStatement.yml | ||
|
|
||
| proof: | ||
| $ref: ../snippets/proof.yml | ||
| additionalProperties: false | ||
| required: | ||
| - '@context' | ||
| - type | ||
| - id | ||
| - issuanceDate | ||
| - issuer | ||
| - credentialSubject | ||
| example: |- | ||
| { | ||
| "type": [ | ||
| "VerifiableCredential", | ||
| "MonthlyAggregateDeliveryStatementCredential" | ||
| ], | ||
| "@context": [ | ||
| "https://www.w3.org/2018/credentials/v1", | ||
| "https://w3id.org/traceability/v1" | ||
| ], | ||
| "id": "urn:credential:123", | ||
| "issuer": { | ||
| "type": [ | ||
| "Organization" | ||
| ], | ||
| "id": "did:web:organization.example.com", | ||
| "name": "Everything Garden Stuff" | ||
| }, | ||
| "issuanceDate": "2022-01-13T09:16:46Z", | ||
| "credentialSubject": { | ||
| "type": [ | ||
| "MonthlyAggregateDeliveryStatement" | ||
| ], | ||
| "deliveryStatements": [ | ||
| { | ||
| "type": [ | ||
| "DeliveryStatement" | ||
| ], | ||
| "commodity": { | ||
| "type": [ | ||
| "Commodity" | ||
| ], | ||
| "commodityCode": "2714.10.00.00", | ||
| "commodityCodeType": "HTS" | ||
| }, | ||
| "deliveredDate": "2019-12-11T03:50:55Z", | ||
| "deliveredVolume": { | ||
| "type": [ | ||
| "MeasuredValue" | ||
| ], | ||
| "value": "8806", | ||
| "unitCode": "dth" | ||
| }, | ||
| "observation": [ | ||
| { | ||
| "type": [ | ||
| "Observation" | ||
| ], | ||
| "property": { | ||
| "type": [ | ||
| "ChemicalProperty" | ||
| ], | ||
| "name": "Heat Content" | ||
| }, | ||
| "measurement": { | ||
| "type": [ | ||
| "MeasuredValue" | ||
| ], | ||
| "value": "50000", | ||
| "unitCode": "BTU" | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| } |
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