Skip to content

Commit

Permalink
docs: update REST API spec
Browse files Browse the repository at this point in the history
  • Loading branch information
nicpuppa authored Sep 5, 2024
1 parent 422d194 commit a62cd70
Show file tree
Hide file tree
Showing 14 changed files with 627 additions and 85 deletions.
435 changes: 397 additions & 38 deletions api/camunda/camunda-openapi.yaml

Large diffs are not rendered by default.

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/isHfmoxWVLSdGv1zUvSLUPbBYm7AYvzgZbOFluKVEkqjmDovw9HSn6JnTQbin1YgMCWebx77p5704o5vrAsu2FnOm8qVM6y24gVaHMjaie0Yhk7NcgdAgcp1BdwGjgUvTQIBa5EOOVVowoObyCXjXVo4qmaqizLlHY4VZNSWEBV1FrQHQt4X6MRpIHLGC4c5I0xqJxsQSvZgm3qWhtngSsQalRhpU27sWqdNhjBshR5OVXCgtIOKuTKwVwbqI0umpzQQ2Mx9kCmikWs5oZX6NCQyyumeIUsY4Pai4JFTJDHNXcli5jBr40wWLDMmQYfhmVSIlycgZ77CKyxOe3jFLOI2bzEirNsxVxbkyXrjFAL1nXR2rh3ZWP5a4Om3TE959I+17ZXNiDYPZobXT2N6TZYRet+1kVLEnsgcq0cKkdnvK6lyDnhST5bArXa161nnzF3FHijazROoKVTvK+FQTt2+zAiNtem4o5o4Q5HTlTIDnlf+JRUBZAELEsMiegd7/WTu6qRks8kBgq7LmJOOHpcJ/x7ob5cBb9Z15GEQVtrZQPW4/SIPg4AGCLrTS65hdzXSQG2yXO0dt5I2RKG7xS1xshD8dpHNpTpNv8x66L/Lu6PxbkP8EmaPiemPp5UxHMuJBYxfKDsLtBxIS1wg1Tod6LAYmhDA3Mw00Ub+5J/JPi10TOJ1Q/7JOyiGsNlkOztQiAHuIUgOAvWb67encLbk9c/3b4onattliTL5TI283yEhXDaxNosEjPP6Z/kXsYwKdEgVLyFGQIvCkE2uYQN7WBrzMVc5AOdPWwg8oJ/T+dMOH2C7MaIPZrH8OnqAkSByol5K9Ri37S/M+eNJB18phuXzSQngtfEfytTx2CbquKmHbrYroEuYtZx12y5wYRyuECzjV8o9+r4YKL+OplcQlABuS7QTwZHg6g3RE5UQomqqVh2kqYRq/h9ePoxTTvSSYw/wxNFmS+5Ctn6wB2hoNrkrXdMKOu4yr8XM9qIhXhod7cI+yQ+Cx51oQwrdKUuaNxp61OHpl7GkqEKk9VmMnYJlaSlAYLmbhigviWxVSieLkuSVamt67IVDe8uuSNm7rgR1IE9kXQcimxIHqlzLssAYJ9EOqBBOTi32TOuzq8n8At3uOStDyqZ3FX9Jn2THtRKoo9oHF9eQPAwpOBWWxjUUn0fVBuEn6PYD1uLeWOEa6/pWgjPDLlBM26Ih3Vq9Pa8dnoOQizqv7wbEua3Pyeec2ppV5tBfn7PqzoU5Fb/Z8fp8ckofTtKX0+OXmfpcZa+itOjk79Cfs61B9Bnz74rxCsaG3xP46P9TL288AWX66pqlO+6agFL4UrgB7ZFFjEpclTW4+xXo0HsfTiBP4JFOIqJ1pB7Q7NdCFc2szjXVZKHa+vPmdSzpOJCJb0Jm5yOP3z6eDYevb84Pf94fT46itPY3TsfPiqGiqttHGH/3R1OL7ZX2JcP/V9t5s7/aH3uE9LhvUtqyYWiZOnXktA8btbLNItYtrNYh/5xG/U94IatVjNu8ZORXUc/h82XukohLDWMR3bf7dD++zX4oCtfsN3ZyO+4bEiKUbkOfewfQnxx1S/RL+HbLwwHUfU/ctVuQxrQbsW4u+0iViIv0HiQQeA0QBlNSM1Gwd4mSu8k4cY4z7F2T8rebk2Py9+vJ9SN+peGShd0x/AlvcbwJcvYlE0JsPbh8Y3O/75ikqtFwxckH/TS399Ssge9
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-05T15:02:03.067Z\"\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

0 comments on commit a62cd70

Please sign in to comment.