From 2b52f28b9e83ece5b1c18319c3b185a0b543374e Mon Sep 17 00:00:00 2001 From: Mahmoud Alkhraishi Date: Fri, 21 Jun 2024 12:25:42 -0400 Subject: [PATCH] makes ID required fora ll credentials --- .../credentials/BankAccountCredential.yml | 3 +- .../credentials/BillOfLadingCredential.yml | 3 +- .../credentials/CBPEntryType86Credential.yml | 15 +-- .../CBPSection321DeMinimisCredential.yml | 41 +++---- .../schemas/credentials/CTPATCertificate.yml | 2 +- .../credentials/CertificationOfOrigin.yml | 4 +- .../CommercialInvoiceCredential.yml | 56 ++++----- .../DCSAShippingInstructionCredential.yml | 3 +- .../DCSATransportDocumentCredential.yml | 3 +- .../DeliveryScheduleCredential.yml | 3 +- .../DeliveryStatementCredential.yml | 5 +- .../DigitalProductPassportCredential.yml | 42 +++---- ...alProductPassportDataCarrierCredential.yml | 42 +++---- .../credentials/EntryNumberCredential.yml | 2 +- .../schemas/credentials/EventCredential.yml | 3 +- .../ExampleCredentialWithStatus.yml | 3 +- .../credentials/FSMACreatingCTECredential.yml | 3 +- .../FSMAFirstReceiverDataCredential.yml | 3 +- .../credentials/FSMAGrowingCTECredential.yml | 3 +- .../FSMAReceivingCTECredential.yml | 3 +- .../credentials/FSMAShippingCTECredential.yml | 3 +- .../FSMATransformingCTECredential.yml | 3 +- .../FoodDefenseInspectionCredential.yml | 3 +- .../FoodGradeInspectionCredential.yml | 3 +- .../credentials/FreightManifestCredential.yml | 3 +- .../credentials/GAPInspectionCredential.yml | 3 +- .../GS18PrefixLicenseCredential.yml | 3 +- .../GS1CompanyPrefixLicenseCredential.yml | 5 +- .../schemas/credentials/GS1DataCredential.yml | 15 +-- .../credentials/GS1DelegationCredential.yml | 7 +- .../GS1IdentificationKeyLicenseCredential.yml | 7 +- .../schemas/credentials/GS1KeyCredential.yml | 5 +- .../GS1PrefixLicenseCredential.yml | 3 +- .../HouseBillOfLadingCredential.yml | 3 +- .../credentials/IATAAirWaybillCredential.yml | 3 +- .../ImporterSecurityFilingCredential.yml | 3 +- .../IntellectualPropertyRightsCredential.yml | 7 +- ...lectualPropertyRightsLicenseCredential.yml | 9 +- .../credentials/IntentToImportCredential.yml | 13 ++- .../InventoryRegistrationCredential.yml | 3 +- .../MasterBillOfLadingCredential.yml | 3 +- .../credentials/MexicoEInvoiceCredential.yml | 28 ++--- .../credentials/MillTestReportCredential.yml | 106 +++++++++--------- .../MonthlyAdvanceManifestCredential.yml | 3 +- .../MultiModalBillOfLadingCredential.yml | 56 ++++----- .../OilAndGasDeliveryTicketCredential.yml | 3 +- .../OilAndGasProductCredential.yml | 3 +- .../OrderConfirmationCredential.yml | 3 +- .../OrganicCertificateCredential.yml | 3 +- .../PGAShipmentStatusCredential.yml | 3 +- .../credentials/PackingListCredential.yml | 16 +-- .../PlantSystemsInspectionCredential.yml | 3 +- .../credentials/PowerOfAttorneyCredential.yml | 2 +- .../ProductRegistrationCredential.yml | 3 +- .../credentials/PurchaseOrderCredential.yml | 12 +- ...teelImportLicenseApplicationCredential.yml | 20 ++-- .../SIMASteelImportLicenseCredential.yml | 22 ++-- .../SeaCargoManifestCredential.yml | 7 +- .../ShippingInstructionsCredential.yml | 5 +- .../SoftwareBillofMaterialsCredential.yml | 3 +- .../TSCACertificationCredential.yml | 5 +- .../schemas/credentials/ThingCredential.yml | 3 +- .../USMCACertificationOfOrigin.yml | 8 +- .../VerifiablePostmanCollection.yml | 5 +- .../credentials/VerifiableScorecard.yml | 5 +- .../environmentalImpactCredential.yml | 1 + 66 files changed, 364 insertions(+), 313 deletions(-) diff --git a/docs/openapi/components/schemas/credentials/BankAccountCredential.yml b/docs/openapi/components/schemas/credentials/BankAccountCredential.yml index 2d43dbcd1..39fa1fc10 100644 --- a/docs/openapi/components/schemas/credentials/BankAccountCredential.yml +++ b/docs/openapi/components/schemas/credentials/BankAccountCredential.yml @@ -76,6 +76,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -120,4 +121,4 @@ example: |- "postalCode": "M3B 1A2" } } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/BillOfLadingCredential.yml b/docs/openapi/components/schemas/credentials/BillOfLadingCredential.yml index 45b7d130b..87c913397 100644 --- a/docs/openapi/components/schemas/credentials/BillOfLadingCredential.yml +++ b/docs/openapi/components/schemas/credentials/BillOfLadingCredential.yml @@ -81,6 +81,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -470,4 +471,4 @@ example: |- } ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/CBPEntryType86Credential.yml b/docs/openapi/components/schemas/credentials/CBPEntryType86Credential.yml index 71c25e2d9..6e8c0c11e 100644 --- a/docs/openapi/components/schemas/credentials/CBPEntryType86Credential.yml +++ b/docs/openapi/components/schemas/credentials/CBPEntryType86Credential.yml @@ -62,7 +62,7 @@ properties: const: OpenApiSpecificationValidator2022 credentialSubject: title: CBP Type 86 Entry - description: CBP ACE Entry Type 86 Test filing for De Minimis shipments. + description: CBP ACE Entry Type 86 Test filing for De Minimis shipments. type: object properties: type: @@ -99,7 +99,7 @@ properties: type: string enum: - Place - usPortCode: + usPortCode: title: US CBP Port Code description: CBP Automated Manifest Interface Requirements, Appendix E - Schedule D – U.S. CBP Port Codes. 4 character port code (https://www.cbp.gov/sites/default/files/assets/documents/2020-Jan/ACE%20Appendix%20E%20Schedule%20D%20January%202020%20(1).pdf). type: string @@ -297,7 +297,7 @@ properties: - type - name - location - countryOfOrigin: + countryOfOrigin: title: Country of Origin type: string quantity: @@ -334,7 +334,7 @@ properties: required: - type - value - fairRetailValue: + fairRetailValue: title: Fair Retail Value description: Fair retail value in the country of shipment. type: object @@ -392,7 +392,7 @@ properties: description: Commodity code type const: HTS default: HTS - importerOfRecord: + importerOfRecord: title: Importer Of Record description: US CBP importer of record identifier and identifier type (IRS, SSN, or CBP). type: object @@ -408,7 +408,7 @@ properties: type: string enum: - CBPImporterOfRecord - number: + number: title: importerOfRecordNumber description: Importer Of Record Number type: string @@ -441,6 +441,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -558,4 +559,4 @@ example: |- "identifierType": "CBP" } } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/CBPSection321DeMinimisCredential.yml b/docs/openapi/components/schemas/credentials/CBPSection321DeMinimisCredential.yml index 15d1732be..39941ec50 100644 --- a/docs/openapi/components/schemas/credentials/CBPSection321DeMinimisCredential.yml +++ b/docs/openapi/components/schemas/credentials/CBPSection321DeMinimisCredential.yml @@ -57,7 +57,7 @@ properties: type: string enum: - Organization - id: + id: title: Identifier description: Organization identifier. type: string @@ -166,13 +166,13 @@ properties: type: string enum: - DeMinimisShipment - originatorCode: + originatorCode: title: Originator Code - description: Originator Code of the Participant (assigned by CBP) + description: Originator Code of the Participant (assigned by CBP) type: string - participantFilerType: + participantFilerType: title: Participant Filer Type - description: Participant Filer Type (e.g., carrier or online marketplace) + description: Participant Filer Type (e.g., carrier or online marketplace) enum: - Manufacturer - Carrier @@ -181,23 +181,23 @@ properties: title: Shipment Tracking Number description: An identifier for the shipment which is the subject of this ecommerce transaction. type: string - houseBillOfLadingNumber: + houseBillOfLadingNumber: title: House Bill of Lading Number description: Reference number assigned to a house bill of lading. type: string - masterBillOfLadingNumber: + masterBillOfLadingNumber: title: Master Bill of Lading Number description: Reference number assigned to a bill of lading. type: string - modeOfTransportation: + modeOfTransportation: title: Mode Of Transportation - description: Mode of transportation (e.g., air, truck, or rail) + description: Mode of transportation (e.g., air, truck, or rail) enum: - Air - Truck - Rail - Vessel - shipmentInitiator: + shipmentInitiator: title: Shipment Initiator description: Shipment Initiator Name and Address (e.g., the entity that causes the movement of a shipment, which may be a seller, shipper, or manufacturer, but not a foreign consolidator). type: object @@ -293,7 +293,7 @@ properties: - type - name - location - seller: + seller: title: Seller description: Seller Name and Address (e.g., an international or domestic company that sells products on marketplaces and other websites), and, if applicable, Shipment Initiator Name and Address (as defined in Section II.A.2) type: object @@ -543,31 +543,31 @@ properties: required: - type - address - enhancedProductDescription: + enhancedProductDescription: title: Enhanced Product Description description: A description of a product shipped to the United States more detailed than the description on the manifest, which should, if applicable, reflect the advertised retail description of the product as listed on an online marketplace. type: string - shipmentSecurityScan: + shipmentSecurityScan: title: Shipment Security Scan - description: Air carriers only. E.g., verification that a foreign security scan for the shipment has been completed such as an x-ray image or other security screening report. + description: Air carriers only. E.g., verification that a foreign security scan for the shipment has been completed such as an x-ray image or other security screening report. type: boolean - knownCarrierCustomerFlag: + knownCarrierCustomerFlag: title: Known Carrier Customer Flag description: An indicator that identifies a shipper as a repeat customer that has consistently paid all required fees and does not have any known trade violations. type: boolean - knownMarketplaceSellerFlag: + knownMarketplaceSellerFlag: title: Known Marketplace Seller Flag description: An indicator provided by a marketplace that identifies a seller as an entity vetted by the marketplace and has no known trade violations). type: boolean - marketplaceSellerAccountNumber: + marketplaceSellerAccountNumber: title: Marketplace Seller Account Number description: The unique identifier a marketplace assigns to sellers. type: string - productPicture: + productPicture: title: Product Picture description: Product Picture (e.g., picture of the product presented on an online marketplace), or Link to Product Listing (e.g., an active and direct link to the listing of a specific product on an online marketplace). type: string - listedPriceOnMarketplace: + listedPriceOnMarketplace: title: Listed Price on Marketplace description: The retail price of a product that a seller lists while advertising on an online marketplace. For auction marketplaces, this price is the price of final sale. type: object @@ -608,6 +608,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -738,4 +739,4 @@ example: |- "priceCurrency": "USD" } } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/CTPATCertificate.yml b/docs/openapi/components/schemas/credentials/CTPATCertificate.yml index 1dcb9126e..31219249f 100644 --- a/docs/openapi/components/schemas/credentials/CTPATCertificate.yml +++ b/docs/openapi/components/schemas/credentials/CTPATCertificate.yml @@ -194,4 +194,4 @@ example: |- "revocationListIndex": 0, "revocationListCredential": "https://api.did.actor/revocation-lists/1.json" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/CertificationOfOrigin.yml b/docs/openapi/components/schemas/credentials/CertificationOfOrigin.yml index b77af3f04..625bd9a3e 100644 --- a/docs/openapi/components/schemas/credentials/CertificationOfOrigin.yml +++ b/docs/openapi/components/schemas/credentials/CertificationOfOrigin.yml @@ -8,7 +8,7 @@ tags: - Agriculture - Oil and Gas - Other -description: >- +description: >- A document attesting to the country of origin of the goods. A certificate of origin is often required by customs authorities of a country as part of the entry process. Such certificates are usually through an official organization in the country of origin such as the local chamber of commerce or a consular office. The goods description must coincide with that provided in the commercial invoice and in the packing list (number, goods description, name of the consignor and of the consignee, trademarks, etc.). If the certificate of origin is not shown, the import customs may, if it deems it necessary, accept the dispatching of goods. In this case, the corresponding tariff would be applied to third countries (non preferential origin), without any tariff discount. Although the World Customs Organization and the World Trade Organization have tried to create a single set of origin criteria in worldwide use, none exists at this time. Some countries and free-trade zones (such as NAFTA) require that origin be certified in terms of special criteria such as tariff shift or percentage value. Traders are well advised to assure that any applicable origin rules are understood and any required documentation is obtainable before concluding sales contracts. (Source: Olegario Llamazares: Dictionary Of International Trade, Key definitions of 2000 trade terms and acronyms.) type: object properties: @@ -141,4 +141,4 @@ example: |- "manufacturingCountry": "IT", "dateOfExport": "2022-02-02" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/CommercialInvoiceCredential.yml b/docs/openapi/components/schemas/credentials/CommercialInvoiceCredential.yml index 75c57bc84..53824e59c 100644 --- a/docs/openapi/components/schemas/credentials/CommercialInvoiceCredential.yml +++ b/docs/openapi/components/schemas/credentials/CommercialInvoiceCredential.yml @@ -53,7 +53,7 @@ properties: format: date-time issuer: title: Issuer Organization - description: Commercial invoice issuing organization. + description: Commercial invoice issuing organization. type: object properties: type: @@ -73,7 +73,7 @@ properties: format: uri maxLength: 512000 description: URI to a remote logo file, or a `data:` scheme URI of an encoded logo - id: + id: title: Issuer's Identifier description: Issuing organization identifier, typically a Decentralized Identifier (DID). type: string @@ -188,19 +188,19 @@ properties: title: Invoice Number description: Invoice Number. type: string - customerReferenceNumber: + customerReferenceNumber: title: Customer's Reference Number description: Oversees customer’s reference number. type: string - purchaseOrderNumbers: + purchaseOrderNumbers: title: Purchase Order Numbers description: The Order(s) related to this Invoice. One or more Orders may be combined into a single Invoice. type: array - items: + items: type: string billOfLadingNumber: title: Bill of Lading Number - description: Carrier-issued number for the associated Bill of Lading or Waybill. + description: Carrier-issued number for the associated Bill of Lading or Waybill. type: string letterOfCreditNumber: title: Letter of Credit Number @@ -251,7 +251,7 @@ properties: description: The date that payment is made. type: string format: date - seller: + seller: title: Seller description: An entity which offers (sells, leases, lends, or loans) the services or goods. A seller may also be a provider. type: object @@ -591,7 +591,7 @@ properties: type: string product: title: Product - description: Product details. + description: Product details. type: object properties: type: @@ -858,13 +858,13 @@ properties: additionalProperties: false required: - type - additionalProperties: false + additionalProperties: false required: - type minItems: 1 comments: title: Comments - description: Free text comments. + description: Free text comments. type: array items: type: string @@ -899,15 +899,15 @@ properties: additionalProperties: false required: - type - termsOfDelivery: + termsOfDelivery: title: Terms of Delivery description: The conditions agreed upon between the parties with regard to the delivery of goods and or services. type: string - termsOfPayment: + termsOfPayment: title: Terms of Payment description: Terms, conditions, and currency of settlement, as agreed upon by the vendor and purchaser per the pro forma invoice, customer purchase order, and/or the letter of credit. type: string - currencyOfSettlement: + currencyOfSettlement: title: Terms of Settlement description: Currency agreed upon between seller and buyer as payment. type: string @@ -941,12 +941,12 @@ properties: type: string additionalProperties: false required: - - type - discounts: + - type + discounts: title: Discounts description: Applicable discounts. type: array - items: + items: type: object properties: type: @@ -974,12 +974,12 @@ properties: type: string additionalProperties: false required: - - type - deductions: + - type + deductions: title: Additions description: Applicable additions. type: array - items: + items: type: object properties: type: @@ -1007,8 +1007,8 @@ properties: type: string additionalProperties: false required: - - type - tax: + - type + tax: title: Tax description: Applicable tax. type: object @@ -1038,8 +1038,8 @@ properties: type: string additionalProperties: false required: - - type - freightCost: + - type + freightCost: title: Freight Cost description: Included cost of freight. type: object @@ -1069,8 +1069,8 @@ properties: type: string additionalProperties: false required: - - type - insuranceCost: + - type + insuranceCost: title: Insurance Cost description: Included cost of insurance. type: object @@ -1100,7 +1100,7 @@ properties: type: string additionalProperties: false required: - - type + - type totalPaymentDue: title: Total Payment Due description: The total amount due. @@ -1144,7 +1144,7 @@ properties: - totalPaymentDue proof: title: proof - description: A JSON Web Signature proof for a credential as defined by the VC data model + description: A JSON Web Signature proof for a credential as defined by the VC data model type: object properties: type: @@ -1386,4 +1386,4 @@ example: |- "priceCurrency": "USD" } } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/DCSAShippingInstructionCredential.yml b/docs/openapi/components/schemas/credentials/DCSAShippingInstructionCredential.yml index db79e9491..4874a999b 100644 --- a/docs/openapi/components/schemas/credentials/DCSAShippingInstructionCredential.yml +++ b/docs/openapi/components/schemas/credentials/DCSAShippingInstructionCredential.yml @@ -79,6 +79,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -297,4 +298,4 @@ example: |- } ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/DCSATransportDocumentCredential.yml b/docs/openapi/components/schemas/credentials/DCSATransportDocumentCredential.yml index b311c0697..46792fb46 100644 --- a/docs/openapi/components/schemas/credentials/DCSATransportDocumentCredential.yml +++ b/docs/openapi/components/schemas/credentials/DCSATransportDocumentCredential.yml @@ -83,6 +83,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -372,4 +373,4 @@ example: |- } ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/DeliveryScheduleCredential.yml b/docs/openapi/components/schemas/credentials/DeliveryScheduleCredential.yml index 9e38933af..22c5b4528 100644 --- a/docs/openapi/components/schemas/credentials/DeliveryScheduleCredential.yml +++ b/docs/openapi/components/schemas/credentials/DeliveryScheduleCredential.yml @@ -69,6 +69,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -223,4 +224,4 @@ example: |- "countryOfDestination": "USA", "nominationMonth": "Jan-23" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/DeliveryStatementCredential.yml b/docs/openapi/components/schemas/credentials/DeliveryStatementCredential.yml index edae5f9c0..93cabe1e8 100644 --- a/docs/openapi/components/schemas/credentials/DeliveryStatementCredential.yml +++ b/docs/openapi/components/schemas/credentials/DeliveryStatementCredential.yml @@ -3,7 +3,7 @@ $linkedData: '@id': https://w3id.org/traceability#DeliveryStatementCredential title: Delivery Statement Credential tags: - - Oil and Gas + - Oil and Gas description: >- Credential containing a statement indicating item(s) delivered type: object @@ -69,6 +69,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -131,4 +132,4 @@ example: |- } ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/DigitalProductPassportCredential.yml b/docs/openapi/components/schemas/credentials/DigitalProductPassportCredential.yml index bfab4ff30..a16ef3d51 100644 --- a/docs/openapi/components/schemas/credentials/DigitalProductPassportCredential.yml +++ b/docs/openapi/components/schemas/credentials/DigitalProductPassportCredential.yml @@ -47,7 +47,7 @@ properties: format: date-time issuer: title: Issuer Organization - description: Commercial invoice issuing organization. + description: Commercial invoice issuing organization. type: object properties: type: @@ -61,7 +61,7 @@ properties: type: string enum: - Organization - id: + id: title: Issuer's Identifier description: Issuing organization identifier, typically a Decentralized Identifier (DID). type: string @@ -108,7 +108,7 @@ properties: description: Basic product data. type: object properties: - type: + type: type: array readOnly: true const: @@ -119,29 +119,29 @@ properties: type: string enum: - Product - image: + image: title: Product Image type: string - name: + name: title: Product Name type: string - description: + description: title: Product Description type: string - id: + id: title: Product Identifier type: string format: uri - url: + url: title: Product Website type: string format: uri - brand: + brand: title: Brand - description: Brand Owner + description: Brand Owner type: object properties: - type: + type: type: array readOnly: true const: @@ -152,14 +152,14 @@ properties: type: string enum: - Organization - name: + name: title: Product Name type: string - id: + id: title: Product Identifier type: string format: uri - url: + url: title: Product Website type: string format: uri @@ -171,14 +171,14 @@ properties: - type - name - id - relatedLinks: + relatedLinks: title: Related links - description: Additional Digital Product Passport material. + description: Additional Digital Product Passport material. type: array - items: + items: type: object properties: - type: + type: type: array readOnly: true const: @@ -189,11 +189,11 @@ properties: type: string enum: - LinkRole - target: + target: title: Link Target type: string format: uri - linkRelationship: + linkRelationship: title: Link Relationship type: string required: @@ -258,4 +258,4 @@ example: |- } ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/DigitalProductPassportDataCarrierCredential.yml b/docs/openapi/components/schemas/credentials/DigitalProductPassportDataCarrierCredential.yml index 284ec16e9..524119ff0 100644 --- a/docs/openapi/components/schemas/credentials/DigitalProductPassportDataCarrierCredential.yml +++ b/docs/openapi/components/schemas/credentials/DigitalProductPassportDataCarrierCredential.yml @@ -5,7 +5,7 @@ title: Digital Product Passport Data Carrier Credential tags: - eCommerce - Other -description: The European Commission's Digital Product Passport Data Carrier is used to carry basic product data, links to its corresponding online Digital Product Passport Credential, and product verification material. It must support offline use cases and therefore be lightweight enough to be encoded by value along with the product itself. +description: The European Commission's Digital Product Passport Data Carrier is used to carry basic product data, links to its corresponding online Digital Product Passport Credential, and product verification material. It must support offline use cases and therefore be lightweight enough to be encoded by value along with the product itself. type: object properties: '@context': @@ -47,7 +47,7 @@ properties: format: date-time issuer: title: Issuer Organization - description: Commercial invoice issuing organization. + description: Commercial invoice issuing organization. type: object properties: type: @@ -61,7 +61,7 @@ properties: type: string enum: - Organization - id: + id: title: Issuer's Identifier description: Issuing organization identifier, typically a Decentralized Identifier (DID). type: string @@ -90,7 +90,7 @@ properties: const: OpenApiSpecificationValidator2022 credentialSubject: title: Digital Product Passport Data Carrier - description: Contains basic product data and links to the online Digital Procuct Passport and verification material. + description: Contains basic product data and links to the online Digital Procuct Passport and verification material. type: object properties: type: @@ -109,7 +109,7 @@ properties: description: Basic product data. type: object properties: - type: + type: type: array readOnly: true const: @@ -120,23 +120,23 @@ properties: type: string enum: - Product - name: + name: title: Product Name type: string - id: + id: title: Product Identifier type: string format: uri - url: + url: title: Product Website type: string format: uri - brand: + brand: title: Brand - description: Brand Owner + description: Brand Owner type: object properties: - type: + type: type: array readOnly: true const: @@ -147,14 +147,14 @@ properties: type: string enum: - Organization - name: + name: title: Product Name type: string - id: + id: title: Product Identifier type: string format: uri - url: + url: title: Product Website type: string format: uri @@ -166,14 +166,14 @@ properties: - type - name - id - relatedLinks: + relatedLinks: title: Relted links - description: Links to online material including the Digital Product Passport and Control data. + description: Links to online material including the Digital Product Passport and Control data. type: array - items: + items: type: object properties: - type: + type: type: array readOnly: true const: @@ -184,11 +184,11 @@ properties: type: string enum: - LinkRole - target: + target: title: Link Target type: string format: uri - linkRelationship: + linkRelationship: title: Link Relationship type: string required: @@ -252,4 +252,4 @@ example: |- "linkRelationship": "digitalProductPassport" } ] - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/EntryNumberCredential.yml b/docs/openapi/components/schemas/credentials/EntryNumberCredential.yml index 183a19047..7def11a08 100644 --- a/docs/openapi/components/schemas/credentials/EntryNumberCredential.yml +++ b/docs/openapi/components/schemas/credentials/EntryNumberCredential.yml @@ -136,4 +136,4 @@ example: |- ], "entryNumber": "12345123456" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/EventCredential.yml b/docs/openapi/components/schemas/credentials/EventCredential.yml index 9bae298b1..87d703d95 100644 --- a/docs/openapi/components/schemas/credentials/EventCredential.yml +++ b/docs/openapi/components/schemas/credentials/EventCredential.yml @@ -78,6 +78,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -142,4 +143,4 @@ example: |- "http://example.org/05b6867b-2211-4c8f-ae7a-2a770b9510af?hl=ZfqLwiBj3yidP7p344d71z8ybyjb2+YVfhckGGHHEzk=" ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/ExampleCredentialWithStatus.yml b/docs/openapi/components/schemas/credentials/ExampleCredentialWithStatus.yml index 800078283..bffa9df98 100644 --- a/docs/openapi/components/schemas/credentials/ExampleCredentialWithStatus.yml +++ b/docs/openapi/components/schemas/credentials/ExampleCredentialWithStatus.yml @@ -68,6 +68,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -97,4 +98,4 @@ example: |- "statusListIndex": "5", "statusListCredential": "https://example.com/status/362bbbb5-3d9b-4405-82ee-cf1443415351" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/FSMACreatingCTECredential.yml b/docs/openapi/components/schemas/credentials/FSMACreatingCTECredential.yml index 93de34701..19a1bd39b 100644 --- a/docs/openapi/components/schemas/credentials/FSMACreatingCTECredential.yml +++ b/docs/openapi/components/schemas/credentials/FSMACreatingCTECredential.yml @@ -84,6 +84,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -215,4 +216,4 @@ example: |- }, "dateCompleted": "2022-02-01T00:00Z" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/FSMAFirstReceiverDataCredential.yml b/docs/openapi/components/schemas/credentials/FSMAFirstReceiverDataCredential.yml index 0cbf64c24..5b2d21cb2 100644 --- a/docs/openapi/components/schemas/credentials/FSMAFirstReceiverDataCredential.yml +++ b/docs/openapi/components/schemas/credentials/FSMAFirstReceiverDataCredential.yml @@ -84,6 +84,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -184,4 +185,4 @@ example: |- "coolingDate": "2022-01-07T00:00Z", "packingDate": "2022-02-03T00:00Z" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/FSMAGrowingCTECredential.yml b/docs/openapi/components/schemas/credentials/FSMAGrowingCTECredential.yml index 690a958f2..e8458feb2 100644 --- a/docs/openapi/components/schemas/credentials/FSMAGrowingCTECredential.yml +++ b/docs/openapi/components/schemas/credentials/FSMAGrowingCTECredential.yml @@ -84,6 +84,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -171,4 +172,4 @@ example: |- "longitude": "70.916213" } } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/FSMAReceivingCTECredential.yml b/docs/openapi/components/schemas/credentials/FSMAReceivingCTECredential.yml index d23473afd..0e8fee3a3 100644 --- a/docs/openapi/components/schemas/credentials/FSMAReceivingCTECredential.yml +++ b/docs/openapi/components/schemas/credentials/FSMAReceivingCTECredential.yml @@ -84,6 +84,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -306,4 +307,4 @@ example: |- }, "dateReceived": "2022-01-03T00:00Z" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/FSMAShippingCTECredential.yml b/docs/openapi/components/schemas/credentials/FSMAShippingCTECredential.yml index 68f31a791..f7c118e33 100644 --- a/docs/openapi/components/schemas/credentials/FSMAShippingCTECredential.yml +++ b/docs/openapi/components/schemas/credentials/FSMAShippingCTECredential.yml @@ -84,6 +84,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -315,4 +316,4 @@ example: |- } ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/FSMATransformingCTECredential.yml b/docs/openapi/components/schemas/credentials/FSMATransformingCTECredential.yml index 43f8fc67b..58fea17bc 100644 --- a/docs/openapi/components/schemas/credentials/FSMATransformingCTECredential.yml +++ b/docs/openapi/components/schemas/credentials/FSMATransformingCTECredential.yml @@ -84,6 +84,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -303,4 +304,4 @@ example: |- }, "dateCompleted": "2022-01-06T00:00Z" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/FoodDefenseInspectionCredential.yml b/docs/openapi/components/schemas/credentials/FoodDefenseInspectionCredential.yml index a7549f39c..b627cdb95 100644 --- a/docs/openapi/components/schemas/credentials/FoodDefenseInspectionCredential.yml +++ b/docs/openapi/components/schemas/credentials/FoodDefenseInspectionCredential.yml @@ -86,6 +86,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -274,4 +275,4 @@ example: |- } ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/FoodGradeInspectionCredential.yml b/docs/openapi/components/schemas/credentials/FoodGradeInspectionCredential.yml index f28c0f221..45cd33c7f 100644 --- a/docs/openapi/components/schemas/credentials/FoodGradeInspectionCredential.yml +++ b/docs/openapi/components/schemas/credentials/FoodGradeInspectionCredential.yml @@ -86,6 +86,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -550,4 +551,4 @@ example: |- ], "estimatedCharges": "$135.00" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/FreightManifestCredential.yml b/docs/openapi/components/schemas/credentials/FreightManifestCredential.yml index cf4ce69fa..abbcda5dd 100644 --- a/docs/openapi/components/schemas/credentials/FreightManifestCredential.yml +++ b/docs/openapi/components/schemas/credentials/FreightManifestCredential.yml @@ -78,6 +78,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -462,4 +463,4 @@ example: |- } ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/GAPInspectionCredential.yml b/docs/openapi/components/schemas/credentials/GAPInspectionCredential.yml index 6c7e1ee65..50398f6a2 100644 --- a/docs/openapi/components/schemas/credentials/GAPInspectionCredential.yml +++ b/docs/openapi/components/schemas/credentials/GAPInspectionCredential.yml @@ -84,6 +84,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -366,4 +367,4 @@ example: |- } ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/GS18PrefixLicenseCredential.yml b/docs/openapi/components/schemas/credentials/GS18PrefixLicenseCredential.yml index 06f111472..4f57eadec 100644 --- a/docs/openapi/components/schemas/credentials/GS18PrefixLicenseCredential.yml +++ b/docs/openapi/components/schemas/credentials/GS18PrefixLicenseCredential.yml @@ -107,6 +107,7 @@ additionalProperties: true required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -133,4 +134,4 @@ example: |- "id": "https://id.gs1.org/vc/license/status/gs1_8_prefix/754", "type": "CredentialStatusList2021" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/GS1CompanyPrefixLicenseCredential.yml b/docs/openapi/components/schemas/credentials/GS1CompanyPrefixLicenseCredential.yml index 0400f55a8..2d7808c25 100644 --- a/docs/openapi/components/schemas/credentials/GS1CompanyPrefixLicenseCredential.yml +++ b/docs/openapi/components/schemas/credentials/GS1CompanyPrefixLicenseCredential.yml @@ -76,7 +76,7 @@ properties: organizationName: description: The name of the organization expressed in text. type: string - extendsCredential: + extendsCredential: description: Reference to the credential that this one extends. Provides a complete chain to the GS1 Prefix or GS1-8 Prefix license credential issued by GS1 Global Office. type: string licenseValue: @@ -97,6 +97,7 @@ additionalProperties: true required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -124,4 +125,4 @@ example: |- "id": "https://www.gs1ca.org/credentials/gs1_company_prefix/status/7541234", "type": "CredentialStatusList2021" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/GS1DataCredential.yml b/docs/openapi/components/schemas/credentials/GS1DataCredential.yml index 26570c07a..d1743034d 100644 --- a/docs/openapi/components/schemas/credentials/GS1DataCredential.yml +++ b/docs/openapi/components/schemas/credentials/GS1DataCredential.yml @@ -74,7 +74,7 @@ properties: const: OpenApiSpecificationValidator2022 credentialSubject: title: Identified Subject - description: Subject identified with a key credential about which data is being asserted. + description: Subject identified with a key credential about which data is being asserted. type: object properties: id: @@ -91,22 +91,22 @@ properties: type: array items: type: string - brandOwner: + brandOwner: description: The brand owner of the product. The organization that is responsible for allocating the GTIN to the product. type: string tradeItemDescription: description: An understandable and useable description of a product using brand and other descriptors. This attribute is filled with as little abbreviation as possible, while keeping to a reasonable length. This should be a meaningful description of the product with full spelling to facilitate message processing. Retailers can use this description as the base to fully understand the brand, flavour, scent etc. of the specific product, in order to accurately create a product description as needed for their internal systems. Examples; XYZ Brand Base Invisible Solid Deodorant AP Stick Spring Breeze. type: string - tradeItemImageURL: + tradeItemImageURL: description: Link to a file containing a visual representation of the product. type: string - netContent: + netContent: description: The quantity of the product contained by a package, usually as claimed on the label. Indicates the net content of the total product. For fixed value products use the value claimed on the package, to avoid variable fill rate issue that arises with some product which are sold by volume or weight, and whose actual content may vary slightly from batch to batch. type: string - netContentUOM: + netContentUOM: description: A string value indicating a Measurement Unit from UN/ECE Recommendation 20, Units of Measure used in International Trade e.g. GRM = gram - see http://www.unece.org/fileadmin/DAM/cefact/recommendations/rec20/rec20_rev3_Annex3e.pdf type: string - targetMarketCountryCode: + targetMarketCountryCode: description: Relates to a set of target market details (product release date and associated countries) type: array items: @@ -121,6 +121,7 @@ additionalProperties: true required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -157,4 +158,4 @@ example: |- "id": "https://www.example.com/mycreds/status/4e24b35d-de87-49d4-a26b-70490c62ec25", "type": "CredentialStatusList2021" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/GS1DelegationCredential.yml b/docs/openapi/components/schemas/credentials/GS1DelegationCredential.yml index 87a6fab0f..ab1a0207d 100644 --- a/docs/openapi/components/schemas/credentials/GS1DelegationCredential.yml +++ b/docs/openapi/components/schemas/credentials/GS1DelegationCredential.yml @@ -71,7 +71,7 @@ properties: description: Delegation party and details. type: object properties: - id: + id: description: URI of the party to which the authority to declare data is delegated. type: string delegation: @@ -79,7 +79,7 @@ properties: type: array items: type: string - identificationKeyType: + identificationKeyType: description: The identification key type to which the delegation applies. This attribute is generally not necessary. If all of the delegations are for individual GS1 key credentials, or if the data type can apply to only one type of thing, the identification key type can be implied. type: string dataCredentialType: @@ -97,6 +97,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -130,4 +131,4 @@ example: |- "CredentialStatusList2021" ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/GS1IdentificationKeyLicenseCredential.yml b/docs/openapi/components/schemas/credentials/GS1IdentificationKeyLicenseCredential.yml index a82cfb16d..2e797eea6 100644 --- a/docs/openapi/components/schemas/credentials/GS1IdentificationKeyLicenseCredential.yml +++ b/docs/openapi/components/schemas/credentials/GS1IdentificationKeyLicenseCredential.yml @@ -90,9 +90,9 @@ properties: alternativeLicenseValue: description: Alternative value of the license. For most licenses, the alternative value of the license is the bridge between the U.P.C. system and the rest of the GS1 system; if the license value starts with zero, then the alternative license value is the same as the license value but without the starting zero. type: string - identificationKeyType: + identificationKeyType: type: string - enum: + enum: - GTIN - GLN - SSCC @@ -116,6 +116,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -147,4 +148,4 @@ example: |- "id": "https://www.gs1ca.org/credentials/gtin/status/7543210555551", "type": "StatusList2021Credential" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/GS1KeyCredential.yml b/docs/openapi/components/schemas/credentials/GS1KeyCredential.yml index a3abc4a8b..ed2ce5e3c 100644 --- a/docs/openapi/components/schemas/credentials/GS1KeyCredential.yml +++ b/docs/openapi/components/schemas/credentials/GS1KeyCredential.yml @@ -79,7 +79,7 @@ properties: id: description: The GS1 Digital Link URI for the GTIN. type: string - extendsCredential: + extendsCredential: description: Reference to the credential that this one extends. Provides a complete chain to the GS1 Prefix or GS1-8 Prefix license credential issued by GS1 Global Office. type: string licenseValue: @@ -98,6 +98,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -125,4 +126,4 @@ example: |- "id": "https://www.example.com/mycreds/status/60cda318-a0a7-4e39-b600-ea38bf68a31f", "type": "StatusList2021Credential" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/GS1PrefixLicenseCredential.yml b/docs/openapi/components/schemas/credentials/GS1PrefixLicenseCredential.yml index 784573fda..dbaaa5ebe 100644 --- a/docs/openapi/components/schemas/credentials/GS1PrefixLicenseCredential.yml +++ b/docs/openapi/components/schemas/credentials/GS1PrefixLicenseCredential.yml @@ -94,6 +94,7 @@ additionalProperties: true required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -120,4 +121,4 @@ example: |- "id": "https://id.gs1.org/vc/license/status/gs1_prefix/754", "type": "CredentialStatusList2021" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/HouseBillOfLadingCredential.yml b/docs/openapi/components/schemas/credentials/HouseBillOfLadingCredential.yml index d0ee14910..443010a09 100644 --- a/docs/openapi/components/schemas/credentials/HouseBillOfLadingCredential.yml +++ b/docs/openapi/components/schemas/credentials/HouseBillOfLadingCredential.yml @@ -75,6 +75,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -303,4 +304,4 @@ example: |- }, "termsAndConditions": "https://terms-of-shipment.freightforwarder.example.com" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/IATAAirWaybillCredential.yml b/docs/openapi/components/schemas/credentials/IATAAirWaybillCredential.yml index 2390145db..f27701a5c 100644 --- a/docs/openapi/components/schemas/credentials/IATAAirWaybillCredential.yml +++ b/docs/openapi/components/schemas/credentials/IATAAirWaybillCredential.yml @@ -75,6 +75,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -300,4 +301,4 @@ example: |- "iataAirportCode": "XMN" } } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/ImporterSecurityFilingCredential.yml b/docs/openapi/components/schemas/credentials/ImporterSecurityFilingCredential.yml index fdef99da9..7c41aa9c7 100644 --- a/docs/openapi/components/schemas/credentials/ImporterSecurityFilingCredential.yml +++ b/docs/openapi/components/schemas/credentials/ImporterSecurityFilingCredential.yml @@ -72,6 +72,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -290,4 +291,4 @@ example: |- } ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/IntellectualPropertyRightsCredential.yml b/docs/openapi/components/schemas/credentials/IntellectualPropertyRightsCredential.yml index f362814af..64baf9cdd 100644 --- a/docs/openapi/components/schemas/credentials/IntellectualPropertyRightsCredential.yml +++ b/docs/openapi/components/schemas/credentials/IntellectualPropertyRightsCredential.yml @@ -5,7 +5,7 @@ title: Intellectual Property Rights Credential tags: - eCommerce description: >- - Credential claiming intellectual property rights of a product. + Credential claiming intellectual property rights of a product. type: object properties: '@context': @@ -61,7 +61,7 @@ properties: const: OpenApiSpecificationValidator2022 credentialSubject: $ref: ../common/IntellectualPropertyRights.yml - evidence: + evidence: $ref: ../common/IntellectualPropertyRightsAffirmation.yml proof: type: object @@ -69,6 +69,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -127,4 +128,4 @@ example: |- "intellectualPropertyRightsType": "Patent", "evidenceDocumentUrl": "https://patents.google.com/patent/EP1820540B1/" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/IntellectualPropertyRightsLicenseCredential.yml b/docs/openapi/components/schemas/credentials/IntellectualPropertyRightsLicenseCredential.yml index 9ce89c636..dabc3fcff 100644 --- a/docs/openapi/components/schemas/credentials/IntellectualPropertyRightsLicenseCredential.yml +++ b/docs/openapi/components/schemas/credentials/IntellectualPropertyRightsLicenseCredential.yml @@ -5,7 +5,7 @@ title: Intellectual Property Rights License Credential tags: - eCommerce description: >- - Credential licensing intellectual property rights. + Credential licensing intellectual property rights. type: object properties: '@context': @@ -58,7 +58,7 @@ properties: type: string enum: - Organization - id: + id: title: Identifier description: Organization identifier. type: string @@ -183,7 +183,7 @@ properties: type: string enum: - Organization - id: + id: title: Identifier description: Organization identifier. type: string @@ -286,6 +286,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -329,4 +330,4 @@ example: |- }, "extendsCredential": "did:web:organization.example.com" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/IntentToImportCredential.yml b/docs/openapi/components/schemas/credentials/IntentToImportCredential.yml index 70c74119d..58bb7b604 100644 --- a/docs/openapi/components/schemas/credentials/IntentToImportCredential.yml +++ b/docs/openapi/components/schemas/credentials/IntentToImportCredential.yml @@ -13,7 +13,7 @@ description: >- An Intent To Import Credential should be included in the first submission of Traceable Presentations. - Any additional Verifiable Credentials to be presented depend on the workflow definition(s) indicated on the presentation. + Any additional Verifiable Credentials to be presented depend on the workflow definition(s) indicated on the presentation. type: object properties: '@context': @@ -56,7 +56,7 @@ properties: format: date-time issuer: title: Issuer Organization - description: The organization indicating intent to import, thereby initiating the corresponding import workflow. + description: The organization indicating intent to import, thereby initiating the corresponding import workflow. type: object properties: type: @@ -70,7 +70,7 @@ properties: type: string enum: - Organization - id: + id: title: Issuer's Identifier description: Issuing organization identifier, typically a Decentralized Identifier (DID). type: string @@ -179,7 +179,7 @@ properties: title: Import Intent type: string readOnly: true - const: By issuing this Intent to Import Verifiable Credential and presenting it in a Traceable Presentation to US CBP, the issuing organization initiates a digital procedure for importing goods into the United States. + const: By issuing this Intent to Import Verifiable Credential and presenting it in a Traceable Presentation to US CBP, the issuing organization initiates a digital procedure for importing goods into the United States. default: By issuing this Intent to Import Verifiable Credential and presenting it in a Traceable Presentation to US CBP, the issuing organization initiates a digital procedure for importing goods into the United States. additionalProperties: false required: @@ -187,7 +187,7 @@ properties: - importIntent proof: title: proof - description: A JSON Web Signature proof for a credential as defined by the VC data model + description: A JSON Web Signature proof for a credential as defined by the VC data model type: object properties: type: @@ -211,6 +211,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -254,4 +255,4 @@ example: |- ], "importIntent": "By issuing this Intent to Import Verifiable Credential and presenting it in a Traceable Presentation to US CBP, the issuing organization initiates a digital procedure for importing goods into the United States." } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/InventoryRegistrationCredential.yml b/docs/openapi/components/schemas/credentials/InventoryRegistrationCredential.yml index 12fa6c18a..90ea9b11a 100644 --- a/docs/openapi/components/schemas/credentials/InventoryRegistrationCredential.yml +++ b/docs/openapi/components/schemas/credentials/InventoryRegistrationCredential.yml @@ -67,6 +67,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -102,4 +103,4 @@ example: |- "id": "did:web:garden-stuff.example.com" } } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/MasterBillOfLadingCredential.yml b/docs/openapi/components/schemas/credentials/MasterBillOfLadingCredential.yml index d4dcb7a87..cbdce29bc 100644 --- a/docs/openapi/components/schemas/credentials/MasterBillOfLadingCredential.yml +++ b/docs/openapi/components/schemas/credentials/MasterBillOfLadingCredential.yml @@ -76,6 +76,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -337,4 +338,4 @@ example: |- "shippedOnBoardDate": "2022-02-02T09:30:00Z", "termsAndConditions": "https://terms-of-shipment.carrier.example.com" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/MexicoEInvoiceCredential.yml b/docs/openapi/components/schemas/credentials/MexicoEInvoiceCredential.yml index cc5e891ac..4492fb94e 100644 --- a/docs/openapi/components/schemas/credentials/MexicoEInvoiceCredential.yml +++ b/docs/openapi/components/schemas/credentials/MexicoEInvoiceCredential.yml @@ -61,7 +61,7 @@ properties: type: string enum: - Organization - id: + id: title: Identifier description: Identifier of the issuer such as a url or DID type: string @@ -241,7 +241,7 @@ properties: documentType: title: Document Type description: The type of the document being referenced - enum: + enum: - MillTestReport - PurchaseOrder - PackingList @@ -365,7 +365,7 @@ properties: maxItems: 1000 items: type: object - additionalProperties: false + additionalProperties: false required: - type properties: @@ -439,19 +439,19 @@ properties: type: string enum: - Shipment - termsOfDelivery: + termsOfDelivery: title: Terms of Delivery description: The conditions agreed upon between the parties with regard to the delivery of goods and or services. type: string - shipmentMethod: + shipmentMethod: title: Shipment Method description: The method in which the goods in the invoice are being shipped type: string - freightCost: + freightCost: title: Freight Cost description: Included cost of freight type: number - freightCostCurrency: + freightCostCurrency: title: Frieght Cost Currency description: Currency in which frieght cost is calculated type: string @@ -578,19 +578,19 @@ properties: type: string enum: - Payment - termsOfPayment: + termsOfPayment: title: Terms of Payment description: Terms, conditions, and currency of settlement, as agreed upon by the vendor and purchaser per the pro forma invoice, customer purchase order, and/or the letter of credit. type: string - currencyOfSettlement: + currencyOfSettlement: title: Terms of Settlement description: Currency agreed upon between seller and buyer as payment. type: string - localCurrency: + localCurrency: title: Local Currency description: Currency in the case the requested and local currency are different type: string - conversionRate: + conversionRate: title: Conversion Rate description: The rate at which the currency conversion is pegged for the transaction type: string @@ -799,7 +799,7 @@ properties: type: string cfdi: title: Comprobantes Fiscal Digital por Internet - description: Requirements for the CFDI digital certificate standard + description: Requirements for the CFDI digital certificate standard type: object properties: taxUuid: @@ -822,7 +822,7 @@ properties: - v4.0 proof: title: proof - description: A JSON Web Signature proof for a credential as defined by the VC data model + description: A JSON Web Signature proof for a credential as defined by the VC data model type: object properties: type: @@ -1054,4 +1054,4 @@ example: |- "id": "https://w3id.org/traceability/openapi/components/schemas/credentials/MexicoEInvoiceCredential.yml", "type": "OpenApiSpecificationValidator2022" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/MillTestReportCredential.yml b/docs/openapi/components/schemas/credentials/MillTestReportCredential.yml index c40c24ac7..38fd96cbe 100644 --- a/docs/openapi/components/schemas/credentials/MillTestReportCredential.yml +++ b/docs/openapi/components/schemas/credentials/MillTestReportCredential.yml @@ -49,7 +49,7 @@ properties: format: date-time issuer: title: Issuer Organization - description: The steel manufacturer issuing the Mill Test Report product certificate. + description: The steel manufacturer issuing the Mill Test Report product certificate. type: object properties: type: @@ -63,7 +63,7 @@ properties: type: string enum: - Organization - id: + id: title: Issuer's Identifier description: Issuing organization identifier, typically a Decentralized Identifier (DID). type: string @@ -174,13 +174,13 @@ properties: type: string certification: title: Certification - description: The type of certification conducted. + description: The type of certification conducted. type: string purchaseOrderNumber: title: Purchase Order Number - description: Purchase order number. + description: Purchase order number. type: string - shipmentDate: + shipmentDate: title: Shipment Date description: Date of shipping. type: string @@ -188,11 +188,11 @@ properties: $linkedData: term: shipmentDate '@id': https://vocabulary.uncefact.org/DateTimePeriodFunctionCodeList#270 - meansOfTransport: + meansOfTransport: title: Means of Transport description: A means of transport, expressed as text, for this transport route. type: string - enum: + enum: - Road - Rail - Ocean @@ -201,7 +201,7 @@ properties: '@id': https://vocabulary.uncefact.org/transportMeans customer: title: Customer - description: Bill to, buyer party. + description: Bill to, buyer party. type: object properties: type: @@ -215,7 +215,7 @@ properties: type: string enum: - Organization - id: + id: title: Identifier description: Customers's identifier, typically a Decentralized Identifier (DID). type: string @@ -326,15 +326,15 @@ properties: type: string heatTreatment: title: Heat Treatment - description: Special heat treatments, depending on product specification. + description: Special heat treatments, depending on product specification. type: string surfaceTreatment: title: Surface Treatment - description: Surface treatments, if applicable. + description: Surface treatments, if applicable. type: string - productDescription: + productDescription: title: Product Description - description: Descriptive product name. + description: Descriptive product name. type: string required: - type @@ -343,16 +343,16 @@ properties: - productDescription remarks: title: Remarks - description: Additional attestation remarks. + description: Additional attestation remarks. type: string inspections: title: Inspections - description: Inspections certified by this Mill Test Report. Multiple inspections can be listed for different items, heats, etc. + description: Inspections certified by this Mill Test Report. Multiple inspections can be listed for different items, heats, etc. type: array minItems: 1 items: title: Inspection - description: Inspections conducted as part of a Mill Test certification. + description: Inspections conducted as part of a Mill Test certification. type: object properties: type: @@ -366,11 +366,11 @@ properties: type: string enum: - Inspection - productIdentifier: + productIdentifier: title: Product Identifier description: Product identifier such as lot, part, coil, or serial number. type: string - productDimensions: + productDimensions: title: Product Dimensions description: Confirmed dimensions of product, as applicable to the product type (for example diameter or thickness). type: object @@ -501,11 +501,11 @@ properties: additionalProperties: false required: - type - pieces: + pieces: title: Pieces - description: The amount of units. + description: The amount of units. type: number - perUnitWeight: + perUnitWeight: title: Per Unit Weight description: Nominal unit weight. type: object @@ -533,7 +533,7 @@ properties: rec20_rev3 type: string - totalWeight: + totalWeight: title: Total Weight description: Total product weight. type: object @@ -561,29 +561,29 @@ properties: rec20_rev3 type: string - countryOfManufacture: + countryOfManufacture: title: Country of Manufacture description: Manufacturing country. type: string - countryOfMeltAndPour: + countryOfMeltAndPour: title: Country of Melt and Pour description: Country of original melt and pour. type: string - meltPractice: + meltPractice: title: Melt Practice description: Type of melting practice. type: string - heatNumber: + heatNumber: title: Heat Number description: Heat identification. type: string - testNumber: + testNumber: title: Test number description: Identifier of test conducted. type: string - chemicalComposition: + chemicalComposition: title: Chemical Composition - description: Measured chemical composition; all values in W%. + description: Measured chemical composition; all values in W%. type: object properties: type: @@ -599,137 +599,137 @@ properties: - ChemicalComposition c: title: C - description: Carbon percentage content. + description: Carbon percentage content. type: number $linkedData: term: c - "@id": https://w3id.org/traceability#c + '@id': https://w3id.org/traceability#c mn: title: Mn description: Manganese percentage content. type: number $linkedData: term: mn - "@id": https://w3id.org/traceability#mn + '@id': https://w3id.org/traceability#mn p: title: P description: Phosphorus percentage content. type: number $linkedData: term: p - "@id": https://w3id.org/traceability#p + '@id': https://w3id.org/traceability#p s: title: S description: Sulphur percentage content. type: number $linkedData: term: s - "@id": https://w3id.org/traceability#s + '@id': https://w3id.org/traceability#s si: title: Si description: Silicon percentage content. type: number $linkedData: term: si - "@id": https://w3id.org/traceability#si + '@id': https://w3id.org/traceability#si al: title: Al description: Aluminum percentage content. type: number $linkedData: term: al - "@id": https://w3id.org/traceability#al + '@id': https://w3id.org/traceability#al cu: title: Cu description: Copper percentage content. type: number $linkedData: term: cu - "@id": https://w3id.org/traceability#cu + '@id': https://w3id.org/traceability#cu ni: title: Ni description: Nickel percentage content. type: number $linkedData: term: ni - "@id": https://w3id.org/traceability#ni + '@id': https://w3id.org/traceability#ni cr: title: Cr description: Chromium percentage content. type: number $linkedData: term: cr - "@id": https://w3id.org/traceability#cr + '@id': https://w3id.org/traceability#cr mo: title: Mo description: Molybdenum percentage content. type: number $linkedData: term: mo - "@id": https://w3id.org/traceability#mo + '@id': https://w3id.org/traceability#mo sn: title: Sn description: Tin percentage content. type: number $linkedData: term: sn - "@id": https://w3id.org/traceability#sn + '@id': https://w3id.org/traceability#sn nbCb: title: NbCb description: Niobium (also known as Columbium) percentage content. type: number $linkedData: term: nbCb - "@id": https://w3id.org/traceability#nbCb + '@id': https://w3id.org/traceability#nbCb v: title: V description: Vanadium percentage content. type: number $linkedData: term: v - "@id": https://w3id.org/traceability#v + '@id': https://w3id.org/traceability#v ti: title: Ti description: Titanium percentage content. type: number $linkedData: term: ti - "@id": https://w3id.org/traceability#ti + '@id': https://w3id.org/traceability#ti b: title: B description: Boron percentage content. type: number $linkedData: term: b - "@id": https://w3id.org/traceability#b + '@id': https://w3id.org/traceability#b n: title: N description: Nitrogen percentage content. type: number $linkedData: term: n - "@id": https://w3id.org/traceability#n + '@id': https://w3id.org/traceability#n ca: title: Ca description: Calcium percentage content. type: number $linkedData: term: ca - "@id": https://w3id.org/traceability#ca + '@id': https://w3id.org/traceability#ca pb: title: Pb description: Lead percentage content. type: number $linkedData: term: pb - "@id": https://w3id.org/traceability#pb + '@id': https://w3id.org/traceability#pb ce: title: C.E. description: Carbon Equivalent percentage content. type: number $linkedData: term: ce - "@id": https://w3id.org/traceability#ce + '@id': https://w3id.org/traceability#ce additionalProperties: false required: - type @@ -738,9 +738,9 @@ properties: - p - s - si - mechanicalProperties: + mechanicalProperties: title: Mechanical Properties - description: Mechanical property measurements. + description: Mechanical property measurements. type: object properties: type: @@ -945,7 +945,7 @@ properties: - inspections proof: title: proof - description: A JSON Web Signature proof for a credential as defined by the VC data model + description: A JSON Web Signature proof for a credential as defined by the VC data model type: object properties: type: @@ -1174,4 +1174,4 @@ example: |- } ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/MonthlyAdvanceManifestCredential.yml b/docs/openapi/components/schemas/credentials/MonthlyAdvanceManifestCredential.yml index 3d3f2c99f..5b96e6789 100644 --- a/docs/openapi/components/schemas/credentials/MonthlyAdvanceManifestCredential.yml +++ b/docs/openapi/components/schemas/credentials/MonthlyAdvanceManifestCredential.yml @@ -79,6 +79,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -145,4 +146,4 @@ example: |- } ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/MultiModalBillOfLadingCredential.yml b/docs/openapi/components/schemas/credentials/MultiModalBillOfLadingCredential.yml index b19327b5d..00a74d8e4 100644 --- a/docs/openapi/components/schemas/credentials/MultiModalBillOfLadingCredential.yml +++ b/docs/openapi/components/schemas/credentials/MultiModalBillOfLadingCredential.yml @@ -8,7 +8,7 @@ tags: - Agriculture - Oil and Gas - Other -description: >- +description: >- A receipt for the cargo and a contract for transportation between a shipper and the carrier. It may also be used as instrument of ownership (negotiable bill of lading) which can be bought, sold or traded while the goods are in transit. To be used in this manner, it must be a negotiable "order bill of lading". (source: Olegario Llamazares: Dictionary Of International Trade, Key definitions of 2000 trade terms and acronyms). Model based on https://service.unece.org/trade/uncefact/publication/Transport%20and%20Logistics/MaritimeBill/HTML/001.htm @@ -74,7 +74,7 @@ properties: maxLength: 512000 description: URI to a remote logo file, or a `data:` scheme URI of an encoded logo - id: + id: title: Identifier description: Carrier identifier. type: string @@ -198,23 +198,23 @@ properties: type: string bookingNumber: title: Booking Number - description: A unique identifier assigned by the carrier to the consignment, such as a booking reference number when cargo space is reserved prior to loading. + description: A unique identifier assigned by the carrier to the consignment, such as a booking reference number when cargo space is reserved prior to loading. type: array - items: + items: type: string shippersReferences: title: Shipper's References description: A number that identifies the SID (shipper's identification) number for a shipment. type: array - items: + items: type: string freightForwardersReferences: title: Freight Forwarder's References description: Reference number assigned by the freight forwarder to identify a particular consignment. type: array - items: + items: type: string - shipper: + shipper: title: Shipper description: Consignor party. type: object @@ -412,7 +412,7 @@ properties: required: - type - name - forwardingAgent: + forwardingAgent: title: Forwarding Agent description: The freight forwarder party for this supply chain consignment. type: object @@ -513,8 +513,8 @@ properties: notifyParty: title: Notify Party description: The freight forwarder party for this supply chain consignment. - type: array - items: + type: array + items: title: Notify Party description: The freight forwarder party for this supply chain consignment. type: object @@ -828,11 +828,11 @@ properties: additionalProperties: false required: - type - totalNumberOfPackages: + totalNumberOfPackages: title: Total Number of Packages description: A number of packages. type: number - transportEquipmentQuantity: + transportEquipmentQuantity: title: Transport Equipment Quantity description: A number of pieces of transport equipment for the consignment or transport movement. type: number @@ -840,7 +840,7 @@ properties: title: Consignment Item Particulars description: A consignment item included in the consignment. type: array - items: + items: title: Consignment Item description: A separately identifiable collection of goods items to be transported or available to be transported from one consignor to one consignee via one or more modes of transport where each consignment is the subject of one single transport contract. type: object @@ -856,15 +856,15 @@ properties: type: string enum: - ConsignmentItem - marksAndNumbers: + marksAndNumbers: title: Marks and Numbers description: Physical markings or labels on individual packages or transport units for shipping purposes. type: string - descriptionOfPackagesAndGoods: + descriptionOfPackagesAndGoods: title: Description of Packages and Goods description: Transport cargo details of the consignment or consignment item sufficient to identify its nature for customs, statistical, or transport purposes. type: string - commodity: + commodity: title: Commodity description: Commodity classification based on either WCO HS or USITS HTS codification. type: object @@ -899,11 +899,11 @@ properties: additionalProperties: false required: - type - packageQuantity: + packageQuantity: title: Number of Packages description: A number of packages. type: number - netWeight: + netWeight: title: Net Weight description: Net weight of the product. type: object @@ -930,7 +930,7 @@ properties: additionalProperties: false required: - type - grossWeight: + grossWeight: title: Gross Weight description: Gross weight of the product. type: object @@ -957,7 +957,7 @@ properties: additionalProperties: false required: - type - grossVolume: + grossVolume: title: Gross Volume description: A measure of the gross volume, normally calculated by multiplying the maximum length, width and height. type: object @@ -984,7 +984,7 @@ properties: additionalProperties: false required: - type - countryOfOrigin: + countryOfOrigin: title: Country of Origin description: A country of origin for the consignment, consignment item, or product. The two-letter ISO 3166-1 alpha-2 country code is recommended. type: string @@ -992,7 +992,7 @@ properties: title: Utilized Transport Equipment description: A piece of transport equipment utilized for the consignment or trade delivery. type: array - items: + items: type: object properties: type: @@ -1094,14 +1094,14 @@ properties: additionalProperties: false required: - type - additionalProperties: false + additionalProperties: false required: - type - freightAndCharges: + freightAndCharges: title: Freight and Charges description: A logistics service charge, such as freight or insurance charges, applicable to this supply chain consignment, supply chain consignment item, piece of logistics transport equipment, logistics means of transport or logistics transport movement. type: array - items: + items: type: object properties: type: @@ -1202,7 +1202,7 @@ properties: additionalProperties: false required: - type - additionalProperties: false + additionalProperties: false required: - type declaredValue: @@ -1258,7 +1258,7 @@ properties: - termsAndConditions proof: title: proof - description: A JSON Web Signature proof for a credential as defined by the VC data model + description: A JSON Web Signature proof for a credential as defined by the VC data model type: object properties: type: @@ -1521,4 +1521,4 @@ example: |- "shippedOnBoardDate": "2022-02-02", "termsAndConditions": "https://terms-of-shipment.carrier.example.com" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/OilAndGasDeliveryTicketCredential.yml b/docs/openapi/components/schemas/credentials/OilAndGasDeliveryTicketCredential.yml index 542861ce3..f237bae8c 100644 --- a/docs/openapi/components/schemas/credentials/OilAndGasDeliveryTicketCredential.yml +++ b/docs/openapi/components/schemas/credentials/OilAndGasDeliveryTicketCredential.yml @@ -76,6 +76,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -282,4 +283,4 @@ example: |- } ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/OilAndGasProductCredential.yml b/docs/openapi/components/schemas/credentials/OilAndGasProductCredential.yml index 4f4f42c5c..49cf9aeda 100644 --- a/docs/openapi/components/schemas/credentials/OilAndGasProductCredential.yml +++ b/docs/openapi/components/schemas/credentials/OilAndGasProductCredential.yml @@ -76,6 +76,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -217,4 +218,4 @@ example: |- } } } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/OrderConfirmationCredential.yml b/docs/openapi/components/schemas/credentials/OrderConfirmationCredential.yml index 0c037e7e1..7a92f216a 100644 --- a/docs/openapi/components/schemas/credentials/OrderConfirmationCredential.yml +++ b/docs/openapi/components/schemas/credentials/OrderConfirmationCredential.yml @@ -67,6 +67,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -111,4 +112,4 @@ example: |- } ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/OrganicCertificateCredential.yml b/docs/openapi/components/schemas/credentials/OrganicCertificateCredential.yml index ddc9928ea..83c7f6427 100644 --- a/docs/openapi/components/schemas/credentials/OrganicCertificateCredential.yml +++ b/docs/openapi/components/schemas/credentials/OrganicCertificateCredential.yml @@ -85,6 +85,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -185,4 +186,4 @@ example: |- "issueDate": "2020-03-14", "anniversaryDate": "2021-03-10" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/PGAShipmentStatusCredential.yml b/docs/openapi/components/schemas/credentials/PGAShipmentStatusCredential.yml index 15474227e..4b8dff7db 100644 --- a/docs/openapi/components/schemas/credentials/PGAShipmentStatusCredential.yml +++ b/docs/openapi/components/schemas/credentials/PGAShipmentStatusCredential.yml @@ -77,6 +77,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -153,4 +154,4 @@ example: |- } ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/PackingListCredential.yml b/docs/openapi/components/schemas/credentials/PackingListCredential.yml index 41993b60a..7b64cfeb9 100644 --- a/docs/openapi/components/schemas/credentials/PackingListCredential.yml +++ b/docs/openapi/components/schemas/credentials/PackingListCredential.yml @@ -49,7 +49,7 @@ properties: format: date-time issuer: title: Issuer Organization - description: Commercial invoice issuing organization. + description: Commercial invoice issuing organization. type: object properties: type: @@ -69,7 +69,7 @@ properties: format: uri maxLength: 512000 description: URI to a remote logo file, or a `data:` scheme URI of an encoded logo - id: + id: title: Issuer's Identifier description: Issuing organization identifier, typically a Decentralized Identifier (DID). type: string @@ -178,7 +178,7 @@ properties: type: string enum: - PackingList - seller: + seller: title: Seller description: An entity which offers (sells, leases, lends, or loans) the services or goods. A seller may also be a provider. type: object @@ -696,13 +696,13 @@ properties: orderNumber: title: Order Number type: string - invoiceId: + invoiceId: title: Invoice Identifier type: string - billOfLadingNumber: + billOfLadingNumber: title: Bill of Lading Number type: string - trackingNumber: + trackingNumber: title: Tracking Number type: string deliveryStatus: @@ -1008,7 +1008,7 @@ properties: - type proof: title: proof - description: A JSON Web Signature proof for a credential as defined by the VC data model + description: A JSON Web Signature proof for a credential as defined by the VC data model type: object properties: type: @@ -1319,4 +1319,4 @@ example: |- "totalNumberOfPackages": 622, "totalItemQuantity": 820 } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/PlantSystemsInspectionCredential.yml b/docs/openapi/components/schemas/credentials/PlantSystemsInspectionCredential.yml index 18b935635..cd8b724e8 100644 --- a/docs/openapi/components/schemas/credentials/PlantSystemsInspectionCredential.yml +++ b/docs/openapi/components/schemas/credentials/PlantSystemsInspectionCredential.yml @@ -85,6 +85,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -313,4 +314,4 @@ example: |- "Reagents observed in partially open containers" ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/PowerOfAttorneyCredential.yml b/docs/openapi/components/schemas/credentials/PowerOfAttorneyCredential.yml index d5b5f71c1..68ea7faa4 100644 --- a/docs/openapi/components/schemas/credentials/PowerOfAttorneyCredential.yml +++ b/docs/openapi/components/schemas/credentials/PowerOfAttorneyCredential.yml @@ -312,4 +312,4 @@ example: |- } } } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/ProductRegistrationCredential.yml b/docs/openapi/components/schemas/credentials/ProductRegistrationCredential.yml index 3c5af598f..385bd9934 100644 --- a/docs/openapi/components/schemas/credentials/ProductRegistrationCredential.yml +++ b/docs/openapi/components/schemas/credentials/ProductRegistrationCredential.yml @@ -67,6 +67,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -124,4 +125,4 @@ example: |- "name": "Everything Garden Stuff" } } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/PurchaseOrderCredential.yml b/docs/openapi/components/schemas/credentials/PurchaseOrderCredential.yml index 6c75e1f3b..76acb9bb7 100644 --- a/docs/openapi/components/schemas/credentials/PurchaseOrderCredential.yml +++ b/docs/openapi/components/schemas/credentials/PurchaseOrderCredential.yml @@ -82,7 +82,7 @@ properties: maxLength: 512000 description: URI to a remote logo file, or a `data:` scheme URI of an encoded logo - id: + id: title: Issuer's Identifier description: Issuing organization identifier, typically a Decentralized Identifier (DID). type: string @@ -303,7 +303,7 @@ properties: additionalProperties: false required: - type - seller: + seller: title: Seller description: An entity which offers (sells, leases, lends, or loans) the services or goods. A seller may also be a provider. type: object @@ -536,7 +536,7 @@ properties: type: string product: title: Product - description: Product details. + description: Product details. type: object properties: type: @@ -727,7 +727,7 @@ properties: - type - price - priceCurrency - additionalProperties: false + additionalProperties: false required: - type - product @@ -1006,7 +1006,7 @@ properties: - totalOrderAmount proof: title: proof - description: A JSON Web Signature proof for a credential as defined by the VC data model + description: A JSON Web Signature proof for a credential as defined by the VC data model type: object properties: type: @@ -1201,4 +1201,4 @@ example: |- "priceCurrency": "USD" } } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/SIMASteelImportLicenseApplicationCredential.yml b/docs/openapi/components/schemas/credentials/SIMASteelImportLicenseApplicationCredential.yml index d57dd6d52..693d3b25d 100644 --- a/docs/openapi/components/schemas/credentials/SIMASteelImportLicenseApplicationCredential.yml +++ b/docs/openapi/components/schemas/credentials/SIMASteelImportLicenseApplicationCredential.yml @@ -58,7 +58,7 @@ properties: type: string enum: - Organization - id: + id: title: Identifier description: Organization identifier. type: string @@ -195,7 +195,7 @@ properties: type: string enum: - Organization - id: + id: title: Identifier description: Organization identifier. type: string @@ -223,7 +223,7 @@ properties: type: string enum: - Organization - id: + id: title: Identifier description: Organization identifier. type: string @@ -251,7 +251,7 @@ properties: type: string enum: - Organization - id: + id: title: Identifier description: Organization identifier. type: string @@ -347,7 +347,7 @@ properties: '@id': https://schema.org/description productCategory: title: Product Category - description: Category assigned to the product based on the Product HTS. + description: Category assigned to the product based on the Product HTS. type: string countryOfMeltAndPour: title: Country of Melt And Pour @@ -380,9 +380,9 @@ properties: '@id': https://schema.org/value unitCode: title: Measurement Unit - description: Product weight must be provided in kilograms on the SIMA Application. + description: Product weight must be provided in kilograms on the SIMA Application. type: string - enum: + enum: - KGM $linkedData: term: unitCode @@ -413,7 +413,7 @@ properties: description: >- The currency in which the monetary amount is expressed. Use standard formats: ISO 4217 currency format, e.g. "USD". type: string - enum: + enum: - USD additionalProperties: false required: @@ -438,7 +438,7 @@ properties: - productInformation proof: title: proof - description: A JSON Web Signature proof for a credential as defined by the VC data model + description: A JSON Web Signature proof for a credential as defined by the VC data model type: object properties: type: @@ -560,4 +560,4 @@ example: |- } ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/SIMASteelImportLicenseCredential.yml b/docs/openapi/components/schemas/credentials/SIMASteelImportLicenseCredential.yml index 11cb973a1..c55ac7647 100644 --- a/docs/openapi/components/schemas/credentials/SIMASteelImportLicenseCredential.yml +++ b/docs/openapi/components/schemas/credentials/SIMASteelImportLicenseCredential.yml @@ -63,7 +63,7 @@ properties: type: string enum: - Organization - id: + id: title: Identifier description: Organization identifier. type: string @@ -127,7 +127,7 @@ properties: type: string enum: - Organization - id: + id: title: Identifier description: Organization identifier. type: string @@ -229,7 +229,7 @@ properties: type: string enum: - Organization - id: + id: title: Identifier description: Organization identifier. type: string @@ -257,7 +257,7 @@ properties: type: string enum: - Organization - id: + id: title: Identifier description: Organization identifier. type: string @@ -285,7 +285,7 @@ properties: type: string enum: - Organization - id: + id: title: Identifier description: Organization identifier. type: string @@ -381,7 +381,7 @@ properties: '@id': https://schema.org/description productCategory: title: Product Category - description: Category assigned to the product based on the Product HTS. + description: Category assigned to the product based on the Product HTS. type: string countryOfMeltAndPour: title: Country of Melt And Pour @@ -414,9 +414,9 @@ properties: '@id': https://schema.org/value unitCode: title: Measurement Unit - description: Product weight must be provided in kilograms on the SIMA Application. + description: Product weight must be provided in kilograms on the SIMA Application. type: string - enum: + enum: - KGM $linkedData: term: unitCode @@ -447,7 +447,7 @@ properties: description: >- The currency in which the monetary amount is expressed. Use standard formats: ISO 4217 currency format, e.g. "USD". type: string - enum: + enum: - USD additionalProperties: false required: @@ -472,7 +472,7 @@ properties: - productInformation proof: title: proof - description: A JSON Web Signature proof for a credential as defined by the VC data model + description: A JSON Web Signature proof for a credential as defined by the VC data model type: object properties: type: @@ -603,4 +603,4 @@ example: |- } ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/SeaCargoManifestCredential.yml b/docs/openapi/components/schemas/credentials/SeaCargoManifestCredential.yml index 5d31cc23e..f1f911569 100644 --- a/docs/openapi/components/schemas/credentials/SeaCargoManifestCredential.yml +++ b/docs/openapi/components/schemas/credentials/SeaCargoManifestCredential.yml @@ -8,8 +8,8 @@ tags: - Agriculture - Oil and Gas - Other -description: >- - In international trade, a listing of all cargo transported on a particular marine voyage or flight. The manifest prepared for cargo loaded at a given port or airport should equal the sum total of all transport documents (bills of lading, air waybills) issued for cargo taken on at that port or airport. The Sea Cargo Manifest is issued by the ocean carrier listing out all cargo that is on board the vessel. +description: >- + In international trade, a listing of all cargo transported on a particular marine voyage or flight. The manifest prepared for cargo loaded at a given port or airport should equal the sum total of all transport documents (bills of lading, air waybills) issued for cargo taken on at that port or airport. The Sea Cargo Manifest is issued by the ocean carrier listing out all cargo that is on board the vessel. type: object properties: '@context': @@ -74,6 +74,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -377,4 +378,4 @@ example: |- } ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/ShippingInstructionsCredential.yml b/docs/openapi/components/schemas/credentials/ShippingInstructionsCredential.yml index 20a2158c5..e68310290 100644 --- a/docs/openapi/components/schemas/credentials/ShippingInstructionsCredential.yml +++ b/docs/openapi/components/schemas/credentials/ShippingInstructionsCredential.yml @@ -8,7 +8,7 @@ tags: - Agriculture - Oil and Gas - Other -description: >- +description: >- Shipping Instructions or Shipper's Letter of Instruction is a form issued by a shipper to authorize a carrier to issue a bill of lading or an air waybill on the shipper's behalf. The form contains all details of shipment (e.g., shipper, consignee, bill-to-party, commodity, pieces, weight, cube, etc.) and authorizes the carrier to sign the bill of lading in the name of the shipper. (source: Olegario Llamazares: Dictionary Of International Trade, Key definitions of 2000 trade terms and acronyms). Model based on https://service.unece.org/trade/uncefact/publication/Transport%20and%20Logistics/itigg%20unttc/Shipping%20Instructions/Multimodal%20Shipping%20Instructions_D21B/HTML/001.htm. @@ -69,6 +69,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -281,4 +282,4 @@ example: |- "priceCurrency": "USD" } } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/SoftwareBillofMaterialsCredential.yml b/docs/openapi/components/schemas/credentials/SoftwareBillofMaterialsCredential.yml index 0d3a7c6d7..4badc4f22 100644 --- a/docs/openapi/components/schemas/credentials/SoftwareBillofMaterialsCredential.yml +++ b/docs/openapi/components/schemas/credentials/SoftwareBillofMaterialsCredential.yml @@ -78,6 +78,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -216,4 +217,4 @@ example: |- } ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/TSCACertificationCredential.yml b/docs/openapi/components/schemas/credentials/TSCACertificationCredential.yml index 04ebbfdaf..733131b58 100644 --- a/docs/openapi/components/schemas/credentials/TSCACertificationCredential.yml +++ b/docs/openapi/components/schemas/credentials/TSCACertificationCredential.yml @@ -76,10 +76,11 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject -example: |- +example: |- { "@context": [ "https://www.w3.org/2018/credentials/v1", @@ -123,4 +124,4 @@ example: |- "phoneNumber": "+1-555-123-4567" } } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/ThingCredential.yml b/docs/openapi/components/schemas/credentials/ThingCredential.yml index 1c47079b1..3555a0e3a 100644 --- a/docs/openapi/components/schemas/credentials/ThingCredential.yml +++ b/docs/openapi/components/schemas/credentials/ThingCredential.yml @@ -71,6 +71,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -99,4 +100,4 @@ example: |- "identifier": "123", "name": "entrySummaryId" } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/USMCACertificationOfOrigin.yml b/docs/openapi/components/schemas/credentials/USMCACertificationOfOrigin.yml index 74a6f0007..6237b9f12 100644 --- a/docs/openapi/components/schemas/credentials/USMCACertificationOfOrigin.yml +++ b/docs/openapi/components/schemas/credentials/USMCACertificationOfOrigin.yml @@ -76,7 +76,7 @@ properties: type: string enum: - Organization - id: + id: title: Identifier description: Identifier of the issuer such as a url or DID type: string @@ -148,7 +148,7 @@ properties: - type employee: title: Certification Manager - description: The employee responsible for this certification. + description: The employee responsible for this certification. type: object properties: type: @@ -620,7 +620,7 @@ properties: enum: - HS - HTS - default: + default: - HTS $linkedData: term: commodityCodeType @@ -819,4 +819,4 @@ example: |- } ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/VerifiablePostmanCollection.yml b/docs/openapi/components/schemas/credentials/VerifiablePostmanCollection.yml index fcc2d66ec..b85e49507 100644 --- a/docs/openapi/components/schemas/credentials/VerifiablePostmanCollection.yml +++ b/docs/openapi/components/schemas/credentials/VerifiablePostmanCollection.yml @@ -2,7 +2,7 @@ title: Verifiable Postman Collection description: >- Postman is an API platform for developers to design, build, test and iterate their APIs. A Verifiable Postman Collection is a Postman collection that has been signed by an - issuier to verify the source of a collection as origininating from a specific entity. + issuier to verify the source of a collection as origininating from a specific entity. tags: - Software $linkedData: @@ -67,6 +67,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject @@ -182,4 +183,4 @@ example: |- } ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/VerifiableScorecard.yml b/docs/openapi/components/schemas/credentials/VerifiableScorecard.yml index e292af242..75930f81a 100644 --- a/docs/openapi/components/schemas/credentials/VerifiableScorecard.yml +++ b/docs/openapi/components/schemas/credentials/VerifiableScorecard.yml @@ -74,9 +74,10 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - - credentialSubject + - credentialSubject example: |- { "@context": [ @@ -193,4 +194,4 @@ example: |- } ] } - } \ No newline at end of file + } diff --git a/docs/openapi/components/schemas/credentials/environmentalImpactCredential.yml b/docs/openapi/components/schemas/credentials/environmentalImpactCredential.yml index 0bc97fc4f..c49e9632b 100644 --- a/docs/openapi/components/schemas/credentials/environmentalImpactCredential.yml +++ b/docs/openapi/components/schemas/credentials/environmentalImpactCredential.yml @@ -111,6 +111,7 @@ additionalProperties: false required: - '@context' - type + - id - issuanceDate - issuer - credentialSubject