regen vnext/zeebe-api-rest specs

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

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

docs/apis-tools/zeebe-api-rest/specifications/get-cluster-topology.api.mdx

@@ -5,44 +5,143 @@ description: "Obtains the current topology of the cluster the gateway is part of
 sidebar_label: "Get cluster topology"
 hide_title: true
 hide_table_of_contents: true
-api: eJy1Vttu2zgQ/RWCT7uAEzndlyJvqesGXvQSJO4utoEfKHkss6VELUk5dQX/+86QlCXbai5AFzBgiRqeM8M5M8OGO5FbfnnPJ6q2DgxfjPgSbGZk5aQu+SX/lDohS8vcGlhWGwOlY05XWul8y/QqrIfN/jkXDh7ElknLKmEcmpzzETdgK11aQK6GvxqP6e//4Ml06XAnwYuqUjITBJ98tcTRcJutoRCn5HMEbF0kMtFRG/i3BusI3G0rQGOdfoXM4XtldAXGyRBVavQ3MPYU/IopaclBFk3Qf+GYMNB6jgsYRoyuxySMEVt8LWulRKpwyZkaRlw6KAaIbozeSFxislxpU/jQGf5EJGalXsLTgZDVbDl8SHUp8TjYbw8SXSbk6PTvHpvN3jJk9vkJlD02iZnJUWEjHpwLS3+84rsRX2vrhgnpSykK8LgGRIa0+TCBdQa/EVylzU/g6MszoB7zlXImCfLRVHdWrBClyGHJPGvQJL2VIesn3G3SX5zkPSXbZ+dFed/vfyL5mORWsvstzzw7o0nEx9hv/VsKofhvxcoxMmyrPgZBWRMslxsoB3lj+kccyrqglqZALKMfSukH/yhLkTmE4AtSHQjl1k/50zajYN069SwPwhZKZl12z0v0C/nRAUSg8+A3LRin1Q22CBn61WkO4mFEmwH192DfeNsZ6sQvx1K9kz8GckDY6HWK2L1GJct+331Oko+b1UHBTHRd/qQwO+5e5VCLtBWW6pKJzGhrf4E3bQkiwTvUgjbD/uAgWcm8NlipvR1s5bfEJjfYs1/iS5xhfz2W8JjpVndfAFJg12HjkPaOSHpymMeRdhsHHYpiR98LcGuNJc9z8E1BUE3wpJ2AuGTBbPxou294bRR+bcIk3V0mSUMtenfZUGvdJZsLtN8II8kH31a63r4StaLzUDoTyi8fXzYOOr6fw0fxHjT3Fu/1+PV4EMp3+4ODu53ezdnVzYyFkDxg/1LQQq6dqwYhg/FToLvdgk4NW4d02zvaEu8IgJI2V3XoOjF1kcsj03swwpXw8K6V0Z9/z30dU+P322NeD53gvQbCx+cXJ1GQo6TfTBcFdnQSNo5BGhm9kHq6Ru0DqYVuBqLoCCdhv9uy98GCRR2zC88ahELBWVRJjvh1eo6kSSZw31IkPwgmSZVOkwKvfkkkssmX6fTN9Gzy6cOHzx9n83/O3s8m04930zPEPXffnT+EClWCg7Xn1TW47oLYafcg+Ka7IP6iC2fMoYPvLqkUApKifOhNrKR7vvdm0d507nnTpMLCZ6N2O1rGuWq2uL7oiofewpCiKUal9w22lL8sg8r5KlO1vzAcX3RJfPuivp6Sav4D0YQjZg==
+api: eJy1Vttu2zgQ/RVinnYBJUq6L4Xe0sQNvOglSNxdbAM/UNJYYiuRCkk59Qr698WQlC3bai5A1y+S6OE5MzxzYQeWFwaSe7isWmNRwzKCHE2mRWOFkpDA59RyIQ2zJbKs1RqlZVY1qlLFhqmVX/eb3XvBLT7yDROGNVxbplanEIFG0yhp0EDSwZuzM3r8HzyZkhalJXjeNJXIOMHH3wxxdGCyEmt+TL4okQ0uEhnfUWt8aNFYArebBiEBlX7DzEIEjVYNait8VKlW31GbY/ALVglDDrJgwmzJLeMaB8+ZLYUZohsxca35BiKQbVXxtEJIrG4xAmGxniC60WotcjRMyJXStQudKcl4IGZS5fh8IGQ1z6cPqZXioUX226OwpSDk4PTvDpvNr9hKeX085YhNSIsFaojAO+eX/ngDfQSlMnaakP6RvEaHq5FnpZDFNIGxWsiC4BqlfwJH/7wA6ilfSTNBkE9KvbNiNZe8wJw5Vp+T9CW96kfcg+ivFnlLybbqvEr37f5nxJ9fbVN2u+WFZ6cVJfEh9pX7StEX/y1fWUaGQ9WHIEg1zgqxRjnJG+SPAGVbU0urkOfBj6pSj+5VSJ5ZsUZYUtYhr2z5nD9DM/LWg1Mv8sBvITFbuXvPkeew7PsIrLB0HnAzgAGtrlEb4fvVsQbhMILNRPaPYN8527lcKbccSvVO/DuhAWHLtk5RjxuVkOO++xKRD5vVXsFcqlb+pDB33KPKoRZpGo08ZzzTyphf4M1QgkLJ9zyzSk/7kym5EkWrMWejHWzltoQmN9mzX+NLmGF/PSV4UHrIu6+IKbJrv3Eq9w5IRumwCCPtNgw66OkXQY22VDkkUKBrCpxqAuJhAkIEBvXajbb7DlpdQQKdn6R9Escdteg+6ai19vH6HCJYcy3IB9dWdr19xduKzqNSGa/c8uFlY6/juzl8EO9ecx/w3p69PZuEct1+7+BuZ3cLdnEzZz4kBzi+FAyQpbXNJKQ3fg6075d0almrhd3c0ZZwR0CuUV+0vusE6QKXQ6ZvbwRReHk/pNGffy9cHVPjd9uDrvtOwKiBwNnp+VEU5Cjlb6bqupUusWXhRsYopFFeVyJDyha6GfB6R3jp99sN++AtWMhjdu5YfaJQcCaJ40LYsk1PM1XHGa9bmfPtM61UGtdcyDhQmfjrbPZudnL5+ePHL5/mi39OPswvZ5/uZifnp+en9od1x9AoY2suR35do91dEXfZuxd+t7si/qIrZ1DR4g8bNxUXknLKBd+FWrqHrTfL4a5zD12XcoNfdNX3tPzQot5Acr/clQ99+TFFc4yK7ztuSMEsw8a6Oqtad2U4vOpS+m3L+npGefMfQ+wkNA==
 sidebar_class_name: "get api-method"
 info_path: docs/apis-tools/zeebe-api-rest/specifications/zeebe-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"}>Get cluster topology</h1>
+<Heading
+  as={"h1"}
+  className={"openapi__heading"}
+  children={"Get cluster topology"}
+></Heading>
 
-<MethodEndpoint method={"get"} path={"/topology"}></MethodEndpoint>
+<MethodEndpoint
+  method={"get"}
+  path={"/topology"}
+  context={"endpoint"}
+></MethodEndpoint>
 
 Obtains the current topology of the cluster the gateway is part of.
 
-## Request
+<ParamsDetails parameters={undefined}></ParamsDetails>
 
-<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
+<RequestSchema title={"Body"} body={undefined}></RequestSchema>
 
-Obtains the current topology of the cluster the gateway is part of.
-
-</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={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>brokers</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
-
-A list of brokers that are part of this cluster.
-
-</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"nodeId"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"description":"The unique (within a cluster) node ID for the broker.","type":"integer","format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"host"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The hostname for reaching the broker.","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"port"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"description":"The port for reaching the broker.","type":"integer","format":"int32"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>partitions</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
-
-A list of partitions managed or replicated on this broker.
-
-</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"partitionId"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"description":"The unique ID of this partition.","type":"integer","format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"role"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`leader`, `follower`, `inactive`]"} schema={{"description":"Describes the Raft role of the broker for a given partition.","type":"string","enum":["leader","follower","inactive"]}}></SchemaItem><SchemaItem collapsible={false} name={"health"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`healthy`, `unhealthy`, `dead`]"} schema={{"description":"Describes the current health of the partition.","type":"string","enum":["healthy","unhealthy","dead"]}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The broker version.","type":"string"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"clusterSize"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"description":"The number of brokers in the cluster.","type":"integer","format":"int32","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"partitionsCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"description":"The number of partitions are spread across the cluster.","type":"integer","format":"int32","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"replicationFactor"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"description":"The configured replication factor for this cluster.","type":"integer","format":"int32","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"gatewayVersion"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The version of the Zeebe Gateway.","type":"string","nullable":true}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"brokers\": [\n    {\n      \"nodeId\": 0,\n      \"host\": \"string\",\n      \"port\": 0,\n      \"partitions\": [\n        {\n          \"partitionId\": 0,\n          \"role\": \"leader\",\n          \"health\": \"healthy\"\n        }\n      ],\n      \"version\": \"string\"\n    }\n  ],\n  \"clusterSize\": 0,\n  \"partitionsCount\": 0,\n  \"replicationFactor\": 0,\n  \"gatewayVersion\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
+<StatusCodes
+  id={undefined}
+  label={undefined}
+  responses={{
+    "200": {
+      description:
+        "Obtains the current topology of the cluster the gateway is part of.",
+      content: {
+        "application/json": {
+          schema: {
+            description: "The response of a topology request.",
+            type: "object",
+            properties: {
+              brokers: {
+                description: "A list of brokers that are part of this cluster.",
+                type: "array",
+                nullable: true,
+                items: {
+                  description: "Provides information on a broker node.",
+                  type: "object",
+                  properties: {
+                    nodeId: {
+                      description:
+                        "The unique (within a cluster) node ID for the broker.",
+                      type: "integer",
+                      format: "int32",
+                    },
+                    host: {
+                      description: "The hostname for reaching the broker.",
+                      type: "string",
+                    },
+                    port: {
+                      description: "The port for reaching the broker.",
+                      type: "integer",
+                      format: "int32",
+                    },
+                    partitions: {
+                      description:
+                        "A list of partitions managed or replicated on this broker.",
+                      type: "array",
+                      items: {
+                        description:
+                          "Provides information on a partition within a broker node.",
+                        type: "object",
+                        properties: {
+                          partitionId: {
+                            description: "The unique ID of this partition.",
+                            type: "integer",
+                            format: "int32",
+                          },
+                          role: {
+                            description:
+                              "Describes the Raft role of the broker for a given partition.",
+                            type: "string",
+                            enum: ["leader", "follower", "inactive"],
+                          },
+                          health: {
+                            description:
+                              "Describes the current health of the partition.",
+                            type: "string",
+                            enum: ["healthy", "unhealthy", "dead"],
+                          },
+                        },
+                        title: "Partition",
+                      },
+                    },
+                    version: {
+                      description: "The broker version.",
+                      type: "string",
+                    },
+                  },
+                  title: "BrokerInfo",
+                },
+              },
+              clusterSize: {
+                description: "The number of brokers in the cluster.",
+                type: "integer",
+                format: "int32",
+                nullable: true,
+              },
+              partitionsCount: {
+                description:
+                  "The number of partitions are spread across the cluster.",
+                type: "integer",
+                format: "int32",
+                nullable: true,
+              },
+              replicationFactor: {
+                description:
+                  "The configured replication factor for this cluster.",
+                type: "integer",
+                format: "int32",
+                nullable: true,
+              },
+              gatewayVersion: {
+                description: "The version of the Zeebe Gateway.",
+                type: "string",
+                nullable: true,
+              },
+            },
+            title: "TopologyResponse",
+          },
+        },
+      },
+    },
+  }}
+></StatusCodes>

docs/apis-tools/zeebe-api-rest/specifications/sidebar.ts

@@ -0,0 +1,54 @@
+import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
+
+const sidebar: SidebarsConfig = {
+  apisidebar: [
+    {
+      type: "doc",
+      id: "apis-tools/zeebe-api-rest/specifications/zeebe-rest-api",
+    },
+    {
+      type: "category",
+      label: "Cluster",
+      items: [
+        {
+          type: "doc",
+          id: "apis-tools/zeebe-api-rest/specifications/get-cluster-topology",
+          label: "Get cluster topology",
+          className: "api-method get",
+        },
+      ],
+    },
+    {
+      type: "category",
+      label: "User task",
+      items: [
+        {
+          type: "doc",
+          id: "apis-tools/zeebe-api-rest/specifications/complete-a-user-task",
+          label: "Complete a user task",
+          className: "api-method post",
+        },
+        {
+          type: "doc",
+          id: "apis-tools/zeebe-api-rest/specifications/assign-a-user-task",
+          label: "Assign a user task",
+          className: "api-method post",
+        },
+        {
+          type: "doc",
+          id: "apis-tools/zeebe-api-rest/specifications/update-a-user-task",
+          label: "Update a user task",
+          className: "api-method patch",
+        },
+        {
+          type: "doc",
+          id: "apis-tools/zeebe-api-rest/specifications/unassign-a-user-task",
+          label: "Unassign a user task",
+          className: "api-method delete",
+        },
+      ],
+    },
+  ],
+};
+
+export default sidebar.apisidebar;