-
Notifications
You must be signed in to change notification settings - Fork 86
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #340 from dominikoeh/osim-kit
doc(resiliency): create first version of osim kit release
- Loading branch information
Showing
15 changed files
with
521 additions
and
16 deletions.
There are no files selected for viewing
25 changes: 25 additions & 0 deletions
25
docs-kits/Resiliency/OSim Kit/Software Development View/osim-api.info.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| --- | ||
| id: osim-api | ||
| title: "OSim API" | ||
| description: "OSim API for requesting and receiving simulation results" | ||
| sidebar_label: Introduction | ||
| sidebar_position: 0 | ||
| hide_title: true | ||
| custom_edit_url: null | ||
| --- | ||
|
|
||
| import ApiLogo from "@theme/ApiLogo"; | ||
| import Tabs from "@theme/Tabs"; | ||
| import TabItem from "@theme/TabItem"; | ||
| import Export from "@theme/ApiDemoPanel/Export"; | ||
|
|
||
| <span className={"theme-doc-version-badge badge badge--secondary"}>Version: 1.0.0</span> | ||
|
|
||
| # OSim API | ||
|
|
||
|
|
||
|
|
||
| OSim API for requesting and receiving simulation results | ||
|
|
||
|
|
||
|
|
56 changes: 56 additions & 0 deletions
56
...Resiliency/OSim Kit/Software Development View/page_software-development-view.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| --- | ||
| id: Specification OSim Kit | ||
| title: Specification | ||
| description: 'OSim Kit' | ||
| sidebar_position: 4 | ||
| --- | ||
|
|
||
| ## Sample Data | ||
|
|
||
| The following example shows the payload used for exchange of simulation results between the OSim partners. The format corresponds with AAS format serialized as a JSON string. | ||
|
|
||
| ```json | ||
| { | ||
| "owner": { "id": "BPNL00000007OTZ3" }, | ||
| "dataQuality": 1, | ||
| "description": "Daily standard simulation", | ||
| "comment": "successful simulation", | ||
| "expirationTimestamp": "2023-03-24T09:15:24.000Z", | ||
| "runId": "0fece48b-c8d1-4180-1a9caca6d67e", | ||
| "shipments": [ | ||
| { | ||
| "handlingUnits": [ | ||
| { | ||
| "name": "Palette", | ||
| "volume": 1, | ||
| "weight": 189, | ||
| "batches": [ | ||
| { | ||
| "unitOfMeasurement": "KG", | ||
| "materialName": "KK1000GR-Gehäuse-Rot", | ||
| "quantity": 50, | ||
| "materialNumber": "KK1000GR", | ||
| "batchOrderId": "Order-0001", | ||
| "batchId": "Batch_1", | ||
| "hazardousGoods": false, | ||
| "batchExpirationTimestamp": "2023-08-22T16:00:00.000Z", | ||
| "batchNumber": "45" | ||
| } | ||
| ], | ||
| "handlingUnitId": "HUT_1", | ||
| "amount": 1 | ||
| } | ||
| ], | ||
| "shipmentId": "DE51515151", | ||
| "recipientTimestampPlanned": "2023-04-19T09:00:00.000Z", | ||
| "destination": { "id": "BPNL00000007OTZ3" }, | ||
| "recipient": { "id": "BPNL00000007OTZ4" }, | ||
| "logistics": { "id": "BPNL00000007OS0H" }, | ||
| "preceding": {}, | ||
| "splittingAllowed": true, | ||
| "destinationTimestamp": "2023-03-19T09:00:00.000Z" | ||
| } | ||
| ], | ||
| "timestamp": "2023-03-09T14:13:42.806Z" | ||
| } | ||
| ``` |
34 changes: 34 additions & 0 deletions
34
...ncy/OSim Kit/Software Development View/receive-latest-simulation-result.api.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| --- | ||
| id: receive-latest-simulation-result | ||
| title: "receiveLatestSimulationResult" | ||
| description: "Receive latest simulation result which can be stored in own OSim Manager instance" | ||
| sidebar_label: "receiveLatestSimulationResult" | ||
| hide_title: true | ||
| hide_table_of_contents: true | ||
| api: {"tags":["receiveLatestSimulationResult"],"description":"Receive latest simulation result which can be stored in own OSim Manager instance","operationId":"receiveLatestSimulationResult","parameters":[{"name":"requestId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"8d628899-3e6f-4666-91c3-74ee7ab88b2b"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"owner":{"type":"object","properties":{"id":{"type":"string"}}},"dataQuality":{"type":"integer"},"description":{"type":"string"},"comment":{"type":"string"},"expirationTimestamp":{"type":"string"},"runId":{"type":"string"},"shipments":{"type":"array","items":{"type":"object","properties":{"handlingUnits":{"type":"array","items":{"type":"object","properties":{"volume":{"type":"integer"},"batches":{"type":"array","items":{"type":"object","properties":{"unitOfMeasurement":{"type":"string"},"materialName":{"type":"string"},"quantity":{"type":"integer"},"materialNumber":{"type":"string"},"batchOrderId":{"type":"string"},"batchId":{"type":"string"},"hazardousGoods":{"type":"boolean"},"batchExpirationTimestamp":{"type":"string"},"batchNumber":{"type":"string"}}}},"handlingUnitId":{"type":"string"},"amount":{"type":"integer"},"name":{"type":"string"},"weight":{"type":"integer"}}}},"shipmentId":{"type":"string"},"recipientTimestampPlanned":{"type":"string"},"destination":{"type":"object","properties":{"id":{"type":"string"}}},"recipient":{"type":"object","properties":{"id":{"type":"string"}}},"logistics":{"type":"object","properties":{"id":{"type":"string"}}},"preceding":{"type":"object","properties":{}},"splittingAllowed":{"type":"boolean"},"destinationTimestamp":{"type":"string"}}}},"timestamp":{"type":"string"}}},"examples":{"0":{"value":"{ \n \"owner\": { \"id\": \"BPNL00000007OTZ3\" }, \n \"dataQuality\": 1, \n \"description\": \"Daily standard simulation\", \n \"comment\": \"successful simulation\", \n \"expirationTimestamp\": \"2023-03-24T09:15:24.000Z\", \n \"runId\": \"0fece48b-c8d1-4180-1a9caca6d67e\", \n \"shipments\": [ \n { \n \"handlingUnits\": [ \n { \n \"name\": \"Palette\", \n \"volume\": 1, \n \"weight\": 189, \n \"batches\": [ \n { \n \"unitOfMeasurement\": \"KG\", \n \"materialName\": \"KK1000GR-Gehäuse-Rot\", \n \"quantity\": 50, \n \"materialNumber\": \"KK1000GR\", \n \"batchOrderId\": \"Order-0001\", \n \"batchId\": \"Batch_1\", \n \"hazardousGoods\": false, \n \"batchExpirationTimestamp\": \"2023-08-22T16:00:00.000Z\", \n \"batchNumber\": \"45\" \n } \n ], \n \"handlingUnitId\": \"HUT_1\", \n \"amount\": 1 \n } \n ], \n \"shipmentId\": \"DE51515151\", \n \"recipientTimestampPlanned\": \"2023-04-19T09:00:00.000Z\", \n \"destination\": { \"id\": \"BPNL00000007OTZ3\" }, \n \"recipient\": { \"id\": \"BPNL00000007OTZ4\" }, \n \"logistics\": { \"id\": \"BPNL00000007OS0H\" }, \n \"preceding\": {}, \n \"splittingAllowed\": true, \n \"destinationTimestamp\": \"2023-03-19T09:00:00.000Z\" \n } \n ], \n \"timestamp\": \"2023-03-09T14:13:42.806Z\" \n}"}}}}},"responses":{"200":{"description":"Simulation Result Received","content":{"text/html; charset=utf-8":{"schema":{"type":"string"},"examples":{}}}}},"servers":[{"url":"https://{server-url}"}],"method":"post","path":"/api/receiveLatestSimulationResult/requestId/{requestId}","jsonRequestBodyExample":{"owner":{"id":"string"},"dataQuality":0,"description":"string","comment":"string","expirationTimestamp":"string","runId":"string","shipments":[{"handlingUnits":[{"volume":0,"batches":[{"unitOfMeasurement":"string","materialName":"string","quantity":0,"materialNumber":"string","batchOrderId":"string","batchId":"string","hazardousGoods":true,"batchExpirationTimestamp":"string","batchNumber":"string"}],"handlingUnitId":"string","amount":0,"name":"string","weight":0}],"shipmentId":"string","recipientTimestampPlanned":"string","destination":{"id":"string"},"recipient":{"id":"string"},"logistics":{"id":"string"},"preceding":{},"splittingAllowed":true,"destinationTimestamp":"string"}],"timestamp":"string"},"info":{"title":"OSim API","description":"OSim API for requesting and receiving simulation results","version":"1.0.0"},"postman":{"name":"receive Latest Simulation Result","description":{"content":"Receive latest simulation result which can be stored in own OSim Manager instance","type":"text/plain"},"url":{"path":["api","receiveLatestSimulationResult","requestId",":requestId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"requestId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/html; charset=utf-8"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} | ||
| sidebar_class_name: "post api-method" | ||
| info_path: docs-kits/Resiliency/OSim Kit/Software Development View//osim-api | ||
| 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"; | ||
|
|
||
| ## receiveLatestSimulationResult | ||
|
|
||
|
|
||
|
|
||
| Receive latest simulation result which can be stored in own OSim Manager instance | ||
|
|
||
| <details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Path Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"requestId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"8d628899-3e6f-4666-91c3-74ee7ab88b2b"}}></ParamsItem></ul></div></details><MimeTabs><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Request Body</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>owner</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"dataQuality"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"integer"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"comment"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"expirationTimestamp"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"runId"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>shipments</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>handlingUnits</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"volume"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"integer"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>batches</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"unitOfMeasurement"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"materialName"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"quantity"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"integer"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"materialNumber"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"batchOrderId"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"batchId"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"hazardousGoods"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"batchExpirationTimestamp"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"batchNumber"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"handlingUnitId"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"amount"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"integer"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"weight"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"integer"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"shipmentId"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"recipientTimestampPlanned"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>destination</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>recipient</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>logistics</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>preceding</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}></div></details></SchemaItem><SchemaItem collapsible={false} name={"splittingAllowed"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"destinationTimestamp"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem></MimeTabs><div><ApiTabs><TabItem label={"200"} value={"200"}><div> | ||
|
|
||
| Simulation Result Received | ||
|
|
||
| </div><div><MimeTabs schemaType={"response"}><TabItem label={"text/html; charset=utf-8"} value={"text/html; charset=utf-8"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div><strong>string</strong></div></li></ul></details></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div> | ||
|
|
Oops, something went wrong.