Skip to content

Commit

Permalink
Merge pull request #975 from w3c-ccg/environmental_passport
Browse files Browse the repository at this point in the history
add NG env passport credential.
mkhraisha authored Sep 19, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
2 parents 83aa443 + 54b001e commit 193cd76
Showing 4 changed files with 310 additions and 22 deletions.
18 changes: 13 additions & 5 deletions docs/credentials-with-issuer-dependent-terms.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
[
{
"type": "environmentalImpactCredential",
"count": 17
},
{
"type": "WebLeiCredential",
"count": 28
"count": 22
},
{
"type": "VerifiableScorecard",
@@ -59,6 +55,10 @@
"type": "SIMASteelImportLicenseApplicationCredential",
"count": 6
},
{
"type": "QualifiedWebLeiIssuerCredential",
"count": 3
},
{
"type": "PurchaseOrderCredential",
"count": 6
@@ -99,6 +99,10 @@
"type": "OilAndGasDeliveryTicketCredential",
"count": 6
},
{
"type": "NaturalGasProducerEnvironmentalPassportCredential",
"count": 34
},
{
"type": "MultiModalBillOfLadingCredential",
"count": 0
@@ -235,6 +239,10 @@
"type": "EventCredential",
"count": 9
},
{
"type": "EnvironmentalImpactCredential",
"count": 17
},
{
"type": "EntryNumberCredential",
"count": 0
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
$linkedData:
term: environmentalImpactCredential
'@id': https://w3id.org/traceability#environmentalImpactCredential
term: EnvironmentalImpactCredential
'@id': https://w3id.org/traceability#EnvironmentalImpactCredential
title: Environmental Impact Credential
tags:
- Oil and Gas
@@ -26,15 +26,15 @@ properties:
readOnly: true
const:
- VerifiableCredential
- environmentalImpactCredential
- EnvironmentalImpactCredential
default:
- VerifiableCredential
- environmentalImpactCredential
- EnvironmentalImpactCredential
items:
type: string
enum:
- VerifiableCredential
- environmentalImpactCredential
- EnvironmentalImpactCredential
id:
type: string
format: uri
@@ -54,8 +54,8 @@ properties:
description: The url of the schema file to validate the shape of the json object
type: string
format: uri
example: https://w3id.org/traceability/openapi/components/schemas/credentials/environmentalImpactCredential.yml
default: https://w3id.org/traceability/openapi/components/schemas/credentials/environmentalImpactCredential.yml
example: https://w3id.org/traceability/openapi/components/schemas/credentials/EnvironmentalImpactCredential.yml
default: https://w3id.org/traceability/openapi/components/schemas/credentials/EnvironmentalImpactCredential.yml
readOnly: true
type:
title: Type
@@ -124,7 +124,7 @@ example: |-
"id": "http://example.com/dd0c6f9a-5df6-40a3-bb34-863cd1fda606",
"type": [
"VerifiableCredential",
"environmentalImpactCredential"
"EnvironmentalImpactCredential"
],
"issuer": {
"type": [
Original file line number Diff line number Diff line change
@@ -0,0 +1,227 @@
$linkedData:
term: NaturalGasProducerEnvironmentalPassportCredential
'@id': https://w3id.org/traceability#NaturalGasProducerEnvironmentalPassportCredential
title: Natural Gas Producer Environmental Passport Credential
tags:
- Oil and Gas
description: A credential that represents the environmental passport of a natural gas producer
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
- NaturalGasProducerEnvironmentalPassportCredential
default:
- VerifiableCredential
- NaturalGasProducerEnvironmentalPassportCredential
items:
type: string
enum:
- VerifiableCredential
- NaturalGasProducerEnvironmentalPassportCredential
id:
type: string
format: uri
issuanceDate:
type: string
format: date-time
expirationDate:
type: string
format: date-time
issuer:
$ref: ../common/Organization.yml
credentialSchema:
type: object
properties:
id:
title: Id
description: The url of the schema file to validate the shape of the json object
type: string
format: uri
example: https://w3id.org/traceability/openapi/components/schemas/credentials/NaturalGasProducerEnvironmentalPassportCredential.yml
default: https://w3id.org/traceability/openapi/components/schemas/credentials/NaturalGasProducerEnvironmentalPassportCredential.yml
readOnly: true
type:
title: Type
description: The type of validation to be run against the defined schema
const: OpenApiSpecificationValidator2022
credentialSubject:
title: Natural Gas Producer Environmental Passport Credential
description: A credential that represents the environmental passport of a natural gas producer
type: object
properties:
organization:
type: object
title: Organization
description: the organization the passport is issued to
properties:
legalName:
type: string
title: Organization Legal Name
description: Legal name of the Organization
dailyVolumeProduced:
type: string
title: Daily volume produced
description: Daily volume of Natural Gas produced in MMcf/d (Millions of cubic feet per day)
productionLocation:
type: object
description: the location of the production site
$ref: ../common/Place.yml
productionPhase:
type: string
enum:
- Active
- Inactive
- In development
required:
- legalName
- dailyVolumeProduced
- productionLocation
- productionPhase
certifications:
title: Certifications
type: array
items:
type: object
properties:
certificationPeriod:
type: string
format: date-time
title: Certification Period
description: the validity period of the certification
certificateIssuer:
type: string
title: Certificate Issuer
description: issuer of the certificate
certificateIdentifier:
type: string
title: CertificateIdentifier
description: the identifier of the certificate
certificationStandard:
type: string
title: CertificationStardard
description: the standard for the certification.
assessmentBody:
type: string
title: Assessment Body
description: The entity that conducts the assessment for the certification
observations:
title: Observations
description: >-
List of observations
type: array
items:
$ref: ../common/Observation.yml
required:
- certificationPeriod
- certificateIssuer
- certificateIdentifier
- certificationStandard
- observations
proof:
$ref: ../snippets/proof.yml
additionalProperties: false
required:
- '@context'
- type
- id
- issuanceDate
- issuer
- credentialSubject
example: |-
{
"@context": [
"https://www.w3.org/2018/credentials/v1",
"https://w3id.org/traceability/v1"
],
"id": "http://example.com/dd0c6f9a-5df6-40a3-bb34-863cd1fda606",
"type": [
"VerifiableCredential",
"NaturalGasProducerEnvironmentalPassportCredential"
],
"issuer": {
"type": [
"Organization"
],
"id": "did:web:organization.example.com"
},
"issuanceDate": "2022-11-01T10:58:45-04:00",
"credentialSubject": {
"organization": {
"legalName": "Example Company",
"dailyVolumeProduced": "200",
"productionLocation": {
"type": [
"Place"
],
"globalLocationNumber": "1111111111111",
"geo": {
"type": [
"GeoCoordinates"
],
"latitude": "-79.6395",
"longitude": "178.5353"
},
"address": {
"type": [
"PostalAddress"
],
"name": "Example Production Location",
"streetAddress": "100 main street",
"addressLocality": "Example locality",
"addressRegion": "Example Region",
"postalCode": "1X2Y3Z",
"addressCountry": "CA"
},
"unLocode": "DKCPH"
},
"productionPhase": "Active"
},
"certifications": [
{
"certificationPeriod": "2019-12-11T03:50:55Z",
"certificateIssuer": "MiQ",
"certificateIdentifier": "123456",
"certificationStandard": "MiQ",
"assessmentBody": "Example Body",
"observations": [
{
"type": [
"Observation"
],
"date": "2019-12-11T03:50:55Z",
"property": {
"type": [
"ChemicalProperty"
],
"name": "Methane Intensity"
},
"measurement": {
"type": [
"MeasuredValue"
],
"value": "00.00",
"unitCode": "UNKNOWN"
}
}
]
}
]
}
}
71 changes: 62 additions & 9 deletions docs/openapi/openapi.yml
Original file line number Diff line number Diff line change
@@ -2556,6 +2556,19 @@ paths:
$ref: './components/schemas/credentials/EntryNumberCredential.yml'


/schemas/credentials/EnvironmentalImpactCredential.yml:
get:
tags:
- credentials
responses:
'200':
description: 'successfully issued EnvironmentalImpactCredential schema.'
content:
application/yml:
schema:
$ref: './components/schemas/credentials/EnvironmentalImpactCredential.yml'


/schemas/credentials/EventCredential.yml:
get:
tags:
@@ -2952,6 +2965,7 @@ paths:
- credentials
responses:
'200':
description: 'successfully issued MonthlyAggregateDeliveryStatements schema.'
content:
application/yml:
schema:
@@ -2971,6 +2985,19 @@ paths:
$ref: './components/schemas/credentials/MultiModalBillOfLadingCredential.yml'


/schemas/credentials/NaturalGasProducerEnvironmentalPassportCredential.yml:
get:
tags:
- credentials
responses:
'200':
description: 'successfully issued NaturalGasProducerEnvironmentalPassportCredential schema.'
content:
application/yml:
schema:
$ref: './components/schemas/credentials/NaturalGasProducerEnvironmentalPassportCredential.yml'


/schemas/credentials/OilAndGasDeliveryTicketCredential.yml:
get:
tags:
@@ -3101,6 +3128,19 @@ paths:
$ref: './components/schemas/credentials/PurchaseOrderCredential.yml'


/schemas/credentials/QualifiedWebLeiIssuerCredential.yml:
get:
tags:
- credentials
responses:
'200':
description: 'successfully issued QualifiedWebLeiIssuerCredential schema.'
content:
application/yml:
schema:
$ref: './components/schemas/credentials/QualifiedWebLeiIssuerCredential.yml'


/schemas/credentials/SIMASteelImportLicenseApplicationCredential.yml:
get:
tags:
@@ -3244,17 +3284,17 @@ paths:
$ref: './components/schemas/credentials/VerifiableScorecard.yml'


/schemas/credentials/environmentalImpactCredential.yml:
/schemas/credentials/WebLeiCredential.yml:
get:
tags:
- credentials
responses:
'200':
description: 'successfully issued environmentalImpactCredential schema.'
description: 'successfully issued WebLeiCredential schema.'
content:
application/yml:
schema:
$ref: './components/schemas/credentials/environmentalImpactCredential.yml'
$ref: './components/schemas/credentials/WebLeiCredential.yml'


/schemas/snippets/BuyerParty.yml:
@@ -3452,30 +3492,43 @@ paths:
$ref: './components/schemas/workflows/businesscard.yml'


/schemas/workflows/cbp-steel-tech-demo-2023.yml:
/schemas/workflows/cbp-ecommerce-apparel-tech-demo-2024.yml:
get:
tags:
- workflows
responses:
'200':
description: 'successfully issued cbp-steel-tech-demo-2023 schema.'
description: 'successfully issued cbp-ecommerce-apparel-tech-demo-2024 schema.'
content:
application/yml:
schema:
$ref: './components/schemas/workflows/cbp-steel-tech-demo-2023.yml'
$ref: './components/schemas/workflows/cbp-ecommerce-apparel-tech-demo-2024.yml'


/schemas/workflows/common-import-credentials.yml:
/schemas/workflows/cbp-ecommerce-pesticides-tech-demo-2024.yml:
get:
tags:
- workflows
responses:
'200':
description: 'successfully issued common-import-credentials schema.'
description: 'successfully issued cbp-ecommerce-pesticides-tech-demo-2024 schema.'
content:
application/yml:
schema:
$ref: './components/schemas/workflows/common-import-credentials.yml'
$ref: './components/schemas/workflows/cbp-ecommerce-pesticides-tech-demo-2024.yml'


/schemas/workflows/cbp-steel-tech-demo-2023.yml:
get:
tags:
- workflows
responses:
'200':
description: 'successfully issued cbp-steel-tech-demo-2023 schema.'
content:
application/yml:
schema:
$ref: './components/schemas/workflows/cbp-steel-tech-demo-2023.yml'


/schemas/workflows/intent-to-import.yml:

0 comments on commit 193cd76

Please sign in to comment.