Merge pull request #853 from mesur-io/feat/new-workflow

Feat/new workflow: Common Import Credentials
w3c-ccg · Aug 22, 2023 · f6f2bdc · f6f2bdc
2 parents 119b713 + 5729212
commit f6f2bdc
Show file tree

Hide file tree

Showing 4 changed files with 112 additions and 5 deletions.
diff --git a/docs/credentials-with-issuer-dependent-terms.json b/docs/credentials-with-issuer-dependent-terms.json
@@ -89,7 +89,7 @@
   },
   {
     "type": "MillTestReportCredential",
-    "count": 187
+    "count": 191
   },
   {
     "type": "MasterBillOfLadingCredential",
@@ -113,7 +113,7 @@
   },
   {
     "type": "IATAAirWaybillCredential",
-    "count": 0
+    "count": 6
   },
   {
     "type": "HouseBillOfLadingCredential",
@@ -191,29 +191,33 @@
     "type": "FSMACreatingCTECredential",
     "count": 0
   },
+  {
+    "type": "ExampleCredential",
+    "count": 3
+  },
   {
     "type": "EventCredential",
     "count": 9
   },
   {
     "type": "EntryNumberCredential",
-    "count": 2
+    "count": 0
   },
   {
     "type": "DeliveryStatementCredential",
     "count": 0
   },
   {
     "type": "DeliveryScheduleCredential",
-    "count": 6
+    "count": 8
   },
   {
     "type": "DeMinimisShipmentCredential",
     "count": 0
   },
   {
     "type": "DCSATransportDocumentCredential",
-    "count": 0
+    "count": 3
   },
   {
     "type": "DCSAShippingInstructionCredential",

diff --git a/docs/openapi/components/schemas/workflows/common-import-credentials.yml b/docs/openapi/components/schemas/workflows/common-import-credentials.yml
@@ -0,0 +1,34 @@
+id: https://w3id.org/traceability/#common-import-credentials
+title: Common Import Credentials
+description: >-
+    Common credentials for an importation workflow.
+tags: 
+  - Steel
+  - Agriculture
+  - Ecommerce
+credentials: 
+  - id: https://w3id.org/traceability/#CommercialInvoiceCredential
+    name: Commercial Invoice Credential
+  - id: https://w3id.org/traceability/#CTPATCertificate
+    name: CTPAT Certificate
+  - id: https://w3id.org/traceability/#IntentToImportCredential
+    name: Intent To Import Credential
+  - id: https://w3id.org/traceability/#MultiModalBillOfLadingCredential
+    name: Multimodal Bill Of Lading Credential
+  - id: https://w3id.org/traceability/#PurchaseOrderCredential
+    name: Purchase Order Credential
+mermaid: >-
+  sequenceDiagram
+    title: Common Import Credentials
+    participant A as Importer
+    participant B as Customs Broker
+    participant C as TraceAPI
+    participant D as CBP
+    A->>C: IntentToImport
+    C->>C: Verification
+    C->>D: Authorized Data
+    A->>C: CommercialInvoice
+    A->>C: PurchaseOrder
+    B->>C: MultiModalBillOfLading
+    A->>C: CTPAT (Verify)
+    C->>D: Authorized Data
diff --git a/docs/openapi/openapi.yml b/docs/openapi/openapi.yml
@@ -3104,6 +3104,18 @@ paths:
                 $ref: './components/schemas/workflows/cbp-steel-tech-demo-2023.yml'
 
 
+  /schemas/workflows/common-import-credentials.yml:
+    get:
+      tags:
+      - workflows
+      responses:
+        '200':
+          content:
+            application/yml:
+              schema:
+                $ref: './components/schemas/workflows/common-import-credentials.yml'
+
+
   /schemas/workflows/intent-to-import.yml:
     get:
       tags:

diff --git a/docs/sections/workflows.html b/docs/sections/workflows.html
@@ -134,6 +134,63 @@ <h3>CBP Steel Tech Demo 2023</h3>
     C->>F: present Multimodal Bill Of Lading Credential</pre>
 
 
+      <h3>Common Import Credentials</h3>
+      <pre class='mermaid'>sequenceDiagram
+  title: Common Import Credentials
+  participant A as Importer
+  participant B as Customs Broker
+  participant C as TraceAPI
+  participant D as CBP
+  A->>C: IntentToImport
+  C->>C: Verification
+  C->>D: Authorized Data
+  A->>C: CommercialInvoice
+  A->>C: PurchaseOrder
+  B->>C: MultiModalBillOfLading
+  A->>C: CTPAT (Verify)
+  C->>D: Authorized Data</pre>
+      <p>Common credentials for an importation workflow.</p>
+      <b>Credentials Used:</b>
+      <ol>
+        <li><a href="https://w3id.org/traceability/#CommercialInvoiceCredential">Commercial Invoice Credential</a></li><li><a href="https://w3id.org/traceability/#CTPATCertificate">CTPAT Certificate</a></li><li><a href="https://w3id.org/traceability/#IntentToImportCredential">Intent To Import Credential</a></li><li><a href="https://w3id.org/traceability/#MultiModalBillOfLadingCredential">Multimodal Bill Of Lading Credential</a></li><li><a href="https://w3id.org/traceability/#PurchaseOrderCredential">Purchase Order Credential</a></li>
+      </ol>
+      <pre class='example yml'>id: https://w3id.org/traceability/#common-import-credentials
+title: Common Import Credentials
+description: >-
+    Common credentials for an importation workflow.
+tags: 
+  - Steel
+  - Agriculture
+  - Ecommerce
+credentials: 
+  - id: https://w3id.org/traceability/#CommercialInvoiceCredential
+    name: Commercial Invoice Credential
+  - id: https://w3id.org/traceability/#CTPATCertificate
+    name: CTPAT Certificate
+  - id: https://w3id.org/traceability/#IntentToImportCredential
+    name: Intent To Import Credential
+  - id: https://w3id.org/traceability/#MultiModalBillOfLadingCredential
+    name: Multimodal Bill Of Lading Credential
+  - id: https://w3id.org/traceability/#PurchaseOrderCredential
+    name: Purchase Order Credential
+mermaid: >-
+  sequenceDiagram
+    title: Common Import Credentials
+    participant A as Importer
+    participant B as Customs Broker
+    participant C as TraceAPI
+    participant D as CBP
+    A->>C: IntentToImport
+    C->>C: Verification
+    C->>D: Authorized Data
+    A->>C: CommercialInvoice
+    A->>C: PurchaseOrder
+    B->>C: MultiModalBillOfLading
+    A->>C: CTPAT (Verify)
+    C->>D: Authorized Data
+</pre>
+
+
       <h3>Intention to Import Workflow</h3>
       <pre class='mermaid'>sequenceDiagram
     participant A as Importer of Record