Merge pull request #670 from w3c-ccg/feat/SIMA-schema-refactor

chore: SIMA application/license schema changes
w3c-ccg · Jan 3, 2023 · d8b9bc6 · d8b9bc6
2 parents a421afd + 1048a14
commit d8b9bc6
Show file tree

Hide file tree

Showing 10 changed files with 16,274 additions and 16,388 deletions.
diff --git a/docs/credentials-with-undefined-terms.json b/docs/credentials-with-undefined-terms.json
@@ -65,7 +65,7 @@
   },
   {
     "type": "OrganicCertificationCredential",
-    "count": 15
+    "count": 0
   },
   {
     "type": "OrderConfirmationCredential",
@@ -225,6 +225,6 @@
   },
   {
     "type": "BankAccountCredential",
-    "count": 26
+    "count": 0
   }
 ]
diff --git a/docs/openapi/components/schemas/common/SIMASteelImportLicense.yml b/docs/openapi/components/schemas/common/SIMASteelImportLicense.yml
@@ -57,7 +57,7 @@ properties:
     $ref: ./Organization.yml
     $linkedData:
       term: manufacturer
-      '@id': https://service.unece.org/trade/uncefact/vocabulary/uncefact/#manufacturerParty  
+      '@id': https://service.unece.org/trade/uncefact/vocabulary/uncefact/#manufacturerParty
   countryOfOrigin:
     title: Country of Origin
     description: Country in which the product(s) were manufactured. The two-letter ISO 3166-1 alpha-2 country code.
@@ -79,24 +79,26 @@ properties:
     $linkedData:
       term: countryOfMeltAndPour
       '@id': https://w3id.org/traceability#countryOfMeltAndPour
-  expectedPortOfEntry: 
+  expectedPortOfEntry:
     title: Expected Port of Entry
-    description: Expected port of entry. 
+    description: Expected port of entry.
     type: string
     $linkedData:
       term: expectedPortOfEntry
       '@id': https://service.unece.org/trade/uncefact/vocabulary/uncefact/#UNECELOCODE
-  expectedDateOfExport: 
+  expectedDateOfExport:
     title: Expected Date of Export
     description: Date product(s) expected to be shipped from the country of exportation.
     type: string
+    format: date-time
     $linkedData:
       term: expectedDateOfExport
       '@id': https://service.unece.org/trade/uncefact/vocabulary/uncefact/#exportExitDateTime
-  expectedDateOfImport: 
+  expectedDateOfImport:
     title: Expected Date of Import
     description: Date product(s) expected to be shipped from the country of exportation.
     type: string
+    format: date-time
     $linkedData:
       term: expectedDateOfImport
       '@id': https://w3id.org/traceability#importDateTime
@@ -109,9 +111,10 @@ properties:
     $linkedData:
       term: productInformation
       '@id': https://w3id.org/traceability#productInformation
-additionalProperties: false  
+additionalProperties: false
 required:
   - type
+  - licenseNumber
   - applicantCompany
   - importer
   - exporter
@@ -122,7 +125,8 @@ required:
   - productInformation
 example: |-
   {
-    "type": ["SIMASteelImportLicense"], 
+    "type": ["SIMASteelImportLicense"],
+    "licenseNumber": "N75REX123",
     "applicantCompany": {
       "type": ["Organization"],
       "name": "Maxi Acero Mexicano",
@@ -222,7 +226,8 @@ example: |-
             "description": "Steel Coils"
           }
         },
+        "productCategory": "Long (Carbon and Alloy)",
         "customsValue": 4450
       }
     ]
-  }
+  }
diff --git a/docs/openapi/components/schemas/common/SIMASteelImportProductSpecifier.yml b/docs/openapi/components/schemas/common/SIMASteelImportProductSpecifier.yml
@@ -24,25 +24,26 @@ properties:
     $linkedData:
       term: steelProduct
       '@id': https://w3id.org/traceability#SteelProduct
-  productCategory: 
+  productCategory:
     title: Product Category
-    description: Category assigned to the product based on the Product HTS. This is automatically generated upon submission. 
+    description: Category assigned to the product based on the Product HTS. This is automatically generated upon submission.
     type: string
     $linkedData:
       term: productCategory
       '@id': https://w3id.org/traceability#ProductCategory
-  customsValue: 
+  customsValue:
     title: Customs Value
     description: Entered value of this product in U.S. dollars; not invoiced value (It should not include duty, brokerage fees, or freight).
     type: number
     $linkedData:
       term: customsValue
       '@id': https://schema.org/MonetaryAmount
-additionalProperties: false  
+additionalProperties: false
 required:
   - type
   - steelProduct
   - customsValue
+  - productCategory
 example: |-
   {
     "type": [
@@ -63,5 +64,6 @@ example: |-
         "description": "Steel Coils"
       }
     },
+    "productCategory": "Long (Carbon and Alloy)",
     "customsValue": 4450
-  }
+  }
diff --git a/docs/openapi/components/schemas/common/SteelProduct.yml b/docs/openapi/components/schemas/common/SteelProduct.yml
@@ -40,13 +40,6 @@ properties:
     $linkedData:
       term: grade
       '@id': https://schema.org/Rating
-  size:
-    title: Size
-    description: The size of the product
-    type: string
-    $linkedData:
-      term: size
-      '@id': https://schema.org/size
   weight:
     title: Weight
     description: The weight of the product
@@ -68,27 +61,6 @@ properties:
     $linkedData:
       term: originalCountryOfMeltAndPour
       '@id': https://schema.org/addressCountry
-  inspection:
-    title: Inspection
-    description: Observations of chemical and mechanical properties of the product
-    $ref: ./InspectionReport.yml
-    $linkedData:
-      term: inspection
-      '@id': https://w3id.org/traceability#InspectionReport
-  purchase:
-    title: Purchase
-    description: Purchase details about a product and its customer
-    $ref: ./Purchase.yml
-    $linkedData:
-      term: purchase
-      '@id': https://w3id.org/traceability#Purchase
-  shipment:
-    title: Parcel Delivery
-    description: Shipment details about a product
-    $ref: ./ParcelDelivery.yml
-    $linkedData:
-      term: shipment
-      '@id': https://schema.org/ParcelDelivery
   commodity:
     title: Commodity
     description: Product commodity code, codification system and description
@@ -117,166 +89,5 @@ example: |-
       "commodityCode": "721320",
       "commodityCodeType": "HS",
       "description": "Steel Coils"
-    },
-    "inspection": {
-      "type": ["InspectionReport"],
-      "observation": [
-        {
-          "type": ["Observation"],
-          "date": "2019-12-11T03:50:55Z",
-          "property": {
-            "type": ["MechanicalProperty"],
-            "identifier": "ISO 1352",
-            "name": "Torque-controlled fatigue testing",
-            "description": "ISO 1352:2011 specifies the conditions for performing torsional, constant-amplitude, nominally elastic stress fatigue tests on metallic specimens without deliberately introducing stress concentrations. The tests are carried out at ambient temperature (ideally at between 10 °C and 35 °C) in air by applying a pure couple to the specimen about its longitudinal axis."
-          },
-          "measurement": {
-            "type": ["MeasuredValue"],
-            "value": "00.00",
-            "unitCode": "UNKNOWN"
-          }
-        },
-        {
-          "type": ["Observation"],
-          "date": "2019-12-11T03:50:55Z",
-          "property": {
-            "type": ["ChemicalProperty"],
-            "name": "Xenon",
-            "formula": "Xe",
-            "inchi": "InChI=1S/Xe",
-            "inchikey": "FHNFHKCVQCLJFQ-UHFFFAOYSA-N"
-          },
-          "measurement": {
-            "type": ["MeasuredValue"],
-            "value": "4.4313",
-            "unitCode": "P1"
-          }
-        },
-        {
-          "type": ["Observation"],
-          "date": "2019-12-11T03:50:55Z",
-          "property": {
-            "type": ["ChemicalProperty"],
-            "name": "Neptunium",
-            "formula": "Np",
-            "inchi": "InChI=1S/Np",
-            "inchikey": "LFNLGNPSGWYGGD-UHFFFAOYSA-N"
-          },
-          "measurement": {
-            "type": ["MeasuredValue"],
-            "value": "3.2397",
-            "unitCode": "P1"
-          }
-        },
-        {
-          "type": ["Observation"],
-          "date": "2019-12-11T03:50:55Z",
-          "property": {
-            "type": ["MechanicalProperty"],
-            "identifier": "ISO 3738",
-            "name": "Rockwell Hardness Test (Scale A)",
-            "description": "The Rockwell hardness test is an empirical indentation hardness test that can provide useful information about metallic materials."
-          },
-          "measurement": {
-            "type": ["MeasuredValue"],
-            "value": "00.00",
-            "unitCode": "UNKNOWN"
-          }
-        },
-        {
-          "type": ["Observation"],
-          "date": "2019-12-11T03:50:55Z",
-          "property": {
-            "type": ["ChemicalProperty"],
-            "name": "Strontium",
-            "formula": "Sr",
-            "inchi": "InChI=1S/Sr",
-            "inchikey": "CIOAGBVUUVVLOB-UHFFFAOYSA-N"
-          },
-          "measurement": {
-            "type": ["MeasuredValue"],
-            "value": "6.4585",
-            "unitCode": "P1"
-          }
-        },
-        {
-          "type": ["Observation"],
-          "date": "2019-12-11T03:50:55Z",
-          "property": {
-            "type": ["ChemicalProperty"],
-            "name": "Lawrencium",
-            "formula": "Lr",
-            "inchi": "InChI=1S/Lr",
-            "inchikey": "CNQCVBJFEGMYDW-UHFFFAOYSA-N"
-          },
-          "measurement": {
-            "type": ["MeasuredValue"],
-            "value": "31.155",
-            "unitCode": "P1"
-          }
-        },
-        {
-          "type": ["Observation"],
-          "date": "2019-12-11T03:50:55Z",
-          "property": {
-            "type": ["MechanicalProperty"],
-            "identifier": "ISO 148",
-            "name": "Charpy Impact Strength Test",
-            "description": "ISO 148-1:2016 specifies the Charpy (V-notch and U-notch) pendulum impact test method for determining the energy absorbed in an impact test of metallic materials. This part of ISO 148 does not cover instrumented impact testing, which is specified in ISO 14556."
-          },
-          "measurement": {
-            "type": ["MeasuredValue"],
-            "value": "16.610",
-            "unitCode": "B13"
-          }
-        },
-        {
-          "type": ["Observation"],
-          "date": "2019-12-11T03:50:55Z",
-          "property": {
-            "type": ["MechanicalProperty"],
-            "identifier": "ISO 180",
-            "name": "Izod Impact Strength Test",
-            "description": "ISO 180 defines the method used for pendulums to determine the impact resistance of a plastic specimen when supported in a cantilever configuration. Test results are used to evaluate the resilience of materials, typically plastics."
-          },
-          "measurement": {
-            "type": ["MeasuredValue"],
-            "value": "43.416",
-            "unitCode": "B13"
-          }
-        },
-        {
-          "type": ["Observation"],
-          "date": "2019-12-11T03:50:55Z",
-          "property": {
-            "type": ["ChemicalProperty"],
-            "name": "Fermium",
-            "formula": "Fm",
-            "inchi": "InChI=1S/Fm",
-            "inchikey": "MIORUQGGZCBUGO-UHFFFAOYSA-N"
-          },
-          "measurement": {
-            "type": ["MeasuredValue"],
-            "value": "24.618",
-            "unitCode": "P1"
-          }
-        },
-        {
-          "type": ["Observation"],
-          "date": "2019-12-11T03:50:55Z",
-          "property": {
-            "type": ["ChemicalProperty"],
-            "name": "Xenon",
-            "formula": "Xe",
-            "inchi": "InChI=1S/Xe",
-            "inchikey": "FHNFHKCVQCLJFQ-UHFFFAOYSA-N"
-          },
-          "measurement": {
-            "type": ["MeasuredValue"],
-            "value": "30.098",
-            "unitCode": "P1"
-          }
-        }
-      ]
     }
   }
diff --git a/docs/openapi/components/schemas/credentials/MillTestReportCredential.yml b/docs/openapi/components/schemas/credentials/MillTestReportCredential.yml
@@ -691,9 +691,9 @@ example: |-
     },
     "proof": {
       "type": "Ed25519Signature2018",
-      "created": "2022-12-06T09:12:16Z",
+      "created": "2022-12-15T18:31:13Z",
       "verificationMethod": "did:key:z6MktHQo3fRRohk44dsbE76CuiTpBmyMWq2VVjvV6aBSeE3U#z6MktHQo3fRRohk44dsbE76CuiTpBmyMWq2VVjvV6aBSeE3U",
       "proofPurpose": "assertionMethod",
-      "jws": "eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..5TaDOB7DUIT27iEtmtpaXz8Se5zbagMPiw607MwNmF-ga_nbQMLBiHAzQE6a9N8YvZ6p6mAoiZhfdz9QvqqJCA"
+      "jws": "eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..wWHJUngv_uMpsFb36QEpWTfGHi-7B2wCG3qxOXzeTmr1IGJ9lUc22_EbnwCS_KS6HsL_BwFqRhHOatghOKJeDA"
     }
   }