Add cluster ID to the topology API

api/camunda/camunda-openapi.yaml

@@ -9787,6 +9787,11 @@ components:
           description: ID of the last completed change
           type: string
           example: "-1"
+        clusterId:
+          description: The unique ID of the cluster.
+          type: string
+          nullable: true
+          example: "cluster-12345"
     LicenseResponse:
       description: The response of a license request.
       type: object

docs/apis-tools/build-your-own-client.md

@@ -118,7 +118,8 @@ Response contents:
   ],
   "clusterSize": 1,
   "partitionsCount": 2,
-  "replicationFactor": 1
+  "replicationFactor": 1,
+  "clusterId": "clusterId"
 }
 
 Response trailers received:

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

@@ -164,6 +164,11 @@ Obtains the current topology of the cluster the gateway is part of.
                 type: "string",
                 example: "-1",
               },
+              clusterId: {
+                description: "The cluster's unique ID.",
+                type: "string",
+                nullable: true,
+              },
             },
             title: "TopologyResponse",
           },

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

@@ -137,6 +137,11 @@ Obtains the current topology of the cluster the gateway is part of.
                 type: "string",
                 nullable: true,
               },
+              clusterId: {
+                description: "the cluster's unique ID.",
+                type: "string",
+                nullable: true,
+              },
             },
             title: "TopologyResponse",
           },

docs/apis-tools/zeebe-api-rest/zeebe-api-rest-authentication.md

@@ -130,7 +130,8 @@ A successful response includes [information about the cluster](/apis-tools/zeebe
   "clusterSize": 3,
   "partitionsCount": 3,
   "replicationFactor": 3,
-  "gatewayVersion": "8.6.0"
+  "gatewayVersion": "8.6.0",
+  "clusterId": "cluster-123456"
 }
 ```
 

docs/apis-tools/zeebe-api/gateway-service.md

@@ -1356,6 +1356,8 @@ message TopologyResponse {
   int32 replicationFactor = 4;
   // gateway version
   string gatewayVersion = 5;
+  // the cluster's unique ID
+  string clusterId = 6;
 }
 
 message BrokerInfo {

docs/self-managed/components/orchestration-cluster/zeebe/operations/cluster-scaling.md

@@ -387,7 +387,8 @@ The response would show that partitions are distributed to new brokers:
   "clusterSize": 6,
   "partitionsCount": 6,
   "replicationFactor": 3,
-  "gatewayVersion": "8.8.0"
+  "gatewayVersion": "8.8.0",
+  "clusterId": "clusterId"
 }
 ```
 
@@ -601,7 +602,8 @@ The response would show that the partitions are moved away from brokers `3`, `4`
    "clusterSize": 3,
    "partitionsCount": 6,
    "replicationFactor": 3,
-   "gatewayVersion": "8.8.0"
+   "gatewayVersion": "8.8.0",
+   "clusterId": "clusterId"
 }
 ```