comments

temporalio · Jan 29, 2025 · 5fa8931 · 5fa8931
1 parent fd4c186
commit 5fa8931
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 21 deletions.
diff --git a/openapi/openapiv2.json b/openapi/openapiv2.json
@@ -480,7 +480,7 @@
     "/api/v1/namespaces/{namespace}/activities/pause": {
       "post": {
         "summary": "PauseActivity pauses the execution of an activity specified by its ID or type.\nIf there are multiple pending activities of the provided type - all of them will be paused",
-        "description": "Pausing an activity means:\n- If the activity is currently waiting for a retry or is running and subsequently fails,\n  it will not be rescheduled until it is unpause.\n- If the activity is already paused, calling this method will have no effect.\n- If the activity is running and finishes successfully, the activity will be completed.\n- If the activity is running and finishes with failure:\n  * if there is no retry left - the activity will be completed.\n  * if there are more retries left - the activity will be paused.\nFor long-running activities:\n- activities in paused state will send a cancellation with \"activity_paused\" set to 'true' in response to 'RecordActivityTaskHeartbeat'.\n- The activity should respond to the cancellation accordingly.\n\nReturns a `NotFound` error if there is no pending activity with the provided ID or type",
+        "description": "Pausing an activity means:\n- If the activity is currently waiting for a retry or is running and subsequently fails,\n  it will not be rescheduled until it is unpaused.\n- If the activity is already paused, calling this method will have no effect.\n- If the activity is running and finishes successfully, the activity will be completed.\n- If the activity is running and finishes with failure:\n  * if there is no retry left - the activity will be completed.\n  * if there are more retries left - the activity will be paused.\nFor long-running activities:\n- activities in paused state will send a cancellation with \"activity_paused\" set to 'true' in response to 'RecordActivityTaskHeartbeat'.\n- The activity should respond to the cancellation accordingly.\n\nReturns a `NotFound` error if there is no pending activity with the provided ID or type",
         "operationId": "PauseActivity2",
         "responses": {
           "200": {
@@ -521,7 +521,7 @@
     "/api/v1/namespaces/{namespace}/activities/reset": {
       "post": {
         "summary": "ResetActivity resets the execution of an activity specified by its ID or type.\nIf there are multiple pending activities of the provided type - all of them will be reset.",
-        "description": "Resetting an activity means:\n* number of attempts will be reset to 0.\n* activity timeouts will be reset.\n* if the activity is waiting for retry, and it is not paused or 'keep_paused' is not provided:\n   it will be scheduled immediately (* see 'jitter' flag),\n\nFlags:\n\n'jitter': the activity will be scheduled at a random time within the jitter duration.\nIf the activity currently paused it will be unpause, unless 'keep_paused' flag is provided.\n'reset_heartbeats': the activity heartbeat timer and heartbeats will be reset.\n'keep_paused': if the activity is paused, it will remain paused.\n\nReturns a `NotFound` error if there is no pending activity with the provided ID or type.",
+        "description": "Resetting an activity means:\n* number of attempts will be reset to 0.\n* activity timeouts will be reset.\n* if the activity is waiting for retry, and it is not paused or 'keep_paused' is not provided:\n   it will be scheduled immediately (* see 'jitter' flag),\n\nFlags:\n\n'jitter': the activity will be scheduled at a random time within the jitter duration.\nIf the activity currently paused it will be unpaused, unless 'keep_paused' flag is provided.\n'reset_heartbeats': the activity heartbeat timer and heartbeats will be reset.\n'keep_paused': if the activity is paused, it will remain paused.\n\nReturns a `NotFound` error if there is no pending activity with the provided ID or type.",
         "operationId": "ResetActivity2",
         "responses": {
           "200": {
@@ -562,7 +562,7 @@
     "/api/v1/namespaces/{namespace}/activities/unpause": {
       "post": {
         "summary": "UnpauseActivity unpauses the execution of an activity specified by its ID or type.\nIf there are multiple pending activities of the provided type - all of them will be unpaused.",
-        "description": "If activity is not paused, this call will have no effect.\nIf the activity was paused while waiting for retry, it will be scheduled immediately (* see 'jitter' flag).\nOnce the activity is unpause, all timeout timers will be regenerated.\n\nFlags:\n'jitter': the activity will be scheduled at a random time within the jitter duration.\n'reset_attempts': the number of attempts will be reset.\n'reset_heartbeat': the activity heartbeat timer and heartbeats will be reset.\n\nReturns a `NotFound` error if there is no pending activity with the provided ID or type",
+        "description": "If activity is not paused, this call will have no effect.\nIf the activity was paused while waiting for retry, it will be scheduled immediately (* see 'jitter' flag).\nOnce the activity is unpaused, all timeout timers will be regenerated.\n\nFlags:\n'jitter': the activity will be scheduled at a random time within the jitter duration.\n'reset_attempts': the number of attempts will be reset.\n'reset_heartbeat': the activity heartbeat timer and heartbeats will be reset.\n\nReturns a `NotFound` error if there is no pending activity with the provided ID or type",
         "operationId": "UnpauseActivity2",
         "responses": {
           "200": {
@@ -3482,7 +3482,7 @@
     "/namespaces/{namespace}/activities/pause": {
       "post": {
         "summary": "PauseActivity pauses the execution of an activity specified by its ID or type.\nIf there are multiple pending activities of the provided type - all of them will be paused",
-        "description": "Pausing an activity means:\n- If the activity is currently waiting for a retry or is running and subsequently fails,\n  it will not be rescheduled until it is unpause.\n- If the activity is already paused, calling this method will have no effect.\n- If the activity is running and finishes successfully, the activity will be completed.\n- If the activity is running and finishes with failure:\n  * if there is no retry left - the activity will be completed.\n  * if there are more retries left - the activity will be paused.\nFor long-running activities:\n- activities in paused state will send a cancellation with \"activity_paused\" set to 'true' in response to 'RecordActivityTaskHeartbeat'.\n- The activity should respond to the cancellation accordingly.\n\nReturns a `NotFound` error if there is no pending activity with the provided ID or type",
+        "description": "Pausing an activity means:\n- If the activity is currently waiting for a retry or is running and subsequently fails,\n  it will not be rescheduled until it is unpaused.\n- If the activity is already paused, calling this method will have no effect.\n- If the activity is running and finishes successfully, the activity will be completed.\n- If the activity is running and finishes with failure:\n  * if there is no retry left - the activity will be completed.\n  * if there are more retries left - the activity will be paused.\nFor long-running activities:\n- activities in paused state will send a cancellation with \"activity_paused\" set to 'true' in response to 'RecordActivityTaskHeartbeat'.\n- The activity should respond to the cancellation accordingly.\n\nReturns a `NotFound` error if there is no pending activity with the provided ID or type",
         "operationId": "PauseActivity",
         "responses": {
           "200": {
@@ -3523,7 +3523,7 @@
     "/namespaces/{namespace}/activities/reset": {
       "post": {
         "summary": "ResetActivity resets the execution of an activity specified by its ID or type.\nIf there are multiple pending activities of the provided type - all of them will be reset.",
-        "description": "Resetting an activity means:\n* number of attempts will be reset to 0.\n* activity timeouts will be reset.\n* if the activity is waiting for retry, and it is not paused or 'keep_paused' is not provided:\n   it will be scheduled immediately (* see 'jitter' flag),\n\nFlags:\n\n'jitter': the activity will be scheduled at a random time within the jitter duration.\nIf the activity currently paused it will be unpause, unless 'keep_paused' flag is provided.\n'reset_heartbeats': the activity heartbeat timer and heartbeats will be reset.\n'keep_paused': if the activity is paused, it will remain paused.\n\nReturns a `NotFound` error if there is no pending activity with the provided ID or type.",
+        "description": "Resetting an activity means:\n* number of attempts will be reset to 0.\n* activity timeouts will be reset.\n* if the activity is waiting for retry, and it is not paused or 'keep_paused' is not provided:\n   it will be scheduled immediately (* see 'jitter' flag),\n\nFlags:\n\n'jitter': the activity will be scheduled at a random time within the jitter duration.\nIf the activity currently paused it will be unpaused, unless 'keep_paused' flag is provided.\n'reset_heartbeats': the activity heartbeat timer and heartbeats will be reset.\n'keep_paused': if the activity is paused, it will remain paused.\n\nReturns a `NotFound` error if there is no pending activity with the provided ID or type.",
         "operationId": "ResetActivity",
         "responses": {
           "200": {
@@ -3564,7 +3564,7 @@
     "/namespaces/{namespace}/activities/unpause": {
       "post": {
         "summary": "UnpauseActivity unpauses the execution of an activity specified by its ID or type.\nIf there are multiple pending activities of the provided type - all of them will be unpaused.",
-        "description": "If activity is not paused, this call will have no effect.\nIf the activity was paused while waiting for retry, it will be scheduled immediately (* see 'jitter' flag).\nOnce the activity is unpause, all timeout timers will be regenerated.\n\nFlags:\n'jitter': the activity will be scheduled at a random time within the jitter duration.\n'reset_attempts': the number of attempts will be reset.\n'reset_heartbeat': the activity heartbeat timer and heartbeats will be reset.\n\nReturns a `NotFound` error if there is no pending activity with the provided ID or type",
+        "description": "If activity is not paused, this call will have no effect.\nIf the activity was paused while waiting for retry, it will be scheduled immediately (* see 'jitter' flag).\nOnce the activity is unpaused, all timeout timers will be regenerated.\n\nFlags:\n'jitter': the activity will be scheduled at a random time within the jitter duration.\n'reset_attempts': the number of attempts will be reset.\n'reset_heartbeat': the activity heartbeat timer and heartbeats will be reset.\n\nReturns a `NotFound` error if there is no pending activity with the provided ID or type",
         "operationId": "UnpauseActivity",
         "responses": {
           "200": {
@@ -5883,7 +5883,7 @@
         },
         "id": {
           "type": "string",
-          "description": "Only activity with this ID will be paused."
+          "description": "Only the activity with this ID will be paused."
         },
         "type": {
           "type": "string",
@@ -6596,7 +6596,7 @@
         },
         "id": {
           "type": "string",
-          "description": "Only activity with this ID will be unpause."
+          "description": "Only the activity with this ID will be unpaused."
         },
         "type": {
           "type": "string",

diff --git a/openapi/openapiv3.yaml b/openapi/openapiv3.yaml
@@ -426,7 +426,7 @@ paths:
 
          Pausing an activity means:
          - If the activity is currently waiting for a retry or is running and subsequently fails,
-           it will not be rescheduled until it is unpause.
+           it will not be rescheduled until it is unpaused.
          - If the activity is already paused, calling this method will have no effect.
          - If the activity is running and finishes successfully, the activity will be completed.
          - If the activity is running and finishes with failure:
@@ -481,7 +481,7 @@ paths:
          Flags:
 
          'jitter': the activity will be scheduled at a random time within the jitter duration.
-         If the activity currently paused it will be unpause, unless 'keep_paused' flag is provided.
+         If the activity currently paused it will be unpaused, unless 'keep_paused' flag is provided.
          'reset_heartbeats': the activity heartbeat timer and heartbeats will be reset.
          'keep_paused': if the activity is paused, it will remain paused.
 
@@ -523,7 +523,7 @@ paths:
 
          If activity is not paused, this call will have no effect.
          If the activity was paused while waiting for retry, it will be scheduled immediately (* see 'jitter' flag).
-         Once the activity is unpause, all timeout timers will be regenerated.
+         Once the activity is unpaused, all timeout timers will be regenerated.
 
          Flags:
          'jitter': the activity will be scheduled at a random time within the jitter duration.
@@ -3093,7 +3093,7 @@ paths:
 
          Pausing an activity means:
          - If the activity is currently waiting for a retry or is running and subsequently fails,
-           it will not be rescheduled until it is unpause.
+           it will not be rescheduled until it is unpaused.
          - If the activity is already paused, calling this method will have no effect.
          - If the activity is running and finishes successfully, the activity will be completed.
          - If the activity is running and finishes with failure:
@@ -3148,7 +3148,7 @@ paths:
          Flags:
 
          'jitter': the activity will be scheduled at a random time within the jitter duration.
-         If the activity currently paused it will be unpause, unless 'keep_paused' flag is provided.
+         If the activity currently paused it will be unpaused, unless 'keep_paused' flag is provided.
          'reset_heartbeats': the activity heartbeat timer and heartbeats will be reset.
          'keep_paused': if the activity is paused, it will remain paused.
 
@@ -3190,7 +3190,7 @@ paths:
 
          If activity is not paused, this call will have no effect.
          If the activity was paused while waiting for retry, it will be scheduled immediately (* see 'jitter' flag).
-         Once the activity is unpause, all timeout timers will be regenerated.
+         Once the activity is unpaused, all timeout timers will be regenerated.
 
          Flags:
          'jitter': the activity will be scheduled at a random time within the jitter duration.
@@ -7494,7 +7494,7 @@ components:
           description: The identity of the client who initiated this request.
         id:
           type: string
-          description: Only activity with this ID will be paused.
+          description: Only the activity with this ID will be paused.
         type:
           type: string
           description: Pause all running activities of this type.
@@ -9785,7 +9785,7 @@ components:
           description: The identity of the client who initiated this request.
         id:
           type: string
-          description: Only activity with this ID will be unpause.
+          description: Only the activity with this ID will be unpaused.
         type:
           type: string
           description: Unpause all running activities with of this type.

diff --git a/temporal/api/workflowservice/v1/request_response.proto b/temporal/api/workflowservice/v1/request_response.proto
@@ -1787,7 +1787,7 @@ message PauseActivityRequest {
 
     // either activity id or activity type must be provided
     oneof activity {
-        // Only activity with this ID will be paused.
+        // Only the activity with this ID will be paused.
         string id = 4;
         // Pause all running activities of this type.
         string type = 5;
@@ -1809,7 +1809,7 @@ message UnpauseActivityRequest {
 
     // either activity id or activity type must be provided
     oneof activity {
-        // Only activity with this ID will be unpause.
+        // Only the activity with this ID will be unpaused.
         string id = 4;
         // Unpause all running activities with of this type.
         string type = 5;

diff --git a/temporal/api/workflowservice/v1/service.proto b/temporal/api/workflowservice/v1/service.proto
@@ -950,7 +950,7 @@ service WorkflowService {
     //
     // Pausing an activity means:
     // - If the activity is currently waiting for a retry or is running and subsequently fails,
-    //   it will not be rescheduled until it is unpause.
+    //   it will not be rescheduled until it is unpaused.
     // - If the activity is already paused, calling this method will have no effect.
     // - If the activity is running and finishes successfully, the activity will be completed.
     // - If the activity is running and finishes with failure:
@@ -977,7 +977,7 @@ service WorkflowService {
     //
     // If activity is not paused, this call will have no effect.
     // If the activity was paused while waiting for retry, it will be scheduled immediately (* see 'jitter' flag).
-    // Once the activity is unpause, all timeout timers will be regenerated.
+    // Once the activity is unpaused, all timeout timers will be regenerated.
     //
     // Flags:
     // 'jitter': the activity will be scheduled at a random time within the jitter duration.
@@ -1008,7 +1008,7 @@ service WorkflowService {
     // Flags:
     //
     // 'jitter': the activity will be scheduled at a random time within the jitter duration.
-    // If the activity currently paused it will be unpause, unless 'keep_paused' flag is provided.
+    // If the activity currently paused it will be unpaused, unless 'keep_paused' flag is provided.
     // 'reset_heartbeats': the activity heartbeat timer and heartbeats will be reset.
     // 'keep_paused': if the activity is paused, it will remain paused.
     //