d3: regenerate camunda api docs, vNext

docs/apis-tools/camunda-api-rest/sidebar-schema.js

@@ -5,7 +5,7 @@ module.exports = {
     "apis-tools/camunda-api-rest/camunda-api-rest-overview",
     "apis-tools/camunda-api-rest/camunda-api-rest-authentication",
     {
-      Specifications: require("./specifications/sidebar.js"),
+      Specifications: require("./specifications/sidebar"),
     },
   ],
 };

docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api.info.mdx

@@ -9,18 +9,33 @@ custom_edit_url: null
 ---
 
 import ApiLogo from "@theme/ApiLogo";
+import Heading from "@theme/Heading";
 import SchemaTabs from "@theme/SchemaTabs";
 import TabItem from "@theme/TabItem";
 import Export from "@theme/ApiExplorer/Export";
 
-<h1 className={"openapi__heading"}>Camunda 8 REST API</h1>
+<span
+  className={"theme-doc-version-badge badge badge--secondary"}
+
+>
+
+</span>
+
+<Heading
+  as={"h1"}
+  className={"openapi__heading"}
+  children={"Camunda 8 REST API"}
+></Heading>
 
 API for communicating with a Camunda 8 cluster.
 
 <div style={{ marginBottom: "2rem" }}>
-  <h2 id={"authentication"} style={{ marginBottom: "1rem" }}>
-    Authentication
-  </h2>
+  <Heading
+    id={"authentication"}
+    as={"h2"}
+    className={"openapi-tabs__heading"}
+    children={"Authentication"}
+  ></Heading>
   <SchemaTabs className={"openapi-tabs__security-schemes"}>
     <TabItem label={"HTTP: Bearer Auth"} value={"bearerAuth"}>
       <div>

docs/apis-tools/camunda-api-rest/specifications/create-document-link.api.mdx

@@ -5,31 +5,31 @@ description: "Create a link to a document in the Camunda 8 cluster."
 sidebar_label: "Create document link (alpha)"
 hide_title: true
 hide_table_of_contents: true
-api: eJztV0tz2zYQ/is7ONlTipQTN015U22ndSdJPbbSHmwfVuRKREICDABa5mj43zsLkJZkybHb5ljN6EUs9/XtfrtcCYcLK9JrcaqzpiLlxG0kdE0GndTqPBepyAyho+H8vVRfRCRyspmRNQuJVJx4EUAopfoCTgNC3suDVOAKghOsGpUjvIWsbKwjE9+oG/VROwJXoANXSAtZYwwpV7agVdmCbepaG2cBFUg1qqjSpl1rtk4bimBZyKwAaUFpBxWhcjDXBmqj8yZjB6Gx5K2laaq0oxs1ZWOk8lpL9tAbuMayLhDmhK4xdHuQZLqqtSLlbEJoynaEWUbWJl4ufI56aRtX+SGgyqHCFmYEtpl9psxxKrIC1YJulFQwb1gYDJWElmzsPbpRIhI1GqzIkWEsVkJhRSIVQ6TnuYiE5ETX6AoRCUNfG2koF6kzDT1GY1oQnJ+CnvvEP6TLaQ9PLCJhs4IqFOlKuLZmS9YZqRai66IH4z67a8tfGzLtluk5lvaltr2ywYPto7nR1bd9ug1WybpfdN6yxI4TmVaOizddCazrUma+fJPPlp1a7erWHh5OvOFid5KsP5UVTfV7eUcbslI5WpARkZhrU6ELl94c73QBx84aRk6PSnlHO1nwwUsFlY39zXNsSifS12/G/Oq6SDjpSra52W2XIXbRdSxhyNZa2eDvq/ERf+26sW1yiRZCF+dgG1/F86YsW/biO2WuMeUudPsSNDDEZmJi0UWC7mtpyE7cPj0Pmc/R0YiTvFd57llI5R4GWBYUuMfb7PXH4qk89wk+Ho9fklOfTyaXOcqS8hg+cIXn5FCWFtAQE9CdzCkfGHBADmY6b2Pf9k8kvzZ6VlL1wy4I215N4CJI9nYhgANoIQjOgvXry3cn8PPxjz/dHhTO1TZNkuVyGZt5NqJcOm1ibRaJmWf8ZrnDGKYFGRroDPNcsk0sYQ072JoyOZfZAGfvNjB4Ib5nus2ffgPsxsgdmCfw6fIcZE7KyXkr1WLX9GZvCZzpxqWzEhngB+Cfq9QJ2Kaq0LRDD28b6CJhHbrGPksTr1/tLdTfptMLCCog0zn5ieVHYG+Ig6ikklVTifR4PI5Ehffh35vxuGOdjPgLIlFc+SWqUK2PwmEyWtetD0wq61Bl3wsZbeRCPra73YR9EZ+GiLrQhhW5QvP6UWvrS4cnXyqSoQttslqPxy7hnrQ8RcjcDVPUc5JYhe7p0iRZFdq6Ll3xUtEldwzNHRqJszIUJB+HLhuqp9QZlkXwYBdFPuBpOUS33nEuz66m8Cs6WmLrs8omt1W/Hb8d79XKok9onFycQ4gw1OAGLwxqucH3qg3CL1HsJ66lrDHStVd8W0jPjNCQmTQMxENt9Pa8dv4fhETU/3g3VMzvf0096Mxpl+tpfnaPVd135MbwHUYil+Nch9NQLLuOM4pkbIh0HB/tFubFue+vTFdVozzJqgUspSsA9+ylIhKlzEhZ71W/DQ1i78MJ/BkswlHMIIZKG7h1IV3RzOJMV0kWbnv4npV6llQoVdKbsMnJ5MOnj6eT0fvzk7OPV2ejo3gcu3vnk8W1X6Ha9CNs2tuz6MAvo4ePA1+t58v/G/p/3dD7cnd075K6RKm4AfutJ3DT9cO+zkSUbi3vgZ5uo55irsVqNUNLn0zZdXw5bNdMWrm0zEdP7NebkP77VXtvLF+o3dr677BsWEowGww0+Q9dPLjsF/VDeP6hZK9X/UVU7aZLg7cbOe5uu0gUhDkZ72QQOAmujKasZq1gZ9Pl555wxyTLqHbflL3dmE4Xf1xNmez6B5NK53yPwSU/KuFSpOJG3LDD2qfH86i/vhIlqkWDC5YPevn1N6xZZOg=
+api: eJztV0tz2zYQ/is7ONlTipQTN015U22ndSdJPbbSHmwfVuRKREICDABa5mj43zsLkJZkybHb5ljN6EUs9/XtfrtcCYcLK9JrcaqzpiLlxG0kdE0GndTqPBepyAyho+H8vVRfRCRyspmRNQuJVJx4EUAopfoCTgNC3suDVOAKghOsGpUjvIWsbKwjE9+oG/VROwJXoANXSAtZYwwpV7agVdmCbepaG2cBFUg1qqjSpl1rtk4bimBZyKwAaUFpBxWhcjDXBmqj8yZjB6Gx5K2laaq0oxs1ZWOk8lpL9tAbuMayLhDmhK4xdHuQZLqqtSLlbEJoynaEWUbWJl4ufI56aRtX+SGgyqHCFmYEtpl9psxxKrIC1YJulFQwb1gYDJWElmzsPbpRIhI1GqzIkWEsVkJhRSIVQ6TnuYiE5ETX6AoRCUNfG2koF6kzDT1GY1oQnJ+CnvvEP6TLaQ9PLCJhs4IqFOlKuLZmS9YZqRai66IH4z67a8tfGzLtluk5lvaltr2ywYPto7nR1bd9ug1WybpfdN6yxI4TmVaOizddCazrUma+fJPPlp1a7erWHh5OvOFid5KsP5UVTfV7eUcbslI5WpARkZhrU6ELl94c73QBx84aRk6PSnlHO1nwwUsFlY39zXNsSifS12/G/Oq6SDjpSra52W2XIXbRdSxhyNZa2eDvq/ERf+26sW1yiRZCF+dgG1/F86YsW/biO2WuMeUudPsSNDDEZmJi0UWC7mtpyE7cPj0Pmc/R0YiTvFd57llI5R4GWBYUuMfb7PXH4qk89wk+Ho9fklOfTyaXOcqS8hg+cIXn5FCWFtAQE9CdzCkfGHBADmY6b2Pf9k8kvzZ6VlL1wy4I215N4CJI9nYhgANoIQjOgvXry3cn8PPxjz/dHhTO1TZNkuVyGZt5NqJcOm1ibRaJmWf8ZrnDGKYFGRroDPNcsk0sYQ072JoyOZfZAGfvNjB4Ib5nus2ffgPsxsgdmCfw6fIcZE7KyXkr1WLX9GZvCZzpxqWzEhngB+Cfq9QJ2Kaq0LRDD28b6CJhHbrGPksTr1/tLdTfptMLCCog0zn5ieVHYG+Ig6ikklVTifR4PI5Ehffh35vxuGOdjPgLIlFc+SWqUK2PwmEyWtetD0wq61Bl3wsZbeRCPra73YR9EZ+GiLrQhhW5QvP6UWvrS4cnXyqSoQttslqPxy7hnrQ8RcjcDVPUc5JYhe7p0iRZFdq6Ll3xUtEldwzNHRqJszIUJB+HLhuqp9QZlkXwYBdFPuBpOUS33nEuz66m8Cs6WmLrs8omt1W/Hb8d79XKok9onFycQ4gw1OAGLwxqucH3qg3CL1HsJ66lrDHStVd8W0jPjNCQmTQMxENt9Pa8dv4fhETU/3g3VMzvf0096Mxpl+tpfnaPVd135MbwHUYil+Nch9NQLLuOM4pkbIh0HB/tFubFue+vTFdVozzJqgUspSsA9+ylIhKlzEhZ71W/DQ1i78MJ/BkswlHMIIZKG7h1IV3RzOJMV0kWbnv4npV6llQoVdKbsMnJ5MOnj6eT0fvzk7OPV2ejo3gcu3vnk8W1X6Ha9CNs2tuz6MAvo4ePA1+t58v/G/p/3dD7cnd075K6RKm4AfutJ3DT9cO+zkSUbi3vgZ5uo55irsVqNUNLn0zZdXw5bNdMWrm0zEdP7NebkP77VXtvLF+o3dr677BsWEowGww0+Q9dPLjsF/VDeP6hZK9X/UVU7aZLg7cbOe5uu0gUhDkZ72QQOAmujKasZq1gZ9Pl555wxyTLqHbflL3dmE4Xf1xNmez6B5NK53yPwSU/KuEyOKt9ajyH+msrUaJaNLhg2aCTX38DK65j7A==
 sidebar_class_name: "post api-method"
 info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api
 custom_edit_url: null
 hide_send_button: true
 ---
 
-import ApiTabs from "@theme/ApiTabs";
-import DiscriminatorTabs from "@theme/DiscriminatorTabs";
 import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
-import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
-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 Markdown from "@theme/Markdown";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
 import OperationTabs from "@theme/OperationTabs";
 import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
 
-<h1 className={"openapi__heading"}>Create document link (alpha)</h1>
+<Heading
+  as={"h1"}
+  className={"openapi__heading"}
+  children={"Create document link (alpha)"}
+></Heading>
 
 <MethodEndpoint
   method={"post"}
   path={"/documents/{documentId}/links"}
+  context={"endpoint"}
 ></MethodEndpoint>
 
 Create a link to a document in the Camunda 8 cluster.
@@ -41,14 +41,119 @@ This endpoint is an [alpha feature](/components/early-access/alpha/alpha-feature
 in future releases.
 :::
 
-## Request
+<Heading
+  id={"request"}
+  as={"h2"}
+  className={"openapi-tabs__heading"}
+  children={"Request"}
+></Heading>
 
-<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"documentId","in":"path","required":true,"description":"The ID of the document to link.","schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"storeId","in":"query","required":false,"description":"The ID of the document store to link the document from.","schema":{"type":"string"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"timeToLive"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","description":"The time-to-live of the document link in ms.","default":3600000}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>
+<ParamsDetails
+  parameters={[
+    {
+      name: "documentId",
+      in: "path",
+      required: true,
+      description: "The ID of the document to link.",
+      schema: { type: "string" },
+    },
+    {
+      name: "storeId",
+      in: "query",
+      required: false,
+      description: "The ID of the document store to link the document from.",
+      schema: { type: "string" },
+    },
+  ]}
+></ParamsDetails>
 
-The document link was created successfully.
+<RequestSchema
+  title={"Body"}
+  body={{
+    required: false,
+    content: {
+      "application/json": {
+        schema: {
+          type: "object",
+          properties: {
+            timeToLive: {
+              type: "integer",
+              format: "int64",
+              description: "The time-to-live of the document link in ms.",
+              default: 3600000,
+            },
+          },
+          title: "DocumentLinkRequest",
+        },
+      },
+    },
+  }}
+></RequestSchema>
 
-</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-12-19T15:07:40.217Z\"\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.
-
-</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/problem+json"} value={"application/problem+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={"type"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"A URI identifying the problem type.","default":"about:blank"}}></SchemaItem><SchemaItem collapsible={false} name={"title"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A summary of the problem type."}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}></SchemaItem><SchemaItem collapsible={false} name={"detail"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"An explanation of the problem in more detail."}}></SchemaItem><SchemaItem collapsible={false} name={"instance"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"A URI identifying the origin of the problem."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"type\": \"about:blank\",\n  \"title\": \"string\",\n  \"status\": 0,\n  \"detail\": \"string\",\n  \"instance\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
+<StatusCodes
+  id={undefined}
+  label={undefined}
+  responses={{
+    "201": {
+      description: "The document link was created successfully.",
+      content: {
+        "application/json": {
+          schema: {
+            type: "object",
+            properties: {
+              url: { type: "string", description: "The link to the document." },
+              expiresAt: {
+                type: "string",
+                format: "date-time",
+                description: "The date and time when the link expires.",
+              },
+            },
+            title: "DocumentLink",
+          },
+        },
+      },
+    },
+    "400": {
+      description:
+        "The document link creation failed. More details are provided in the response body.\n",
+      content: {
+        "application/problem+json": {
+          schema: {
+            description:
+              "A Problem detail object as described in [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457). There may be additional properties specific to the problem type.\n",
+            type: "object",
+            properties: {
+              type: {
+                type: "string",
+                format: "uri",
+                description: "A URI identifying the problem type.",
+                default: "about:blank",
+              },
+              title: {
+                type: "string",
+                description: "A summary of the problem type.",
+              },
+              status: {
+                type: "integer",
+                format: "int32",
+                description: "The HTTP status code for this problem.",
+                minimum: 400,
+                maximum: 600,
+              },
+              detail: {
+                type: "string",
+                description: "An explanation of the problem in more detail.",
+              },
+              instance: {
+                type: "string",
+                format: "uri",
+                description: "A URI identifying the origin of the problem.",
+              },
+            },
+            title: "ProblemDetail",
+          },
+        },
+      },
+    },
+  }}
+></StatusCodes>