Merge pull request #872 from w3c-ccg/mtr-feedback-impl

MTR updates from industry feedback
w3c-ccg · Sep 19, 2023 · fc46ecc · fc46ecc
2 parents f9231c3 + d2ca9ab
commit fc46ecc
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 128 deletions.
diff --git a/docs/openapi/components/schemas/common/PostalAddress.yml b/docs/openapi/components/schemas/common/PostalAddress.yml
@@ -95,6 +95,13 @@ properties:
     $linkedData:
       term: postOfficeBoxNumber
       '@id': https://schema.org/postOfficeBoxNumber
+  plantOrSiteName:
+    title: Plant or Site Name
+    description: Name of Plant, Site or Unit.
+    type: string
+    $linkedData:
+      term: plantOrSiteName
+      '@id': https://vocabulary.uncefact.org/buildingName
 additionalProperties: false
 required:
   - type

diff --git a/docs/openapi/components/schemas/credentials/MillTestReportCredential.yml b/docs/openapi/components/schemas/credentials/MillTestReportCredential.yml
@@ -163,6 +163,37 @@ properties:
     description: Test results made by a manufacturer of a metal product.
     type: object
     properties:
+      certificateNumber:
+        title: Certificate Number
+        description: Mill test report certificate number.
+        type: string
+      certification:
+        title: Certification
+        description: The type of certification conducted. 
+        type: string
+      purchaseOrderNumber:
+        title: Purchase Order Number
+        description: Purchase order number. 
+        type: string
+      shipmentDate: 
+        title: Shipment Date
+        description: Date of shipping.
+        type: string
+        format: date
+        $linkedData:
+          term: shipmentDate
+          '@id': https://vocabulary.uncefact.org/DateTimePeriodFunctionCodeList#270
+      meansOfTransport: 
+        title: Means of Transport
+        description: A means of transport, expressed as text, for this transport route.
+        type: string
+        enum: 
+          - Road
+          - Rail
+          - Ocean
+        $linkedData:
+          term: meansOfTransport
+          '@id': https://vocabulary.uncefact.org/transportMeans
       customer:
         title: Customer
         description: Bill to, buyer party. 
@@ -220,6 +251,10 @@ properties:
                       type: string
                       enum:
                         - PostalAddress
+                  plantOrSiteName:
+                    title: Plant or Site Name
+                    description: Name of Plant, Site or Unit.
+                    type: string
                   streetAddress:
                     title: Street Address
                     description: >-
@@ -260,108 +295,6 @@ properties:
           - type
           - name
           - location
-      shipTo:
-        title: Ship To
-        description: The shipment's ship to party.
-        type: object
-        properties:
-          type:
-            type: array
-            readOnly: true
-            const:
-              - Organization
-            default:
-              - Organization
-            items:
-              type: string
-              enum:
-                - Organization
-          id: 
-            title: Identifier
-            description: Ship to party's identifier, typically a Decentralized Identifier (DID).
-            type: string
-            format: uri
-          name:
-            title: Name
-            description: Ship to organization's name. Conditionally mandatory if the ship to party is included. 
-            type: string
-          location:
-            title: Location
-            description: Ship to location.
-            type: object
-            properties:
-              type:
-                type: array
-                readOnly: true
-                const:
-                  - Place
-                default:
-                  - Place
-                items:
-                  type: string
-                  enum:
-                    - Place
-              address:
-                title: Postal Address
-                description: Ship to postal address.
-                type: object
-                properties:
-                  type:
-                    type: array
-                    readOnly: true
-                    const:
-                      - PostalAddress
-                    default:
-                      - PostalAddress
-                    items:
-                      type: string
-                      enum:
-                        - PostalAddress
-                  streetAddress:
-                    title: Street Address
-                    description: >-
-                      The street address expressed as free form text. The street address is
-                      printed on paper as the first lines below the name. For example, the name
-                      of the street and the number in the street or the name of a building.
-                      Conditionally mandatory if the ship to party is included. 
-                    type: string
-                  addressLocality:
-                    title: City
-                    description: >-
-                      Text specifying the name of the locality; for example, a city.
-                      Conditionally mandatory if the ship to party is included. 
-                    type: string
-                  addressRegion:
-                    title: State
-                    description: >-
-                      Text specifying a province or state in abbreviated format; for example,
-                      NJ. 
-                    type: string
-                  postalCode:
-                    title: Postal Code
-                    description: Text specifying the postal code for an address.
-                    type: string
-                  addressCountry:
-                    title: Country
-                    description: >-
-                      The two-letter ISO 3166-1 alpha-2 country code.
-                      Conditionally mandatory if the ship to party is included. 
-                    type: string
-                additionalProperties: false
-            additionalProperties: false
-        additionalProperties: false
-      certificateNumber:
-        title: Certificate Number
-        description: Mill test report certificate number.
-        type: string
-      certification:
-        title: Certification
-        description: The type of certification conducted. 
-        type: string
-      purchaseOrderNumber:
-        title: Purchase Order Number
-        description: Purchase order number. 
-        type: string
       productSpecification:
         title: Product Specification
         description: Specifications of product.
@@ -738,7 +671,7 @@ properties:
                     "@id": https://w3id.org/traceability#sn
                 nbCb:
                   title: NbCb
-                  description: Niobium (Columbium) percentage content.
+                  description: Niobium (also known as Columbium) percentage content.
                   type: number
                   $linkedData:
                     term: nbCb
@@ -1072,6 +1005,10 @@ example: |-
     },
     "issuanceDate": "2022-06-06T08:10:00+00:00",
     "credentialSubject": {
+      "certificateNumber": "202304215088",
+      "certification": "EN 10204.3.1",
+      "purchaseOrderNumber": "PO992765413",
+      "meansOfTransport": "Road",
       "customer": {
         "type": [
           "Organization"
@@ -1086,6 +1023,7 @@ example: |-
             "type": [
               "PostalAddress"
             ],
+            "plantOrSiteName": "Rise Warehouse West",
             "streetAddress": "4423 Reeves Street",
             "addressLocality": "Baileys Harbor",
             "addressRegion": "California",
@@ -1094,31 +1032,6 @@ example: |-
           }
         }
       },
-      "shipTo": {
-        "type": [
-          "Organization"
-        ],
-        "id": "did:web:rise-higher-construction.example.com",
-        "name": "Rise Higher Construction, Ltd.",
-        "location": {
-          "type": [
-            "Place"
-          ],
-          "address": {
-            "type": [
-              "PostalAddress"
-            ],
-            "streetAddress": "1988 Industry Ave.",
-            "addressLocality": "Norfolk",
-            "addressRegion": "California",
-            "postalCode": "95670",
-            "addressCountry": "US"
-          }
-        }
-      },
-      "certificateNumber": "202304215088",
-      "certification": "EN 10204.3.1",
-      "purchaseOrderNumber": "PO992765413",
       "productSpecification": {
         "type": [
           "SteelProduct"