chore: cleanup json schemas

AggregationEvent.json

@@ -1 +1 @@
-{"type":"object","additionalProperties":false,"properties":{"parentItem":{"$ref":"#/$defs/Item","description":"The unique item identifier that is the result of this aggreation. Typcially a packaging ID used in shipments that represents a box/ pallet / container of contained items."},"childItems":{"type":"array","items":{"$ref":"#/$defs/Item"},"description":"The list of child items that have been aggreated into the parent (or disaggregated from the parent). Maybe a list of pckage referneces (eg boxes on a pallet) or may be individual items (eg products in a box)."},"childQuantityList":{"type":"array","items":{"$ref":"#/$defs/QuantityElement"},"description":"List of quantified product classes that have been aggregated into the parent.  Used whwn the child items do not have unique identifiers (eg 100 Kg of cotton bales)"},"eventID":{"x-jargon-isKey":true,"readOnly":true,"type":"string","description":"The unique identifier of this event - SHOULD be a UUID"},"eventType":{"type":"string","enum":["object","transaction","aggregation","transformation"],"example":"object","description":"The event type - object, aggregation, transformation, transaction."},"eventTime":{"type":"string","description":"The ISO-8601 date time when the event occured."},"actionCode":{"type":"string","enum":["observe","add","delete"],"example":"observe","description":"The Action type says how an event relates to the lifecycle of the entity being described. For example, AggregationEvent is used to capture events related to aggregations of objects, such as cases aggregated to a pallet. Throughout its life, the pallet load participates in many business process steps, each of which may generate an EPCIS event. The action field of each event says how the aggregation itself has changed during the event: have objects been added to the aggregation, have objects been removed from the aggregation, or has the aggregation simply been observed without change to its membership? The action is independent of the bizStep (of type BusinessStepID) which identifies the specific business process step in which the action took place.  allowed values are: - ADD (The entity in question has been created or added to.) - OBSERVE (Theentityinquestionhasnotbeenchanged:ithasneitherbeencreated,addedto,destroyed,orremovedfrom.) - DELETE (The entity in question has been removed from or destroyed altogether.)"},"dispositionCode":{"type":"string","enum":["active","expired","disposed","conformant","non_conformant","in-transit","dispensed"],"example":"active","description":"Disposition code is a vocabulary whose elements denote a business state of an object. An example is a code that denotes “recalled\". The disposition field of an event specifies the business condition of the event’s objects, subsequent to the event. The disposition is assumed to hold true until another event indicates a change of disposition. Intervening events that do not specify a disposition field have no effect on the presumed disposition of the object.  The GS1 vocabulary (CBV v2.0) defines 33 possible disposition codes but this specification restricts the options to the minimum set of values that are relevant for supply chain traceability.  "},"businessStepCode":{"type":"string","enum":["commissioning","inspecting","shipping","packing","unpacking"],"example":"commissioning","description":"BusinessStepID is a vocabulary whose elements denote steps in business processes. An example is an identifier that denotes “shipping.” The business step field of an event specifies the business context of an event: what business process step was taking place that caused the event to be captured? This specification has chosena 5 of the 41 possible bizstep values defined by GS1 that are appropriate for the sustainbility use case."},"readPointId":{"type":"string","description":"A Read Point is a discretely recorded location that is meant to identify the most specific place at which an EPCIS event took place. Read Points are determined by the EPCIS Capturing Application, perhaps inferred as a function of logical reader if stationary readers are used, perhaps determined overtly by reading a location tag if the reader is mobile, or in general determined by any other means the EPCIS Capturing Application chooses to use. Conceptually, the Read Point is designed to identify “where objects were at the time of the EPCIS event.”"},"locationId":{"type":"string","description":"A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. This specification requires the use of https://maps.google.com/pluscodes/ as geospatial identifiers rather than identifier schemes that cannot be reolved to a geogrpahic point or area."},"certification":{"type":"array","items":{"$ref":"#/$defs/CertificationInfo"},"description":"Any test result or certification related to this EPCIS event.Could be self-assessed or independent and has asssociated sustainabiloity claims from the ITC vocabulary."}},"description":"Aggregation represents an event that happened to one or more objects that are physically aggregated together (physically constrained to be in the same place at the same time, as when cases are aggregated to a pallet).  This event is also used to represent de-aggregation (eg unpacking) when businessStepCode is unpacking.","$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"Item":{"type":"object","additionalProperties":false,"properties":{"itemID":{"x-jargon-isKey":true,"type":"string","format":"uri","description":"The globally unique identifier (eg GS1 GTIN or digital link) of the product item.  "},"name":{"type":"string","description":"The name of the product class to which the product item belongs.  "}},"description":"A specific trade item /product code which could be either a product serial number or a consignment identifier "},"QuantityElement":{"type":"object","additionalProperties":false,"properties":{"productClass":{"type":"string","description":"THe identifier of a product class (as opposed to a product instance) such as a GTIN code for a manufactured product."},"quantity":{"type":"string","description":"The numeric quantity of the product class (eg 100 kg of cotton)"},"uom":{"type":"string","x-external-enumeration":"https://api.sustainability.unece.org/referenceData/unitOfMeasureCode","description":"The unit of measure for the quantity value (eg Kg or meters etc) using the UNECE Rec 20 unit of measure codelist.\n\n    This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL:  https://api.sustainability.unece.org/referenceData/unitOfMeasureCode\n    "}},"description":"The quantity elment is used to define the quantities (eg 100), units of measure (eg Kg) and product class (eg GTIN or other class identifier) of products that are inputs or outputs or the subject of supply chain events.  ","required":["quantity"]},"CertificationInfo":{"type":"object","additionalProperties":false,"properties":{"certificateID":{"x-jargon-isKey":true,"type":"string","format":"uri","description":"The ID of the certificate document"},"referenceStandard":{"type":"string","format":"uri","description":"The identifier (as a URI) of the sustainability standard against whichthe certificate is issued.  For example abvtex.org.br/v4.0"},"evidenceURL":{"type":"string","format":"uri","description":"The URL of the certificate document. For privacy and integrity reasons, it is recommended (but not required) that * the documentURL is a hashlink (https://w3c-ccg.github.io/hashlink/) so that if the document the URL is changed then the hash verification will fail.* the document is encrypted for privacy reasons and that the symmetric key for decruption is provided as a URL parameter.* the document filename is a GUID so that there is no leakage of possibly identifying information in the URL.https://domain/GUID?h1={document_hash}&key={decryption_key}For examplehttps://docstore.com/ef1e69fbbeaf47b4af97e29c69dc09cf.pdf?h1=zQmWvQxTqbG2Z9HPJgG57jjwR154cKhbtJenbyYTWkjgF3e&key=462D4A614E645267556B587032733576"},"criteriaList":{"type":"array","items":{"type":"string","format":"uri"},"description":"Optional list of specific sustainability criteria that the certificate claims are met."},"assessmentLevel":{"type":"string","enum":["self-assessed","independent-certifier"],"example":"self-assessed","description":"The integrity level of the sustainability claims. Self asssed or independently certified.  "},"responsibleAgency":{"$ref":"#/$defs/Party","description":"The issuing authority of the certificate."}},"description":"Details of a self asssessed or independently verified set of sustainability claims about a product or an establishment."},"Party":{"type":"object","additionalProperties":false,"properties":{"partyID":{"x-jargon-isKey":true,"type":"string","format":"uri","description":"The globally unique identifier of the party. This must be expressed as a URI that is (preferably) resolvable to an entity register such as a national business register - eg https://abr.business.gov.au/ABN/View?abn=41161080146 "},"name":{"type":"string","description":"The entity name of the identified party - usually the business anme from the corresponding natinal registery -eg ACME LTD"}},"description":"A trade party "}}}
+{"type":"object","additionalProperties":false,"properties":{"parentItem":{"$ref":"#/$defs/Item","description":"The unique item identifier that is the result of this aggreation. Typcially a packaging ID used in shipments that represents a box/ pallet / container of contained items."},"childItems":{"type":"array","items":{"$ref":"#/$defs/Item"},"description":"The list of child items that have been aggreated into the parent (or disaggregated from the parent). Maybe a list of pckage referneces (eg boxes on a pallet) or may be individual items (eg products in a box)."},"childQuantityList":{"type":"array","items":{"$ref":"#/$defs/QuantityElement"},"description":"List of quantified product classes that have been aggregated into the parent.  Used whwn the child items do not have unique identifiers (eg 100 Kg of cotton bales)"},"eventID":{"readOnly":true,"type":"string","description":"The unique identifier of this event - SHOULD be a UUID"},"eventType":{"type":"string","enum":["object","transaction","aggregation","transformation"],"example":"object","description":"The event type - object, aggregation, transformation, transaction."},"eventTime":{"type":"string","description":"The ISO-8601 date time when the event occured."},"actionCode":{"type":"string","enum":["observe","add","delete"],"example":"observe","description":"The Action type says how an event relates to the lifecycle of the entity being described. For example, AggregationEvent is used to capture events related to aggregations of objects, such as cases aggregated to a pallet. Throughout its life, the pallet load participates in many business process steps, each of which may generate an EPCIS event. The action field of each event says how the aggregation itself has changed during the event: have objects been added to the aggregation, have objects been removed from the aggregation, or has the aggregation simply been observed without change to its membership? The action is independent of the bizStep (of type BusinessStepID) which identifies the specific business process step in which the action took place.  allowed values are: - ADD (The entity in question has been created or added to.) - OBSERVE (Theentityinquestionhasnotbeenchanged:ithasneitherbeencreated,addedto,destroyed,orremovedfrom.) - DELETE (The entity in question has been removed from or destroyed altogether.)"},"dispositionCode":{"type":"string","enum":["active","expired","disposed","conformant","non_conformant","in-transit","dispensed"],"example":"active","description":"Disposition code is a vocabulary whose elements denote a business state of an object. An example is a code that denotes “recalled\". The disposition field of an event specifies the business condition of the event’s objects, subsequent to the event. The disposition is assumed to hold true until another event indicates a change of disposition. Intervening events that do not specify a disposition field have no effect on the presumed disposition of the object.  The GS1 vocabulary (CBV v2.0) defines 33 possible disposition codes but this specification restricts the options to the minimum set of values that are relevant for supply chain traceability.  "},"businessStepCode":{"type":"string","enum":["commissioning","inspecting","shipping","packing","unpacking"],"example":"commissioning","description":"BusinessStepID is a vocabulary whose elements denote steps in business processes. An example is an identifier that denotes “shipping.” The business step field of an event specifies the business context of an event: what business process step was taking place that caused the event to be captured? This specification has chosena 5 of the 41 possible bizstep values defined by GS1 that are appropriate for the sustainbility use case."},"readPointId":{"type":"string","description":"A Read Point is a discretely recorded location that is meant to identify the most specific place at which an EPCIS event took place. Read Points are determined by the EPCIS Capturing Application, perhaps inferred as a function of logical reader if stationary readers are used, perhaps determined overtly by reading a location tag if the reader is mobile, or in general determined by any other means the EPCIS Capturing Application chooses to use. Conceptually, the Read Point is designed to identify “where objects were at the time of the EPCIS event.”"},"locationId":{"type":"string","description":"A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. This specification requires the use of https://maps.google.com/pluscodes/ as geospatial identifiers rather than identifier schemes that cannot be reolved to a geogrpahic point or area."},"certification":{"type":"array","items":{"$ref":"#/$defs/CertificationInfo"},"description":"Any test result or certification related to this EPCIS event.Could be self-assessed or independent and has asssociated sustainabiloity claims from the ITC vocabulary."}},"description":"Aggregation represents an event that happened to one or more objects that are physically aggregated together (physically constrained to be in the same place at the same time, as when cases are aggregated to a pallet).  This event is also used to represent de-aggregation (eg unpacking) when businessStepCode is unpacking.","$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"Item":{"type":"object","additionalProperties":false,"properties":{"itemID":{"type":"string","format":"uri","description":"The globally unique identifier (eg GS1 GTIN or digital link) of the product item.  "},"name":{"type":"string","description":"The name of the product class to which the product item belongs.  "}},"description":"A specific trade item /product code which could be either a product serial number or a consignment identifier "},"QuantityElement":{"type":"object","additionalProperties":false,"properties":{"productClass":{"type":"string","description":"THe identifier of a product class (as opposed to a product instance) such as a GTIN code for a manufactured product."},"quantity":{"type":"string","description":"The numeric quantity of the product class (eg 100 kg of cotton)"},"uom":{"type":"string","x-external-enumeration":"https://api.sustainability.unece.org/referenceData/unitOfMeasureCode","description":"The unit of measure for the quantity value (eg Kg or meters etc) using the UNECE Rec 20 unit of measure codelist.\n\n    This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL:  https://api.sustainability.unece.org/referenceData/unitOfMeasureCode\n    "}},"description":"The quantity elment is used to define the quantities (eg 100), units of measure (eg Kg) and product class (eg GTIN or other class identifier) of products that are inputs or outputs or the subject of supply chain events.  ","required":["quantity"]},"CertificationInfo":{"type":"object","additionalProperties":false,"properties":{"certificateID":{"type":"string","format":"uri","description":"The ID of the certificate document"},"referenceStandard":{"type":"string","format":"uri","description":"The identifier (as a URI) of the sustainability standard against whichthe certificate is issued.  For example abvtex.org.br/v4.0"},"evidenceURL":{"type":"string","format":"uri","description":"The URL of the certificate document. For privacy and integrity reasons, it is recommended (but not required) that * the documentURL is a hashlink (https://w3c-ccg.github.io/hashlink/) so that if the document the URL is changed then the hash verification will fail.* the document is encrypted for privacy reasons and that the symmetric key for decruption is provided as a URL parameter.* the document filename is a GUID so that there is no leakage of possibly identifying information in the URL.https://domain/GUID?h1={document_hash}&key={decryption_key}For examplehttps://docstore.com/ef1e69fbbeaf47b4af97e29c69dc09cf.pdf?h1=zQmWvQxTqbG2Z9HPJgG57jjwR154cKhbtJenbyYTWkjgF3e&key=462D4A614E645267556B587032733576"},"criteriaList":{"type":"array","items":{"type":"string","format":"uri"},"description":"Optional list of specific sustainability criteria that the certificate claims are met."},"assessmentLevel":{"type":"string","enum":["self-assessed","independent-certifier"],"example":"self-assessed","description":"The integrity level of the sustainability claims. Self asssed or independently certified.  "},"responsibleAgency":{"$ref":"#/$defs/Party","description":"The issuing authority of the certificate."}},"description":"Details of a self asssessed or independently verified set of sustainability claims about a product or an establishment."},"Party":{"type":"object","additionalProperties":false,"properties":{"partyID":{"type":"string","format":"uri","description":"The globally unique identifier of the party. This must be expressed as a URI that is (preferably) resolvable to an entity register such as a national business register - eg https://abr.business.gov.au/ABN/View?abn=41161080146 "},"name":{"type":"string","description":"The entity name of the identified party - usually the business anme from the corresponding natinal registery -eg ACME LTD"}},"description":"A trade party "}}}