Add DCM API definitions into Kit structure

docs-kits/kits/DCM-Kit/Software-Development-View/_category_.json

@@ -0,0 +1,4 @@
+{
+    "label": "Software Development View"
+}
+

docs-kits/kits/DCM-Kit/Software-Development-View/receive-comment-information.api.mdx

@@ -0,0 +1,62 @@
+---
+id: receive-comment-information
+title: "Receive comment information"
+description: "Endpoint of an internal application responsible for recieving comment information from a Catena-X partner. This endpoint must be called via EDC Asset definition."
+sidebar_label: "Receive comment information"
+hide_title: true
+hide_table_of_contents: true
+api: {"description":"Endpoint of an internal application responsible for recieving comment information from a Catena-X partner. This endpoint must be called via EDC Asset definition.","requestBody":{"description":"This request body defines the payload with it's mandatory and optional properties that must be sent to this endpoint.","required":true,"content":{"application/json":{"schema":{"description":"Aspect model for an exchange of comment belonging to a entity.","type":"object","properties":{"commentId":{"description":"The Comment ID uniquely identifies the entity within the business relationship between a customer and its supplier.","type":"string","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}$)"},"objectId":{"description":"The ID of the object to which the comment belongs.","type":"string","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}$)"},"author":{"description":"The E-Mail address of the creator who wrote the comment. In case comment creator wants to stay anonymous, show BPNL in app which is sent the comment along.","type":"string"},"postedAt":{"description":"Point in time when the comment was created.","type":"string","format":"date-time"},"changedAt":{"description":"Point in time when the comment was last changed.","type":"string","format":"date-time"},"commentText":{"description":"Text up to 5.000 characters in format \"UTF-8\" will be shared.","type":"string","pattern":"^[\\s\\S]{0,5000}$"},"commentType":{"description":"Type of a comment to indicate a priority.","type":"string","enum":["information","warning","default","actionRequired"]},"requestDelete":{"description":"Indicates that the deletion of the comment is requested by sender incl. all of it's history.","type":"boolean"},"listOfReferenceDates":{"description":"Point in time the comment belongs to.","type":"array","items":{"type":"string","format":"date"},"uniqueItems":true},"objectType":{"description":"Aspect Model which the comment refers to. The value MUST consist of the Catena-X aspect model unique identifier of the referenced data model without a version.","type":"string"},"customer":{"description":"The Business Partner Number Legal Entity (BPNL) of the party requesting materials from a supplier.","type":"string","pattern":"^BPNL[0-9]{8}[a-zA-Z0-9]{4}$"},"supplier":{"description":"The Business Partner Number Legal Entity (BPNL) of the party providing materials to a customer.","type":"string","pattern":"^BPNL[0-9]{8}[a-zA-Z0-9]{4}$"}},"required":["commentId","objectId","objectType","customer","supplier"]}}}},"tags":["IdBasedComment"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"405":{"description":"Method not allowed"},"422":{"description":"Unprocessable Entity"},"503":{"description":"Service Unavailable"}},"method":"post","path":"/internal-dcm-application-comment-post-endpoint","jsonRequestBodyExample":{"commentId":"string","objectId":"string","author":"string","postedAt":"2024-02-13","changedAt":"2024-02-13","commentText":"string","commentType":"information","requestDelete":true,"listOfReferenceDates":["2024-02-13"],"objectType":"string","customer":"string","supplier":"string"},"info":{"title":"Id Based Comment","version":"v1"},"postman":{"name":"Receive comment information","description":{"content":"Endpoint of an internal application responsible for recieving comment information from a Catena-X partner. This endpoint must be called via EDC Asset definition.","type":"text/plain"},"url":{"path":["internal-dcm-application-comment-post-endpoint"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}}
+sidebar_class_name: "post api-method"
+info_path: docs-kits/kits/DCM-Kit/Software-Development-View//id-based-comment
+custom_edit_url: null
+---
+
+import ApiTabs from "@theme/ApiTabs";
+import MimeTabs from "@theme/MimeTabs";
+import ParamsItem from "@theme/ParamsItem";
+import ResponseSamples from "@theme/ResponseSamples";
+import SchemaItem from "@theme/SchemaItem";
+import SchemaTabs from "@theme/SchemaTabs";
+import DiscriminatorTabs from "@theme/DiscriminatorTabs";
+import TabItem from "@theme/TabItem";
+
+## Receive comment information
+
+
+
+Endpoint of an internal application responsible for recieving comment information from a Catena-X partner. This endpoint must be called via EDC Asset definition.
+
+<MimeTabs><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Request Body</strong><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
+
+This request body defines the payload with it's mandatory and optional properties that must be sent to this endpoint.
+
+</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"commentId"} required={true} deprecated={undefined} schemaDescription={"The Comment ID uniquely identifies the entity within the business relationship between a customer and its supplier."} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `(^[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}$)`"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} deprecated={undefined} schemaDescription={"The ID of the object to which the comment belongs."} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `(^[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}$)`"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"author"} required={false} deprecated={undefined} schemaDescription={"The E-Mail address of the creator who wrote the comment. In case comment creator wants to stay anonymous, show BPNL in app which is sent the comment along."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"postedAt"} required={false} deprecated={undefined} schemaDescription={"Point in time when the comment was created."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"changedAt"} required={false} deprecated={undefined} schemaDescription={"Point in time when the comment was last changed."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"commentText"} required={false} deprecated={undefined} schemaDescription={"Text up to 5.000 characters in format \"UTF-8\" will be shared."} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `^[\\s\\S]{0,5000}$`"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"commentType"} required={false} deprecated={undefined} schemaDescription={"Type of a comment to indicate a priority."} schemaName={"string"} qualifierMessage={"**Possible values:** [`information`, `warning`, `default`, `actionRequired`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"requestDelete"} required={false} deprecated={undefined} schemaDescription={"Indicates that the deletion of the comment is requested by sender incl. all of it's history."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"listOfReferenceDates"} required={false} deprecated={undefined} schemaDescription={"Point in time the comment belongs to."} schemaName={"date[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={true} deprecated={undefined} schemaDescription={"Aspect Model which the comment refers to. The value MUST consist of the Catena-X aspect model unique identifier of the referenced data model without a version."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"customer"} required={true} deprecated={undefined} schemaDescription={"The Business Partner Number Legal Entity (BPNL) of the party requesting materials from a supplier."} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `^BPNL[0-9]{8}[a-zA-Z0-9]{4}$`"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"supplier"} required={true} deprecated={undefined} schemaDescription={"The Business Partner Number Legal Entity (BPNL) of the party providing materials to a customer."} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `^BPNL[0-9]{8}[a-zA-Z0-9]{4}$`"} defaultValue={undefined}></SchemaItem></ul></details></TabItem></MimeTabs><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
+
+OK
+
+</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
+
+Bad request
+
+</div><div></div></TabItem><TabItem label={"401"} value={"401"}><div>
+
+Unauthorized
+
+</div><div></div></TabItem><TabItem label={"403"} value={"403"}><div>
+
+Forbidden
+
+</div><div></div></TabItem><TabItem label={"405"} value={"405"}><div>
+
+Method not allowed
+
+</div><div></div></TabItem><TabItem label={"422"} value={"422"}><div>
+
+Unprocessable Entity
+
+</div><div></div></TabItem><TabItem label={"503"} value={"503"}><div>
+
+Service Unavailable
+
+</div><div></div></TabItem></ApiTabs></div>
+

docs-kits/kits/DCM-Kit/Software-Development-View/receive-request-for-update-information.api.mdx

@@ -0,0 +1,72 @@
+---
+id: receive-request-for-update-information
+title: "Receive request for update information"
+description: "Endpoint of an internal application responsible for recieving request for update information from a Catena-X partner. This endpoint must be called via EDC Asset definition."
+sidebar_label: "Receive request for update information"
+hide_title: true
+hide_table_of_contents: true
+api: {"description":"Endpoint of an internal application responsible for recieving request for update information from a Catena-X partner. This endpoint must be called via EDC Asset definition.","requestBody":{"description":"This request body defines the payload with it's mandatory and optional properties that must be sent to this endpoint.","required":true,"content":{"application/json":{"schema":{"description":"The requirements for a request for update from another Catena-X Partner of a specific entity.\nIf within the payload, no specific object type is defined (Payload empty), than an update of all objects within the sender reciever relation is requested).","type":"object","properties":{"materialDemand":{"description":"Material demands the supplier requests an update for.\nIf within the array, no specific ID (array empty), than an update of all IDs is requested).","type":"array","items":{"description":"Encapsulates the information that is necessary for an update request.","type":"object","properties":{"materialDemandId":{"description":"The Material Demand ID uniquely identifies the material demand the supplier requests an update for within the business relationship between the customer and its supplier.","type":"string","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}$)"},"changedAt":{"description":"Point in time of the last update known to the requesting business partner. If the requested entity has been changed more recently, the requested party should resend the data. If the changedAt property is not given, the latest entity should be send without precondition.","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))?"}},"required":["materialDemandId"]},"uniqueItems":true},"weekBasedCapacityGroup":{"description":"Capacity groups the customer requests an update for.\nIf within the array, no specific ID (array empty), than an update of all IDs is requested).","type":"array","items":{"description":"Encapsulates the information that is necessary for an update request.","type":"object","properties":{"capacityGroupId":{"description":"The Capacity Group ID uniquely identifies the capacity group the supplier requests an update for within the business relationship between the supplier and its customer.","type":"string","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}$)"},"changedAt":{"description":"Point in time of the last update known to the requesting business partner. If the requested entity has been changed more recently, the requested party should resend the data. If the changedAt property is not given, the latest entity should be send without precondition.","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))?"}},"required":["capacityGroupId"]},"uniqueItems":true}}}}}},"tags":["IdBasedRequestForUpdate"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"405":{"description":"Method not allowed"},"422":{"description":"Unprocessable Entity"},"503":{"description":"Service Unavailable"}},"method":"post","path":"/internal-dcm-application-request-for-update-post-endpoint","jsonRequestBodyExample":{"materialDemand":[{"materialDemandId":"string","changedAt":"string"}],"weekBasedCapacityGroup":[{"capacityGroupId":"string","changedAt":"string"}]},"info":{"title":"ID Based Request For Update","version":"v2"},"postman":{"name":"Receive request for update information","description":{"content":"Endpoint of an internal application responsible for recieving request for update information from a Catena-X partner. This endpoint must be called via EDC Asset definition.","type":"text/plain"},"url":{"path":["internal-dcm-application-request-for-update-post-endpoint"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}}
+sidebar_class_name: "post api-method"
+info_path: docs-kits/kits/DCM-Kit/Software-Development-View//id-based-request-for-update
+custom_edit_url: null
+---
+
+import ApiTabs from "@theme/ApiTabs";
+import MimeTabs from "@theme/MimeTabs";
+import ParamsItem from "@theme/ParamsItem";
+import ResponseSamples from "@theme/ResponseSamples";
+import SchemaItem from "@theme/SchemaItem";
+import SchemaTabs from "@theme/SchemaTabs";
+import DiscriminatorTabs from "@theme/DiscriminatorTabs";
+import TabItem from "@theme/TabItem";
+
+## Receive request for update information
+
+
+
+Endpoint of an internal application responsible for recieving request for update information from a Catena-X partner. This endpoint must be called via EDC Asset definition.
+
+<MimeTabs><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Request Body</strong><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
+
+This request body defines the payload with it's mandatory and optional properties that must be sent to this endpoint.
+
+</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>materialDemand</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
+
+Material demands the supplier requests an update for.
+If within the array, no specific ID (array empty), than an update of all IDs is requested).
+
+</div><SchemaItem collapsible={false} name={"materialDemandId"} required={true} deprecated={undefined} schemaDescription={"The Material Demand ID uniquely identifies the material demand the supplier requests an update for within the business relationship between the customer and its supplier."} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `(^[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}$)`"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"changedAt"} required={false} deprecated={undefined} schemaDescription={"Point in time of the last update known to the requesting business partner. If the requested entity has been changed more recently, the requested party should resend the data. If the changedAt property is not given, the latest entity should be send without precondition."} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `-?([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))?`"} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>weekBasedCapacityGroup</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
+
+Capacity groups the customer requests an update for.
+If within the array, no specific ID (array empty), than an update of all IDs is requested).
+
+</div><SchemaItem collapsible={false} name={"capacityGroupId"} required={true} deprecated={undefined} schemaDescription={"The Capacity Group ID uniquely identifies the capacity group the supplier requests an update for within the business relationship between the supplier and its customer."} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `(^[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}$)`"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"changedAt"} required={false} deprecated={undefined} schemaDescription={"Point in time of the last update known to the requesting business partner. If the requested entity has been changed more recently, the requested party should resend the data. If the changedAt property is not given, the latest entity should be send without precondition."} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `-?([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))?`"} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
+
+OK
+
+</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
+
+Bad request
+
+</div><div></div></TabItem><TabItem label={"401"} value={"401"}><div>
+
+Unauthorized
+
+</div><div></div></TabItem><TabItem label={"403"} value={"403"}><div>
+
+Forbidden
+
+</div><div></div></TabItem><TabItem label={"405"} value={"405"}><div>
+
+Method not allowed
+
+</div><div></div></TabItem><TabItem label={"422"} value={"422"}><div>
+
+Unprocessable Entity
+
+</div><div></div></TabItem><TabItem label={"503"} value={"503"}><div>
+
+Service Unavailable
+
+</div><div></div></TabItem></ApiTabs></div>
+

docusaurus.config.js

@@ -333,6 +333,42 @@ const config = {
               groupPathsBy: 'tag',
             },
           },
+          dcm_material_demand: {
+            specPath:
+              './openApi/resiliency/dcm/MaterialDemand.yaml', // Path to designated spec file
+            outputDir:
+              './docs-kits/kits/DCM-Kit/Software-Development-View/', // Output directory for generated .mdx docs
+            sidebarOptions: {
+              groupPathsBy: 'tag',
+            },
+          },
+          dcm_week_based_capacity_group: {
+            specPath:
+              './openApi/resiliency/dcm/WeekBasedCapacityGroup.yaml', // Path to designated spec file
+            outputDir:
+              './docs-kits/kits/DCM-Kit/Software-Development-View/', // Output directory for generated .mdx docs
+            sidebarOptions: {
+              groupPathsBy: 'tag',
+            },
+          },
+          dcm_request_for_update: {
+            specPath:
+              './openApi/resiliency/dcm/IdBasedRequestForUpdate.yaml', // Path to designated spec file
+            outputDir:
+              './docs-kits/kits/DCM-Kit/Software-Development-View/', // Output directory for generated .mdx docs
+            sidebarOptions: {
+              groupPathsBy: 'tag',
+            },
+          },
+          dcm_comment: {
+            specPath:
+              './openApi/resiliency/dcm/IdBasedComment.yaml', // Path to designated spec file
+            outputDir:
+              './docs-kits/kits/DCM-Kit/Software-Development-View/', // Output directory for generated .mdx docs
+            sidebarOptions: {
+              groupPathsBy: 'tag',
+            },
+          },
         },
       },
     ],

openApi/resiliency/dcm/IdBasedComment.yaml

@@ -0,0 +1,138 @@
+---
+openapi: 3.0.3
+info:
+  title: Id Based Comment
+  version: v1
+paths:
+  /internal-dcm-application-comment-post-endpoint:
+    post:
+      summary: Receive comment information
+      description: Endpoint of an internal application responsible for recieving comment information from a Catena-X partner. This endpoint must be called via EDC Asset definition.
+      requestBody:
+        $ref: '#/components/requestBodies/IdBasedComment'
+      tags:
+      - IdBasedComment
+      responses:
+        "200":
+          description: OK
+        "400":
+          description: Bad request
+        "401":
+          description: Unauthorized
+        "403":
+          description: Forbidden
+        "405":
+          description: Method not allowed
+        "422":
+          description: Unprocessable Entity
+        "503":
+          description: Service Unavailable
+components:
+  schemas:
+    urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait:
+      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),\
+        \ optionally prefixed by \"urn:uuid:\" to make it an IRI."
+      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_samm_io.catenax.id_based_comment_1.0.0_AuthorCharacteristic:
+      type: string
+      description: Characteristic for an E-Mail or a BPNL
+    urn_samm_io.catenax.id_based_comment_1.0.0_Timestamp:
+      type: string
+      format: date-time
+      description: Point in time.
+    urn_samm_io.catenax.id_based_comment_1.0.0_CommentTrait:
+      type: string
+      description: The provided regular expression ensures that the text of a comment
+        is limited to the maximum length of 5.000 characters.
+      pattern: "^[\\s\\S]{0,5000}$"
+    urn_samm_io.catenax.id_based_comment_1.0.0_CommentTypeCharacteristic:
+      type: string
+      description: The classification of a comment.
+      enum:
+      - information
+      - warning
+      - default
+      - actionRequired
+    urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean:
+      type: boolean
+      description: Represents a boolean value (i.e. a "flag").
+    urn_samm_io.catenax.id_based_comment_1.0.0_ListOfReferenceDatesCharacteristic:
+      description: Point in time.
+      type: array
+      items:
+        type: string
+        format: date
+      uniqueItems: true
+    urn_samm_io.catenax.id_based_comment_1.0.0_ObjectTypeCharacteristic:
+      type: string
+      description: Defining a string value for the objectType.
+    urn_samm_io.catenax.shared.business_partner_number_1.0.0_BpnlTrait:
+      type: string
+      description: "The provided regular expression ensures that the BPNL is composed\
+        \ of prefix 'BPNL', 10 digits and two uppercase letters."
+      pattern: "^BPNL[0-9]{8}[a-zA-Z0-9]{4}$"
+    IdBasedComment:
+      description: Aspect model for an exchange of comment belonging to a entity.
+      type: object
+      properties:
+        commentId:
+          description: The Comment ID uniquely identifies the entity within the business
+            relationship between a customer and its supplier.
+          $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait'
+        objectId:
+          description: The ID of the object to which the comment belongs.
+          $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait'
+        author:
+          description: "The E-Mail address of the creator who wrote the comment. In\
+            \ case comment creator wants to stay anonymous, show BPNL in app which\
+            \ is sent the comment along."
+          $ref: '#/components/schemas/urn_samm_io.catenax.id_based_comment_1.0.0_AuthorCharacteristic'
+        postedAt:
+          description: Point in time when the comment was created.
+          $ref: '#/components/schemas/urn_samm_io.catenax.id_based_comment_1.0.0_Timestamp'
+        changedAt:
+          description: Point in time when the comment was last changed.
+          $ref: '#/components/schemas/urn_samm_io.catenax.id_based_comment_1.0.0_Timestamp'
+        commentText:
+          description: Text up to 5.000 characters in format "UTF-8" will be shared.
+          $ref: '#/components/schemas/urn_samm_io.catenax.id_based_comment_1.0.0_CommentTrait'
+        commentType:
+          description: Type of a comment to indicate a priority.
+          $ref: '#/components/schemas/urn_samm_io.catenax.id_based_comment_1.0.0_CommentTypeCharacteristic'
+        requestDelete:
+          description: Indicates that the deletion of the comment is requested by
+            sender incl. all of it's history.
+          $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean'
+        listOfReferenceDates:
+          description: Point in time the comment belongs to.
+          $ref: '#/components/schemas/urn_samm_io.catenax.id_based_comment_1.0.0_ListOfReferenceDatesCharacteristic'
+        objectType:
+          description: Aspect Model which the comment refers to. The value MUST consist
+            of the Catena-X aspect model unique identifier of the referenced data
+            model without a version.
+          $ref: '#/components/schemas/urn_samm_io.catenax.id_based_comment_1.0.0_ObjectTypeCharacteristic'
+        customer:
+          description: The Business Partner Number Legal Entity (BPNL) of the party
+            requesting materials from a supplier.
+          $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_1.0.0_BpnlTrait'
+        supplier:
+          description: The Business Partner Number Legal Entity (BPNL) of the party
+            providing materials to a customer.
+          $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_1.0.0_BpnlTrait'
+      required:
+      - commentId
+      - objectId
+      - objectType
+      - customer
+      - supplier
+  requestBodies:
+    IdBasedComment:
+      description: This request body defines the payload with it's mandatory and optional properties that must be sent to this endpoint.
+      required: true
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/IdBasedComment'

openApi/resiliency/dcm/IdBasedRequestForUpdate.yaml

@@ -0,0 +1,116 @@
+---
+openapi: 3.0.3
+info:
+  title: ID Based Request For Update
+  version: v2
+paths:
+  /internal-dcm-application-request-for-update-post-endpoint:
+    post:
+      summary: Receive request for update information
+      description: Endpoint of an internal application responsible for recieving request for update information from a Catena-X partner. This endpoint must be called via EDC Asset definition.
+      requestBody:
+        $ref: '#/components/requestBodies/IdBasedRequestForUpdate'
+      tags:
+      - IdBasedRequestForUpdate
+      responses:
+        "200":
+          description: OK
+        "400":
+          description: Bad request
+        "401":
+          description: Unauthorized
+        "403":
+          description: Forbidden
+        "405":
+          description: Method not allowed
+        "422":
+          description: Unprocessable Entity
+        "503":
+          description: Service Unavailable
+components:
+  schemas:
+    urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait:
+      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),\
+        \ optionally prefixed by \"urn:uuid:\" to make it an IRI."
+      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_samm_io.catenax.id_based_request_for_update_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_samm_io.catenax.id_based_request_for_update_2.0.0_MaterialDemandEntity:
+      description: Encapsulates the information that is necessary for an update request.
+      type: object
+      properties:
+        materialDemandId:
+          description: The Material Demand ID uniquely identifies the material demand
+            the supplier requests an update for within the business relationship between
+            the customer and its supplier.
+          $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait'
+        changedAt:
+          description: "Point in time of the last update known to the requesting business\
+            \ partner. If the requested entity has been changed more recently, the\
+            \ requested party should resend the data. If the changedAt property is\
+            \ not given, the latest entity should be send without precondition."
+          $ref: '#/components/schemas/urn_samm_io.catenax.id_based_request_for_update_2.0.0_Timestamp'
+      required:
+      - materialDemandId
+    urn_samm_io.catenax.id_based_request_for_update_2.0.0_MaterialDemandCharacteristic:
+      description: A list of material demand UUIDs without duplicates an update is
+        requested for.
+      type: array
+      items:
+        $ref: '#/components/schemas/urn_samm_io.catenax.id_based_request_for_update_2.0.0_MaterialDemandEntity'
+      uniqueItems: true
+    urn_samm_io.catenax.id_based_request_for_update_2.0.0_WeekBasedCapacityGroupEntity:
+      description: Encapsulates the information that is necessary for an update request.
+      type: object
+      properties:
+        capacityGroupId:
+          description: The Capacity Group ID uniquely identifies the capacity group
+            the supplier requests an update for within the business relationship between
+            the supplier and its customer.
+          $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait'
+        changedAt:
+          description: "Point in time of the last update known to the requesting business\
+            \ partner. If the requested entity has been changed more recently, the\
+            \ requested party should resend the data. If the changedAt property is\
+            \ not given, the latest entity should be send without precondition."
+          $ref: '#/components/schemas/urn_samm_io.catenax.id_based_request_for_update_2.0.0_Timestamp'
+      required:
+      - capacityGroupId
+    urn_samm_io.catenax.id_based_request_for_update_2.0.0_WeekBasedCapacityGroupCharacteristic:
+      description: A list of capacity group UUIDs without duplicates an update is
+        requested for.
+      type: array
+      items:
+        $ref: '#/components/schemas/urn_samm_io.catenax.id_based_request_for_update_2.0.0_WeekBasedCapacityGroupEntity'
+      uniqueItems: true
+    IdBasedRequestForUpdate:
+      description: |-
+        The requirements for a request for update from another Catena-X Partner of a specific entity.
+        If within the payload, no specific object type is defined (Payload empty), than an update of all objects within the sender reciever relation is requested).
+      type: object
+      properties:
+        materialDemand:
+          description: |-
+            Material demands the supplier requests an update for.
+            If within the array, no specific ID (array empty), than an update of all IDs is requested).
+          $ref: '#/components/schemas/urn_samm_io.catenax.id_based_request_for_update_2.0.0_MaterialDemandCharacteristic'
+        weekBasedCapacityGroup:
+          description: |-
+            Capacity groups the customer requests an update for.
+            If within the array, no specific ID (array empty), than an update of all IDs is requested).
+          $ref: '#/components/schemas/urn_samm_io.catenax.id_based_request_for_update_2.0.0_WeekBasedCapacityGroupCharacteristic'
+  requestBodies:
+    IdBasedRequestForUpdate:
+      description: This request body defines the payload with it's mandatory and optional properties that must be sent to this endpoint.
+      required: true
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/IdBasedRequestForUpdate'