Skip to content

Commit fa2c2e2

Browse files
authored
Mark pause activity by type API as experimental (#642)
<!-- Describe what has changed in this PR --> What: Annotating the pause activity by type parameter as experimental. <!-- Tell your future self why have you made these changes --> Why: We might revisit this API and change its behavior. So marking it as experimental.
1 parent a09b22e commit fa2c2e2

File tree

4 files changed

+23
-14
lines changed

4 files changed

+23
-14
lines changed

openapi/openapiv2.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2906,7 +2906,7 @@
29062906
},
29072907
"/api/v1/namespaces/{namespace}/workflows/{execution.workflowId}/history-reverse": {
29082908
"get": {
2909-
"summary": "GetWorkflowExecutionHistoryReverse returns the history of specified workflow execution in reverse \norder (starting from last event). Fails with`NotFound` if the specified workflow execution is \nunknown to the service.",
2909+
"summary": "GetWorkflowExecutionHistoryReverse returns the history of specified workflow execution in reverse\norder (starting from last event). Fails with`NotFound` if the specified workflow execution is\nunknown to the service.",
29102910
"operationId": "GetWorkflowExecutionHistoryReverse2",
29112911
"responses": {
29122912
"200": {
@@ -6731,7 +6731,7 @@
67316731
},
67326732
"/namespaces/{namespace}/workflows/{execution.workflowId}/history-reverse": {
67336733
"get": {
6734-
"summary": "GetWorkflowExecutionHistoryReverse returns the history of specified workflow execution in reverse \norder (starting from last event). Fails with`NotFound` if the specified workflow execution is \nunknown to the service.",
6734+
"summary": "GetWorkflowExecutionHistoryReverse returns the history of specified workflow execution in reverse\norder (starting from last event). Fails with`NotFound` if the specified workflow execution is\nunknown to the service.",
67356735
"operationId": "GetWorkflowExecutionHistoryReverse",
67366736
"responses": {
67376737
"200": {
@@ -8029,7 +8029,7 @@
80298029
},
80308030
"type": {
80318031
"type": "string",
8032-
"description": "Pause all running activities of this type."
8032+
"description": "Pause all running activities of this type.\nNote: Experimental - the behavior of pause by activity type might change in a future release."
80338033
},
80348034
"reason": {
80358035
"type": "string",

openapi/openapiv3.yaml

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2610,7 +2610,10 @@ paths:
26102610
get:
26112611
tags:
26122612
- WorkflowService
2613-
description: "GetWorkflowExecutionHistoryReverse returns the history of specified workflow execution in reverse \n order (starting from last event). Fails with`NotFound` if the specified workflow execution is \n unknown to the service."
2613+
description: |-
2614+
GetWorkflowExecutionHistoryReverse returns the history of specified workflow execution in reverse
2615+
order (starting from last event). Fails with`NotFound` if the specified workflow execution is
2616+
unknown to the service.
26142617
operationId: GetWorkflowExecutionHistoryReverse
26152618
parameters:
26162619
- name: namespace
@@ -6031,7 +6034,10 @@ paths:
60316034
get:
60326035
tags:
60336036
- WorkflowService
6034-
description: "GetWorkflowExecutionHistoryReverse returns the history of specified workflow execution in reverse \n order (starting from last event). Fails with`NotFound` if the specified workflow execution is \n unknown to the service."
6037+
description: |-
6038+
GetWorkflowExecutionHistoryReverse returns the history of specified workflow execution in reverse
6039+
order (starting from last event). Fails with`NotFound` if the specified workflow execution is
6040+
unknown to the service.
60356041
operationId: GetWorkflowExecutionHistoryReverse
60366042
parameters:
60376043
- name: namespace
@@ -9613,7 +9619,9 @@ components:
96139619
description: Only the activity with this ID will be paused.
96149620
type:
96159621
type: string
9616-
description: Pause all running activities of this type.
9622+
description: |-
9623+
Pause all running activities of this type.
9624+
Note: Experimental - the behavior of pause by activity type might change in a future release.
96179625
reason:
96189626
type: string
96199627
description: Reason to pause the activity.

temporal/api/workflowservice/v1/request_response.proto

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1940,6 +1940,7 @@ message PauseActivityRequest {
19401940
// Only the activity with this ID will be paused.
19411941
string id = 4;
19421942
// Pause all running activities of this type.
1943+
// Note: Experimental - the behavior of pause by activity type might change in a future release.
19431944
string type = 5;
19441945
}
19451946

@@ -2258,8 +2259,8 @@ message ListWorkerDeploymentsResponse {
22582259
google.protobuf.Timestamp create_time = 2;
22592260
temporal.api.deployment.v1.RoutingConfig routing_config = 3;
22602261
// Summary of the version that was added most recently in the Worker Deployment.
2261-
temporal.api.deployment.v1.WorkerDeploymentInfo.WorkerDeploymentVersionSummary latest_version_summary = 4;
2262-
// Summary of the current version of the Worker Deployment.
2262+
temporal.api.deployment.v1.WorkerDeploymentInfo.WorkerDeploymentVersionSummary latest_version_summary = 4;
2263+
// Summary of the current version of the Worker Deployment.
22632264
temporal.api.deployment.v1.WorkerDeploymentInfo.WorkerDeploymentVersionSummary current_version_summary = 5;
22642265
// Summary of the ramping version of the Worker Deployment.
22652266
temporal.api.deployment.v1.WorkerDeploymentInfo.WorkerDeploymentVersionSummary ramping_version_summary = 6;
@@ -2591,4 +2592,4 @@ message DescribeWorkerRequest {
25912592

25922593
message DescribeWorkerResponse {
25932594
temporal.api.worker.v1.WorkerInfo worker_info = 1;
2594-
}
2595+
}

temporal/api/workflowservice/v1/service.proto

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -133,9 +133,9 @@ service WorkflowService {
133133
}
134134
};
135135
}
136-
137-
// GetWorkflowExecutionHistoryReverse returns the history of specified workflow execution in reverse
138-
// order (starting from last event). Fails with`NotFound` if the specified workflow execution is
136+
137+
// GetWorkflowExecutionHistoryReverse returns the history of specified workflow execution in reverse
138+
// order (starting from last event). Fails with`NotFound` if the specified workflow execution is
139139
// unknown to the service.
140140
rpc GetWorkflowExecutionHistoryReverse (GetWorkflowExecutionHistoryReverseRequest) returns (GetWorkflowExecutionHistoryReverseResponse) {
141141
option (google.api.http) = {
@@ -670,8 +670,8 @@ service WorkflowService {
670670
// members are compatible with one another.
671671
//
672672
// A single build id may be mapped to multiple task queues using this API for cases where a single process hosts
673-
// multiple workers.
674-
//
673+
// multiple workers.
674+
//
675675
// To query which workers can be retired, use the `GetWorkerTaskReachability` API.
676676
//
677677
// NOTE: The number of task queues mapped to a single build id is limited by the `limit.taskQueuesPerBuildId`

0 commit comments

Comments
 (0)