work on comments

Author: ychebotarev

openapi/openapiv2.json

@@ -2225,7 +2225,7 @@
           },
           {
             "name": "query",
-            "description": "`query` in ListWorkers is used to filter workers based on worker status info.\nThe following worker status attributes are expected are supported as part of the query:\n* WorkerId\n* WorkerIdentity\n* HostId\n* TaskQueue\n* DeploymentName\n* BuildId\n* SdkName\n* SdkVersion\n* Uptime\n* LastHeartbeatTime\n* Status\nCurrently metrics are not supported as a part of ListWorkers query.",
+            "description": "`query` in ListWorkers is used to filter workers based on worker status info.\nThe following worker status attributes are expected are supported as part of the query:\n* WorkerId\n* WorkerIdentity\n* HostId\n* TaskQueue\n* DeploymentName\n* BuildId\n* SdkName\n* SdkVersion\n* StartTime\n* LastHeartbeatTime\n* Status\nCurrently metrics are not supported as a part of ListWorkers query.",
             "in": "query",
             "required": false,
             "type": "string"
@@ -5866,7 +5866,7 @@
           },
           {
             "name": "query",
-            "description": "`query` in ListWorkers is used to filter workers based on worker status info.\nThe following worker status attributes are expected are supported as part of the query:\n* WorkerId\n* WorkerIdentity\n* HostId\n* TaskQueue\n* DeploymentName\n* BuildId\n* SdkName\n* SdkVersion\n* Uptime\n* LastHeartbeatTime\n* Status\nCurrently metrics are not supported as a part of ListWorkers query.",
+            "description": "`query` in ListWorkers is used to filter workers based on worker status info.\nThe following worker status attributes are expected are supported as part of the query:\n* WorkerId\n* WorkerIdentity\n* HostId\n* TaskQueue\n* DeploymentName\n* BuildId\n* SdkName\n* SdkVersion\n* StartTime\n* LastHeartbeatTime\n* Status\nCurrently metrics are not supported as a part of ListWorkers query.",
             "in": "query",
             "required": false,
             "type": "string"
@@ -15290,7 +15290,7 @@
     "v1WorkerInfo": {
       "type": "object",
       "properties": {
-        "workerId": {
+        "workerInstanceKey": {
           "type": "string",
           "description": "Worker identifier, should be unique for the namespace.\nIt is different from worker identity, which is usually a combination of host_name and process_id."
         },
@@ -15315,9 +15315,10 @@
           "$ref": "#/definitions/v1WorkerStatus",
           "description": "Worker status. Possible values - \"running\", \"shutting_down\", \"shutdown\"."
         },
-        "uptime": {
+        "startTime": {
           "type": "string",
-          "title": "Uptime of the worker, since it started.\nThis is the time since the worker started, not the time since the last heartbeat.\nIt can be used to determine worker start time. (current time - uptime)"
+          "format": "date-time",
+          "title": "Worker start time.\nIt can be used to determine worker uptime. (current time - start time)"
         },
         "lastHeartbeatTime": {
           "type": "string",
@@ -15407,7 +15408,7 @@
         "processedTasks": {
           "type": "integer",
           "format": "int32",
-          "description": "Total number of tasks processed by the worker so far."
+          "description": "Total number of tasks processed (completed both successfully and unsuccesfully)\nby the worker since the worker started. This is a cumulative counter."
         },
         "failedTasks": {
           "type": "integer",

openapi/openapiv3.yaml

@@ -2017,7 +2017,7 @@ paths:
             * BuildId
             * SdkName
             * SdkVersion
-            * Uptime
+            * StartTime
             * LastHeartbeatTime
             * Status
              Currently metrics are not supported as a part of ListWorkers query.
@@ -5282,7 +5282,7 @@ paths:
             * BuildId
             * SdkName
             * SdkVersion
-            * Uptime
+            * StartTime
             * LastHeartbeatTime
             * Status
              Currently metrics are not supported as a part of ListWorkers query.
@@ -12682,7 +12682,7 @@ components:
     WorkerInfo:
       type: object
       properties:
-        workerId:
+        workerInstanceKey:
           type: string
           description: |-
             Worker identifier, should be unique for the namespace.
@@ -12709,13 +12709,12 @@ components:
           type: string
           description: Worker status. Possible values - "running", "shutting_down", "shutdown".
           format: enum
-        uptime:
-          pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
+        startTime:
           type: string
           description: |-
-            Uptime of the worker, since it started.
-             This is the time since the worker started, not the time since the last heartbeat.
-             It can be used to determine worker start time. (current time - uptime)
+            Worker start time.
+             It can be used to determine worker uptime. (current time - start time)
+          format: date-time
         lastHeartbeatTime:
           type: string
           description: Last heartbeat time, coming from the worker. Worker should set it to "now".
@@ -12781,7 +12780,9 @@ components:
           format: int32
         processedTasks:
           type: integer
-          description: Total number of tasks processed by the worker so far.
+          description: |-
+            Total number of tasks processed (completed both successfully and unsuccesfully)
+             by the worker since the worker started. This is a cumulative counter.
           format: int32
         failedTasks:
           type: integer

temporal/api/worker/v1/message.proto

@@ -9,8 +9,6 @@ option java_outer_classname = "MessageProto";
 option ruby_package = "Temporalio::Api::Worker::V1";
 option csharp_namespace = "Temporalio.Api.Worker.V1";
 
-
-import "google/protobuf/duration.proto";
 import "google/protobuf/timestamp.proto";
 import "temporal/api/deployment/v1/message.proto";
 import "temporal/api/enums/v1/common.proto";
@@ -31,7 +29,8 @@ message WorkerSlotsInfo {
   // Number of slots used by the worker for specific tasks.
   int32 slots_used = 2;
 
-  // Total number of tasks processed by the worker so far.
+  // Total number of tasks processed (completed both successfully and unsuccesfully)
+  // by the worker since the worker started. This is a cumulative counter.
   int32 processed_tasks = 3;
   // Total number of failed tasks processed by the worker so far.
   int32 failed_tasks = 4;
@@ -60,7 +59,7 @@ message WorkerHostInfo {
 message WorkerInfo {
   // Worker identifier, should be unique for the namespace.
   // It is different from worker identity, which is usually a combination of host_name and process_id.
-  string worker_id = 1;
+  string worker_instance_key = 1;
 
   // Worker host information.
   WorkerHostInfo host_info = 2;
@@ -76,10 +75,9 @@ message WorkerInfo {
   // Worker status. Possible values - "running", "shutting_down", "shutdown".
   temporal.api.enums.v1.WorkerStatus status = 7;
 
-  // Uptime of the worker, since it started.
-  // This is the time since the worker started, not the time since the last heartbeat.
-  // It can be used to determine worker start time. (current time - uptime)
-  google.protobuf.Duration uptime = 8;
+  // Worker start time.
+  // It can be used to determine worker uptime. (current time - start time)
+  google.protobuf.Timestamp start_time = 8;
 
   // Last heartbeat time, coming from the worker. Worker should set it to "now".
   google.protobuf.Timestamp last_heartbeat_time = 9;

temporal/api/workflowservice/v1/request_response.proto

@@ -2376,7 +2376,7 @@ message ListWorkersRequest {
     //* BuildId
     //* SdkName
     //* SdkVersion
-    //* Uptime
+    //* StartTime
     //* LastHeartbeatTime
     //* Status
     // Currently metrics are not supported as a part of ListWorkers query.