Merge pull request #181 from bci-oss/add_artifacts_to_models

Add generated artifacts to various models

io.catenax.bom_as_specified/2.0.0/gen/SingleLevelBomAsSpecified-schema.json

@@ -0,0 +1,151 @@
+{
+  "$schema" : "http://json-schema.org/draft-04/schema",
+  "description" : "The SingleLevelBomAsSpecified defines the view of the OEM or producer of the whole product, e.g. the OEM of a vehicle. It is free of any supplier-related information and specifies the promised and guaranteed content of the whole product to the end customer. This “top-down” view is in contrast to the “bottom-up” view of the SingleLevelBoMAsPlanned, though several sub-aspects are shared. The BomAsSpecified is merely one aspect, which is attached to the twin of the whole product and itself does neither introduce further twins nor reference them. Instead it merely comprises all functional information required by dismantlers, workshops or requestors for used parts to search for and to make a match on the market place.",
+  "type" : "object",
+  "components" : {
+    "schemas" : {
+      "urn_bamm_io.catenax.bom_as_specified_2.0.0_CatenaXIdTrait" : {
+        "type" : "string",
+        "description" : "The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens).",
+        "pattern" : "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)"
+      },
+      "urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text" : {
+        "type" : "string",
+        "description" : "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc."
+      },
+      "urn_bamm_io.openmanufacturing_characteristic_2.0.0_UnitReference" : {
+        "type" : "string",
+        "pattern" : "[a-zA-Z]*:[a-zA-Z]+",
+        "description" : "Describes a Property containing a reference to one of the units in the Unit Catalog."
+      },
+      "urn_bamm_io.catenax.bom_as_specified_2.0.0_NumberOfObjects" : {
+        "type" : "number",
+        "description" : "Quantifiable number of objects in reference to the measurementUnit."
+      },
+      "urn_bamm_io.catenax.bom_as_specified_2.0.0_PartQuantityCharacteristic" : {
+        "description" : "The characteristic of the part quantity.",
+        "type" : "object",
+        "properties" : {
+          "measurementUnit" : {
+            "description" : "Unit of measurement for the quantity of serialized objects.",
+            "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_UnitReference"
+          },
+          "quantityNumber" : {
+            "description" : "The number of objects related to the measurement unit.",
+            "$ref" : "#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_NumberOfObjects"
+          }
+        },
+        "required" : [ "measurementUnit", "quantityNumber", "measurementUnit", "quantityNumber" ]
+      },
+      "urn_bamm_io.catenax.bom_as_specified_2.0.0_PartClassificationEntity" : {
+        "description" : "The entity encapsulating the properties of the part classification.",
+        "type" : "object",
+        "properties" : {
+          "key" : {
+            "description" : "Key within the classification.",
+            "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"
+          },
+          "value" : {
+            "description" : "Value within the classification.",
+            "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"
+          }
+        },
+        "required" : [ "key", "value", "key", "value" ]
+      },
+      "urn_bamm_io.catenax.bom_as_specified_2.0.0_PartClassificationCharacteristic" : {
+        "description" : "The characteristic of the part classification.",
+        "type" : "array",
+        "items" : {
+          "$ref" : "#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_PartClassificationEntity"
+        },
+        "uniqueItems" : true
+      },
+      "urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp" : {
+        "type" : "string",
+        "pattern" : "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?",
+        "description" : "Describes a Property which contains the date and time with an optional timezone."
+      },
+      "urn_bamm_io.catenax.bom_as_specified_2.0.0_PartEntity" : {
+        "description" : "Entity encapsulating the properies describing a part",
+        "type" : "object",
+        "properties" : {
+          "ownerPartId" : {
+            "description" : "This is the key field of the component which usually keeps the part numbers used in after-sales, e.g. when repairing broken parts and searching for a replacement. This ownerPartId itself isn't usually bound to one part version, with the assumption that all part versions with the same ownerPartId are mutually interchangeable.",
+            "$ref" : "#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_CatenaXIdTrait"
+          },
+          "partVersion" : {
+            "description" : "This is the version of the part. The engineering will at times supercede an older part version by a newer one, which might have different material aspects, physical dimensions etc., still maintaining compatibility.",
+            "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"
+          },
+          "partQuantity" : {
+            "description" : "This is the quantity how often this part is in the item.",
+            "$ref" : "#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_PartQuantityCharacteristic"
+          },
+          "partDescription" : {
+            "description" : "The description of the part in the primary language of the production facility of the product owner.",
+            "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"
+          },
+          "partClassification" : {
+            "description" : "The part classification.",
+            "$ref" : "#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_PartClassificationCharacteristic"
+          },
+          "lastModifiedOn" : {
+            "description" : "The time the item was modified the last time",
+            "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp"
+          },
+          "createdOn" : {
+            "description" : "The time the item was created on",
+            "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp"
+          }
+        },
+        "required" : [ "ownerPartId", "ownerPartId" ]
+      },
+      "urn_bamm_io.catenax.bom_as_specified_2.0.0_PartCharacteristic" : {
+        "description" : "Characteristic of the part.",
+        "type" : "array",
+        "items" : {
+          "$ref" : "#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_PartEntity"
+        },
+        "uniqueItems" : true
+      },
+      "urn_bamm_io.catenax.bom_as_specified_2.0.0_ChildPartsEntity" : {
+        "description" : "Encapsulates the properties describing the child part item",
+        "type" : "object",
+        "properties" : {
+          "childPartsCategory" : {
+            "description" : "The BomAsSpecified defines the view of the OEM or producer of the whole product, e.g. the OEM of a vehicle. It is free of any supplier-related information and specifies the promised and guaranteed content of the whole product to the end customer. This “top-down” view is in contrast to the “bottom-up” view of the SingleLevelBoMAsPlanned, though several sub-aspects are shared. The BomAsSpecified is merely one aspect, which is attached to the twin of the whole product and itself does neither introduce further twins nor reference them. Instead it merely comprises all functional information required by dismantlers, workshops or requestors for used parts to search for and to make a match on the market place.",
+            "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"
+          },
+          "part" : {
+            "description" : "The description of the part in the primary language of the production facility of the product owner.",
+            "$ref" : "#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_PartCharacteristic"
+          },
+          "childCatenaXId" : {
+            "description" : "Describes the Catena-X ID of the child part",
+            "$ref" : "#/components/schemas/urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"
+          }
+        },
+        "required" : [ "childPartsCategory", "part", "childPartsCategory", "part", "childCatenaXId" ]
+      },
+      "urn_bamm_io.catenax.bom_as_specified_2.0.0_ChildPartsCharacteristic" : {
+        "description" : "The characteristic of the child part property",
+        "type" : "array",
+        "items" : {
+          "$ref" : "#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_ChildPartsEntity"
+        },
+        "uniqueItems" : true
+      }
+    }
+  },
+  "properties" : {
+    "catenaXId" : {
+      "description" : "A unique reference within Catena-X of this items",
+      "$ref" : "#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_CatenaXIdTrait"
+    },
+    "childParts" : {
+      "description" : "The child part of the observed parent item",
+      "$ref" : "#/components/schemas/urn_bamm_io.catenax.bom_as_specified_2.0.0_ChildPartsCharacteristic"
+    }
+  },
+  "required" : [ "catenaXId", "childParts", "catenaXId", "childParts" ]
+}

io.catenax.bom_as_specified/2.0.0/gen/SingleLevelBomAsSpecified.json

@@ -0,0 +1,22 @@
+{
+  "catenaXId" : "urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d",
+  "childParts" : [ {
+    "childPartsCategory" : "e.g. vehicle, winter wheels, bicycle rack",
+    "part" : [ {
+      "ownerPartId" : "uuid!",
+      "partVersion" : "05",
+      "partQuantity" : {
+        "quantityNumber" : 350.0,
+        "measurementUnit" : "kW"
+      },
+      "partDescription" : "The steering wheel is nice and round",
+      "partClassification" : [ {
+        "value" : "STEEWHL",
+        "key" : "BMW:PartFamily"
+      } ],
+      "createdOn" : "2022-02-03T14:48:54.709Z",
+      "lastModifiedOn" : "2022-02-03T14:48:54.709Z"
+    } ],
+    "childCatenaXId" : "urn:uuid:218b26f4-4a0b-4a7f-b2c1-d248927718bf "
+  } ]
+}