Add CountWorkers API

openapi/openapiv2.json

@@ -2755,6 +2755,51 @@
         ]
       }
     },
+    "/api/v1/namespaces/{namespace}/worker-count": {
+      "get": {
+        "summary": "CountWorkers counts the number of workers in a specific namespace.",
+        "operationId": "CountWorkers2",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/v1CountWorkersResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "namespace",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "query",
+            "description": "Query to filter workers before counting.\nSupported filter fields are the same as in ListWorkersRequest.",
+            "in": "query",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "includeSystemWorkers",
+            "description": "When true, the count will include system workers that are created implicitly\nby the server and not by the user. By default, system workers are excluded.",
+            "in": "query",
+            "required": false,
+            "type": "boolean"
+          }
+        ],
+        "tags": [
+          "WorkflowService"
+        ]
+      }
+    },
     "/api/v1/namespaces/{namespace}/worker-deployment-versions/{deploymentVersion.deploymentName}": {
       "post": {
         "summary": "Creates a new Worker Deployment Version.",
@@ -8244,6 +8289,51 @@
         ]
       }
     },
+    "/namespaces/{namespace}/worker-count": {
+      "get": {
+        "summary": "CountWorkers counts the number of workers in a specific namespace.",
+        "operationId": "CountWorkers",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/v1CountWorkersResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "namespace",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "query",
+            "description": "Query to filter workers before counting.\nSupported filter fields are the same as in ListWorkersRequest.",
+            "in": "query",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "includeSystemWorkers",
+            "description": "When true, the count will include system workers that are created implicitly\nby the server and not by the user. By default, system workers are excluded.",
+            "in": "query",
+            "required": false,
+            "type": "boolean"
+          }
+        ],
+        "tags": [
+          "WorkflowService"
+        ]
+      }
+    },
     "/namespaces/{namespace}/worker-deployment-versions/{deploymentVersion.deploymentName}": {
       "post": {
         "summary": "Creates a new Worker Deployment Version.",
@@ -14743,6 +14833,16 @@
         }
       }
     },
+    "v1CountWorkersResponse": {
+      "type": "object",
+      "properties": {
+        "count": {
+          "type": "string",
+          "format": "int64",
+          "description": "Number of workers matching the query."
+        }
+      }
+    },
     "v1CountWorkflowExecutionsResponse": {
       "type": "object",
       "properties": {

openapi/openapiv3.yaml

@@ -2487,6 +2487,45 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Status'
+  /api/v1/namespaces/{namespace}/worker-count:
+    get:
+      tags:
+        - WorkflowService
+      description: CountWorkers counts the number of workers in a specific namespace.
+      operationId: CountWorkers
+      parameters:
+        - name: namespace
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: query
+          in: query
+          description: |-
+            Query to filter workers before counting.
+             Supported filter fields are the same as in ListWorkersRequest.
+          schema:
+            type: string
+        - name: includeSystemWorkers
+          in: query
+          description: |-
+            When true, the count will include system workers that are created implicitly
+             by the server and not by the user. By default, system workers are excluded.
+          schema:
+            type: boolean
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CountWorkersResponse'
+        default:
+          description: Default error response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Status'
   /api/v1/namespaces/{namespace}/worker-deployment-versions/{deployment_version.deployment_name}:
     post:
       tags:
@@ -7444,6 +7483,45 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Status'
+  /namespaces/{namespace}/worker-count:
+    get:
+      tags:
+        - WorkflowService
+      description: CountWorkers counts the number of workers in a specific namespace.
+      operationId: CountWorkers
+      parameters:
+        - name: namespace
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: query
+          in: query
+          description: |-
+            Query to filter workers before counting.
+             Supported filter fields are the same as in ListWorkersRequest.
+          schema:
+            type: string
+        - name: includeSystemWorkers
+          in: query
+          description: |-
+            When true, the count will include system workers that are created implicitly
+             by the server and not by the user. By default, system workers are excluded.
+          schema:
+            type: boolean
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CountWorkersResponse'
+        default:
+          description: Default error response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Status'
   /namespaces/{namespace}/worker-deployment-versions/{deployment_version.deployment_name}:
     post:
       tags:
@@ -11129,6 +11207,12 @@ components:
             $ref: '#/components/schemas/Payload'
         count:
           type: string
+    CountWorkersResponse:
+      type: object
+      properties:
+        count:
+          type: string
+          description: Number of workers matching the query.
     CountWorkflowExecutionsResponse:
       type: object
       properties:

temporal/api/workflowservice/v1/request_response.proto

@@ -3062,6 +3062,21 @@ message DescribeWorkerResponse {
     temporal.api.worker.v1.WorkerInfo worker_info = 1;
 }
 
+message CountWorkersRequest {
+    string namespace = 1;
+    // Query to filter workers before counting.
+    // Supported filter fields are the same as in ListWorkersRequest.
+    string query = 2;
+    // When true, the count will include system workers that are created implicitly
+    // by the server and not by the user. By default, system workers are excluded.
+    bool include_system_workers = 3;
+}
+
+message CountWorkersResponse {
+    // Number of workers matching the query.
+    int64 count = 1;
+}
+
 // Request to pause a workflow execution.
 message PauseWorkflowExecutionRequest {
     // Namespace of the workflow to pause.

temporal/api/workflowservice/v1/service.proto

@@ -1565,6 +1565,16 @@ service WorkflowService {
         };
     }
 
+    // CountWorkers counts the number of workers in a specific namespace.
+    rpc CountWorkers (CountWorkersRequest) returns (CountWorkersResponse) {
+        option (google.api.http) = {
+            get: "/namespaces/{namespace}/worker-count"
+            additional_bindings {
+                get: "/api/v1/namespaces/{namespace}/worker-count"
+            }
+        };
+    }
+
     // Updates task queue configuration.
     // For the overall queue rate limit: the rate limit set by this api overrides the worker-set rate limit,
     // which uncouples the rate limit from the worker lifecycle.