Merge pull request #979 from w3c-ccg/update_schedule_feedback

update deliveryStatement
w3c-ccg · Oct 10, 2024 · c84c53e · c84c53e
2 parents dc8ee67 + 30c4ea9
commit c84c53e
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 17 deletions.
diff --git a/docs/openapi/components/schemas/common/DeliveryStatement.yml b/docs/openapi/components/schemas/common/DeliveryStatement.yml
@@ -38,6 +38,36 @@ properties:
     $linkedData:
       term: deliveredVolume
       '@id': https://schema.org/MeasuredValue
+  carrier:
+    title: Carrier
+    description: >-
+      The party providing the transport of goods in this consignment between
+      named points.
+    $ref: ./Organization.yml
+    $linkedData:
+      term: transporter
+      '@id': https://schema.org/agent
+  consignor:
+    title: Consignor
+    description: >-
+      The party consigning goods, as stipulated in the transport contract by the
+      party ordering transport.
+    $ref: ./Organization.yml
+    $linkedData:
+      term: consignor
+      '@id': >-
+        https://vocabulary.uncefact.org/consignorParty
+  notificationOfShipment:
+    title: Notification of Shipment Month
+    description: Year and month of the notification of shipment statement
+    type: string
+  destination:
+    title: Delivery Destination
+    description: The address to which the commodity is being shipped
+    $ref: ./Place.yml
+    $linkedData:
+      term: place
+      '@id': https://schema.org/toLocation
   observation:
     title: Observation List
     description: List of observations
@@ -47,7 +77,7 @@ properties:
     $linkedData:
       term: observation
       '@id': https://w3id.org/traceability#observation
-additionalProperties: false  
+additionalProperties: false
 required:
   - type
 example: |-

diff --git a/packages/traceability-schemas/scripts/schemas-to-vocab.js b/packages/traceability-schemas/scripts/schemas-to-vocab.js
@@ -2,7 +2,7 @@
 /* eslint-disable operator-linebreak */
 const fs = require('fs');
 const path = require('path');
-const { load } = require('js-yaml')
+const { load } = require('js-yaml');
 
 const { schemas } = require('../services/schemas');
 
@@ -25,7 +25,7 @@ const buildLinkedDataTable = (schema) => {
   if (!$linkedData) {
     return '';
   }
-  
+
   const section = `
   
   <table class="simple">
@@ -76,9 +76,9 @@ const buildClass = (schema) => {
   }
 
   const props = schema.properties ? Object.keys(schema.properties) : [];
-    let catair = ``;
-    const {$id} = schema;
-    if (schema.tags && schema.tags.includes(htmlSectionSchemaTags) ) {
+    let catair = '';
+    const { $id } = schema;
+    if (schema.tags && schema.tags.includes(htmlSectionSchemaTags)) {
       const htmlExtension = $id.split('/').pop().replace('.yml', '.html');
       catair = fs.readFileSync(path.resolve(
         __dirname,
@@ -135,22 +135,23 @@ const separateSchemas = (schemaList) => {
 };
 
 const buildWorkflowSection = () => {
-
   const files = fs.readdirSync(
     path.resolve(__dirname, '../../../docs/openapi/components/schemas/workflows')
   );
 
   const w = [];
-  files.forEach( file => {
+  files.forEach((file) => {
     const ymlText = fs.readFileSync(
       path.resolve(__dirname, `../../../docs/openapi/components/schemas/workflows/${file}`)
-    )
+    );
     const yml = load(ymlText);
-    const { title, description, credentials, mermaid } = yml;
-
-    const types = credentials.reduce( (prev, curr) => {
+    const {
+ title, description, credentials, mermaid
+} = yml;
+
+    const types = credentials.reduce((prev, curr) => {
       const { name, id } = curr;
-      const li = `<li><a href="${id}">${name}</a></li>`
+      const li = `<li><a href="${id}">${name}</a></li>`;
       return prev + li;
     }, '');
 
@@ -164,10 +165,10 @@ const buildWorkflowSection = () => {
       </ol>
       <pre class='example yml'>${ymlText}</pre>
     `);
-  })
+  });
 
   return w.join('\n');
-}
+};
 
 (() => {
   console.log('🧪 build vocab from schemas');

diff --git a/packages/traceability-tests/examples/v2.json b/packages/traceability-tests/examples/v2.json
@@ -9,7 +9,7 @@
   },
   "examples": [
     {
-      "issued": "eyJpc3MiOiJkaWQ6andrOmV5SnJkSGtpT2lKRlF5SXNJbU55ZGlJNklsQXRNemcwSWl3aVlXeG5Jam9pUlZNek9EUWlMQ0o0SWpvaU9XcHpSbEpXVm1weFNsazFTa2w1U25JMU9HZEZRblZ5YW10emFreHdUVUp2V1ZaRFpUWmxNRUo2VXpoQlV6Tk1RWGx5TjNoTGVGTm5VRTlwVUdOSFRTSXNJbmtpT2lKaWRIUk1YMlpWYTNSa2NpMU1hSGhOWTNwSmFtbDBaRnBXY0c5cGFYcHBVR2xuT0cxbk9ERmlkR1ZVVW0welFtcGFMV3c0ZFU1cWRrcExZV3RuVWpOQ0luMCIsImtpZCI6IiMwIiwiYWxnIjoiRVMzODQiLCJjdHkiOiJ2YytsZCtqc29uIn0.eyJAY29udGV4dCI6WyJodHRwczovL3d3dy53My5vcmcvMjAxOC9jcmVkZW50aWFscy92MSIsImh0dHBzOi8vd3d3LnczLm9yZy9ucy9hY3Rpdml0eXN0cmVhbXMiXSwiaWQiOiJ1cm46dXVpZDo3MTRjZmQ3My1jNTJlLTRiYTgtOTM5Mi03MDYyZTY1NDAwODgiLCJ0eXBlIjpbIlZlcmlmaWFibGVDcmVkZW50aWFsIiwiQWN0aXZpdHlQdWJBY3RvckNhcmQiXSwiY3JlZGVudGlhbFNjaGVtYSI6eyJpZCI6Imh0dHBzOi8vdzNjLWNjZy5naXRodWIuaW8vdHJhY2VhYmlsaXR5LXZvY2FiL29wZW5hcGkvY29tcG9uZW50cy9zY2hlbWFzL2NyZWRlbnRpYWxzL0FjdGl2aXR5UHViQWN0b3JDYXJkLnltbCIsInR5cGUiOiJKc29uU2NoZW1hIn0sImlzc3VhbmNlRGF0ZSI6IjIwMjMtMDUtMjFUMTU6Mzk6NTcuOTQ0WiIsImlzc3VlciI6eyJpZCI6ImRpZDpqd2s6ZXlKcmRIa2lPaUpGUXlJc0ltTnlkaUk2SWxBdE16ZzBJaXdpWVd4bklqb2lSVk16T0RRaUxDSjRJam9pT1dwelJsSldWbXB4U2xrMVNrbDVTbkkxT0dkRlFuVnlhbXR6YWt4d1RVSnZXVlpEWlRabE1FSjZVemhCVXpOTVFYbHlOM2hMZUZOblVFOXBVR05IVFNJc0lua2lPaUppZEhSTVgyWlZhM1JrY2kxTWFIaE5ZM3BKYW1sMFpGcFdjRzlwYVhwcFVHbG5PRzFuT0RGaWRHVlVVbTB6UW1wYUxXdzRkVTVxZGtwTFlXdG5Vak5DSW4wIn0sImNyZWRlbnRpYWxTdWJqZWN0Ijp7InR5cGUiOlsiUGVyc29uIl0sImlkIjoiaHR0cHM6Ly9rZW56b2lzaGlpLmV4YW1wbGUuY29tLyIsImZvbGxvd2luZyI6Imh0dHBzOi8va2Vuem9pc2hpaS5leGFtcGxlLmNvbS9mb2xsb3dpbmcuanNvbiIsImZvbGxvd2VycyI6Imh0dHBzOi8va2Vuem9pc2hpaS5leGFtcGxlLmNvbS9mb2xsb3dlcnMuanNvbiIsImxpa2VkIjoiaHR0cHM6Ly9rZW56b2lzaGlpLmV4YW1wbGUuY29tL2xpa2VkLmpzb24iLCJpbmJveCI6Imh0dHBzOi8va2Vuem9pc2hpaS5leGFtcGxlLmNvbS9pbmJveC5qc29uIiwib3V0Ym94IjoiaHR0cHM6Ly9rZW56b2lzaGlpLmV4YW1wbGUuY29tL2ZlZWQuanNvbiIsInByZWZlcnJlZFVzZXJuYW1lIjoia2Vuem9pc2hpaSIsIm5hbWUiOiLnn7PkupXlgaXolLUiLCJzdW1tYXJ5Ijoi44GT44Gu5pa544Gv44Gf44Gg44Gu5L6L44Gn44GZIiwiaWNvbiI6WyJodHRwczovL2tlbnpvaXNoaWkuZXhhbXBsZS5jb20vaW1hZ2UvMTY1OTg3YWtscmU0Il19fQ.M9HzYIyhpbDbBHh1eVu1PTZqS5Uc5-DWOP3w5ZCnuKlC8OeyffZKBmdIknn47Wn1pR5PkPxun1iKa1h0alh4SDjwNZucsl_YnjTn3pgnHnmIFiTqUjrLQTpRsUcM-jge",
+      "issued": "eyJpc3MiOiJkaWQ6andrOmV5SnJkSGtpT2lKRlF5SXNJbU55ZGlJNklsQXRNemcwSWl3aVlXeG5Jam9pUlZNek9EUWlMQ0o0SWpvaU9XcHpSbEpXVm1weFNsazFTa2w1U25JMU9HZEZRblZ5YW10emFreHdUVUp2V1ZaRFpUWmxNRUo2VXpoQlV6Tk1RWGx5TjNoTGVGTm5VRTlwVUdOSFRTSXNJbmtpT2lKaWRIUk1YMlpWYTNSa2NpMU1hSGhOWTNwSmFtbDBaRnBXY0c5cGFYcHBVR2xuT0cxbk9ERmlkR1ZVVW0welFtcGFMV3c0ZFU1cWRrcExZV3RuVWpOQ0luMCIsImtpZCI6IiMwIiwiYWxnIjoiRVMzODQiLCJjdHkiOiJ2YytsZCtqc29uIn0.eyJAY29udGV4dCI6WyJodHRwczovL3d3dy53My5vcmcvMjAxOC9jcmVkZW50aWFscy92MSIsImh0dHBzOi8vd3d3LnczLm9yZy9ucy9hY3Rpdml0eXN0cmVhbXMiXSwiaWQiOiJ1cm46dXVpZDo4YTMyMjdkNC1kZmFmLTQ2MGMtOGY2My1lZDRhODAyY2UzNjIiLCJ0eXBlIjpbIlZlcmlmaWFibGVDcmVkZW50aWFsIiwiQWN0aXZpdHlQdWJBY3RvckNhcmQiXSwiY3JlZGVudGlhbFNjaGVtYSI6eyJpZCI6Imh0dHBzOi8vdzNjLWNjZy5naXRodWIuaW8vdHJhY2VhYmlsaXR5LXZvY2FiL29wZW5hcGkvY29tcG9uZW50cy9zY2hlbWFzL2NyZWRlbnRpYWxzL0FjdGl2aXR5UHViQWN0b3JDYXJkLnltbCIsInR5cGUiOiJKc29uU2NoZW1hIn0sImlzc3VhbmNlRGF0ZSI6IjIwMjMtMDUtMjFUMTU6Mzk6NTcuOTQ0WiIsImlzc3VlciI6eyJpZCI6ImRpZDpqd2s6ZXlKcmRIa2lPaUpGUXlJc0ltTnlkaUk2SWxBdE16ZzBJaXdpWVd4bklqb2lSVk16T0RRaUxDSjRJam9pT1dwelJsSldWbXB4U2xrMVNrbDVTbkkxT0dkRlFuVnlhbXR6YWt4d1RVSnZXVlpEWlRabE1FSjZVemhCVXpOTVFYbHlOM2hMZUZOblVFOXBVR05IVFNJc0lua2lPaUppZEhSTVgyWlZhM1JrY2kxTWFIaE5ZM3BKYW1sMFpGcFdjRzlwYVhwcFVHbG5PRzFuT0RGaWRHVlVVbTB6UW1wYUxXdzRkVTVxZGtwTFlXdG5Vak5DSW4wIn0sImNyZWRlbnRpYWxTdWJqZWN0Ijp7InR5cGUiOlsiUGVyc29uIl0sImlkIjoiaHR0cHM6Ly9rZW56b2lzaGlpLmV4YW1wbGUuY29tLyIsImZvbGxvd2luZyI6Imh0dHBzOi8va2Vuem9pc2hpaS5leGFtcGxlLmNvbS9mb2xsb3dpbmcuanNvbiIsImZvbGxvd2VycyI6Imh0dHBzOi8va2Vuem9pc2hpaS5leGFtcGxlLmNvbS9mb2xsb3dlcnMuanNvbiIsImxpa2VkIjoiaHR0cHM6Ly9rZW56b2lzaGlpLmV4YW1wbGUuY29tL2xpa2VkLmpzb24iLCJpbmJveCI6Imh0dHBzOi8va2Vuem9pc2hpaS5leGFtcGxlLmNvbS9pbmJveC5qc29uIiwib3V0Ym94IjoiaHR0cHM6Ly9rZW56b2lzaGlpLmV4YW1wbGUuY29tL2ZlZWQuanNvbiIsInByZWZlcnJlZFVzZXJuYW1lIjoia2Vuem9pc2hpaSIsIm5hbWUiOiLnn7PkupXlgaXolLUiLCJzdW1tYXJ5Ijoi44GT44Gu5pa544Gv44Gf44Gg44Gu5L6L44Gn44GZIiwiaWNvbiI6WyJodHRwczovL2tlbnpvaXNoaWkuZXhhbXBsZS5jb20vaW1hZ2UvMTY1OTg3YWtscmU0Il19fQ.gJ8EKG76Hwr58HsuXb-gtQ-auU0V3gRbYuHFPflaUI-XqEcGPTbhrcGsbgZM8rdmA3HuAHBFhdgKMq3BbDQHTOy3WYJ0W5Agcu_FEyJi7ti1otc7jh9IY8P-NvcBdORQ",
       "verified": {
         "protectedHeader": {
           "iss": "did:jwk:eyJrdHkiOiJFQyIsImNydiI6IlAtMzg0IiwiYWxnIjoiRVMzODQiLCJ4IjoiOWpzRlJWVmpxSlk1Skl5SnI1OGdFQnVyamtzakxwTUJvWVZDZTZlMEJ6UzhBUzNMQXlyN3hLeFNnUE9pUGNHTSIsInkiOiJidHRMX2ZVa3Rkci1MaHhNY3pJaml0ZFpWcG9paXppUGlnOG1nODFidGVUUm0zQmpaLWw4dU5qdkpLYWtnUjNCIn0",
@@ -22,7 +22,7 @@
             "https://www.w3.org/2018/credentials/v1",
             "https://www.w3.org/ns/activitystreams"
           ],
-          "id": "urn:uuid:714cfd73-c52e-4ba8-9392-7062e6540088",
+          "id": "urn:uuid:8a3227d4-dfaf-460c-8f63-ed4a802ce362",
           "type": [
             "VerifiableCredential",
             "ActivityPubActorCard"