Skip to content

Commit 906dd19

Browse files
dandavisondandavison
committed
Unify Describe and GetResult
1 parent 0b0a6bf commit 906dd19

File tree

4 files changed

+193
-320
lines changed

4 files changed

+193
-320
lines changed

‎openapi/openapiv2.json‎

Lines changed: 69 additions & 133 deletions
Original file line numberDiff line numberDiff line change
@@ -859,13 +859,14 @@
859859
},
860860
"/api/v1/namespaces/{namespace}/activities/{activityId}": {
861861
"get": {
862-
"summary": "DescribeActivityExecution returns information about the specified activity execution.\nPass in a long_poll_token to turn this request into a long poll that gets unblocked when the activity makes\nprogress.\nIn case the activity has not made progress by the time the long poll request times out, an empty response is\nreturned and the caller may issue an identical DescribeActivityExecution request to continue polling.",
863-
"operationId": "DescribeActivityExecution2",
862+
"summary": "GetActivityExecutionStatus returns the status and/or outcome of an activity execution.\nThis unified endpoint can:\n- Get current activity info synchronously (when include_info is true)\n- Long poll for activity info updates (when wait_info is true)\n- Get activity outcome synchronously if completed (when include_outcome is true)\n- Long poll for activity completion (when wait_outcome is true)",
863+
"description": "This replaces both DescribeActivityExecution and GetActivityExecutionResult with a single\nflexible endpoint that can handle both synchronous queries and long polling for both\ninfo updates and completion.",
864+
"operationId": "GetActivityExecutionStatus2",
864865
"responses": {
865866
"200": {
866867
"description": "A successful response.",
867868
"schema": {
868-
"$ref": "#/definitions/v1DescribeActivityExecutionResponse"
869+
"$ref": "#/definitions/v1GetActivityExecutionStatusResponse"
869870
}
870871
},
871872
"default": {
@@ -890,21 +891,31 @@
890891
},
891892
{
892893
"name": "runId",
893-
"description": "Activity run ID, targets the latest run if run_id is empty.",
894894
"in": "query",
895895
"required": false,
896896
"type": "string"
897897
},
898898
{
899-
"name": "includeInput",
900-
"description": "If true, the activity input is returned in the response.",
899+
"name": "includeInfo.includeInput",
901900
"in": "query",
902901
"required": false,
903902
"type": "boolean"
904903
},
905904
{
906-
"name": "longPollToken",
907-
"description": "If not empty, turns this request into a long poll that is unblocked when the activity state changes from the time\nthe token was returned.\nThis token is returned as part of the `DescribeActivityExecutionResponse`.",
905+
"name": "noWait",
906+
"in": "query",
907+
"required": false,
908+
"type": "object"
909+
},
910+
{
911+
"name": "waitAnyStateChange.longPollToken",
912+
"in": "query",
913+
"required": false,
914+
"type": "string",
915+
"format": "byte"
916+
},
917+
{
918+
"name": "waitCompletion.longPollToken",
908919
"in": "query",
909920
"required": false,
910921
"type": "string",
@@ -1006,57 +1017,6 @@
10061017
]
10071018
}
10081019
},
1009-
"/api/v1/namespaces/{namespace}/activities/{activityId}/result": {
1010-
"get": {
1011-
"summary": "GetActivityExecutionResult returns the activity result if it is in a terminal status or (optionally) wait for it\nto reach one.",
1012-
"operationId": "GetActivityExecutionResult2",
1013-
"responses": {
1014-
"200": {
1015-
"description": "A successful response.",
1016-
"schema": {
1017-
"$ref": "#/definitions/v1GetActivityExecutionResultResponse"
1018-
}
1019-
},
1020-
"default": {
1021-
"description": "An unexpected error response.",
1022-
"schema": {
1023-
"$ref": "#/definitions/rpcStatus"
1024-
}
1025-
}
1026-
},
1027-
"parameters": [
1028-
{
1029-
"name": "namespace",
1030-
"in": "path",
1031-
"required": true,
1032-
"type": "string"
1033-
},
1034-
{
1035-
"name": "activityId",
1036-
"in": "path",
1037-
"required": true,
1038-
"type": "string"
1039-
},
1040-
{
1041-
"name": "runId",
1042-
"description": "Activity run ID, targets the latest run if run_id is empty.",
1043-
"in": "query",
1044-
"required": false,
1045-
"type": "string"
1046-
},
1047-
{
1048-
"name": "wait",
1049-
"description": "If set, turns this request into a long poll that is unblocked when the activity reaches a terminal status.\nThe wait duration is capped by the request's context deadline or by the maximum enforced long poll interval\nallowed by the server.",
1050-
"in": "query",
1051-
"required": false,
1052-
"type": "boolean"
1053-
}
1054-
],
1055-
"tags": [
1056-
"WorkflowService"
1057-
]
1058-
}
1059-
},
10601020
"/api/v1/namespaces/{namespace}/activities/{activityId}/terminate": {
10611021
"post": {
10621022
"summary": "TerminateActivityExecution terminates an existing activity execution immediately.",
@@ -5474,13 +5434,14 @@
54745434
},
54755435
"/namespaces/{namespace}/activities/{activityId}": {
54765436
"get": {
5477-
"summary": "DescribeActivityExecution returns information about the specified activity execution.\nPass in a long_poll_token to turn this request into a long poll that gets unblocked when the activity makes\nprogress.\nIn case the activity has not made progress by the time the long poll request times out, an empty response is\nreturned and the caller may issue an identical DescribeActivityExecution request to continue polling.",
5478-
"operationId": "DescribeActivityExecution",
5437+
"summary": "GetActivityExecutionStatus returns the status and/or outcome of an activity execution.\nThis unified endpoint can:\n- Get current activity info synchronously (when include_info is true)\n- Long poll for activity info updates (when wait_info is true)\n- Get activity outcome synchronously if completed (when include_outcome is true)\n- Long poll for activity completion (when wait_outcome is true)",
5438+
"description": "This replaces both DescribeActivityExecution and GetActivityExecutionResult with a single\nflexible endpoint that can handle both synchronous queries and long polling for both\ninfo updates and completion.",
5439+
"operationId": "GetActivityExecutionStatus",
54795440
"responses": {
54805441
"200": {
54815442
"description": "A successful response.",
54825443
"schema": {
5483-
"$ref": "#/definitions/v1DescribeActivityExecutionResponse"
5444+
"$ref": "#/definitions/v1GetActivityExecutionStatusResponse"
54845445
}
54855446
},
54865447
"default": {
@@ -5505,21 +5466,31 @@
55055466
},
55065467
{
55075468
"name": "runId",
5508-
"description": "Activity run ID, targets the latest run if run_id is empty.",
55095469
"in": "query",
55105470
"required": false,
55115471
"type": "string"
55125472
},
55135473
{
5514-
"name": "includeInput",
5515-
"description": "If true, the activity input is returned in the response.",
5474+
"name": "includeInfo.includeInput",
55165475
"in": "query",
55175476
"required": false,
55185477
"type": "boolean"
55195478
},
55205479
{
5521-
"name": "longPollToken",
5522-
"description": "If not empty, turns this request into a long poll that is unblocked when the activity state changes from the time\nthe token was returned.\nThis token is returned as part of the `DescribeActivityExecutionResponse`.",
5480+
"name": "noWait",
5481+
"in": "query",
5482+
"required": false,
5483+
"type": "object"
5484+
},
5485+
{
5486+
"name": "waitAnyStateChange.longPollToken",
5487+
"in": "query",
5488+
"required": false,
5489+
"type": "string",
5490+
"format": "byte"
5491+
},
5492+
{
5493+
"name": "waitCompletion.longPollToken",
55235494
"in": "query",
55245495
"required": false,
55255496
"type": "string",
@@ -5621,57 +5592,6 @@
56215592
]
56225593
}
56235594
},
5624-
"/namespaces/{namespace}/activities/{activityId}/result": {
5625-
"get": {
5626-
"summary": "GetActivityExecutionResult returns the activity result if it is in a terminal status or (optionally) wait for it\nto reach one.",
5627-
"operationId": "GetActivityExecutionResult",
5628-
"responses": {
5629-
"200": {
5630-
"description": "A successful response.",
5631-
"schema": {
5632-
"$ref": "#/definitions/v1GetActivityExecutionResultResponse"
5633-
}
5634-
},
5635-
"default": {
5636-
"description": "An unexpected error response.",
5637-
"schema": {
5638-
"$ref": "#/definitions/rpcStatus"
5639-
}
5640-
}
5641-
},
5642-
"parameters": [
5643-
{
5644-
"name": "namespace",
5645-
"in": "path",
5646-
"required": true,
5647-
"type": "string"
5648-
},
5649-
{
5650-
"name": "activityId",
5651-
"in": "path",
5652-
"required": true,
5653-
"type": "string"
5654-
},
5655-
{
5656-
"name": "runId",
5657-
"description": "Activity run ID, targets the latest run if run_id is empty.",
5658-
"in": "query",
5659-
"required": false,
5660-
"type": "string"
5661-
},
5662-
{
5663-
"name": "wait",
5664-
"description": "If set, turns this request into a long poll that is unblocked when the activity reaches a terminal status.\nThe wait duration is capped by the request's context deadline or by the maximum enforced long poll interval\nallowed by the server.",
5665-
"in": "query",
5666-
"required": false,
5667-
"type": "boolean"
5668-
}
5669-
],
5670-
"tags": [
5671-
"WorkflowService"
5672-
]
5673-
}
5674-
},
56755595
"/namespaces/{namespace}/activities/{activityId}/terminate": {
56765596
"post": {
56775597
"summary": "TerminateActivityExecution terminates an existing activity execution immediately.",
@@ -8863,6 +8783,26 @@
88638783
}
88648784
}
88658785
},
8786+
"GetActivityExecutionStatusRequestIncludeInfoOptions": {
8787+
"type": "object",
8788+
"properties": {
8789+
"includeInput": {
8790+
"type": "boolean"
8791+
}
8792+
}
8793+
},
8794+
"GetActivityExecutionStatusRequestIncludeOutcomeOptions": {
8795+
"type": "object"
8796+
},
8797+
"GetActivityExecutionStatusRequestWaitOptions": {
8798+
"type": "object",
8799+
"properties": {
8800+
"longPollToken": {
8801+
"type": "string",
8802+
"format": "byte"
8803+
}
8804+
}
8805+
},
88668806
"LinkActivity": {
88678807
"type": "object",
88688808
"properties": {
@@ -12858,19 +12798,6 @@
1285812798
"type": "object",
1285912799
"description": "Deprecated."
1286012800
},
12861-
"v1DescribeActivityExecutionResponse": {
12862-
"type": "object",
12863-
"properties": {
12864-
"info": {
12865-
"$ref": "#/definitions/v1ActivityExecutionInfo"
12866-
},
12867-
"longPollToken": {
12868-
"type": "string",
12869-
"format": "byte",
12870-
"description": "A token that can be passed in via a subsequent `DescribeActivityExecutionRequest` to long poll on the activity\nstate as it makes progress."
12871-
}
12872-
}
12873-
},
1287412801
"v1DescribeBatchOperationResponse": {
1287512802
"type": "object",
1287612803
"properties": {
@@ -13367,12 +13294,16 @@
1336713294
}
1336813295
}
1336913296
},
13370-
"v1GetActivityExecutionResultResponse": {
13297+
"v1GetActivityExecutionStatusResponse": {
1337113298
"type": "object",
1337213299
"properties": {
1337313300
"runId": {
1337413301
"type": "string",
13375-
"description": "The run ID of the completed activity, may be used in case a run ID was not specified in the request."
13302+
"description": "The run ID of the activity, useful when run_id was not specified in the request."
13303+
},
13304+
"info": {
13305+
"$ref": "#/definitions/v1ActivityExecutionInfo",
13306+
"description": "Only set if include_info was present in the request."
1337613307
},
1337713308
"result": {
1337813309
"$ref": "#/definitions/v1Payloads",
@@ -13381,6 +13312,11 @@
1338113312
"failure": {
1338213313
"$ref": "#/definitions/apifailurev1Failure",
1338313314
"description": "The failure if the activity completed unsuccessfully."
13315+
},
13316+
"stateChangeLongPollToken": {
13317+
"type": "string",
13318+
"format": "byte",
13319+
"description": "Token to use for a follow-on request using wait_any_state_change.\nOnly set if wait_policy was wait_any_state_change and the activity is not complete."
1338413320
}
1338513321
}
1338613322
},

0 commit comments

Comments
 (0)