Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update camunda REST API doc #4256

Merged
merged 2 commits into from
Sep 9, 2024
Merged

Update camunda REST API doc #4256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
46b8563
docs: update REST API spec
nicpuppa Sep 5, 2024
1618d96
Merge branch 'main' into update-rest-doc
pepopowitz Sep 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
568 changes: 530 additions & 38 deletions api/camunda/camunda-openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions ...tools/camunda-api-rest/specifications/create-document-link-experimental.api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Create a link to a document in the Camunda 8 cluster."
sidebar_label: "Create document link (experimental)"
hide_title: true
hide_table_of_contents: true
api: eJzdV21v2zYQ/isHfmoxWVLStE31zUvSLUPbBYm7AUvygZbOFluKVEkqjmDovw9HSn6JnTQbin1YgMCWebx77p5705I5Prcsu2anOm8qVM6y24gVaHMjaie0Yhk7McgdAgcp1FdwGjgUvTQIBa5EOOFVowoOx5DLxjo08Y26UVmWKe3wRk1KYQFVUWtBdyzgfY1GkAYuYzh3kDfGoHKyBa1kC7apa22cBa5AqFGFlTbt2qp12mAEi1Lk5Y0SFpR2UCFXDmbaQG100eSEHhqLsQdyo1jEam54hQ4NubxkilfIMjaoPS9YxAR5XHNXsogZ/NYIgwXLnGnwYVgmJcL5KeiZj8AKm9M+TjGLmM1LrDjLlsy1NVmyzgg1Z10XrYx7V9aWvzVo2i3TMy7tc217ZQOC7aOZ0dXTmG6DVbTuZ120JLEDItfKoXJ0xutaipwTnuSLJVDLXd16+gVzR4E3ukbjBFo6xftaGLRjtwsjYjNtKu6IFu5w5ESFbJ/3hU9JVQBJwKLEkIje8V4/uasaKflUYqCw6yLmhKPHVcJ/EOrrZfCbdR1JGLS1VjZgPUwP6GMPgCGy3uSCW8h9nRRgmzxHa2eNlC1h+EFRa4zcF69dZEOZbvIfsy767+L+WJz7AB+l6XNi6uNJRTzjQmIRw0fK7gIdF9ICN0iFficKLIY2NDAHU120sS/5R4JfGz2VWP20S8I2qjFcBMneLgRygFsIgtNg/fry/Qm8O3r99vZF6VxtsyRZLBaxmeUjLITTJtZmnphZTv8k9zKGSYkGoeItTBF4UQiyySWsaQdbYy5mIh/o7GEDkRf8ezpnwukTZDdG7NA8hs+X5yAKVE7MWqHmu6b9nRlvJOngU924bCo5Ebwi/nuZOgbbVBU37dDFtg10EbOOu2bDDSaUwzmaTfxCuVeHexP118nkAoIKyHWBfjI4GkS9IXKiEkpUTcWyozSNWMXvw9ObNO1IJzH+DE8UZb7kKmTrA3eEgmqdt94xoazjKv9RzGgj5uKh3e0i7JP4NHjUhTKs0JW6oHGnrU8dmnoZS4YqTJbrydglVJKWBgiau2GA+pbElqF4uixJlqW2rsuWNLy75I6YueNGUAf2RNJxKLIheaTOuSwDgF0S6YAG5eDces+4PLuawC/c4YK3Pqhkclv1cXqc7tVKoo9oHF+cQ/AwpOBGWxjUUn3vVRuEn6PYD1uLeWOEa6/oWgjPFLlBM26Ih1Vq9Pa8dnoOQizqv7wfEua3Pyeec2ppl+tBfnbPqzoU5Eb/Z4fp4dEoPR69Sifpmyw9zF6/jd8dvPkr5OdMewB99uy6QryiscH3ND7YzdSLc19wua6qRvmuq+awEK4EvmdbZBGTIkdlPc5+NRrEPoQT+CNYhIOYaA25NzTbuXBlM41zXSV5uLb6nEo9TSouVNKbsMnJ+OPnT6fj0Yfzk7NPV2ejgziN3b3z4aNiqLjaxBH23+3h9GJzhX350P/leu78j9bnPiEd3rukllwoSpZ+LQnN43q1TLOIZVuLdegft1HfA67ZcjnlFj8b2XX0c9h8qasUwlLDeGT33Qztv1+D97ryFdutjfyOy4akGJXr0Mf+IcQXl/0S/RK+/8KwF1X/I1ftJqQB7UaMu9suYiXyAo0HGQROApTRhNSsFexsovROEm6M8xxr96Ts7cb0uPj9akLdqH9pqHRBdwxf0GsMX7CM3bAbAqx9eHyj878vmeRq3vA5yQe99Pc3n4kHzg==
api: eJzdV21v2zYQ/isHfmoxWVLSdG31zUvSLUPbBYm7AYvzgZbOFluK1EgqjmDovw9HSn6JnTQbin1YgMCWebx77p5704o5vrAsu2FnOm8qVM6y24gVaHMjaie0Yhk7NcgdAgcp1FdwGjgUvTQIBa5EOOVVowoObyGXjXVo4qmaqizLlHY4VZNSWEBV1FrQHQt4X6MRpIHLGC4c5I0xqJxsQSvZgm3qWhtngSsQalRhpU27sWqdNhjBshR5OVXCgtIOKuTKwVwbqI0umpzQQ2Mx9kCmikWs5oZX6NCQyyumeIUsY4Pai4JFTJDHNXcli5jBvxphsGCZMw0+DMukRLg4Az33EVhjc9rHKWYRs3mJFWfZirm2JkvWGaEWrOuitXHvysbyXw2adsf0nEv7XNte2YBg92hudPU0pttgFa37SRctSeyByLVyqByd8bqWIueEJ/liCdRqX7eefcHcUeCNrtE4gZZO8b4WBu3Y7cOI2FybijuihTscOVEhO+R94VNSFUASsCwxJKJ3vNdP7qpGSj6TGCjsuog54ehxnfAfhPp6FfxmXUcSBm2tlQ1Yj9Mj+jgAYIisN7nkFnJfJwXYJs/R2nkjZUsYvlPUGiMPxWsf2VCm2/zHrIv+u7g/Fuc+wCdp+pyY+nhSEc+5kFjE8JGyu0DHhbTADVKh34kCi6ENDczBTBdt7Ev+keDXRs8kVj/sk7CLagyXQbK3C4Ec4BaC4CxYv7l6fwrvTl6/uX1ROlfbLEmWy2Vs5vkIC+G0ibVZJGae0z/JvYxhUqJBqHgLMwReFIJscgkb2sHWmIu5yAc6e9hA5AX/ns6ZcPoE2Y0RezSP4fPVBYgClRPzVqjFvml/Z84bSTr4TDcum0lOBK+J/1amjsE2VcVNO3SxXQNdxKzjrtlygwnlcIFmG79Q7tXxwUT9ZTK5hKACcl2gnwyOBlFviJyohBJVU7HsJE0jVvH78PRjmnakkxh/hieKMl9yFbL1gTtCQbXJW++YUNZxlX8vZrQRC/HQ7m4R9kl8FjzqQhlW6Epd0LjT1qcOTb2MJUMVJqvNZOwSKklLAwTN3TBAfUtiq1A8XZYkq1Jb12UrGt5dckfM3HEjqAN7Iuk4FNmQPFLnXJYBwD6JdECDcnBus2dcnV9P4GfucMlbH1Qyuav6bfo2PaiVRB/ROL68gOBhSMGttjCopfo+qDYIP0exH7YW88YI117TtRCeGXKDZtwQD+vU6O157fQchFjUf3k/JMyvf0w859TSrjaD/PyeV3UoyK3+z47T45NR+m6Uvp4cp9nJSfbqKE6P3vwZ8nOuPYA+e/ZdIV7R2OB7Gh/tZ+rlhS+4XFdVo3zXVQtYClcCP7AtsohJkaOyHme/Gg1iH8IJ/B4swlFMtIbcG5rtQriymcW5rpI8XFt/zqSeJRUXKulN2OR0/PHzp7Px6MPF6fmn6/PRUZzG7t758FExVFxt4wj77+5werG9wr586P9qM3f+R+tzn5AO711SSy4UJUu/loTmcbNeplnEsp3FOvSP26jvATdstZpxi5+N7Dr6OWy+1FUKYalhPLL7bof236/BB135iu3ORn7HZUNSjMp16GP/EOKLq36JfgnffmE4iKr/kat2G9KAdivG3W0XsRJ5gcaDDAKnAcpoQmo2CvY2UXonCTfGeY61e1L2dmt6XP52PaFu1L80VLqgO4Yv6TWGL1nGpmxKgLUPj290/vcVk1wtGr4g+aCX/v4GbdgHww==
sidebar_class_name: "post api-method"
info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api
custom_edit_url: null
Expand Down Expand Up @@ -45,7 +45,7 @@ is not meant for production use.

The document link was created successfully.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"url"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The link to the document."}}></SchemaItem><SchemaItem collapsible={false} name={"expiresAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date and time when the link expires."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"url\": \"string\",\n \"expiresAt\": \"2024-08-30T06:02:57.966Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"url"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The link to the document."}}></SchemaItem><SchemaItem collapsible={false} name={"expiresAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date and time when the link expires."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"url\": \"string\",\n \"expiresAt\": \"2024-09-05T20:44:31.070Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The document link creation failed. More details are provided in the response body.

Expand Down
Loading
Loading