Skip to content

Commit e5b3697

Browse files
committed
doc strings
1 parent 9f332d3 commit e5b3697

3 files changed

Lines changed: 8 additions & 2 deletions

File tree

openapi/openapiv2.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15262,14 +15262,16 @@
1526215262
"title": "Reason indicates the reason to stop a operation"
1526315263
},
1526415264
"query": {
15265-
"type": "string"
15265+
"type": "string",
15266+
"title": "Query is the visibility query that defines the group of workflow to apply the batch operation"
1526615267
},
1526715268
"executions": {
1526815269
"type": "array",
1526915270
"items": {
1527015271
"type": "object",
1527115272
"$ref": "#/definitions/v1Execution"
15272-
}
15273+
},
15274+
"title": "Executions is the list of workflow executions to apply the batch operation"
1527315275
}
1527415276
}
1527515277
},

openapi/openapiv3.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11721,10 +11721,12 @@ components:
1172111721
description: Reason indicates the reason to stop a operation
1172211722
query:
1172311723
type: string
11724+
description: Query is the visibility query that defines the group of workflow to apply the batch operation
1172411725
executions:
1172511726
type: array
1172611727
items:
1172711728
$ref: '#/components/schemas/Execution'
11729+
description: Executions is the list of workflow executions to apply the batch operation
1172811730
DescribeDeploymentResponse:
1172911731
type: object
1173011732
properties:

temporal/api/workflowservice/v1/request_response.proto

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1911,7 +1911,9 @@ message DescribeBatchOperationResponse {
19111911
string identity = 9;
19121912
// Reason indicates the reason to stop a operation
19131913
string reason = 10;
1914+
// Query is the visibility query that defines the group of workflow to apply the batch operation
19141915
string query = 11;
1916+
// Executions is the list of workflow executions to apply the batch operation
19151917
repeated temporal.api.common.v1.Execution executions = 12;
19161918
}
19171919

0 commit comments

Comments
 (0)