diff --git a/docs/credentials-with-issuer-dependent-terms.json b/docs/credentials-with-issuer-dependent-terms.json index 4e392f56c..cae6396ee 100644 --- a/docs/credentials-with-issuer-dependent-terms.json +++ b/docs/credentials-with-issuer-dependent-terms.json @@ -19,6 +19,10 @@ "type": "ThingCredential", "count": 0 }, + { + "type": "TSCACertificationCredential", + "count": 0 + }, { "type": "SoftwareBillofMaterialsCredential", "count": 200 @@ -27,10 +31,6 @@ "type": "ShippingInstructionsCredential", "count": 0 }, - { - "type": "SellerRegistrationCredential", - "count": 10 - }, { "type": "SeaCargoManifestCredential", "count": 0 @@ -51,6 +51,10 @@ "type": "ProductRegistrationCredential", "count": 0 }, + { + "type": "PowerOfAttorneyCredential", + "count": 0 + }, { "type": "PlantSystemsInspectionCredential", "count": 0 @@ -85,7 +89,7 @@ }, { "type": "MonthlyAdvanceManifestCredential", - "count": 14 + "count": 26 }, { "type": "MillTestReportCredential", @@ -107,6 +111,10 @@ "type": "IntentToImportCredential", "count": 2 }, + { + "type": "IntellectualPropertyRightsLicenseCredential", + "count": 8 + }, { "type": "IntellectualPropertyRightsCredential", "count": 8 @@ -155,10 +163,6 @@ "type": "GAPInspectionCredential", "count": 0 }, - { - "type": "FulfillmentRegistrationCredential", - "count": 0 - }, { "type": "FreightManifestCredential", "count": 0 @@ -207,13 +211,25 @@ "type": "EntryNumberCredential", "count": 0 }, + { + "type": "EPA35401PesticidesPart3Credential", + "count": 6 + }, + { + "type": "EPA35401PesticidesPart2Credential", + "count": 6 + }, + { + "type": "EPA35401PesticidesCredential", + "count": 42 + }, { "type": "DigitalProductPassportDataCarrierCredential", "count": 6 }, { "type": "DigitalProductPassportCredential", - "count": 5 + "count": 7 }, { "type": "DeliveryStatementCredential", @@ -221,7 +237,7 @@ }, { "type": "DeliveryScheduleCredential", - "count": 8 + "count": 12 }, { "type": "DCSATransportDocumentCredential", @@ -239,22 +255,6 @@ "type": "CertificationOfOrigin", "count": 0 }, - { - "type": "CTPATEIPSellerCredential", - "count": 0 - }, - { - "type": "CTPATEIPMarketplaceCredential", - "count": 0 - }, - { - "type": "CTPATEIPFulfillmentCredential", - "count": 0 - }, - { - "type": "CTPATEIPApplicationCredential", - "count": 0 - }, { "type": "CTPATCertificate", "count": 17 diff --git a/docs/openapi/components/schemas/common/TSCACertification.yml b/docs/openapi/components/schemas/common/TSCACertification.yml new file mode 100644 index 000000000..a990bdc5c --- /dev/null +++ b/docs/openapi/components/schemas/common/TSCACertification.yml @@ -0,0 +1,69 @@ +$linkedData: + term: TSCACertification + '@id': https://w3id.org/traceability/TSCACertification +title: TSCA Certification +description: TSCA Import Certification Statement +type: object +properties: + type: + type: array + readOnly: true + const: + - TSCACertification + default: + - TSCACertification + items: + type: string + enum: + - TSCACertification + certificationType: + title: Certification Type + description: >- + The type of TSCA certification. This can be either 'Positive' to certify + compliance with all applicable TSCA rules and orders, or 'Negative' to + certify that the chemical shipment is not subject to TSCA. + type: string + enum: + - Positive + - Negative + $linkedData: + term: certificationType + '@id': https://schema.org/DefinedTerm + certifierDetails: + title: Certifier's Details + description: >- + Provide the certifier’s name, title, address (including country), telephone + number and email address. + $ref: ./Organization.yml + $linkedData: + term: certifierDetails + '@id': https://w3id.org/traceability#certifierDetails +additionalProperties: true +required: + - type + - certificationType + - certifierDetails +example: |- + { + "type": ["TSCACertification"], + "certificationType": "Positive", + "certifierDetails": { + "type": ["Organization"], + "id": "did:key:z6MkjR12D3456sn2yBAyqj5gqckDjvyAbNSusehsxtkvknfa", + "name": "Chemical Import Co", + "description": "Specialist in importing and distributing chemical products", + "location": { + "type": ["Place"], + "address": { + "type": ["PostalAddress"], + "streetAddress": "123 Industry Blvd", + "addressLocality": "Chemtown", + "addressRegion": "CA", + "postalCode": "90001", + "addressCountry": "USA" + } + }, + "email": "contact@chemicalimportco.com", + "phoneNumber": "+1-555-123-4567" + } + } diff --git a/docs/openapi/components/schemas/credentials/MonthlyAdvanceManifestCredential.yml b/docs/openapi/components/schemas/credentials/MonthlyAdvanceManifestCredential.yml index 20e65dbe6..b8f4e919c 100644 --- a/docs/openapi/components/schemas/credentials/MonthlyAdvanceManifestCredential.yml +++ b/docs/openapi/components/schemas/credentials/MonthlyAdvanceManifestCredential.yml @@ -103,21 +103,25 @@ example: |- "scheduledDeliveries": [ { "portCode": "3901", - "portOfArrival": - { - "type": ["Place"], + "portOfArrival": { + "type": [ + "Place" + ], "locationName": "Morgan", "usPortCode": "3319" }, - "portOfDestination": - { - "type": ["Place"], + "portOfDestination": { + "type": [ + "Place" + ], "locationName": "Pembina ND", "usPortCode": "3401" }, "transporter": { - "type": ["Organization"], - "name": "Gas Transmission Northwest (GTN)" + "type": [ + "Organization" + ], + "name": "Gas Transmission Northwest (GTN)" }, "deliveryLocation": "Chicago", "sumOfScheduledDeliveries": [ diff --git a/docs/openapi/components/schemas/credentials/TSCACertificationCredential.yml b/docs/openapi/components/schemas/credentials/TSCACertificationCredential.yml new file mode 100644 index 000000000..ec78868b8 --- /dev/null +++ b/docs/openapi/components/schemas/credentials/TSCACertificationCredential.yml @@ -0,0 +1,126 @@ +$linkedData: + term: TSCACertificationCredential + '@id': https://w3id.org/traceability#TSCACertificationCredential +title: TSCA Certification Credential +tags: + - Environmental Compliance +description: A credential for compliance with the Toxic Substances Control Act (TSCA) regulations +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 + - TSCACertificationCredential + default: + - VerifiableCredential + - TSCACertificationCredential + items: + type: string + enum: + - VerifiableCredential + - TSCACertificationCredential + id: + type: string + name: + type: string + description: + type: string + issuanceDate: + type: string + expirationDate: + type: string + issuer: + type: string + 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/TSCACertificationCredential.yml + default: https://w3id.org/traceability/openapi/components/schemas/credentials/TSCACertificationCredential.yml + readOnly: true + type: + title: Type + description: The type of validation to be run against the defined schema + const: OpenApiSpecificationValidator2022 + credentialSubject: + $ref: ../common/TSCACertification.yml + proof: + $ref: ../snippets/proof.yml + relatedLink: + title: Related Link + description: Links related to this verifiable credential + type: array + items: + $ref: ../common/LinkRole.yml +additionalProperties: false +required: + - '@context' + - type + - issuanceDate + - issuer + - credentialSubject +example: |- + { + "@context": [ + "https://www.w3.org/2018/credentials/v1", + "https://w3id.org/traceability/v1" + ], + "id": "http://example.org/credentials/", + "type": [ + "VerifiableCredential", + "TSCACertificationCredential" + ], + "issuanceDate": "2024-01-04T20:29:37+00:00", + "issuer": "did:key:z6MktHQo3fRRohk44dsbE76CuiTpBmyMWq2VVjvV6aBSeE3U", + "credentialSubject": { + "type": [ + "TSCACertification" + ], + "certificationType": "Positive", + "certifierDetails": { + "type": [ + "Organization" + ], + "id": "did:key:z6MkjR12D3456sn2yBAyqj5gqckDjvyAbNSusehsxtkvknfa", + "name": "Chemical Import Co", + "description": "Specialist in importing and distributing chemical products", + "location": { + "type": [ + "Place" + ], + "address": { + "type": [ + "PostalAddress" + ], + "streetAddress": "123 Industry Blvd", + "addressLocality": "Chemtown", + "addressRegion": "CA", + "postalCode": "90001", + "addressCountry": "USA" + } + }, + "email": "contact@chemicalimportco.com", + "phoneNumber": "+1-555-123-4567" + } + } + } \ No newline at end of file diff --git a/docs/openapi/openapi.yml b/docs/openapi/openapi.yml index 231ff66b5..0d7741392 100644 --- a/docs/openapi/openapi.yml +++ b/docs/openapi/openapi.yml @@ -920,6 +920,18 @@ paths: $ref: './components/schemas/common/IntellectualPropertyRightsAffirmation.yml' + /schemas/common/IntellectualPropertyRightsLicense.yml: + get: + tags: + - common + responses: + '200': + content: + application/yml: + schema: + $ref: './components/schemas/common/IntellectualPropertyRightsLicense.yml' + + /schemas/common/IntentToImport.yml: get: tags: @@ -1772,6 +1784,18 @@ paths: $ref: './components/schemas/common/SteelProduct.yml' + /schemas/common/TSCACertification.yml: + get: + tags: + - common + responses: + '200': + content: + application/yml: + schema: + $ref: './components/schemas/common/TSCACertification.yml' + + /schemas/common/Taxonomy.yml: get: tags: @@ -2204,19 +2228,7 @@ paths: $ref: './components/schemas/credentials/CTPATCertificate.yml' - /schemas/credentials/CTPATEIPApplicationCredential.yml: - get: - tags: - - credentials - responses: - '200': - content: - application/yml: - schema: - $ref: './components/schemas/credentials/CTPATEIPApplicationCredential.yml' - - - /schemas/credentials/CTPATEIPFulfillmentCredential.yml: + /schemas/credentials/CertificationOfOrigin.yml: get: tags: - credentials @@ -2225,10 +2237,10 @@ paths: content: application/yml: schema: - $ref: './components/schemas/credentials/CTPATEIPFulfillmentCredential.yml' + $ref: './components/schemas/credentials/CertificationOfOrigin.yml' - /schemas/credentials/CTPATEIPMarketplaceCredential.yml: + /schemas/credentials/CommercialInvoiceCredential.yml: get: tags: - credentials @@ -2237,10 +2249,10 @@ paths: content: application/yml: schema: - $ref: './components/schemas/credentials/CTPATEIPMarketplaceCredential.yml' + $ref: './components/schemas/credentials/CommercialInvoiceCredential.yml' - /schemas/credentials/CTPATEIPSellerCredential.yml: + /schemas/credentials/DCSAShippingInstructionCredential.yml: get: tags: - credentials @@ -2249,10 +2261,10 @@ paths: content: application/yml: schema: - $ref: './components/schemas/credentials/CTPATEIPSellerCredential.yml' + $ref: './components/schemas/credentials/DCSAShippingInstructionCredential.yml' - /schemas/credentials/CertificationOfOrigin.yml: + /schemas/credentials/DCSATransportDocumentCredential.yml: get: tags: - credentials @@ -2261,10 +2273,10 @@ paths: content: application/yml: schema: - $ref: './components/schemas/credentials/CertificationOfOrigin.yml' + $ref: './components/schemas/credentials/DCSATransportDocumentCredential.yml' - /schemas/credentials/CommercialInvoiceCredential.yml: + /schemas/credentials/DeliveryScheduleCredential.yml: get: tags: - credentials @@ -2273,10 +2285,10 @@ paths: content: application/yml: schema: - $ref: './components/schemas/credentials/CommercialInvoiceCredential.yml' + $ref: './components/schemas/credentials/DeliveryScheduleCredential.yml' - /schemas/credentials/DCSAShippingInstructionCredential.yml: + /schemas/credentials/DeliveryStatementCredential.yml: get: tags: - credentials @@ -2285,10 +2297,10 @@ paths: content: application/yml: schema: - $ref: './components/schemas/credentials/DCSAShippingInstructionCredential.yml' + $ref: './components/schemas/credentials/DeliveryStatementCredential.yml' - /schemas/credentials/DCSATransportDocumentCredential.yml: + /schemas/credentials/DigitalProductPassportCredential.yml: get: tags: - credentials @@ -2297,10 +2309,10 @@ paths: content: application/yml: schema: - $ref: './components/schemas/credentials/DCSATransportDocumentCredential.yml' + $ref: './components/schemas/credentials/DigitalProductPassportCredential.yml' - /schemas/credentials/DeliveryScheduleCredential.yml: + /schemas/credentials/DigitalProductPassportDataCarrierCredential.yml: get: tags: - credentials @@ -2309,10 +2321,10 @@ paths: content: application/yml: schema: - $ref: './components/schemas/credentials/DeliveryScheduleCredential.yml' + $ref: './components/schemas/credentials/DigitalProductPassportDataCarrierCredential.yml' - /schemas/credentials/DeliveryStatementCredential.yml: + /schemas/credentials/EPA35401PesticidesCredential.yml: get: tags: - credentials @@ -2321,10 +2333,10 @@ paths: content: application/yml: schema: - $ref: './components/schemas/credentials/DeliveryStatementCredential.yml' + $ref: './components/schemas/credentials/EPA35401PesticidesCredential.yml' - /schemas/credentials/DigitalProductPassportCredential.yml: + /schemas/credentials/EPA35401PesticidesPart2Credential.yml: get: tags: - credentials @@ -2333,10 +2345,10 @@ paths: content: application/yml: schema: - $ref: './components/schemas/credentials/DigitalProductPassportCredential.yml' + $ref: './components/schemas/credentials/EPA35401PesticidesPart2Credential.yml' - /schemas/credentials/DigitalProductPassportDataCarrierCredential.yml: + /schemas/credentials/EPA35401PesticidesPart3Credential.yml: get: tags: - credentials @@ -2345,7 +2357,7 @@ paths: content: application/yml: schema: - $ref: './components/schemas/credentials/DigitalProductPassportDataCarrierCredential.yml' + $ref: './components/schemas/credentials/EPA35401PesticidesPart3Credential.yml' /schemas/credentials/EntryNumberCredential.yml: @@ -2492,18 +2504,6 @@ paths: $ref: './components/schemas/credentials/FreightManifestCredential.yml' - /schemas/credentials/FulfillmentRegistrationCredential.yml: - get: - tags: - - credentials - responses: - '200': - content: - application/yml: - schema: - $ref: './components/schemas/credentials/FulfillmentRegistrationCredential.yml' - - /schemas/credentials/GAPInspectionCredential.yml: get: tags: @@ -2648,6 +2648,18 @@ paths: $ref: './components/schemas/credentials/IntellectualPropertyRightsCredential.yml' + /schemas/credentials/IntellectualPropertyRightsLicenseCredential.yml: + get: + tags: + - credentials + responses: + '200': + content: + application/yml: + schema: + $ref: './components/schemas/credentials/IntellectualPropertyRightsLicenseCredential.yml' + + /schemas/credentials/IntentToImportCredential.yml: get: tags: @@ -2816,6 +2828,18 @@ paths: $ref: './components/schemas/credentials/PlantSystemsInspectionCredential.yml' + /schemas/credentials/PowerOfAttorneyCredential.yml: + get: + tags: + - credentials + responses: + '200': + content: + application/yml: + schema: + $ref: './components/schemas/credentials/PowerOfAttorneyCredential.yml' + + /schemas/credentials/ProductRegistrationCredential.yml: get: tags: @@ -2876,7 +2900,7 @@ paths: $ref: './components/schemas/credentials/SeaCargoManifestCredential.yml' - /schemas/credentials/SellerRegistrationCredential.yml: + /schemas/credentials/ShippingInstructionsCredential.yml: get: tags: - credentials @@ -2885,10 +2909,10 @@ paths: content: application/yml: schema: - $ref: './components/schemas/credentials/SellerRegistrationCredential.yml' + $ref: './components/schemas/credentials/ShippingInstructionsCredential.yml' - /schemas/credentials/ShippingInstructionsCredential.yml: + /schemas/credentials/SoftwareBillofMaterialsCredential.yml: get: tags: - credentials @@ -2897,10 +2921,10 @@ paths: content: application/yml: schema: - $ref: './components/schemas/credentials/ShippingInstructionsCredential.yml' + $ref: './components/schemas/credentials/SoftwareBillofMaterialsCredential.yml' - /schemas/credentials/SoftwareBillofMaterialsCredential.yml: + /schemas/credentials/TSCACertificationCredential.yml: get: tags: - credentials @@ -2909,7 +2933,7 @@ paths: content: application/yml: schema: - $ref: './components/schemas/credentials/SoftwareBillofMaterialsCredential.yml' + $ref: './components/schemas/credentials/TSCACertificationCredential.yml' /schemas/credentials/ThingCredential.yml: