d3: regenerate vNext API docs (#4801)

* d3: regenerate camunda api docs, vNext * d3: regenerate operate api docs, vNext * d3: regenerate tasklist api docs, vNext * d3: regenerate admin sm api docs, vNext * fix: update badge removal regex and regen vNext API docs to scrub the duplicate badges
camunda · Dec 19, 2024 · 237c326 · 237c326
1 parent 6847a7b
commit 237c326
Show file tree

Hide file tree

Showing 136 changed files with 39,600 additions and 5,954 deletions.
diff --git a/api/remove-duplicate-version-badge.js b/api/remove-duplicate-version-badge.js
@@ -6,7 +6,7 @@ function removeDuplicateVersionBadge(generatedInfoFilePath) {
   console.log("removing duplicate version badge...");
   replace.sync({
     files: generatedInfoFilePath,
-    from: /^.*Version: .*$/m,
+    from: /<span[^>]*\s*children=\{"Version: [^"]*"\}\s*>\n<\/span>\n/m,
     to: "",
   });
 }

diff --git a/docs/apis-tools/administration-sm-api/sidebar-schema.js b/docs/apis-tools/administration-sm-api/sidebar-schema.js
@@ -5,7 +5,7 @@ module.exports = {
     "apis-tools/administration-sm-api/administration-sm-api-overview",
     "apis-tools/administration-sm-api/administration-sm-api-authentication",
     {
-      Specifications: require("./specifications/sidebar.js"),
+      Specifications: require("./specifications/sidebar"),
     },
   ],
 };
diff --git a/...s/administration-sm-api/specifications/administration-api-self-managed.info.mdx b/...s/administration-sm-api/specifications/administration-api-self-managed.info.mdx
@@ -9,18 +9,26 @@ 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"}>Administration API (Self-Managed)</h1>
+<Heading
+  as={"h1"}
+  className={"openapi__heading"}
+  children={"Administration API (Self-Managed)"}
+></Heading>
 
 Access the administration API of Console Self-Managed.
 
 <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={"bearer"}>
       <div>
@@ -53,9 +61,7 @@ Access the administration API of Console Self-Managed.
 >
   <h3 style={{ marginBottom: "0.25rem" }}>Contact</h3>
   <span></span>
-  <span>
-    URL: <a href={"https://www.camunda.com"}>https://www.camunda.com</a>
-  </span>
+  <span>URL: [https://www.camunda.com](https://www.camunda.com)</span>
 </div>
 <div style={{ marginBottom: "var(--ifm-paragraph-margin-bottom)" }}>
   <h3 style={{ marginBottom: "0.25rem" }}>License</h3>

diff --git a/docs/apis-tools/administration-sm-api/specifications/get-clusters.api.mdx b/docs/apis-tools/administration-sm-api/specifications/get-clusters.api.mdx
diff --git a/docs/apis-tools/administration-sm-api/specifications/get-usage-metrics.api.mdx b/docs/apis-tools/administration-sm-api/specifications/get-usage-metrics.api.mdx
@@ -5,59 +5,152 @@ description: "Returns usage metrics for a specific cluster for a given time rang
 sidebar_label: "Get usage metrics for clusters"
 hide_title: true
 hide_table_of_contents: true
-api: eJzlV99v2zYQ/leIe2oBxvZ+AYUwDMiKpciwbEWTYAMMP5zJs81GIhWSShsI+t+HoyRbsWWvGxLsoS+JJR8/fvzu7ju6BleSx2icvdSQwZribcA1XVH0RgWQ4CmUzgYKkNXw7WzG/zQF5U3JqyCDP+5AgnI2ko38LZZlblTCnH4MHFJDUBsqkD+VnneMpgU0mv/Gx5IggxC9sWuQe/g3GxJGk41mZcgLtxJxQ0LlVYjkJ9BIxlQUwqUNEa1qkQ8xKj6YKNqTiZXzIkT0kbTo1gvTA0xA7hGNLmI+4GqrYkkeJKycLzBCBtpVy5xG2bfBzPyQA4pQkjIrowRDT6BpWPT7ynjSkM27nRey39ktP5KKIAG1NrwJ5u8HVFeYB5IQTcw5+q2zweV0fXWuC2PPSzMZ5nenWMO8lQlcCP9WRvpMqmIde4SvXMiI4e42kP9iATEEs7akBa8UFS/9X4WT0DHqmjRSEQ77tNkqid7j4+i+6SwibjCmswWxwQcSSyI7OLQ7lqshj5fJ2802VfsMjIYRYxnrkmHCX4blhfNvW7uDpmGi38++O6ytC+eXRmuynJkfxpz6mvwD+bNgNAny3vl06qcxHyhW3obTddKZb/d6bR7IimgKEh7tmibisMzRk8D12tMa2SncA/lk47tVAq0Wxqq80sN6PerR8pTvyIR2pK8irgOnOEks+lG3kBBIVd7ER8jmNSwJPXnI5otmIaFEjwXF1NTz0a625r46MahAguHY+4o894rFghOfymxXd9FXJAfTcq/jGjm2dZIoKRkiFmW/8VDaIG5/v/xrEGOsKEyem0DKWR2OsEvIJwkems9TezpCmax+EcJkT+v5z3QXEgqKG9fdhtgEMG4ggylya55haaaptM+K7R0ppL5qK6PyOWRQt1s22XRab1yITVaXzscGJDygN7jMW2vl79o+XWGVM7HcKczT6zE/5S/4qL1k5+8vRbt7exFyfg/uzezNbBSJQ4+g7OTa4WxiLEdx2uBRpCRm31PXHNceuu+sbXl34AmKn7sA2X246JP26583ybGMXbm0vHPPZJomxPYim0i8uqZ8dXaFFtekXx8wP1fJTJgyHi52K9EZshjCsHdwnluIbyazyay7+aJKsre559OEbDr99OnTRGFRWY0T5QpWNjeKbCCO7Qr2t+6N3FusnQrb1cal56mnFXmyiqYdUJgmPUoXYoF2APuO4oiDd1YU9uWod9f3r8L/26qL9DlOyxxNGphJ/rpr9jlsm50z86TdF7Lr2jnU9RID3fq8afh160VpPJjALa63c/6o3K8+dF71WnzhFBllf0eP/TB5wLziAEjO+1+JPM9MOcG1Hy3PQ/c55skJsu1Y2VFd7Gw8XRAkbAh1ui3U3RJ2mHJ4wIOfxU9GzbtfbviuWHH1bX1xzwcTen/lto8D7B9/TgHixt2R/Ql62pEfoVk0TfM3+WOSPA==
+api: eJzlV01v2zgQ/SvEnFqAsb1fQKFbUGyKLDa7RZNgFzB8GJNjm41EKiSVNBD034uhJFuxZW93kWAPvSSWPHx8fDPzhq7BleQxGmcvNWSwpngbcE1XFL1RASR4CqWzgQJkNfw4m/E/TUF5U/IqyODPO5CgnI1kI3+LZZkblTCnnwOH1BDUhgrkT6XnHaNpAY3mv/GpJMggRG/sGuQe/s2GhNFko1kZ8sKtRNyQUHkVIvkJNJIxFYVwaUNEq1rkQ4yKDyaK9mRi5bwIEX0kLbr1wvQAE5B7RKOLmA+42qpYkgcJK+cLjJCBdtUyp1H2bTAzP+SAIpSkzMoowdATaBoW/b4ynjRk827nhex3dsvPpCJIQK0Nb4L5xwHVFeaBJEQTc45+72xwOV1fnevC2PPSTIb53SnWMG9lAhfCv5WRvpCqWMce4TsXMmK4uw3kv1lADMGsLWnBK0XFS/9X4SR0jLomjVSEwz5ttkqi9/g0um86i4gbjOlsQWzwgcSSyA4O7Y7lasjjdfJ2s03VPgOjYcRYxrpkmPDXYXnh/PvW7qBpmOjPs58Oa+vC+aXRmixn5pcxp74m/0D+LBhNgrx3Pp36ecwnipW34XSddObbvV6bB7IimoKER7umiTgsc/QkcL32tEZ2CvdAPtn4bpVAq4WxKq/0sF6PerQ85TsyoR3pq4jrwClOEot+1C0kBFKVN/EJsnkNS0JPHrL5ollIKNFjQTE19Xy0q625r04MKpBgOPa+Is+9YrHgxKcy29Vd9BXJwbTc67hGjm2dJEpKhohF2W88lDaI2z8u/x7EGCsKk+cmkHJWhyPsEvJJgofm89yejlAmq1+FMNnTev4z3YWEguLGdbchNgGMG8hgityaZ1iaaSrts2J7Rwqpr9rKqHwOGdTtlk02ndYbF2KT1aXzsQEJD+gNLvPWWvm7tk9XWOVMLHcK8/R6zE/5Cz5qL9n5x0vR7t5ehJzfg3s3ezcbReLQIyg7uXY4mxjLUZw2eBQpidn31DXHtYfuO2tb3h14guLnLkB2Hy76pP32101yLGNXLi3v3DOZpgmxvcgmEm+uKV+dXaHFNem3B8zPVTITpoyHi91KdIYshjDsHZznFuKHyWwy626+qJLsbe75NCGbTh8fHycKi8pqnChXsLK5UWQDcWxXsL93b+TeYu1U2K42Lj1PPa3Ik1U07YDCNOlRuhALtAPYDxRHHLyzorAvR727vn8X/t9WXaQvcVrmaNLATPLXXbPPYdvsnJln7b6QXdfOoa6XGOjW503Dr1svSuPBBG5xvZ3zR+V+86nzqrfiG6fIKPs7euqHyQPmFQdAct7/SuRlZsoJrv1oeRm6LzFPTpBtx8qO6mJn4+mCIGFDqNNtoe6WsMOUwwMe/Cx+Nmo+/HrDd8WKq2/ri3s+mND7K7d9GmDXdRtx4+7INjxlWhKRn6FZNE3zFavQk7I=
 sidebar_class_name: "get api-method"
 info_path: docs/apis-tools/administration-sm-api/specifications/administration-api-self-managed
 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"}>Get usage metrics for clusters</h1>
+<Heading
+  as={"h1"}
+  className={"openapi__heading"}
+  children={"Get usage metrics for clusters"}
+></Heading>
 
 <MethodEndpoint
   method={"get"}
   path={"/admin-api/usage-metrics"}
+  context={"endpoint"}
 ></MethodEndpoint>
 
 Returns usage metrics for a specific cluster for a given time range. The usage metrics are aggregated over the time range and include number of started process instances, executed decision instances, and assigned task users.
 
-## Request
-
-<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={{"description":"The unique identifier of the cluster","in":"query","name":"id","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"The start timestamp of the time range as UNIX timestamp in milliseconds","in":"query","name":"start","required":true,"schema":{"format":"double","type":"number"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"The end timestamp of the time range as UNIX timestamp in milliseconds","in":"query","name":"end","required":true,"schema":{"format":"double","type":"number"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
-
-Ok
-
-</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={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The identifier of the cluster."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>processInstances</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
-
-The usage metrics for started process instances.
-
-</div><SchemaItem collapsible={false} name={"total"} required={true} schemaName={"double"} qualifierMessage={undefined} schema={{"type":"number","format":"double","description":"The number of usage metrics for a specific type."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>decisionInstances</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
-
-The usage metrics for executed decision instances.
-
-</div><SchemaItem collapsible={false} name={"total"} required={true} schemaName={"double"} qualifierMessage={undefined} schema={{"type":"number","format":"double","description":"The number of usage metrics for a specific type."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>taskUsers</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
-
-The usage metrics for assigned task users.
-
-</div><SchemaItem collapsible={false} name={"total"} required={true} schemaName={"double"} qualifierMessage={undefined} schema={{"type":"number","format":"double","description":"The number of usage metrics for a specific type."}}></SchemaItem><SchemaItem collapsible={false} name={"assignees"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"items":{"type":"string"},"type":"array","description":"The users that tasks have been assigned to."}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"string\",\n  \"processInstances\": {\n    \"total\": 0\n  },\n  \"decisionInstances\": {\n    \"total\": 0\n  },\n  \"taskUsers\": {\n    \"total\": 0,\n    \"assignees\": [\n      \"string\"\n    ]\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
-
-Forbidden
-
-</div><div></div></TabItem><TabItem label={"500"} value={"500"}><div>
-
-Server-side error
-
-</div><div></div></TabItem></ApiTabs></div></div>
+<Heading
+  id={"request"}
+  as={"h2"}
+  className={"openapi-tabs__heading"}
+  children={"Request"}
+></Heading>
+
+<ParamsDetails
+  parameters={[
+    {
+      description: "The unique identifier of the cluster",
+      in: "query",
+      name: "id",
+      required: true,
+      schema: { type: "string" },
+    },
+    {
+      description:
+        "The start timestamp of the time range as UNIX timestamp in milliseconds",
+      in: "query",
+      name: "start",
+      required: true,
+      schema: { format: "double", type: "number" },
+    },
+    {
+      description:
+        "The end timestamp of the time range as UNIX timestamp in milliseconds",
+      in: "query",
+      name: "end",
+      required: true,
+      schema: { format: "double", type: "number" },
+    },
+  ]}
+></ParamsDetails>
+
+<RequestSchema title={"Body"} body={undefined}></RequestSchema>
+
+<StatusCodes
+  id={undefined}
+  label={undefined}
+  responses={{
+    "200": {
+      description: "Ok",
+      content: {
+        "application/json": {
+          schema: {
+            properties: {
+              id: {
+                type: "string",
+                description: "The identifier of the cluster.",
+              },
+              processInstances: {
+                description: "The usage metrics for started process instances.",
+                properties: {
+                  total: {
+                    type: "number",
+                    format: "double",
+                    description:
+                      "The number of usage metrics for a specific type.",
+                  },
+                },
+                required: ["total"],
+                type: "object",
+                additionalProperties: false,
+                title: "ConsoleSMAdminApi.UsageMetricsInstances",
+              },
+              decisionInstances: {
+                description:
+                  "The usage metrics for executed decision instances.",
+                properties: {
+                  total: {
+                    type: "number",
+                    format: "double",
+                    description:
+                      "The number of usage metrics for a specific type.",
+                  },
+                },
+                required: ["total"],
+                type: "object",
+                additionalProperties: false,
+                title: "ConsoleSMAdminApi.UsageMetricsInstances",
+              },
+              taskUsers: {
+                description: "The usage metrics for assigned task users.",
+                properties: {
+                  total: {
+                    type: "number",
+                    format: "double",
+                    description:
+                      "The number of usage metrics for a specific type.",
+                  },
+                  assignees: {
+                    items: { type: "string" },
+                    type: "array",
+                    description: "The users that tasks have been assigned to.",
+                  },
+                },
+                required: ["total", "assignees"],
+                type: "object",
+                additionalProperties: false,
+                title: "ConsoleSMAdminApi.UsageMetricsTaskUsers",
+              },
+            },
+            required: [
+              "id",
+              "processInstances",
+              "decisionInstances",
+              "taskUsers",
+            ],
+            type: "object",
+            additionalProperties: false,
+            title: "ConsoleSMAdminApi.UsageMetricsForCluster",
+          },
+        },
+      },
+    },
+    "403": { description: "Forbidden" },
+    "500": { description: "Server-side error" },
+  }}
+></StatusCodes>
diff --git a/docs/apis-tools/administration-sm-api/specifications/sidebar.js b/docs/apis-tools/administration-sm-api/specifications/sidebar.js
diff --git a/docs/apis-tools/administration-sm-api/specifications/sidebar.ts b/docs/apis-tools/administration-sm-api/specifications/sidebar.ts
@@ -0,0 +1,36 @@
+import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
+
+const sidebar: SidebarsConfig = {
+  apisidebar: [
+    {
+      type: "doc",
+      id: "apis-tools/administration-sm-api/specifications/administration-api-self-managed",
+    },
+    {
+      type: "category",
+      label: "Usage Metrics",
+      items: [
+        {
+          type: "doc",
+          id: "apis-tools/administration-sm-api/specifications/get-usage-metrics",
+          label: "Get usage metrics for clusters",
+          className: "api-method get",
+        },
+      ],
+    },
+    {
+      type: "category",
+      label: "Clusters",
+      items: [
+        {
+          type: "doc",
+          id: "apis-tools/administration-sm-api/specifications/get-clusters",
+          label: "Get current clusters",
+          className: "api-method get",
+        },
+      ],
+    },
+  ],
+};
+
+export default sidebar.apisidebar;
diff --git a/docs/apis-tools/camunda-api-rest/sidebar-schema.js b/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"),
     },
   ],
 };