Merge pull request #855 from w3c-ccg/workflow-id-missing-in-context

Workflow cleanup
w3c-ccg · Aug 15, 2023 · 119b713 · 119b713
2 parents f50b8e9 + bbdfc83
commit 119b713
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 92 deletions.
diff --git a/docs/index.html b/docs/index.html
@@ -1166,7 +1166,20 @@ <h4>Traceable Presentation</h4>
         </section>
 
         <section>
-          <h4>Workflow Definition</h4>
+          <h4>Workflow</h4>
+          <p>
+            A <code>TraceablePresentation</code> MAY specify a <code>workflow</code>. 
+          </p>
+          <p>
+            A <code>workflow</code> MAY reference one or more <a href="https://w3id.org/traceability#workflow-definition>">WorkflowDefinitions</a> to indicate the intention of the presentation. 
+          </p>
+          <p>
+            A <code>workflow</code> MAY reference one or more <a href="https://w3id.org/traceability#workflow-instance>">WorkflowInstances</a> to correlate multiple <code>TraceablePresentations</code>.
+          </p>
+
+
+        <section>
+          <h5>Workflow Definition</h5>
           <p>
             The sequence of industrial, administrative, or other processes
             through which a piece of work passes from initiation to completion.
@@ -1239,7 +1252,7 @@ <h4>Workflow Definition</h4>
         </section>
 
         <section>
-          <h4>Workflow Instance</h4>
+          <h5>Workflow Instance</h5>
           <p>
             Each defined workflow may be executed many times for different sets
             of inputs and among different stakeholders.
@@ -1305,6 +1318,7 @@ <h4>Workflow Instance</h4>
     }
   }
 }
+</section>
         </pre>
         </section>
         <section>

diff --git a/docs/openapi/components/schemas/common/Workflow.yml b/docs/openapi/components/schemas/common/Workflow.yml
diff --git a/docs/openapi/components/schemas/presentations/TraceablePresentation.yml b/docs/openapi/components/schemas/presentations/TraceablePresentation.yml
diff --git a/docs/openapi/openapi.yml b/docs/openapi/openapi.yml
@@ -2084,18 +2084,6 @@ paths:
                 $ref: './components/schemas/common/UsdaSc6.yml'
 
 
-  /schemas/common/Workflow.yml:
-    get:
-      tags:
-      - common
-      responses:
-        '200':
-          content:
-            application/yml:
-              schema:
-                $ref: './components/schemas/common/Workflow.yml'
-
-
   /schemas/credentials/ActivityPubActorCard.yml:
     get:
       tags:
@@ -2336,6 +2324,18 @@ paths:
                 $ref: './components/schemas/credentials/EventCredential.yml'
 
 
+  /schemas/credentials/ExampleCredentialWithStatus.yml:
+    get:
+      tags:
+      - credentials
+      responses:
+        '200':
+          content:
+            application/yml:
+              schema:
+                $ref: './components/schemas/credentials/ExampleCredentialWithStatus.yml'
+
+
   /schemas/credentials/FSMACreatingCTECredential.yml:
     get:
       tags:
@@ -2912,18 +2912,6 @@ paths:
                 $ref: './components/schemas/credentials/VerifiableScorecard.yml'
 
 
-  /schemas/presentations/TraceablePresentation.yml:
-    get:
-      tags:
-      - presentations
-      responses:
-        '200':
-          content:
-            application/yml:
-              schema:
-                $ref: './components/schemas/presentations/TraceablePresentation.yml'
-
-
   /schemas/snippets/BuyerParty.yml:
     get:
       tags:

diff --git a/packages/traceability-schemas/scripts/rootTerms.json b/packages/traceability-schemas/scripts/rootTerms.json
@@ -26,6 +26,7 @@
         "@type": "@id"
       },
       "workflow": {
+        "@id": "https://w3id.org/traceability#workflow",
         "@context": {
           "definition": {
             "@id": "https://w3id.org/traceability#workflow-definition",

diff --git a/packages/traceability-schemas/scripts/schemas-to-openapi.js b/packages/traceability-schemas/scripts/schemas-to-openapi.js
@@ -19,7 +19,6 @@ const getTagsFromDirectory = () => {
   const dirs = [
     'common',
     'credentials',
-    'presentations',
     'snippets',
     'workflows',
   ];