@temporalio/core-bridge 1.15.0 → 1.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Cargo.lock +172 -70
- package/lib/native.d.ts +1 -1
- package/package.json +2 -2
- package/releases/aarch64-apple-darwin/index.node +0 -0
- package/releases/aarch64-unknown-linux-gnu/index.node +0 -0
- package/releases/x86_64-apple-darwin/index.node +0 -0
- package/releases/x86_64-pc-windows-msvc/index.node +0 -0
- package/releases/x86_64-unknown-linux-gnu/index.node +0 -0
- package/sdk-core/.github/workflows/per-pr.yml +6 -6
- package/sdk-core/AGENTS.md +41 -30
- package/sdk-core/Cargo.toml +3 -0
- package/sdk-core/README.md +15 -9
- package/sdk-core/crates/client/Cargo.toml +4 -0
- package/sdk-core/crates/client/README.md +139 -0
- package/sdk-core/crates/client/src/async_activity_handle.rs +297 -0
- package/sdk-core/crates/client/src/callback_based.rs +7 -0
- package/sdk-core/crates/client/src/errors.rs +294 -0
- package/sdk-core/crates/client/src/{raw.rs → grpc.rs} +280 -159
- package/sdk-core/crates/client/src/lib.rs +920 -1326
- package/sdk-core/crates/client/src/metrics.rs +24 -33
- package/sdk-core/crates/client/src/options_structs.rs +457 -0
- package/sdk-core/crates/client/src/replaceable.rs +5 -4
- package/sdk-core/crates/client/src/request_extensions.rs +8 -9
- package/sdk-core/crates/client/src/retry.rs +99 -54
- package/sdk-core/crates/client/src/{worker/mod.rs → worker.rs} +1 -1
- package/sdk-core/crates/client/src/workflow_handle.rs +826 -0
- package/sdk-core/crates/common/Cargo.toml +61 -2
- package/sdk-core/crates/common/build.rs +742 -12
- package/sdk-core/crates/common/protos/api_upstream/.github/workflows/ci.yml +2 -0
- package/sdk-core/crates/common/protos/api_upstream/Makefile +2 -1
- package/sdk-core/crates/common/protos/api_upstream/buf.yaml +0 -3
- package/sdk-core/crates/common/protos/api_upstream/cmd/check-path-conflicts/main.go +137 -0
- package/sdk-core/crates/common/protos/api_upstream/openapi/openapiv2.json +1166 -770
- package/sdk-core/crates/common/protos/api_upstream/openapi/openapiv3.yaml +1243 -750
- package/sdk-core/crates/common/protos/api_upstream/temporal/api/deployment/v1/message.proto +2 -2
- package/sdk-core/crates/common/protos/api_upstream/temporal/api/enums/v1/workflow.proto +4 -3
- package/sdk-core/crates/common/protos/api_upstream/temporal/api/failure/v1/message.proto +1 -0
- package/sdk-core/crates/common/protos/api_upstream/temporal/api/history/v1/message.proto +4 -0
- package/sdk-core/crates/common/protos/api_upstream/temporal/api/namespace/v1/message.proto +6 -0
- package/sdk-core/crates/common/protos/api_upstream/temporal/api/nexus/v1/message.proto +16 -1
- package/sdk-core/crates/common/protos/api_upstream/temporal/api/workflowservice/v1/request_response.proto +64 -6
- package/sdk-core/crates/common/protos/api_upstream/temporal/api/workflowservice/v1/service.proto +88 -33
- package/sdk-core/crates/common/protos/local/temporal/sdk/core/nexus/nexus.proto +4 -2
- package/sdk-core/crates/common/protos/local/temporal/sdk/core/workflow_activation/workflow_activation.proto +4 -0
- package/sdk-core/crates/common/protos/local/temporal/sdk/core/workflow_commands/workflow_commands.proto +5 -5
- package/sdk-core/crates/common/src/activity_definition.rs +20 -0
- package/sdk-core/crates/common/src/data_converters.rs +770 -0
- package/sdk-core/crates/common/src/envconfig.rs +5 -0
- package/sdk-core/crates/common/src/lib.rs +15 -211
- package/sdk-core/crates/common/src/payload_visitor.rs +648 -0
- package/sdk-core/crates/common/src/priority.rs +110 -0
- package/sdk-core/crates/common/src/protos/canned_histories.rs +3 -0
- package/sdk-core/crates/common/src/protos/history_builder.rs +45 -0
- package/sdk-core/crates/common/src/protos/history_info.rs +2 -0
- package/sdk-core/crates/common/src/protos/mod.rs +122 -27
- package/sdk-core/crates/common/src/protos/task_token.rs +3 -3
- package/sdk-core/crates/common/src/protos/utilities.rs +11 -0
- package/sdk-core/crates/{sdk-core → common}/src/telemetry/log_export.rs +5 -7
- package/sdk-core/crates/common/src/telemetry/metrics/core.rs +125 -0
- package/sdk-core/crates/common/src/telemetry/metrics.rs +268 -223
- package/sdk-core/crates/{sdk-core → common}/src/telemetry/otel.rs +8 -13
- package/sdk-core/crates/{sdk-core → common}/src/telemetry/prometheus_meter.rs +49 -50
- package/sdk-core/crates/{sdk-core → common}/src/telemetry/prometheus_server.rs +2 -3
- package/sdk-core/crates/common/src/telemetry.rs +264 -4
- package/sdk-core/crates/common/src/worker.rs +68 -603
- package/sdk-core/crates/common/src/workflow_definition.rs +60 -0
- package/sdk-core/crates/macros/Cargo.toml +5 -1
- package/sdk-core/crates/macros/src/activities_definitions.rs +585 -0
- package/sdk-core/crates/macros/src/fsm_impl.rs +507 -0
- package/sdk-core/crates/macros/src/lib.rs +138 -512
- package/sdk-core/crates/macros/src/macro_utils.rs +106 -0
- package/sdk-core/crates/macros/src/workflow_definitions.rs +1224 -0
- package/sdk-core/crates/sdk/Cargo.toml +19 -6
- package/sdk-core/crates/sdk/README.md +415 -0
- package/sdk-core/crates/sdk/src/activities.rs +417 -0
- package/sdk-core/crates/sdk/src/interceptors.rs +1 -1
- package/sdk-core/crates/sdk/src/lib.rs +757 -442
- package/sdk-core/crates/sdk/src/workflow_context/options.rs +45 -35
- package/sdk-core/crates/sdk/src/workflow_context.rs +1033 -289
- package/sdk-core/crates/sdk/src/workflow_future.rs +277 -213
- package/sdk-core/crates/sdk/src/workflows.rs +711 -0
- package/sdk-core/crates/sdk-core/Cargo.toml +57 -64
- package/sdk-core/crates/sdk-core/benches/workflow_replay_bench.rs +41 -35
- package/sdk-core/crates/sdk-core/machine_coverage/ActivityMachine_Coverage.puml +1 -1
- package/sdk-core/crates/sdk-core/src/abstractions.rs +6 -10
- package/sdk-core/crates/sdk-core/src/core_tests/activity_tasks.rs +6 -5
- package/sdk-core/crates/sdk-core/src/core_tests/mod.rs +13 -15
- package/sdk-core/crates/sdk-core/src/core_tests/queries.rs +21 -25
- package/sdk-core/crates/sdk-core/src/core_tests/replay_flag.rs +7 -10
- package/sdk-core/crates/sdk-core/src/core_tests/updates.rs +14 -17
- package/sdk-core/crates/sdk-core/src/core_tests/workers.rs +493 -26
- package/sdk-core/crates/sdk-core/src/core_tests/workflow_tasks.rs +4 -8
- package/sdk-core/crates/sdk-core/src/ephemeral_server/mod.rs +7 -7
- package/sdk-core/crates/sdk-core/src/histfetch.rs +20 -10
- package/sdk-core/crates/sdk-core/src/lib.rs +41 -111
- package/sdk-core/crates/sdk-core/src/pollers/mod.rs +4 -9
- package/sdk-core/crates/sdk-core/src/pollers/poll_buffer.rs +118 -19
- package/sdk-core/crates/sdk-core/src/protosext/mod.rs +2 -2
- package/sdk-core/crates/sdk-core/src/replay/mod.rs +14 -5
- package/sdk-core/crates/sdk-core/src/telemetry/metrics.rs +179 -196
- package/sdk-core/crates/sdk-core/src/telemetry/mod.rs +3 -280
- package/sdk-core/crates/sdk-core/src/test_help/integ_helpers.rs +6 -9
- package/sdk-core/crates/sdk-core/src/test_help/unit_helpers.rs +3 -6
- package/sdk-core/crates/sdk-core/src/worker/activities/local_activities.rs +11 -14
- package/sdk-core/crates/sdk-core/src/worker/activities.rs +16 -19
- package/sdk-core/crates/sdk-core/src/worker/client/mocks.rs +9 -5
- package/sdk-core/crates/sdk-core/src/worker/client.rs +103 -81
- package/sdk-core/crates/sdk-core/src/worker/heartbeat.rs +7 -11
- package/sdk-core/crates/sdk-core/src/worker/mod.rs +1124 -229
- package/sdk-core/crates/sdk-core/src/worker/nexus.rs +145 -23
- package/sdk-core/crates/sdk-core/src/worker/slot_provider.rs +2 -2
- package/sdk-core/crates/sdk-core/src/worker/tuner/fixed_size.rs +2 -2
- package/sdk-core/crates/sdk-core/src/worker/tuner/resource_based.rs +13 -13
- package/sdk-core/crates/sdk-core/src/worker/tuner.rs +28 -8
- package/sdk-core/crates/sdk-core/src/worker/workflow/driven_workflow.rs +9 -3
- package/sdk-core/crates/sdk-core/src/worker/workflow/machines/upsert_search_attributes_state_machine.rs +21 -22
- package/sdk-core/crates/sdk-core/src/worker/workflow/machines/workflow_machines.rs +16 -3
- package/sdk-core/crates/sdk-core/src/worker/workflow/managed_run.rs +14 -18
- package/sdk-core/crates/sdk-core/src/worker/workflow/mod.rs +4 -6
- package/sdk-core/crates/sdk-core/src/worker/workflow/run_cache.rs +4 -7
- package/sdk-core/crates/sdk-core/src/worker/workflow/wft_extraction.rs +2 -4
- package/sdk-core/crates/sdk-core/src/worker/workflow/wft_poller.rs +8 -9
- package/sdk-core/crates/sdk-core/src/worker/workflow/workflow_stream.rs +1 -3
- package/sdk-core/crates/sdk-core/tests/activities_procmacro.rs +6 -0
- package/sdk-core/crates/sdk-core/tests/activities_trybuild/basic_pass.rs +54 -0
- package/sdk-core/crates/sdk-core/tests/activities_trybuild/invalid_self_type_fail.rs +18 -0
- package/sdk-core/crates/sdk-core/tests/activities_trybuild/invalid_self_type_fail.stderr +5 -0
- package/sdk-core/crates/sdk-core/tests/activities_trybuild/missing_context_fail.rs +14 -0
- package/sdk-core/crates/sdk-core/tests/activities_trybuild/missing_context_fail.stderr +5 -0
- package/sdk-core/crates/sdk-core/tests/activities_trybuild/multi_arg_pass.rs +48 -0
- package/sdk-core/crates/sdk-core/tests/activities_trybuild/no_input_pass.rs +14 -0
- package/sdk-core/crates/sdk-core/tests/activities_trybuild/no_return_type_pass.rs +19 -0
- package/sdk-core/crates/sdk-core/tests/cloud_tests.rs +14 -5
- package/sdk-core/crates/sdk-core/tests/common/activity_functions.rs +55 -0
- package/sdk-core/crates/sdk-core/tests/common/mod.rs +241 -196
- package/sdk-core/crates/sdk-core/tests/common/workflows.rs +41 -28
- package/sdk-core/crates/sdk-core/tests/global_metric_tests.rs +3 -5
- package/sdk-core/crates/sdk-core/tests/heavy_tests/fuzzy_workflow.rs +73 -64
- package/sdk-core/crates/sdk-core/tests/heavy_tests.rs +298 -252
- package/sdk-core/crates/sdk-core/tests/integ_tests/async_activity_client_tests.rs +230 -0
- package/sdk-core/crates/sdk-core/tests/integ_tests/client_tests.rs +94 -57
- package/sdk-core/crates/sdk-core/tests/integ_tests/data_converter_tests.rs +381 -0
- package/sdk-core/crates/sdk-core/tests/integ_tests/ephemeral_server_tests.rs +16 -12
- package/sdk-core/crates/sdk-core/tests/integ_tests/heartbeat_tests.rs +48 -40
- package/sdk-core/crates/sdk-core/tests/integ_tests/metrics_tests.rs +327 -255
- package/sdk-core/crates/sdk-core/tests/integ_tests/pagination_tests.rs +50 -45
- package/sdk-core/crates/sdk-core/tests/integ_tests/polling_tests.rs +147 -126
- package/sdk-core/crates/sdk-core/tests/integ_tests/queries_tests.rs +103 -89
- package/sdk-core/crates/sdk-core/tests/integ_tests/update_tests.rs +609 -453
- package/sdk-core/crates/sdk-core/tests/integ_tests/visibility_tests.rs +80 -62
- package/sdk-core/crates/sdk-core/tests/integ_tests/worker_heartbeat_tests.rs +360 -231
- package/sdk-core/crates/sdk-core/tests/integ_tests/worker_tests.rs +248 -185
- package/sdk-core/crates/sdk-core/tests/integ_tests/worker_versioning_tests.rs +52 -43
- package/sdk-core/crates/sdk-core/tests/integ_tests/workflow_client_tests.rs +180 -0
- package/sdk-core/crates/sdk-core/tests/integ_tests/workflow_tests/activities.rs +428 -315
- package/sdk-core/crates/sdk-core/tests/integ_tests/workflow_tests/cancel_external.rs +82 -56
- package/sdk-core/crates/sdk-core/tests/integ_tests/workflow_tests/cancel_wf.rs +56 -28
- package/sdk-core/crates/sdk-core/tests/integ_tests/workflow_tests/child_workflows.rs +364 -243
- package/sdk-core/crates/sdk-core/tests/integ_tests/workflow_tests/client_interactions.rs +552 -0
- package/sdk-core/crates/sdk-core/tests/integ_tests/workflow_tests/continue_as_new.rs +101 -42
- package/sdk-core/crates/sdk-core/tests/integ_tests/workflow_tests/determinism.rs +243 -147
- package/sdk-core/crates/sdk-core/tests/integ_tests/workflow_tests/eager.rs +98 -28
- package/sdk-core/crates/sdk-core/tests/integ_tests/workflow_tests/local_activities.rs +1475 -1036
- package/sdk-core/crates/sdk-core/tests/integ_tests/workflow_tests/modify_wf_properties.rs +73 -41
- package/sdk-core/crates/sdk-core/tests/integ_tests/workflow_tests/nexus.rs +397 -238
- package/sdk-core/crates/sdk-core/tests/integ_tests/workflow_tests/patches.rs +340 -188
- package/sdk-core/crates/sdk-core/tests/integ_tests/workflow_tests/queries.rs +415 -0
- package/sdk-core/crates/sdk-core/tests/integ_tests/workflow_tests/replay.rs +96 -36
- package/sdk-core/crates/sdk-core/tests/integ_tests/workflow_tests/resets.rs +154 -137
- package/sdk-core/crates/sdk-core/tests/integ_tests/workflow_tests/signals.rs +183 -105
- package/sdk-core/crates/sdk-core/tests/integ_tests/workflow_tests/stickyness.rs +85 -38
- package/sdk-core/crates/sdk-core/tests/integ_tests/workflow_tests/timers.rs +142 -40
- package/sdk-core/crates/sdk-core/tests/integ_tests/workflow_tests/upsert_search_attrs.rs +73 -54
- package/sdk-core/crates/sdk-core/tests/integ_tests/workflow_tests.rs +363 -226
- package/sdk-core/crates/sdk-core/tests/main.rs +17 -15
- package/sdk-core/crates/sdk-core/tests/manual_tests.rs +207 -152
- package/sdk-core/crates/sdk-core/tests/shared_tests/mod.rs +65 -34
- package/sdk-core/crates/sdk-core/tests/shared_tests/priority.rs +107 -84
- package/sdk-core/crates/sdk-core/tests/workflows_procmacro.rs +6 -0
- package/sdk-core/crates/sdk-core/tests/workflows_trybuild/async_query_fail.rs +26 -0
- package/sdk-core/crates/sdk-core/tests/workflows_trybuild/async_query_fail.stderr +5 -0
- package/sdk-core/crates/sdk-core/tests/workflows_trybuild/basic_pass.rs +49 -0
- package/sdk-core/crates/sdk-core/tests/workflows_trybuild/minimal_pass.rs +21 -0
- package/sdk-core/crates/sdk-core/tests/workflows_trybuild/mut_query_fail.rs +26 -0
- package/sdk-core/crates/sdk-core/tests/workflows_trybuild/mut_query_fail.stderr +5 -0
- package/sdk-core/crates/sdk-core/tests/workflows_trybuild/sync_run_fail.rs +21 -0
- package/sdk-core/crates/sdk-core/tests/workflows_trybuild/sync_run_fail.stderr +5 -0
- package/sdk-core/crates/sdk-core-c-bridge/Cargo.toml +7 -1
- package/sdk-core/crates/sdk-core-c-bridge/include/temporal-sdk-core-c-bridge.h +14 -14
- package/sdk-core/crates/sdk-core-c-bridge/src/client.rs +83 -74
- package/sdk-core/crates/sdk-core-c-bridge/src/metric.rs +9 -14
- package/sdk-core/crates/sdk-core-c-bridge/src/runtime.rs +1 -2
- package/sdk-core/crates/sdk-core-c-bridge/src/tests/context.rs +13 -13
- package/sdk-core/crates/sdk-core-c-bridge/src/tests/mod.rs +6 -6
- package/sdk-core/crates/sdk-core-c-bridge/src/tests/utils.rs +3 -4
- package/sdk-core/crates/sdk-core-c-bridge/src/worker.rs +62 -75
- package/sdk-core/rustfmt.toml +2 -1
- package/src/client.rs +205 -318
- package/src/metrics.rs +22 -30
- package/src/runtime.rs +4 -5
- package/src/worker.rs +15 -18
- package/ts/native.ts +1 -1
- package/sdk-core/crates/client/src/workflow_handle/mod.rs +0 -212
- package/sdk-core/crates/common/src/errors.rs +0 -85
- package/sdk-core/crates/common/tests/worker_task_types_test.rs +0 -129
- package/sdk-core/crates/sdk/src/activity_context.rs +0 -238
- package/sdk-core/crates/sdk/src/app_data.rs +0 -37
- package/sdk-core/crates/sdk-core/tests/integ_tests/activity_functions.rs +0 -5
- package/sdk-core/crates/sdk-core/tests/integ_tests/workflow_tests/appdata_propagation.rs +0 -61
|
@@ -211,16 +211,16 @@
|
|
|
211
211
|
]
|
|
212
212
|
}
|
|
213
213
|
},
|
|
214
|
-
"/api/v1/namespaces/{namespace}/activities/
|
|
214
|
+
"/api/v1/namespaces/{namespace}/activities-deprecated/pause": {
|
|
215
215
|
"post": {
|
|
216
|
-
"summary": "
|
|
217
|
-
"description": "
|
|
218
|
-
"operationId": "
|
|
216
|
+
"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",
|
|
217
|
+
"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\nThis API will be deprecated soon and replaced with a newer PauseActivityExecution that is better named and\nstructured to work well for standalone activities.",
|
|
218
|
+
"operationId": "PauseActivity2",
|
|
219
219
|
"responses": {
|
|
220
220
|
"200": {
|
|
221
221
|
"description": "A successful response.",
|
|
222
222
|
"schema": {
|
|
223
|
-
"$ref": "#/definitions/
|
|
223
|
+
"$ref": "#/definitions/v1PauseActivityResponse"
|
|
224
224
|
}
|
|
225
225
|
},
|
|
226
226
|
"default": {
|
|
@@ -233,6 +233,7 @@
|
|
|
233
233
|
"parameters": [
|
|
234
234
|
{
|
|
235
235
|
"name": "namespace",
|
|
236
|
+
"description": "Namespace of the workflow which scheduled this activity.",
|
|
236
237
|
"in": "path",
|
|
237
238
|
"required": true,
|
|
238
239
|
"type": "string"
|
|
@@ -242,7 +243,7 @@
|
|
|
242
243
|
"in": "body",
|
|
243
244
|
"required": true,
|
|
244
245
|
"schema": {
|
|
245
|
-
"$ref": "#/definitions/
|
|
246
|
+
"$ref": "#/definitions/WorkflowServicePauseActivityBody"
|
|
246
247
|
}
|
|
247
248
|
}
|
|
248
249
|
],
|
|
@@ -251,15 +252,16 @@
|
|
|
251
252
|
]
|
|
252
253
|
}
|
|
253
254
|
},
|
|
254
|
-
"/api/v1/namespaces/{namespace}/activities/
|
|
255
|
+
"/api/v1/namespaces/{namespace}/activities-deprecated/reset": {
|
|
255
256
|
"post": {
|
|
256
|
-
"summary": "
|
|
257
|
-
"
|
|
257
|
+
"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.",
|
|
258
|
+
"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.\nThis API will be deprecated soon and replaced with a newer ResetActivityExecution that is better named and\nstructured to work well for standalone activities.",
|
|
259
|
+
"operationId": "ResetActivity2",
|
|
258
260
|
"responses": {
|
|
259
261
|
"200": {
|
|
260
262
|
"description": "A successful response.",
|
|
261
263
|
"schema": {
|
|
262
|
-
"$ref": "#/definitions/
|
|
264
|
+
"$ref": "#/definitions/v1ResetActivityResponse"
|
|
263
265
|
}
|
|
264
266
|
},
|
|
265
267
|
"default": {
|
|
@@ -272,7 +274,7 @@
|
|
|
272
274
|
"parameters": [
|
|
273
275
|
{
|
|
274
276
|
"name": "namespace",
|
|
275
|
-
"description": "Namespace of the workflow which scheduled this activity",
|
|
277
|
+
"description": "Namespace of the workflow which scheduled this activity.",
|
|
276
278
|
"in": "path",
|
|
277
279
|
"required": true,
|
|
278
280
|
"type": "string"
|
|
@@ -282,7 +284,7 @@
|
|
|
282
284
|
"in": "body",
|
|
283
285
|
"required": true,
|
|
284
286
|
"schema": {
|
|
285
|
-
"$ref": "#/definitions/
|
|
287
|
+
"$ref": "#/definitions/WorkflowServiceResetActivityBody"
|
|
286
288
|
}
|
|
287
289
|
}
|
|
288
290
|
],
|
|
@@ -291,16 +293,16 @@
|
|
|
291
293
|
]
|
|
292
294
|
}
|
|
293
295
|
},
|
|
294
|
-
"/api/v1/namespaces/{namespace}/activities/
|
|
296
|
+
"/api/v1/namespaces/{namespace}/activities-deprecated/unpause": {
|
|
295
297
|
"post": {
|
|
296
|
-
"summary": "
|
|
297
|
-
"description": "
|
|
298
|
-
"operationId": "
|
|
298
|
+
"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.",
|
|
299
|
+
"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\nThis API will be deprecated soon and replaced with a newer UnpauseActivityExecution that is better named and\nstructured to work well for standalone activities.",
|
|
300
|
+
"operationId": "UnpauseActivity2",
|
|
299
301
|
"responses": {
|
|
300
302
|
"200": {
|
|
301
303
|
"description": "A successful response.",
|
|
302
304
|
"schema": {
|
|
303
|
-
"$ref": "#/definitions/
|
|
305
|
+
"$ref": "#/definitions/v1UnpauseActivityResponse"
|
|
304
306
|
}
|
|
305
307
|
},
|
|
306
308
|
"default": {
|
|
@@ -313,6 +315,7 @@
|
|
|
313
315
|
"parameters": [
|
|
314
316
|
{
|
|
315
317
|
"name": "namespace",
|
|
318
|
+
"description": "Namespace of the workflow which scheduled this activity.",
|
|
316
319
|
"in": "path",
|
|
317
320
|
"required": true,
|
|
318
321
|
"type": "string"
|
|
@@ -322,7 +325,7 @@
|
|
|
322
325
|
"in": "body",
|
|
323
326
|
"required": true,
|
|
324
327
|
"schema": {
|
|
325
|
-
"$ref": "#/definitions/
|
|
328
|
+
"$ref": "#/definitions/WorkflowServiceUnpauseActivityBody"
|
|
326
329
|
}
|
|
327
330
|
}
|
|
328
331
|
],
|
|
@@ -331,15 +334,15 @@
|
|
|
331
334
|
]
|
|
332
335
|
}
|
|
333
336
|
},
|
|
334
|
-
"/api/v1/namespaces/{namespace}/activities/
|
|
337
|
+
"/api/v1/namespaces/{namespace}/activities-deprecated/update-options": {
|
|
335
338
|
"post": {
|
|
336
|
-
"summary": "
|
|
337
|
-
"operationId": "
|
|
339
|
+
"summary": "UpdateActivityOptions is called by the client to update the options of an activity by its ID or type.\nIf there are multiple pending activities of the provided type - all of them will be updated.\nThis API will be deprecated soon and replaced with a newer UpdateActivityExecutionOptions that is better named and\nstructured to work well for standalone activities.",
|
|
340
|
+
"operationId": "UpdateActivityOptions2",
|
|
338
341
|
"responses": {
|
|
339
342
|
"200": {
|
|
340
343
|
"description": "A successful response.",
|
|
341
344
|
"schema": {
|
|
342
|
-
"$ref": "#/definitions/
|
|
345
|
+
"$ref": "#/definitions/v1UpdateActivityOptionsResponse"
|
|
343
346
|
}
|
|
344
347
|
},
|
|
345
348
|
"default": {
|
|
@@ -362,7 +365,7 @@
|
|
|
362
365
|
"in": "body",
|
|
363
366
|
"required": true,
|
|
364
367
|
"schema": {
|
|
365
|
-
"$ref": "#/definitions/
|
|
368
|
+
"$ref": "#/definitions/WorkflowServiceUpdateActivityOptionsBody"
|
|
366
369
|
}
|
|
367
370
|
}
|
|
368
371
|
],
|
|
@@ -371,16 +374,15 @@
|
|
|
371
374
|
]
|
|
372
375
|
}
|
|
373
376
|
},
|
|
374
|
-
"/api/v1/namespaces/{namespace}/activities/
|
|
375
|
-
"
|
|
376
|
-
"summary": "
|
|
377
|
-
"
|
|
378
|
-
"operationId": "RespondActivityTaskFailed2",
|
|
377
|
+
"/api/v1/namespaces/{namespace}/activities/{activityId}": {
|
|
378
|
+
"get": {
|
|
379
|
+
"summary": "DescribeActivityExecution returns information about an activity execution.\nIt can be used to:\n- Get current activity info without waiting\n- Long-poll for next state change and return new activity info\nResponse can optionally include activity input or outcome (if the activity has completed).",
|
|
380
|
+
"operationId": "DescribeActivityExecution2",
|
|
379
381
|
"responses": {
|
|
380
382
|
"200": {
|
|
381
383
|
"description": "A successful response.",
|
|
382
384
|
"schema": {
|
|
383
|
-
"$ref": "#/definitions/
|
|
385
|
+
"$ref": "#/definitions/v1DescribeActivityExecutionResponse"
|
|
384
386
|
}
|
|
385
387
|
},
|
|
386
388
|
"default": {
|
|
@@ -398,28 +400,54 @@
|
|
|
398
400
|
"type": "string"
|
|
399
401
|
},
|
|
400
402
|
{
|
|
401
|
-
"name": "
|
|
402
|
-
"in": "
|
|
403
|
+
"name": "activityId",
|
|
404
|
+
"in": "path",
|
|
403
405
|
"required": true,
|
|
404
|
-
"
|
|
405
|
-
|
|
406
|
-
|
|
406
|
+
"type": "string"
|
|
407
|
+
},
|
|
408
|
+
{
|
|
409
|
+
"name": "runId",
|
|
410
|
+
"description": "Activity run ID. If empty the request targets the latest run.",
|
|
411
|
+
"in": "query",
|
|
412
|
+
"required": false,
|
|
413
|
+
"type": "string"
|
|
414
|
+
},
|
|
415
|
+
{
|
|
416
|
+
"name": "includeInput",
|
|
417
|
+
"description": "Include the input field in the response.",
|
|
418
|
+
"in": "query",
|
|
419
|
+
"required": false,
|
|
420
|
+
"type": "boolean"
|
|
421
|
+
},
|
|
422
|
+
{
|
|
423
|
+
"name": "includeOutcome",
|
|
424
|
+
"description": "Include the outcome (result/failure) in the response if the activity has completed.",
|
|
425
|
+
"in": "query",
|
|
426
|
+
"required": false,
|
|
427
|
+
"type": "boolean"
|
|
428
|
+
},
|
|
429
|
+
{
|
|
430
|
+
"name": "longPollToken",
|
|
431
|
+
"description": "Token from a previous DescribeActivityExecutionResponse. If present, long-poll until activity\nstate changes from the state encoded in this token. If absent, return current state immediately.\nIf present, run_id must also be present.\nNote that activity state may change multiple times between requests, therefore it is not\nguaranteed that a client making a sequence of long-poll requests will see a complete\nsequence of state changes.",
|
|
432
|
+
"in": "query",
|
|
433
|
+
"required": false,
|
|
434
|
+
"type": "string",
|
|
435
|
+
"format": "byte"
|
|
407
436
|
}
|
|
408
437
|
],
|
|
409
438
|
"tags": [
|
|
410
439
|
"WorkflowService"
|
|
411
440
|
]
|
|
412
|
-
}
|
|
413
|
-
},
|
|
414
|
-
"/api/v1/namespaces/{namespace}/activities/fail-by-id": {
|
|
441
|
+
},
|
|
415
442
|
"post": {
|
|
416
|
-
"summary": "
|
|
417
|
-
"
|
|
443
|
+
"summary": "StartActivityExecution starts a new activity execution.",
|
|
444
|
+
"description": "Returns an `ActivityExecutionAlreadyStarted` error if an instance already exists with same activity ID in this namespace\nunless permitted by the specified ID conflict policy.",
|
|
445
|
+
"operationId": "StartActivityExecution2",
|
|
418
446
|
"responses": {
|
|
419
447
|
"200": {
|
|
420
448
|
"description": "A successful response.",
|
|
421
449
|
"schema": {
|
|
422
|
-
"$ref": "#/definitions/
|
|
450
|
+
"$ref": "#/definitions/v1StartActivityExecutionResponse"
|
|
423
451
|
}
|
|
424
452
|
},
|
|
425
453
|
"default": {
|
|
@@ -432,7 +460,13 @@
|
|
|
432
460
|
"parameters": [
|
|
433
461
|
{
|
|
434
462
|
"name": "namespace",
|
|
435
|
-
"
|
|
463
|
+
"in": "path",
|
|
464
|
+
"required": true,
|
|
465
|
+
"type": "string"
|
|
466
|
+
},
|
|
467
|
+
{
|
|
468
|
+
"name": "activityId",
|
|
469
|
+
"description": "Identifier for this activity. Required. This identifier should be meaningful in the user's\nown system. It must be unique among activities in the same namespace, subject to the rules\nimposed by id_reuse_policy and id_conflict_policy.",
|
|
436
470
|
"in": "path",
|
|
437
471
|
"required": true,
|
|
438
472
|
"type": "string"
|
|
@@ -442,7 +476,7 @@
|
|
|
442
476
|
"in": "body",
|
|
443
477
|
"required": true,
|
|
444
478
|
"schema": {
|
|
445
|
-
"$ref": "#/definitions/
|
|
479
|
+
"$ref": "#/definitions/WorkflowServiceStartActivityExecutionBody"
|
|
446
480
|
}
|
|
447
481
|
}
|
|
448
482
|
],
|
|
@@ -451,16 +485,16 @@
|
|
|
451
485
|
]
|
|
452
486
|
}
|
|
453
487
|
},
|
|
454
|
-
"/api/v1/namespaces/{namespace}/activities/
|
|
488
|
+
"/api/v1/namespaces/{namespace}/activities/{activityId}/cancel": {
|
|
455
489
|
"post": {
|
|
456
|
-
"summary": "
|
|
457
|
-
"description": "
|
|
458
|
-
"operationId": "
|
|
490
|
+
"summary": "RequestCancelActivityExecution requests cancellation of an activity execution.",
|
|
491
|
+
"description": "Cancellation is cooperative: this call records the request, but the activity must detect and\nacknowledge it for the activity to reach CANCELED status. The cancellation signal is\ndelivered via `cancel_requested` in the heartbeat response; SDKs surface this via\nlanguage-idiomatic mechanisms (context cancellation, exceptions, abort signals).",
|
|
492
|
+
"operationId": "RequestCancelActivityExecution2",
|
|
459
493
|
"responses": {
|
|
460
494
|
"200": {
|
|
461
495
|
"description": "A successful response.",
|
|
462
496
|
"schema": {
|
|
463
|
-
"$ref": "#/definitions/
|
|
497
|
+
"$ref": "#/definitions/v1RequestCancelActivityExecutionResponse"
|
|
464
498
|
}
|
|
465
499
|
},
|
|
466
500
|
"default": {
|
|
@@ -477,12 +511,18 @@
|
|
|
477
511
|
"required": true,
|
|
478
512
|
"type": "string"
|
|
479
513
|
},
|
|
514
|
+
{
|
|
515
|
+
"name": "activityId",
|
|
516
|
+
"in": "path",
|
|
517
|
+
"required": true,
|
|
518
|
+
"type": "string"
|
|
519
|
+
},
|
|
480
520
|
{
|
|
481
521
|
"name": "body",
|
|
482
522
|
"in": "body",
|
|
483
523
|
"required": true,
|
|
484
524
|
"schema": {
|
|
485
|
-
"$ref": "#/definitions/
|
|
525
|
+
"$ref": "#/definitions/WorkflowServiceRequestCancelActivityExecutionBody"
|
|
486
526
|
}
|
|
487
527
|
}
|
|
488
528
|
],
|
|
@@ -491,15 +531,15 @@
|
|
|
491
531
|
]
|
|
492
532
|
}
|
|
493
533
|
},
|
|
494
|
-
"/api/v1/namespaces/{namespace}/activities/
|
|
534
|
+
"/api/v1/namespaces/{namespace}/activities/{activityId}/complete": {
|
|
495
535
|
"post": {
|
|
496
|
-
"summary": "See `
|
|
497
|
-
"operationId": "
|
|
536
|
+
"summary": "See `RespondActivityTaskCompleted`. This version allows clients to record completions by\nnamespace/workflow id/activity id instead of task token.",
|
|
537
|
+
"operationId": "RespondActivityTaskCompletedById2",
|
|
498
538
|
"responses": {
|
|
499
539
|
"200": {
|
|
500
540
|
"description": "A successful response.",
|
|
501
541
|
"schema": {
|
|
502
|
-
"$ref": "#/definitions/
|
|
542
|
+
"$ref": "#/definitions/v1RespondActivityTaskCompletedByIdResponse"
|
|
503
543
|
}
|
|
504
544
|
},
|
|
505
545
|
"default": {
|
|
@@ -517,12 +557,19 @@
|
|
|
517
557
|
"required": true,
|
|
518
558
|
"type": "string"
|
|
519
559
|
},
|
|
560
|
+
{
|
|
561
|
+
"name": "activityId",
|
|
562
|
+
"description": "Id of the activity to complete",
|
|
563
|
+
"in": "path",
|
|
564
|
+
"required": true,
|
|
565
|
+
"type": "string"
|
|
566
|
+
},
|
|
520
567
|
{
|
|
521
568
|
"name": "body",
|
|
522
569
|
"in": "body",
|
|
523
570
|
"required": true,
|
|
524
571
|
"schema": {
|
|
525
|
-
"$ref": "#/definitions/
|
|
572
|
+
"$ref": "#/definitions/WorkflowServiceRespondActivityTaskCompletedByIdBody"
|
|
526
573
|
}
|
|
527
574
|
}
|
|
528
575
|
],
|
|
@@ -531,16 +578,15 @@
|
|
|
531
578
|
]
|
|
532
579
|
}
|
|
533
580
|
},
|
|
534
|
-
"/api/v1/namespaces/{namespace}/activities/
|
|
581
|
+
"/api/v1/namespaces/{namespace}/activities/{activityId}/fail": {
|
|
535
582
|
"post": {
|
|
536
|
-
"summary": "
|
|
537
|
-
"
|
|
538
|
-
"operationId": "PauseActivity2",
|
|
583
|
+
"summary": "See `RecordActivityTaskFailed`. This version allows clients to record failures by\nnamespace/workflow id/activity id instead of task token.",
|
|
584
|
+
"operationId": "RespondActivityTaskFailedById2",
|
|
539
585
|
"responses": {
|
|
540
586
|
"200": {
|
|
541
587
|
"description": "A successful response.",
|
|
542
588
|
"schema": {
|
|
543
|
-
"$ref": "#/definitions/
|
|
589
|
+
"$ref": "#/definitions/v1RespondActivityTaskFailedByIdResponse"
|
|
544
590
|
}
|
|
545
591
|
},
|
|
546
592
|
"default": {
|
|
@@ -553,7 +599,14 @@
|
|
|
553
599
|
"parameters": [
|
|
554
600
|
{
|
|
555
601
|
"name": "namespace",
|
|
556
|
-
"description": "Namespace of the workflow which scheduled this activity
|
|
602
|
+
"description": "Namespace of the workflow which scheduled this activity",
|
|
603
|
+
"in": "path",
|
|
604
|
+
"required": true,
|
|
605
|
+
"type": "string"
|
|
606
|
+
},
|
|
607
|
+
{
|
|
608
|
+
"name": "activityId",
|
|
609
|
+
"description": "Id of the activity to fail",
|
|
557
610
|
"in": "path",
|
|
558
611
|
"required": true,
|
|
559
612
|
"type": "string"
|
|
@@ -563,7 +616,7 @@
|
|
|
563
616
|
"in": "body",
|
|
564
617
|
"required": true,
|
|
565
618
|
"schema": {
|
|
566
|
-
"$ref": "#/definitions/
|
|
619
|
+
"$ref": "#/definitions/WorkflowServiceRespondActivityTaskFailedByIdBody"
|
|
567
620
|
}
|
|
568
621
|
}
|
|
569
622
|
],
|
|
@@ -572,16 +625,15 @@
|
|
|
572
625
|
]
|
|
573
626
|
}
|
|
574
627
|
},
|
|
575
|
-
"/api/v1/namespaces/{namespace}/activities/
|
|
628
|
+
"/api/v1/namespaces/{namespace}/activities/{activityId}/heartbeat": {
|
|
576
629
|
"post": {
|
|
577
|
-
"summary": "
|
|
578
|
-
"
|
|
579
|
-
"operationId": "ResetActivity2",
|
|
630
|
+
"summary": "See `RecordActivityTaskHeartbeat`. This version allows clients to record heartbeats by\nnamespace/workflow id/activity id instead of task token.",
|
|
631
|
+
"operationId": "RecordActivityTaskHeartbeatById2",
|
|
580
632
|
"responses": {
|
|
581
633
|
"200": {
|
|
582
634
|
"description": "A successful response.",
|
|
583
635
|
"schema": {
|
|
584
|
-
"$ref": "#/definitions/
|
|
636
|
+
"$ref": "#/definitions/v1RecordActivityTaskHeartbeatByIdResponse"
|
|
585
637
|
}
|
|
586
638
|
},
|
|
587
639
|
"default": {
|
|
@@ -594,7 +646,14 @@
|
|
|
594
646
|
"parameters": [
|
|
595
647
|
{
|
|
596
648
|
"name": "namespace",
|
|
597
|
-
"description": "Namespace of the workflow which scheduled this activity
|
|
649
|
+
"description": "Namespace of the workflow which scheduled this activity",
|
|
650
|
+
"in": "path",
|
|
651
|
+
"required": true,
|
|
652
|
+
"type": "string"
|
|
653
|
+
},
|
|
654
|
+
{
|
|
655
|
+
"name": "activityId",
|
|
656
|
+
"description": "Id of the activity we're heartbeating",
|
|
598
657
|
"in": "path",
|
|
599
658
|
"required": true,
|
|
600
659
|
"type": "string"
|
|
@@ -604,7 +663,7 @@
|
|
|
604
663
|
"in": "body",
|
|
605
664
|
"required": true,
|
|
606
665
|
"schema": {
|
|
607
|
-
"$ref": "#/definitions/
|
|
666
|
+
"$ref": "#/definitions/WorkflowServiceRecordActivityTaskHeartbeatByIdBody"
|
|
608
667
|
}
|
|
609
668
|
}
|
|
610
669
|
],
|
|
@@ -613,16 +672,15 @@
|
|
|
613
672
|
]
|
|
614
673
|
}
|
|
615
674
|
},
|
|
616
|
-
"/api/v1/namespaces/{namespace}/activities/
|
|
617
|
-
"
|
|
618
|
-
"summary": "
|
|
619
|
-
"
|
|
620
|
-
"operationId": "UnpauseActivity2",
|
|
675
|
+
"/api/v1/namespaces/{namespace}/activities/{activityId}/outcome": {
|
|
676
|
+
"get": {
|
|
677
|
+
"summary": "PollActivityExecution long-polls for an activity execution to complete and returns the\noutcome (result or failure).",
|
|
678
|
+
"operationId": "PollActivityExecution2",
|
|
621
679
|
"responses": {
|
|
622
680
|
"200": {
|
|
623
681
|
"description": "A successful response.",
|
|
624
682
|
"schema": {
|
|
625
|
-
"$ref": "#/definitions/
|
|
683
|
+
"$ref": "#/definitions/v1PollActivityExecutionResponse"
|
|
626
684
|
}
|
|
627
685
|
},
|
|
628
686
|
"default": {
|
|
@@ -635,18 +693,22 @@
|
|
|
635
693
|
"parameters": [
|
|
636
694
|
{
|
|
637
695
|
"name": "namespace",
|
|
638
|
-
"description": "Namespace of the workflow which scheduled this activity.",
|
|
639
696
|
"in": "path",
|
|
640
697
|
"required": true,
|
|
641
698
|
"type": "string"
|
|
642
699
|
},
|
|
643
700
|
{
|
|
644
|
-
"name": "
|
|
645
|
-
"in": "
|
|
701
|
+
"name": "activityId",
|
|
702
|
+
"in": "path",
|
|
646
703
|
"required": true,
|
|
647
|
-
"
|
|
648
|
-
|
|
649
|
-
|
|
704
|
+
"type": "string"
|
|
705
|
+
},
|
|
706
|
+
{
|
|
707
|
+
"name": "runId",
|
|
708
|
+
"description": "Activity run ID. If empty the request targets the latest run.",
|
|
709
|
+
"in": "query",
|
|
710
|
+
"required": false,
|
|
711
|
+
"type": "string"
|
|
650
712
|
}
|
|
651
713
|
],
|
|
652
714
|
"tags": [
|
|
@@ -654,15 +716,15 @@
|
|
|
654
716
|
]
|
|
655
717
|
}
|
|
656
718
|
},
|
|
657
|
-
"/api/v1/namespaces/{namespace}/activities/
|
|
719
|
+
"/api/v1/namespaces/{namespace}/activities/{activityId}/resolve-as-canceled": {
|
|
658
720
|
"post": {
|
|
659
|
-
"summary": "
|
|
660
|
-
"operationId": "
|
|
721
|
+
"summary": "See `RespondActivityTaskCanceled`. This version allows clients to record failures by\nnamespace/workflow id/activity id instead of task token.",
|
|
722
|
+
"operationId": "RespondActivityTaskCanceledById2",
|
|
661
723
|
"responses": {
|
|
662
724
|
"200": {
|
|
663
725
|
"description": "A successful response.",
|
|
664
726
|
"schema": {
|
|
665
|
-
"$ref": "#/definitions/
|
|
727
|
+
"$ref": "#/definitions/v1RespondActivityTaskCanceledByIdResponse"
|
|
666
728
|
}
|
|
667
729
|
},
|
|
668
730
|
"default": {
|
|
@@ -680,12 +742,19 @@
|
|
|
680
742
|
"required": true,
|
|
681
743
|
"type": "string"
|
|
682
744
|
},
|
|
745
|
+
{
|
|
746
|
+
"name": "activityId",
|
|
747
|
+
"description": "Id of the activity to confirm is cancelled",
|
|
748
|
+
"in": "path",
|
|
749
|
+
"required": true,
|
|
750
|
+
"type": "string"
|
|
751
|
+
},
|
|
683
752
|
{
|
|
684
753
|
"name": "body",
|
|
685
754
|
"in": "body",
|
|
686
755
|
"required": true,
|
|
687
756
|
"schema": {
|
|
688
|
-
"$ref": "#/definitions/
|
|
757
|
+
"$ref": "#/definitions/WorkflowServiceRespondActivityTaskCanceledByIdBody"
|
|
689
758
|
}
|
|
690
759
|
}
|
|
691
760
|
],
|
|
@@ -694,15 +763,16 @@
|
|
|
694
763
|
]
|
|
695
764
|
}
|
|
696
765
|
},
|
|
697
|
-
"/api/v1/namespaces/{namespace}/activities/{activityId}": {
|
|
698
|
-
"
|
|
699
|
-
"summary": "
|
|
700
|
-
"
|
|
766
|
+
"/api/v1/namespaces/{namespace}/activities/{activityId}/terminate": {
|
|
767
|
+
"post": {
|
|
768
|
+
"summary": "TerminateActivityExecution terminates an existing activity execution immediately.",
|
|
769
|
+
"description": "Termination does not reach the worker and the activity code cannot react to it. A terminated activity may have a\nrunning attempt.",
|
|
770
|
+
"operationId": "TerminateActivityExecution2",
|
|
701
771
|
"responses": {
|
|
702
772
|
"200": {
|
|
703
773
|
"description": "A successful response.",
|
|
704
774
|
"schema": {
|
|
705
|
-
"$ref": "#/definitions/
|
|
775
|
+
"$ref": "#/definitions/v1TerminateActivityExecutionResponse"
|
|
706
776
|
}
|
|
707
777
|
},
|
|
708
778
|
"default": {
|
|
@@ -726,49 +796,30 @@
|
|
|
726
796
|
"type": "string"
|
|
727
797
|
},
|
|
728
798
|
{
|
|
729
|
-
"name": "
|
|
730
|
-
"
|
|
731
|
-
"
|
|
732
|
-
"
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
"
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
"required": false,
|
|
754
|
-
"type": "string",
|
|
755
|
-
"format": "byte"
|
|
756
|
-
}
|
|
757
|
-
],
|
|
758
|
-
"tags": [
|
|
759
|
-
"WorkflowService"
|
|
760
|
-
]
|
|
761
|
-
},
|
|
762
|
-
"post": {
|
|
763
|
-
"summary": "StartActivityExecution starts a new activity execution.",
|
|
764
|
-
"description": "Returns an `ActivityExecutionAlreadyStarted` error if an instance already exists with same activity ID in this namespace\nunless permitted by the specified ID conflict policy.",
|
|
765
|
-
"operationId": "StartActivityExecution2",
|
|
766
|
-
"responses": {
|
|
767
|
-
"200": {
|
|
768
|
-
"description": "A successful response.",
|
|
769
|
-
"schema": {
|
|
770
|
-
"$ref": "#/definitions/v1StartActivityExecutionResponse"
|
|
771
|
-
}
|
|
799
|
+
"name": "body",
|
|
800
|
+
"in": "body",
|
|
801
|
+
"required": true,
|
|
802
|
+
"schema": {
|
|
803
|
+
"$ref": "#/definitions/WorkflowServiceTerminateActivityExecutionBody"
|
|
804
|
+
}
|
|
805
|
+
}
|
|
806
|
+
],
|
|
807
|
+
"tags": [
|
|
808
|
+
"WorkflowService"
|
|
809
|
+
]
|
|
810
|
+
}
|
|
811
|
+
},
|
|
812
|
+
"/api/v1/namespaces/{namespace}/activity-complete": {
|
|
813
|
+
"post": {
|
|
814
|
+
"summary": "RespondActivityTaskCompleted is called by workers when they successfully complete an activity\ntask.",
|
|
815
|
+
"description": "For workflow activities, this results in a new `ACTIVITY_TASK_COMPLETED` event being written to the workflow history\nand a new workflow task created for the workflow. Fails with `NotFound` if the task token is\nno longer valid due to activity timeout, already being completed, or never having existed.",
|
|
816
|
+
"operationId": "RespondActivityTaskCompleted2",
|
|
817
|
+
"responses": {
|
|
818
|
+
"200": {
|
|
819
|
+
"description": "A successful response.",
|
|
820
|
+
"schema": {
|
|
821
|
+
"$ref": "#/definitions/v1RespondActivityTaskCompletedResponse"
|
|
822
|
+
}
|
|
772
823
|
},
|
|
773
824
|
"default": {
|
|
774
825
|
"description": "An unexpected error response.",
|
|
@@ -784,19 +835,12 @@
|
|
|
784
835
|
"required": true,
|
|
785
836
|
"type": "string"
|
|
786
837
|
},
|
|
787
|
-
{
|
|
788
|
-
"name": "activityId",
|
|
789
|
-
"description": "Identifier for this activity. Required. This identifier should be meaningful in the user's\nown system. It must be unique among activities in the same namespace, subject to the rules\nimposed by id_reuse_policy and id_conflict_policy.",
|
|
790
|
-
"in": "path",
|
|
791
|
-
"required": true,
|
|
792
|
-
"type": "string"
|
|
793
|
-
},
|
|
794
838
|
{
|
|
795
839
|
"name": "body",
|
|
796
840
|
"in": "body",
|
|
797
841
|
"required": true,
|
|
798
842
|
"schema": {
|
|
799
|
-
"$ref": "#/definitions/
|
|
843
|
+
"$ref": "#/definitions/WorkflowServiceRespondActivityTaskCompletedBody"
|
|
800
844
|
}
|
|
801
845
|
}
|
|
802
846
|
],
|
|
@@ -805,16 +849,15 @@
|
|
|
805
849
|
]
|
|
806
850
|
}
|
|
807
851
|
},
|
|
808
|
-
"/api/v1/namespaces/{namespace}/
|
|
809
|
-
"
|
|
810
|
-
"summary": "
|
|
811
|
-
"
|
|
812
|
-
"operationId": "RequestCancelActivityExecution2",
|
|
852
|
+
"/api/v1/namespaces/{namespace}/activity-count": {
|
|
853
|
+
"get": {
|
|
854
|
+
"summary": "CountActivityExecutions is a visibility API to count activity executions in a specific namespace.",
|
|
855
|
+
"operationId": "CountActivityExecutions2",
|
|
813
856
|
"responses": {
|
|
814
857
|
"200": {
|
|
815
858
|
"description": "A successful response.",
|
|
816
859
|
"schema": {
|
|
817
|
-
"$ref": "#/definitions/
|
|
860
|
+
"$ref": "#/definitions/v1CountActivityExecutionsResponse"
|
|
818
861
|
}
|
|
819
862
|
},
|
|
820
863
|
"default": {
|
|
@@ -832,18 +875,11 @@
|
|
|
832
875
|
"type": "string"
|
|
833
876
|
},
|
|
834
877
|
{
|
|
835
|
-
"name": "
|
|
836
|
-
"
|
|
837
|
-
"
|
|
878
|
+
"name": "query",
|
|
879
|
+
"description": "Visibility query, see https://docs.temporal.io/list-filter for the syntax.",
|
|
880
|
+
"in": "query",
|
|
881
|
+
"required": false,
|
|
838
882
|
"type": "string"
|
|
839
|
-
},
|
|
840
|
-
{
|
|
841
|
-
"name": "body",
|
|
842
|
-
"in": "body",
|
|
843
|
-
"required": true,
|
|
844
|
-
"schema": {
|
|
845
|
-
"$ref": "#/definitions/WorkflowServiceRequestCancelActivityExecutionBody"
|
|
846
|
-
}
|
|
847
883
|
}
|
|
848
884
|
],
|
|
849
885
|
"tags": [
|
|
@@ -851,15 +887,16 @@
|
|
|
851
887
|
]
|
|
852
888
|
}
|
|
853
889
|
},
|
|
854
|
-
"/api/v1/namespaces/{namespace}/
|
|
855
|
-
"
|
|
856
|
-
"summary": "
|
|
857
|
-
"
|
|
890
|
+
"/api/v1/namespaces/{namespace}/activity-fail": {
|
|
891
|
+
"post": {
|
|
892
|
+
"summary": "RespondActivityTaskFailed is called by workers when processing an activity task fails.",
|
|
893
|
+
"description": "This results in a new `ACTIVITY_TASK_FAILED` event being written to the workflow history and\na new workflow task created for the workflow. Fails with `NotFound` if the task token is no\nlonger valid due to activity timeout, already being completed, or never having existed.",
|
|
894
|
+
"operationId": "RespondActivityTaskFailed2",
|
|
858
895
|
"responses": {
|
|
859
896
|
"200": {
|
|
860
897
|
"description": "A successful response.",
|
|
861
898
|
"schema": {
|
|
862
|
-
"$ref": "#/definitions/
|
|
899
|
+
"$ref": "#/definitions/v1RespondActivityTaskFailedResponse"
|
|
863
900
|
}
|
|
864
901
|
},
|
|
865
902
|
"default": {
|
|
@@ -877,17 +914,12 @@
|
|
|
877
914
|
"type": "string"
|
|
878
915
|
},
|
|
879
916
|
{
|
|
880
|
-
"name": "
|
|
881
|
-
"in": "
|
|
917
|
+
"name": "body",
|
|
918
|
+
"in": "body",
|
|
882
919
|
"required": true,
|
|
883
|
-
"
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
"name": "runId",
|
|
887
|
-
"description": "Activity run ID. If empty the request targets the latest run.",
|
|
888
|
-
"in": "query",
|
|
889
|
-
"required": false,
|
|
890
|
-
"type": "string"
|
|
920
|
+
"schema": {
|
|
921
|
+
"$ref": "#/definitions/WorkflowServiceRespondActivityTaskFailedBody"
|
|
922
|
+
}
|
|
891
923
|
}
|
|
892
924
|
],
|
|
893
925
|
"tags": [
|
|
@@ -895,16 +927,16 @@
|
|
|
895
927
|
]
|
|
896
928
|
}
|
|
897
929
|
},
|
|
898
|
-
"/api/v1/namespaces/{namespace}/
|
|
930
|
+
"/api/v1/namespaces/{namespace}/activity-heartbeat": {
|
|
899
931
|
"post": {
|
|
900
|
-
"summary": "
|
|
901
|
-
"description": "
|
|
902
|
-
"operationId": "
|
|
932
|
+
"summary": "RecordActivityTaskHeartbeat is optionally called by workers while they execute activities.",
|
|
933
|
+
"description": "If a worker fails to heartbeat within the `heartbeat_timeout` interval for the activity task,\nthen the current attempt times out. Depending on RetryPolicy, this may trigger a retry or\ntime out the activity.\n\nFor workflow activities, an `ACTIVITY_TASK_TIMED_OUT` event will be written to the workflow\nhistory. Calling `RecordActivityTaskHeartbeat` will fail with `NotFound` in such situations,\nin that event, the SDK should request cancellation of the activity.\n\nThe request may contain response `details` which will be persisted by the server and may be\nused by the activity to checkpoint progress. The `cancel_requested` field in the response\nindicates whether cancellation has been requested for the activity.",
|
|
934
|
+
"operationId": "RecordActivityTaskHeartbeat2",
|
|
903
935
|
"responses": {
|
|
904
936
|
"200": {
|
|
905
937
|
"description": "A successful response.",
|
|
906
938
|
"schema": {
|
|
907
|
-
"$ref": "#/definitions/
|
|
939
|
+
"$ref": "#/definitions/v1RecordActivityTaskHeartbeatResponse"
|
|
908
940
|
}
|
|
909
941
|
},
|
|
910
942
|
"default": {
|
|
@@ -921,18 +953,12 @@
|
|
|
921
953
|
"required": true,
|
|
922
954
|
"type": "string"
|
|
923
955
|
},
|
|
924
|
-
{
|
|
925
|
-
"name": "activityId",
|
|
926
|
-
"in": "path",
|
|
927
|
-
"required": true,
|
|
928
|
-
"type": "string"
|
|
929
|
-
},
|
|
930
956
|
{
|
|
931
957
|
"name": "body",
|
|
932
958
|
"in": "body",
|
|
933
959
|
"required": true,
|
|
934
960
|
"schema": {
|
|
935
|
-
"$ref": "#/definitions/
|
|
961
|
+
"$ref": "#/definitions/WorkflowServiceRecordActivityTaskHeartbeatBody"
|
|
936
962
|
}
|
|
937
963
|
}
|
|
938
964
|
],
|
|
@@ -941,15 +967,16 @@
|
|
|
941
967
|
]
|
|
942
968
|
}
|
|
943
969
|
},
|
|
944
|
-
"/api/v1/namespaces/{namespace}/activity-
|
|
945
|
-
"
|
|
946
|
-
"summary": "
|
|
947
|
-
"
|
|
970
|
+
"/api/v1/namespaces/{namespace}/activity-resolve-as-canceled": {
|
|
971
|
+
"post": {
|
|
972
|
+
"summary": "RespondActivityTaskFailed is called by workers when processing an activity task fails.",
|
|
973
|
+
"description": "For workflow activities, this results in a new `ACTIVITY_TASK_CANCELED` event being written to the workflow history\nand a new workflow task created for the workflow. Fails with `NotFound` if the task token is\nno longer valid due to activity timeout, already being completed, or never having existed.",
|
|
974
|
+
"operationId": "RespondActivityTaskCanceled2",
|
|
948
975
|
"responses": {
|
|
949
976
|
"200": {
|
|
950
977
|
"description": "A successful response.",
|
|
951
978
|
"schema": {
|
|
952
|
-
"$ref": "#/definitions/
|
|
979
|
+
"$ref": "#/definitions/v1RespondActivityTaskCanceledResponse"
|
|
953
980
|
}
|
|
954
981
|
},
|
|
955
982
|
"default": {
|
|
@@ -967,11 +994,12 @@
|
|
|
967
994
|
"type": "string"
|
|
968
995
|
},
|
|
969
996
|
{
|
|
970
|
-
"name": "
|
|
971
|
-
"
|
|
972
|
-
"
|
|
973
|
-
"
|
|
974
|
-
|
|
997
|
+
"name": "body",
|
|
998
|
+
"in": "body",
|
|
999
|
+
"required": true,
|
|
1000
|
+
"schema": {
|
|
1001
|
+
"$ref": "#/definitions/WorkflowServiceRespondActivityTaskCanceledBody"
|
|
1002
|
+
}
|
|
975
1003
|
}
|
|
976
1004
|
],
|
|
977
1005
|
"tags": [
|
|
@@ -1434,6 +1462,44 @@
|
|
|
1434
1462
|
]
|
|
1435
1463
|
}
|
|
1436
1464
|
},
|
|
1465
|
+
"/api/v1/namespaces/{namespace}/schedule-count": {
|
|
1466
|
+
"get": {
|
|
1467
|
+
"summary": "CountSchedules is a visibility API to count schedules in a specific namespace.",
|
|
1468
|
+
"operationId": "CountSchedules2",
|
|
1469
|
+
"responses": {
|
|
1470
|
+
"200": {
|
|
1471
|
+
"description": "A successful response.",
|
|
1472
|
+
"schema": {
|
|
1473
|
+
"$ref": "#/definitions/v1CountSchedulesResponse"
|
|
1474
|
+
}
|
|
1475
|
+
},
|
|
1476
|
+
"default": {
|
|
1477
|
+
"description": "An unexpected error response.",
|
|
1478
|
+
"schema": {
|
|
1479
|
+
"$ref": "#/definitions/rpcStatus"
|
|
1480
|
+
}
|
|
1481
|
+
}
|
|
1482
|
+
},
|
|
1483
|
+
"parameters": [
|
|
1484
|
+
{
|
|
1485
|
+
"name": "namespace",
|
|
1486
|
+
"in": "path",
|
|
1487
|
+
"required": true,
|
|
1488
|
+
"type": "string"
|
|
1489
|
+
},
|
|
1490
|
+
{
|
|
1491
|
+
"name": "query",
|
|
1492
|
+
"description": "Visibility query, see https://docs.temporal.io/list-filter for the syntax.",
|
|
1493
|
+
"in": "query",
|
|
1494
|
+
"required": false,
|
|
1495
|
+
"type": "string"
|
|
1496
|
+
}
|
|
1497
|
+
],
|
|
1498
|
+
"tags": [
|
|
1499
|
+
"WorkflowService"
|
|
1500
|
+
]
|
|
1501
|
+
}
|
|
1502
|
+
},
|
|
1437
1503
|
"/api/v1/namespaces/{namespace}/schedules": {
|
|
1438
1504
|
"get": {
|
|
1439
1505
|
"summary": "List all schedules in a namespace.",
|
|
@@ -3076,46 +3142,6 @@
|
|
|
3076
3142
|
]
|
|
3077
3143
|
}
|
|
3078
3144
|
},
|
|
3079
|
-
"/api/v1/namespaces/{namespace}/workflows/execute-multi-operation": {
|
|
3080
|
-
"post": {
|
|
3081
|
-
"summary": "ExecuteMultiOperation executes multiple operations within a single workflow.",
|
|
3082
|
-
"description": "Operations are started atomically, meaning if *any* operation fails to be started, none are,\nand the request fails. Upon start, the API returns only when *all* operations have a response.\n\nUpon failure, it returns `MultiOperationExecutionFailure` where the status code\nequals the status code of the *first* operation that failed to be started.\n\nNOTE: Experimental API.",
|
|
3083
|
-
"operationId": "ExecuteMultiOperation2",
|
|
3084
|
-
"responses": {
|
|
3085
|
-
"200": {
|
|
3086
|
-
"description": "A successful response.",
|
|
3087
|
-
"schema": {
|
|
3088
|
-
"$ref": "#/definitions/v1ExecuteMultiOperationResponse"
|
|
3089
|
-
}
|
|
3090
|
-
},
|
|
3091
|
-
"default": {
|
|
3092
|
-
"description": "An unexpected error response.",
|
|
3093
|
-
"schema": {
|
|
3094
|
-
"$ref": "#/definitions/rpcStatus"
|
|
3095
|
-
}
|
|
3096
|
-
}
|
|
3097
|
-
},
|
|
3098
|
-
"parameters": [
|
|
3099
|
-
{
|
|
3100
|
-
"name": "namespace",
|
|
3101
|
-
"in": "path",
|
|
3102
|
-
"required": true,
|
|
3103
|
-
"type": "string"
|
|
3104
|
-
},
|
|
3105
|
-
{
|
|
3106
|
-
"name": "body",
|
|
3107
|
-
"in": "body",
|
|
3108
|
-
"required": true,
|
|
3109
|
-
"schema": {
|
|
3110
|
-
"$ref": "#/definitions/WorkflowServiceExecuteMultiOperationBody"
|
|
3111
|
-
}
|
|
3112
|
-
}
|
|
3113
|
-
],
|
|
3114
|
-
"tags": [
|
|
3115
|
-
"WorkflowService"
|
|
3116
|
-
]
|
|
3117
|
-
}
|
|
3118
|
-
},
|
|
3119
3145
|
"/api/v1/namespaces/{namespace}/workflows/{execution.workflowId}": {
|
|
3120
3146
|
"get": {
|
|
3121
3147
|
"summary": "DescribeWorkflowExecution returns information about the specified workflow execution.",
|
|
@@ -3613,7 +3639,322 @@
|
|
|
3613
3639
|
"type": "string"
|
|
3614
3640
|
},
|
|
3615
3641
|
{
|
|
3616
|
-
"name": "workflowExecution.workflowId",
|
|
3642
|
+
"name": "workflowExecution.workflowId",
|
|
3643
|
+
"in": "path",
|
|
3644
|
+
"required": true,
|
|
3645
|
+
"type": "string"
|
|
3646
|
+
},
|
|
3647
|
+
{
|
|
3648
|
+
"name": "body",
|
|
3649
|
+
"in": "body",
|
|
3650
|
+
"required": true,
|
|
3651
|
+
"schema": {
|
|
3652
|
+
"$ref": "#/definitions/WorkflowServiceUpdateWorkflowExecutionOptionsBody"
|
|
3653
|
+
}
|
|
3654
|
+
}
|
|
3655
|
+
],
|
|
3656
|
+
"tags": [
|
|
3657
|
+
"WorkflowService"
|
|
3658
|
+
]
|
|
3659
|
+
}
|
|
3660
|
+
},
|
|
3661
|
+
"/api/v1/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/update/{request.input.name}": {
|
|
3662
|
+
"post": {
|
|
3663
|
+
"summary": "Invokes the specified Update function on user Workflow code.",
|
|
3664
|
+
"operationId": "UpdateWorkflowExecution2",
|
|
3665
|
+
"responses": {
|
|
3666
|
+
"200": {
|
|
3667
|
+
"description": "A successful response.",
|
|
3668
|
+
"schema": {
|
|
3669
|
+
"$ref": "#/definitions/v1UpdateWorkflowExecutionResponse"
|
|
3670
|
+
}
|
|
3671
|
+
},
|
|
3672
|
+
"default": {
|
|
3673
|
+
"description": "An unexpected error response.",
|
|
3674
|
+
"schema": {
|
|
3675
|
+
"$ref": "#/definitions/rpcStatus"
|
|
3676
|
+
}
|
|
3677
|
+
}
|
|
3678
|
+
},
|
|
3679
|
+
"parameters": [
|
|
3680
|
+
{
|
|
3681
|
+
"name": "namespace",
|
|
3682
|
+
"description": "The namespace name of the target Workflow.",
|
|
3683
|
+
"in": "path",
|
|
3684
|
+
"required": true,
|
|
3685
|
+
"type": "string"
|
|
3686
|
+
},
|
|
3687
|
+
{
|
|
3688
|
+
"name": "workflowExecution.workflowId",
|
|
3689
|
+
"in": "path",
|
|
3690
|
+
"required": true,
|
|
3691
|
+
"type": "string"
|
|
3692
|
+
},
|
|
3693
|
+
{
|
|
3694
|
+
"name": "request.input.name",
|
|
3695
|
+
"description": "The name of the Update handler to invoke on the target Workflow.",
|
|
3696
|
+
"in": "path",
|
|
3697
|
+
"required": true,
|
|
3698
|
+
"type": "string"
|
|
3699
|
+
},
|
|
3700
|
+
{
|
|
3701
|
+
"name": "body",
|
|
3702
|
+
"in": "body",
|
|
3703
|
+
"required": true,
|
|
3704
|
+
"schema": {
|
|
3705
|
+
"$ref": "#/definitions/WorkflowServiceUpdateWorkflowExecutionBody"
|
|
3706
|
+
}
|
|
3707
|
+
}
|
|
3708
|
+
],
|
|
3709
|
+
"tags": [
|
|
3710
|
+
"WorkflowService"
|
|
3711
|
+
]
|
|
3712
|
+
}
|
|
3713
|
+
},
|
|
3714
|
+
"/api/v1/namespaces/{namespace}/workflows/{workflowId}": {
|
|
3715
|
+
"post": {
|
|
3716
|
+
"summary": "StartWorkflowExecution starts a new workflow execution.",
|
|
3717
|
+
"description": "It will create the execution with a `WORKFLOW_EXECUTION_STARTED` event in its history and\nalso schedule the first workflow task. Returns `WorkflowExecutionAlreadyStarted`, if an\ninstance already exists with same workflow id.",
|
|
3718
|
+
"operationId": "StartWorkflowExecution2",
|
|
3719
|
+
"responses": {
|
|
3720
|
+
"200": {
|
|
3721
|
+
"description": "A successful response.",
|
|
3722
|
+
"schema": {
|
|
3723
|
+
"$ref": "#/definitions/v1StartWorkflowExecutionResponse"
|
|
3724
|
+
}
|
|
3725
|
+
},
|
|
3726
|
+
"default": {
|
|
3727
|
+
"description": "An unexpected error response.",
|
|
3728
|
+
"schema": {
|
|
3729
|
+
"$ref": "#/definitions/rpcStatus"
|
|
3730
|
+
}
|
|
3731
|
+
}
|
|
3732
|
+
},
|
|
3733
|
+
"parameters": [
|
|
3734
|
+
{
|
|
3735
|
+
"name": "namespace",
|
|
3736
|
+
"in": "path",
|
|
3737
|
+
"required": true,
|
|
3738
|
+
"type": "string"
|
|
3739
|
+
},
|
|
3740
|
+
{
|
|
3741
|
+
"name": "workflowId",
|
|
3742
|
+
"in": "path",
|
|
3743
|
+
"required": true,
|
|
3744
|
+
"type": "string"
|
|
3745
|
+
},
|
|
3746
|
+
{
|
|
3747
|
+
"name": "body",
|
|
3748
|
+
"in": "body",
|
|
3749
|
+
"required": true,
|
|
3750
|
+
"schema": {
|
|
3751
|
+
"$ref": "#/definitions/WorkflowServiceStartWorkflowExecutionBody"
|
|
3752
|
+
}
|
|
3753
|
+
}
|
|
3754
|
+
],
|
|
3755
|
+
"tags": [
|
|
3756
|
+
"WorkflowService"
|
|
3757
|
+
]
|
|
3758
|
+
}
|
|
3759
|
+
},
|
|
3760
|
+
"/api/v1/namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}/complete": {
|
|
3761
|
+
"post": {
|
|
3762
|
+
"summary": "See `RespondActivityTaskCompleted`. This version allows clients to record completions by\nnamespace/workflow id/activity id instead of task token.",
|
|
3763
|
+
"operationId": "RespondActivityTaskCompletedById4",
|
|
3764
|
+
"responses": {
|
|
3765
|
+
"200": {
|
|
3766
|
+
"description": "A successful response.",
|
|
3767
|
+
"schema": {
|
|
3768
|
+
"$ref": "#/definitions/v1RespondActivityTaskCompletedByIdResponse"
|
|
3769
|
+
}
|
|
3770
|
+
},
|
|
3771
|
+
"default": {
|
|
3772
|
+
"description": "An unexpected error response.",
|
|
3773
|
+
"schema": {
|
|
3774
|
+
"$ref": "#/definitions/rpcStatus"
|
|
3775
|
+
}
|
|
3776
|
+
}
|
|
3777
|
+
},
|
|
3778
|
+
"parameters": [
|
|
3779
|
+
{
|
|
3780
|
+
"name": "namespace",
|
|
3781
|
+
"description": "Namespace of the workflow which scheduled this activity",
|
|
3782
|
+
"in": "path",
|
|
3783
|
+
"required": true,
|
|
3784
|
+
"type": "string"
|
|
3785
|
+
},
|
|
3786
|
+
{
|
|
3787
|
+
"name": "workflowId",
|
|
3788
|
+
"description": "Id of the workflow which scheduled this activity, leave empty to target a standalone activity",
|
|
3789
|
+
"in": "path",
|
|
3790
|
+
"required": true,
|
|
3791
|
+
"type": "string"
|
|
3792
|
+
},
|
|
3793
|
+
{
|
|
3794
|
+
"name": "activityId",
|
|
3795
|
+
"description": "Id of the activity to complete",
|
|
3796
|
+
"in": "path",
|
|
3797
|
+
"required": true,
|
|
3798
|
+
"type": "string"
|
|
3799
|
+
},
|
|
3800
|
+
{
|
|
3801
|
+
"name": "body",
|
|
3802
|
+
"in": "body",
|
|
3803
|
+
"required": true,
|
|
3804
|
+
"schema": {
|
|
3805
|
+
"$ref": "#/definitions/WorkflowServiceRespondActivityTaskCompletedByIdBody"
|
|
3806
|
+
}
|
|
3807
|
+
}
|
|
3808
|
+
],
|
|
3809
|
+
"tags": [
|
|
3810
|
+
"WorkflowService"
|
|
3811
|
+
]
|
|
3812
|
+
}
|
|
3813
|
+
},
|
|
3814
|
+
"/api/v1/namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}/fail": {
|
|
3815
|
+
"post": {
|
|
3816
|
+
"summary": "See `RecordActivityTaskFailed`. This version allows clients to record failures by\nnamespace/workflow id/activity id instead of task token.",
|
|
3817
|
+
"operationId": "RespondActivityTaskFailedById4",
|
|
3818
|
+
"responses": {
|
|
3819
|
+
"200": {
|
|
3820
|
+
"description": "A successful response.",
|
|
3821
|
+
"schema": {
|
|
3822
|
+
"$ref": "#/definitions/v1RespondActivityTaskFailedByIdResponse"
|
|
3823
|
+
}
|
|
3824
|
+
},
|
|
3825
|
+
"default": {
|
|
3826
|
+
"description": "An unexpected error response.",
|
|
3827
|
+
"schema": {
|
|
3828
|
+
"$ref": "#/definitions/rpcStatus"
|
|
3829
|
+
}
|
|
3830
|
+
}
|
|
3831
|
+
},
|
|
3832
|
+
"parameters": [
|
|
3833
|
+
{
|
|
3834
|
+
"name": "namespace",
|
|
3835
|
+
"description": "Namespace of the workflow which scheduled this activity",
|
|
3836
|
+
"in": "path",
|
|
3837
|
+
"required": true,
|
|
3838
|
+
"type": "string"
|
|
3839
|
+
},
|
|
3840
|
+
{
|
|
3841
|
+
"name": "workflowId",
|
|
3842
|
+
"description": "Id of the workflow which scheduled this activity, leave empty to target a standalone activity",
|
|
3843
|
+
"in": "path",
|
|
3844
|
+
"required": true,
|
|
3845
|
+
"type": "string"
|
|
3846
|
+
},
|
|
3847
|
+
{
|
|
3848
|
+
"name": "activityId",
|
|
3849
|
+
"description": "Id of the activity to fail",
|
|
3850
|
+
"in": "path",
|
|
3851
|
+
"required": true,
|
|
3852
|
+
"type": "string"
|
|
3853
|
+
},
|
|
3854
|
+
{
|
|
3855
|
+
"name": "body",
|
|
3856
|
+
"in": "body",
|
|
3857
|
+
"required": true,
|
|
3858
|
+
"schema": {
|
|
3859
|
+
"$ref": "#/definitions/WorkflowServiceRespondActivityTaskFailedByIdBody"
|
|
3860
|
+
}
|
|
3861
|
+
}
|
|
3862
|
+
],
|
|
3863
|
+
"tags": [
|
|
3864
|
+
"WorkflowService"
|
|
3865
|
+
]
|
|
3866
|
+
}
|
|
3867
|
+
},
|
|
3868
|
+
"/api/v1/namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}/heartbeat": {
|
|
3869
|
+
"post": {
|
|
3870
|
+
"summary": "See `RecordActivityTaskHeartbeat`. This version allows clients to record heartbeats by\nnamespace/workflow id/activity id instead of task token.",
|
|
3871
|
+
"operationId": "RecordActivityTaskHeartbeatById4",
|
|
3872
|
+
"responses": {
|
|
3873
|
+
"200": {
|
|
3874
|
+
"description": "A successful response.",
|
|
3875
|
+
"schema": {
|
|
3876
|
+
"$ref": "#/definitions/v1RecordActivityTaskHeartbeatByIdResponse"
|
|
3877
|
+
}
|
|
3878
|
+
},
|
|
3879
|
+
"default": {
|
|
3880
|
+
"description": "An unexpected error response.",
|
|
3881
|
+
"schema": {
|
|
3882
|
+
"$ref": "#/definitions/rpcStatus"
|
|
3883
|
+
}
|
|
3884
|
+
}
|
|
3885
|
+
},
|
|
3886
|
+
"parameters": [
|
|
3887
|
+
{
|
|
3888
|
+
"name": "namespace",
|
|
3889
|
+
"description": "Namespace of the workflow which scheduled this activity",
|
|
3890
|
+
"in": "path",
|
|
3891
|
+
"required": true,
|
|
3892
|
+
"type": "string"
|
|
3893
|
+
},
|
|
3894
|
+
{
|
|
3895
|
+
"name": "workflowId",
|
|
3896
|
+
"description": "Id of the workflow which scheduled this activity, leave empty to target a standalone activity",
|
|
3897
|
+
"in": "path",
|
|
3898
|
+
"required": true,
|
|
3899
|
+
"type": "string"
|
|
3900
|
+
},
|
|
3901
|
+
{
|
|
3902
|
+
"name": "activityId",
|
|
3903
|
+
"description": "Id of the activity we're heartbeating",
|
|
3904
|
+
"in": "path",
|
|
3905
|
+
"required": true,
|
|
3906
|
+
"type": "string"
|
|
3907
|
+
},
|
|
3908
|
+
{
|
|
3909
|
+
"name": "body",
|
|
3910
|
+
"in": "body",
|
|
3911
|
+
"required": true,
|
|
3912
|
+
"schema": {
|
|
3913
|
+
"$ref": "#/definitions/WorkflowServiceRecordActivityTaskHeartbeatByIdBody"
|
|
3914
|
+
}
|
|
3915
|
+
}
|
|
3916
|
+
],
|
|
3917
|
+
"tags": [
|
|
3918
|
+
"WorkflowService"
|
|
3919
|
+
]
|
|
3920
|
+
}
|
|
3921
|
+
},
|
|
3922
|
+
"/api/v1/namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}/resolve-as-canceled": {
|
|
3923
|
+
"post": {
|
|
3924
|
+
"summary": "See `RespondActivityTaskCanceled`. This version allows clients to record failures by\nnamespace/workflow id/activity id instead of task token.",
|
|
3925
|
+
"operationId": "RespondActivityTaskCanceledById4",
|
|
3926
|
+
"responses": {
|
|
3927
|
+
"200": {
|
|
3928
|
+
"description": "A successful response.",
|
|
3929
|
+
"schema": {
|
|
3930
|
+
"$ref": "#/definitions/v1RespondActivityTaskCanceledByIdResponse"
|
|
3931
|
+
}
|
|
3932
|
+
},
|
|
3933
|
+
"default": {
|
|
3934
|
+
"description": "An unexpected error response.",
|
|
3935
|
+
"schema": {
|
|
3936
|
+
"$ref": "#/definitions/rpcStatus"
|
|
3937
|
+
}
|
|
3938
|
+
}
|
|
3939
|
+
},
|
|
3940
|
+
"parameters": [
|
|
3941
|
+
{
|
|
3942
|
+
"name": "namespace",
|
|
3943
|
+
"description": "Namespace of the workflow which scheduled this activity",
|
|
3944
|
+
"in": "path",
|
|
3945
|
+
"required": true,
|
|
3946
|
+
"type": "string"
|
|
3947
|
+
},
|
|
3948
|
+
{
|
|
3949
|
+
"name": "workflowId",
|
|
3950
|
+
"description": "Id of the workflow which scheduled this activity, leave empty to target a standalone activity",
|
|
3951
|
+
"in": "path",
|
|
3952
|
+
"required": true,
|
|
3953
|
+
"type": "string"
|
|
3954
|
+
},
|
|
3955
|
+
{
|
|
3956
|
+
"name": "activityId",
|
|
3957
|
+
"description": "Id of the activity to confirm is cancelled",
|
|
3617
3958
|
"in": "path",
|
|
3618
3959
|
"required": true,
|
|
3619
3960
|
"type": "string"
|
|
@@ -3623,7 +3964,7 @@
|
|
|
3623
3964
|
"in": "body",
|
|
3624
3965
|
"required": true,
|
|
3625
3966
|
"schema": {
|
|
3626
|
-
"$ref": "#/definitions/
|
|
3967
|
+
"$ref": "#/definitions/WorkflowServiceRespondActivityTaskCanceledByIdBody"
|
|
3627
3968
|
}
|
|
3628
3969
|
}
|
|
3629
3970
|
],
|
|
@@ -3632,15 +3973,15 @@
|
|
|
3632
3973
|
]
|
|
3633
3974
|
}
|
|
3634
3975
|
},
|
|
3635
|
-
"/api/v1/namespaces/{namespace}/workflows/{
|
|
3976
|
+
"/api/v1/namespaces/{namespace}/workflows/{workflowId}/pause": {
|
|
3636
3977
|
"post": {
|
|
3637
|
-
"summary": "
|
|
3638
|
-
"operationId": "
|
|
3978
|
+
"summary": "Note: This is an experimental API and the behavior may change in a future release.\nPauseWorkflowExecution pauses the workflow execution specified in the request. Pausing a workflow execution results in\n- The workflow execution status changes to `PAUSED` and a new WORKFLOW_EXECUTION_PAUSED event is added to the history\n- No new workflow tasks or activity tasks are dispatched.\n - Any workflow task currently executing on the worker will be allowed to complete.\n - Any activity task currently executing will be paused.\n- All server-side events will continue to be processed by the server.\n- Queries & Updates on a paused workflow will be rejected.",
|
|
3979
|
+
"operationId": "PauseWorkflowExecution2",
|
|
3639
3980
|
"responses": {
|
|
3640
3981
|
"200": {
|
|
3641
3982
|
"description": "A successful response.",
|
|
3642
3983
|
"schema": {
|
|
3643
|
-
"$ref": "#/definitions/
|
|
3984
|
+
"$ref": "#/definitions/v1PauseWorkflowExecutionResponse"
|
|
3644
3985
|
}
|
|
3645
3986
|
},
|
|
3646
3987
|
"default": {
|
|
@@ -3653,20 +3994,14 @@
|
|
|
3653
3994
|
"parameters": [
|
|
3654
3995
|
{
|
|
3655
3996
|
"name": "namespace",
|
|
3656
|
-
"description": "
|
|
3657
|
-
"in": "path",
|
|
3658
|
-
"required": true,
|
|
3659
|
-
"type": "string"
|
|
3660
|
-
},
|
|
3661
|
-
{
|
|
3662
|
-
"name": "workflowExecution.workflowId",
|
|
3997
|
+
"description": "Namespace of the workflow to pause.",
|
|
3663
3998
|
"in": "path",
|
|
3664
3999
|
"required": true,
|
|
3665
4000
|
"type": "string"
|
|
3666
4001
|
},
|
|
3667
4002
|
{
|
|
3668
|
-
"name": "
|
|
3669
|
-
"description": "
|
|
4003
|
+
"name": "workflowId",
|
|
4004
|
+
"description": "ID of the workflow execution to be paused. Required.",
|
|
3670
4005
|
"in": "path",
|
|
3671
4006
|
"required": true,
|
|
3672
4007
|
"type": "string"
|
|
@@ -3676,7 +4011,7 @@
|
|
|
3676
4011
|
"in": "body",
|
|
3677
4012
|
"required": true,
|
|
3678
4013
|
"schema": {
|
|
3679
|
-
"$ref": "#/definitions/
|
|
4014
|
+
"$ref": "#/definitions/WorkflowServicePauseWorkflowExecutionBody"
|
|
3680
4015
|
}
|
|
3681
4016
|
}
|
|
3682
4017
|
],
|
|
@@ -3685,16 +4020,16 @@
|
|
|
3685
4020
|
]
|
|
3686
4021
|
}
|
|
3687
4022
|
},
|
|
3688
|
-
"/api/v1/namespaces/{namespace}/workflows/{workflowId}": {
|
|
4023
|
+
"/api/v1/namespaces/{namespace}/workflows/{workflowId}/signal-with-start/{signalName}": {
|
|
3689
4024
|
"post": {
|
|
3690
|
-
"summary": "
|
|
3691
|
-
"description": "
|
|
3692
|
-
"operationId": "
|
|
4025
|
+
"summary": "SignalWithStartWorkflowExecution is used to ensure a signal is sent to a workflow, even if\nit isn't yet started.",
|
|
4026
|
+
"description": "If the workflow is running, a `WORKFLOW_EXECUTION_SIGNALED` event is recorded in the history\nand a workflow task is generated.\n\nIf the workflow is not running or not found, then the workflow is created with\n`WORKFLOW_EXECUTION_STARTED` and `WORKFLOW_EXECUTION_SIGNALED` events in its history, and a\nworkflow task is generated.",
|
|
4027
|
+
"operationId": "SignalWithStartWorkflowExecution2",
|
|
3693
4028
|
"responses": {
|
|
3694
4029
|
"200": {
|
|
3695
4030
|
"description": "A successful response.",
|
|
3696
4031
|
"schema": {
|
|
3697
|
-
"$ref": "#/definitions/
|
|
4032
|
+
"$ref": "#/definitions/v1SignalWithStartWorkflowExecutionResponse"
|
|
3698
4033
|
}
|
|
3699
4034
|
},
|
|
3700
4035
|
"default": {
|
|
@@ -3717,12 +4052,19 @@
|
|
|
3717
4052
|
"required": true,
|
|
3718
4053
|
"type": "string"
|
|
3719
4054
|
},
|
|
4055
|
+
{
|
|
4056
|
+
"name": "signalName",
|
|
4057
|
+
"description": "The workflow author-defined name of the signal to send to the workflow",
|
|
4058
|
+
"in": "path",
|
|
4059
|
+
"required": true,
|
|
4060
|
+
"type": "string"
|
|
4061
|
+
},
|
|
3720
4062
|
{
|
|
3721
4063
|
"name": "body",
|
|
3722
4064
|
"in": "body",
|
|
3723
4065
|
"required": true,
|
|
3724
4066
|
"schema": {
|
|
3725
|
-
"$ref": "#/definitions/
|
|
4067
|
+
"$ref": "#/definitions/WorkflowServiceSignalWithStartWorkflowExecutionBody"
|
|
3726
4068
|
}
|
|
3727
4069
|
}
|
|
3728
4070
|
],
|
|
@@ -3731,16 +4073,15 @@
|
|
|
3731
4073
|
]
|
|
3732
4074
|
}
|
|
3733
4075
|
},
|
|
3734
|
-
"/api/v1/namespaces/{namespace}/workflows/{workflowId}/
|
|
4076
|
+
"/api/v1/namespaces/{namespace}/workflows/{workflowId}/unpause": {
|
|
3735
4077
|
"post": {
|
|
3736
|
-
"summary": "
|
|
3737
|
-
"
|
|
3738
|
-
"operationId": "SignalWithStartWorkflowExecution2",
|
|
4078
|
+
"summary": "Note: This is an experimental API and the behavior may change in a future release.\nUnpauseWorkflowExecution unpauses a previously paused workflow execution specified in the request.\nUnpausing a workflow execution results in\n- The workflow execution status changes to `RUNNING` and a new WORKFLOW_EXECUTION_UNPAUSED event is added to the history\n- Workflow tasks and activity tasks are resumed.",
|
|
4079
|
+
"operationId": "UnpauseWorkflowExecution2",
|
|
3739
4080
|
"responses": {
|
|
3740
4081
|
"200": {
|
|
3741
4082
|
"description": "A successful response.",
|
|
3742
4083
|
"schema": {
|
|
3743
|
-
"$ref": "#/definitions/
|
|
4084
|
+
"$ref": "#/definitions/v1UnpauseWorkflowExecutionResponse"
|
|
3744
4085
|
}
|
|
3745
4086
|
},
|
|
3746
4087
|
"default": {
|
|
@@ -3753,19 +4094,14 @@
|
|
|
3753
4094
|
"parameters": [
|
|
3754
4095
|
{
|
|
3755
4096
|
"name": "namespace",
|
|
4097
|
+
"description": "Namespace of the workflow to unpause.",
|
|
3756
4098
|
"in": "path",
|
|
3757
4099
|
"required": true,
|
|
3758
4100
|
"type": "string"
|
|
3759
4101
|
},
|
|
3760
4102
|
{
|
|
3761
4103
|
"name": "workflowId",
|
|
3762
|
-
"
|
|
3763
|
-
"required": true,
|
|
3764
|
-
"type": "string"
|
|
3765
|
-
},
|
|
3766
|
-
{
|
|
3767
|
-
"name": "signalName",
|
|
3768
|
-
"description": "The workflow author-defined name of the signal to send to the workflow",
|
|
4104
|
+
"description": "ID of the workflow execution to be paused. Required.",
|
|
3769
4105
|
"in": "path",
|
|
3770
4106
|
"required": true,
|
|
3771
4107
|
"type": "string"
|
|
@@ -3775,7 +4111,7 @@
|
|
|
3775
4111
|
"in": "body",
|
|
3776
4112
|
"required": true,
|
|
3777
4113
|
"schema": {
|
|
3778
|
-
"$ref": "#/definitions/
|
|
4114
|
+
"$ref": "#/definitions/WorkflowServiceUnpauseWorkflowExecutionBody"
|
|
3779
4115
|
}
|
|
3780
4116
|
}
|
|
3781
4117
|
],
|
|
@@ -4445,16 +4781,16 @@
|
|
|
4445
4781
|
]
|
|
4446
4782
|
}
|
|
4447
4783
|
},
|
|
4448
|
-
"/namespaces/{namespace}/activities/
|
|
4784
|
+
"/namespaces/{namespace}/activities-deprecated/pause": {
|
|
4449
4785
|
"post": {
|
|
4450
|
-
"summary": "
|
|
4451
|
-
"description": "
|
|
4452
|
-
"operationId": "
|
|
4786
|
+
"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",
|
|
4787
|
+
"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\nThis API will be deprecated soon and replaced with a newer PauseActivityExecution that is better named and\nstructured to work well for standalone activities.",
|
|
4788
|
+
"operationId": "PauseActivity",
|
|
4453
4789
|
"responses": {
|
|
4454
4790
|
"200": {
|
|
4455
4791
|
"description": "A successful response.",
|
|
4456
4792
|
"schema": {
|
|
4457
|
-
"$ref": "#/definitions/
|
|
4793
|
+
"$ref": "#/definitions/v1PauseActivityResponse"
|
|
4458
4794
|
}
|
|
4459
4795
|
},
|
|
4460
4796
|
"default": {
|
|
@@ -4467,6 +4803,7 @@
|
|
|
4467
4803
|
"parameters": [
|
|
4468
4804
|
{
|
|
4469
4805
|
"name": "namespace",
|
|
4806
|
+
"description": "Namespace of the workflow which scheduled this activity.",
|
|
4470
4807
|
"in": "path",
|
|
4471
4808
|
"required": true,
|
|
4472
4809
|
"type": "string"
|
|
@@ -4476,7 +4813,7 @@
|
|
|
4476
4813
|
"in": "body",
|
|
4477
4814
|
"required": true,
|
|
4478
4815
|
"schema": {
|
|
4479
|
-
"$ref": "#/definitions/
|
|
4816
|
+
"$ref": "#/definitions/WorkflowServicePauseActivityBody"
|
|
4480
4817
|
}
|
|
4481
4818
|
}
|
|
4482
4819
|
],
|
|
@@ -4485,15 +4822,16 @@
|
|
|
4485
4822
|
]
|
|
4486
4823
|
}
|
|
4487
4824
|
},
|
|
4488
|
-
"/namespaces/{namespace}/activities/
|
|
4825
|
+
"/namespaces/{namespace}/activities-deprecated/reset": {
|
|
4489
4826
|
"post": {
|
|
4490
|
-
"summary": "
|
|
4491
|
-
"
|
|
4827
|
+
"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.",
|
|
4828
|
+
"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.\nThis API will be deprecated soon and replaced with a newer ResetActivityExecution that is better named and\nstructured to work well for standalone activities.",
|
|
4829
|
+
"operationId": "ResetActivity",
|
|
4492
4830
|
"responses": {
|
|
4493
4831
|
"200": {
|
|
4494
4832
|
"description": "A successful response.",
|
|
4495
4833
|
"schema": {
|
|
4496
|
-
"$ref": "#/definitions/
|
|
4834
|
+
"$ref": "#/definitions/v1ResetActivityResponse"
|
|
4497
4835
|
}
|
|
4498
4836
|
},
|
|
4499
4837
|
"default": {
|
|
@@ -4506,7 +4844,7 @@
|
|
|
4506
4844
|
"parameters": [
|
|
4507
4845
|
{
|
|
4508
4846
|
"name": "namespace",
|
|
4509
|
-
"description": "Namespace of the workflow which scheduled this activity",
|
|
4847
|
+
"description": "Namespace of the workflow which scheduled this activity.",
|
|
4510
4848
|
"in": "path",
|
|
4511
4849
|
"required": true,
|
|
4512
4850
|
"type": "string"
|
|
@@ -4516,7 +4854,7 @@
|
|
|
4516
4854
|
"in": "body",
|
|
4517
4855
|
"required": true,
|
|
4518
4856
|
"schema": {
|
|
4519
|
-
"$ref": "#/definitions/
|
|
4857
|
+
"$ref": "#/definitions/WorkflowServiceResetActivityBody"
|
|
4520
4858
|
}
|
|
4521
4859
|
}
|
|
4522
4860
|
],
|
|
@@ -4525,16 +4863,16 @@
|
|
|
4525
4863
|
]
|
|
4526
4864
|
}
|
|
4527
4865
|
},
|
|
4528
|
-
"/namespaces/{namespace}/activities/
|
|
4866
|
+
"/namespaces/{namespace}/activities-deprecated/unpause": {
|
|
4529
4867
|
"post": {
|
|
4530
|
-
"summary": "
|
|
4531
|
-
"description": "
|
|
4532
|
-
"operationId": "
|
|
4868
|
+
"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.",
|
|
4869
|
+
"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\nThis API will be deprecated soon and replaced with a newer UnpauseActivityExecution that is better named and\nstructured to work well for standalone activities.",
|
|
4870
|
+
"operationId": "UnpauseActivity",
|
|
4533
4871
|
"responses": {
|
|
4534
4872
|
"200": {
|
|
4535
4873
|
"description": "A successful response.",
|
|
4536
4874
|
"schema": {
|
|
4537
|
-
"$ref": "#/definitions/
|
|
4875
|
+
"$ref": "#/definitions/v1UnpauseActivityResponse"
|
|
4538
4876
|
}
|
|
4539
4877
|
},
|
|
4540
4878
|
"default": {
|
|
@@ -4547,6 +4885,7 @@
|
|
|
4547
4885
|
"parameters": [
|
|
4548
4886
|
{
|
|
4549
4887
|
"name": "namespace",
|
|
4888
|
+
"description": "Namespace of the workflow which scheduled this activity.",
|
|
4550
4889
|
"in": "path",
|
|
4551
4890
|
"required": true,
|
|
4552
4891
|
"type": "string"
|
|
@@ -4556,7 +4895,7 @@
|
|
|
4556
4895
|
"in": "body",
|
|
4557
4896
|
"required": true,
|
|
4558
4897
|
"schema": {
|
|
4559
|
-
"$ref": "#/definitions/
|
|
4898
|
+
"$ref": "#/definitions/WorkflowServiceUnpauseActivityBody"
|
|
4560
4899
|
}
|
|
4561
4900
|
}
|
|
4562
4901
|
],
|
|
@@ -4565,15 +4904,15 @@
|
|
|
4565
4904
|
]
|
|
4566
4905
|
}
|
|
4567
4906
|
},
|
|
4568
|
-
"/namespaces/{namespace}/activities/
|
|
4907
|
+
"/namespaces/{namespace}/activities-deprecated/update-options": {
|
|
4569
4908
|
"post": {
|
|
4570
|
-
"summary": "
|
|
4571
|
-
"operationId": "
|
|
4909
|
+
"summary": "UpdateActivityOptions is called by the client to update the options of an activity by its ID or type.\nIf there are multiple pending activities of the provided type - all of them will be updated.\nThis API will be deprecated soon and replaced with a newer UpdateActivityExecutionOptions that is better named and\nstructured to work well for standalone activities.",
|
|
4910
|
+
"operationId": "UpdateActivityOptions",
|
|
4572
4911
|
"responses": {
|
|
4573
4912
|
"200": {
|
|
4574
4913
|
"description": "A successful response.",
|
|
4575
4914
|
"schema": {
|
|
4576
|
-
"$ref": "#/definitions/
|
|
4915
|
+
"$ref": "#/definitions/v1UpdateActivityOptionsResponse"
|
|
4577
4916
|
}
|
|
4578
4917
|
},
|
|
4579
4918
|
"default": {
|
|
@@ -4596,7 +4935,7 @@
|
|
|
4596
4935
|
"in": "body",
|
|
4597
4936
|
"required": true,
|
|
4598
4937
|
"schema": {
|
|
4599
|
-
"$ref": "#/definitions/
|
|
4938
|
+
"$ref": "#/definitions/WorkflowServiceUpdateActivityOptionsBody"
|
|
4600
4939
|
}
|
|
4601
4940
|
}
|
|
4602
4941
|
],
|
|
@@ -4605,16 +4944,15 @@
|
|
|
4605
4944
|
]
|
|
4606
4945
|
}
|
|
4607
4946
|
},
|
|
4608
|
-
"/namespaces/{namespace}/activities/
|
|
4609
|
-
"
|
|
4610
|
-
"summary": "
|
|
4611
|
-
"
|
|
4612
|
-
"operationId": "RespondActivityTaskFailed",
|
|
4947
|
+
"/namespaces/{namespace}/activities/{activityId}": {
|
|
4948
|
+
"get": {
|
|
4949
|
+
"summary": "DescribeActivityExecution returns information about an activity execution.\nIt can be used to:\n- Get current activity info without waiting\n- Long-poll for next state change and return new activity info\nResponse can optionally include activity input or outcome (if the activity has completed).",
|
|
4950
|
+
"operationId": "DescribeActivityExecution",
|
|
4613
4951
|
"responses": {
|
|
4614
4952
|
"200": {
|
|
4615
4953
|
"description": "A successful response.",
|
|
4616
4954
|
"schema": {
|
|
4617
|
-
"$ref": "#/definitions/
|
|
4955
|
+
"$ref": "#/definitions/v1DescribeActivityExecutionResponse"
|
|
4618
4956
|
}
|
|
4619
4957
|
},
|
|
4620
4958
|
"default": {
|
|
@@ -4632,69 +4970,54 @@
|
|
|
4632
4970
|
"type": "string"
|
|
4633
4971
|
},
|
|
4634
4972
|
{
|
|
4635
|
-
"name": "
|
|
4636
|
-
"in": "
|
|
4973
|
+
"name": "activityId",
|
|
4974
|
+
"in": "path",
|
|
4637
4975
|
"required": true,
|
|
4638
|
-
"
|
|
4639
|
-
"$ref": "#/definitions/WorkflowServiceRespondActivityTaskFailedBody"
|
|
4640
|
-
}
|
|
4641
|
-
}
|
|
4642
|
-
],
|
|
4643
|
-
"tags": [
|
|
4644
|
-
"WorkflowService"
|
|
4645
|
-
]
|
|
4646
|
-
}
|
|
4647
|
-
},
|
|
4648
|
-
"/namespaces/{namespace}/activities/fail-by-id": {
|
|
4649
|
-
"post": {
|
|
4650
|
-
"summary": "See `RecordActivityTaskFailed`. This version allows clients to record failures by\nnamespace/workflow id/activity id instead of task token.",
|
|
4651
|
-
"operationId": "RespondActivityTaskFailedById",
|
|
4652
|
-
"responses": {
|
|
4653
|
-
"200": {
|
|
4654
|
-
"description": "A successful response.",
|
|
4655
|
-
"schema": {
|
|
4656
|
-
"$ref": "#/definitions/v1RespondActivityTaskFailedByIdResponse"
|
|
4657
|
-
}
|
|
4976
|
+
"type": "string"
|
|
4658
4977
|
},
|
|
4659
|
-
"default": {
|
|
4660
|
-
"description": "An unexpected error response.",
|
|
4661
|
-
"schema": {
|
|
4662
|
-
"$ref": "#/definitions/rpcStatus"
|
|
4663
|
-
}
|
|
4664
|
-
}
|
|
4665
|
-
},
|
|
4666
|
-
"parameters": [
|
|
4667
4978
|
{
|
|
4668
|
-
"name": "
|
|
4669
|
-
"description": "
|
|
4670
|
-
"in": "
|
|
4671
|
-
"required":
|
|
4979
|
+
"name": "runId",
|
|
4980
|
+
"description": "Activity run ID. If empty the request targets the latest run.",
|
|
4981
|
+
"in": "query",
|
|
4982
|
+
"required": false,
|
|
4672
4983
|
"type": "string"
|
|
4673
4984
|
},
|
|
4674
4985
|
{
|
|
4675
|
-
"name": "
|
|
4676
|
-
"
|
|
4677
|
-
"
|
|
4678
|
-
"
|
|
4679
|
-
|
|
4680
|
-
|
|
4986
|
+
"name": "includeInput",
|
|
4987
|
+
"description": "Include the input field in the response.",
|
|
4988
|
+
"in": "query",
|
|
4989
|
+
"required": false,
|
|
4990
|
+
"type": "boolean"
|
|
4991
|
+
},
|
|
4992
|
+
{
|
|
4993
|
+
"name": "includeOutcome",
|
|
4994
|
+
"description": "Include the outcome (result/failure) in the response if the activity has completed.",
|
|
4995
|
+
"in": "query",
|
|
4996
|
+
"required": false,
|
|
4997
|
+
"type": "boolean"
|
|
4998
|
+
},
|
|
4999
|
+
{
|
|
5000
|
+
"name": "longPollToken",
|
|
5001
|
+
"description": "Token from a previous DescribeActivityExecutionResponse. If present, long-poll until activity\nstate changes from the state encoded in this token. If absent, return current state immediately.\nIf present, run_id must also be present.\nNote that activity state may change multiple times between requests, therefore it is not\nguaranteed that a client making a sequence of long-poll requests will see a complete\nsequence of state changes.",
|
|
5002
|
+
"in": "query",
|
|
5003
|
+
"required": false,
|
|
5004
|
+
"type": "string",
|
|
5005
|
+
"format": "byte"
|
|
4681
5006
|
}
|
|
4682
5007
|
],
|
|
4683
5008
|
"tags": [
|
|
4684
5009
|
"WorkflowService"
|
|
4685
5010
|
]
|
|
4686
|
-
}
|
|
4687
|
-
},
|
|
4688
|
-
"/namespaces/{namespace}/activities/heartbeat": {
|
|
5011
|
+
},
|
|
4689
5012
|
"post": {
|
|
4690
|
-
"summary": "
|
|
4691
|
-
"description": "
|
|
4692
|
-
"operationId": "
|
|
5013
|
+
"summary": "StartActivityExecution starts a new activity execution.",
|
|
5014
|
+
"description": "Returns an `ActivityExecutionAlreadyStarted` error if an instance already exists with same activity ID in this namespace\nunless permitted by the specified ID conflict policy.",
|
|
5015
|
+
"operationId": "StartActivityExecution",
|
|
4693
5016
|
"responses": {
|
|
4694
5017
|
"200": {
|
|
4695
5018
|
"description": "A successful response.",
|
|
4696
5019
|
"schema": {
|
|
4697
|
-
"$ref": "#/definitions/
|
|
5020
|
+
"$ref": "#/definitions/v1StartActivityExecutionResponse"
|
|
4698
5021
|
}
|
|
4699
5022
|
},
|
|
4700
5023
|
"default": {
|
|
@@ -4712,41 +5035,8 @@
|
|
|
4712
5035
|
"type": "string"
|
|
4713
5036
|
},
|
|
4714
5037
|
{
|
|
4715
|
-
"name": "
|
|
4716
|
-
"
|
|
4717
|
-
"required": true,
|
|
4718
|
-
"schema": {
|
|
4719
|
-
"$ref": "#/definitions/WorkflowServiceRecordActivityTaskHeartbeatBody"
|
|
4720
|
-
}
|
|
4721
|
-
}
|
|
4722
|
-
],
|
|
4723
|
-
"tags": [
|
|
4724
|
-
"WorkflowService"
|
|
4725
|
-
]
|
|
4726
|
-
}
|
|
4727
|
-
},
|
|
4728
|
-
"/namespaces/{namespace}/activities/heartbeat-by-id": {
|
|
4729
|
-
"post": {
|
|
4730
|
-
"summary": "See `RecordActivityTaskHeartbeat`. This version allows clients to record heartbeats by\nnamespace/workflow id/activity id instead of task token.",
|
|
4731
|
-
"operationId": "RecordActivityTaskHeartbeatById",
|
|
4732
|
-
"responses": {
|
|
4733
|
-
"200": {
|
|
4734
|
-
"description": "A successful response.",
|
|
4735
|
-
"schema": {
|
|
4736
|
-
"$ref": "#/definitions/v1RecordActivityTaskHeartbeatByIdResponse"
|
|
4737
|
-
}
|
|
4738
|
-
},
|
|
4739
|
-
"default": {
|
|
4740
|
-
"description": "An unexpected error response.",
|
|
4741
|
-
"schema": {
|
|
4742
|
-
"$ref": "#/definitions/rpcStatus"
|
|
4743
|
-
}
|
|
4744
|
-
}
|
|
4745
|
-
},
|
|
4746
|
-
"parameters": [
|
|
4747
|
-
{
|
|
4748
|
-
"name": "namespace",
|
|
4749
|
-
"description": "Namespace of the workflow which scheduled this activity",
|
|
5038
|
+
"name": "activityId",
|
|
5039
|
+
"description": "Identifier for this activity. Required. This identifier should be meaningful in the user's\nown system. It must be unique among activities in the same namespace, subject to the rules\nimposed by id_reuse_policy and id_conflict_policy.",
|
|
4750
5040
|
"in": "path",
|
|
4751
5041
|
"required": true,
|
|
4752
5042
|
"type": "string"
|
|
@@ -4756,7 +5046,7 @@
|
|
|
4756
5046
|
"in": "body",
|
|
4757
5047
|
"required": true,
|
|
4758
5048
|
"schema": {
|
|
4759
|
-
"$ref": "#/definitions/
|
|
5049
|
+
"$ref": "#/definitions/WorkflowServiceStartActivityExecutionBody"
|
|
4760
5050
|
}
|
|
4761
5051
|
}
|
|
4762
5052
|
],
|
|
@@ -4765,16 +5055,16 @@
|
|
|
4765
5055
|
]
|
|
4766
5056
|
}
|
|
4767
5057
|
},
|
|
4768
|
-
"/namespaces/{namespace}/activities/
|
|
5058
|
+
"/namespaces/{namespace}/activities/{activityId}/cancel": {
|
|
4769
5059
|
"post": {
|
|
4770
|
-
"summary": "
|
|
4771
|
-
"description": "
|
|
4772
|
-
"operationId": "
|
|
5060
|
+
"summary": "RequestCancelActivityExecution requests cancellation of an activity execution.",
|
|
5061
|
+
"description": "Cancellation is cooperative: this call records the request, but the activity must detect and\nacknowledge it for the activity to reach CANCELED status. The cancellation signal is\ndelivered via `cancel_requested` in the heartbeat response; SDKs surface this via\nlanguage-idiomatic mechanisms (context cancellation, exceptions, abort signals).",
|
|
5062
|
+
"operationId": "RequestCancelActivityExecution",
|
|
4773
5063
|
"responses": {
|
|
4774
5064
|
"200": {
|
|
4775
5065
|
"description": "A successful response.",
|
|
4776
5066
|
"schema": {
|
|
4777
|
-
"$ref": "#/definitions/
|
|
5067
|
+
"$ref": "#/definitions/v1RequestCancelActivityExecutionResponse"
|
|
4778
5068
|
}
|
|
4779
5069
|
},
|
|
4780
5070
|
"default": {
|
|
@@ -4787,7 +5077,12 @@
|
|
|
4787
5077
|
"parameters": [
|
|
4788
5078
|
{
|
|
4789
5079
|
"name": "namespace",
|
|
4790
|
-
"
|
|
5080
|
+
"in": "path",
|
|
5081
|
+
"required": true,
|
|
5082
|
+
"type": "string"
|
|
5083
|
+
},
|
|
5084
|
+
{
|
|
5085
|
+
"name": "activityId",
|
|
4791
5086
|
"in": "path",
|
|
4792
5087
|
"required": true,
|
|
4793
5088
|
"type": "string"
|
|
@@ -4797,7 +5092,7 @@
|
|
|
4797
5092
|
"in": "body",
|
|
4798
5093
|
"required": true,
|
|
4799
5094
|
"schema": {
|
|
4800
|
-
"$ref": "#/definitions/
|
|
5095
|
+
"$ref": "#/definitions/WorkflowServiceRequestCancelActivityExecutionBody"
|
|
4801
5096
|
}
|
|
4802
5097
|
}
|
|
4803
5098
|
],
|
|
@@ -4806,16 +5101,15 @@
|
|
|
4806
5101
|
]
|
|
4807
5102
|
}
|
|
4808
5103
|
},
|
|
4809
|
-
"/namespaces/{namespace}/activities/
|
|
5104
|
+
"/namespaces/{namespace}/activities/{activityId}/complete": {
|
|
4810
5105
|
"post": {
|
|
4811
|
-
"summary": "
|
|
4812
|
-
"
|
|
4813
|
-
"operationId": "ResetActivity",
|
|
5106
|
+
"summary": "See `RespondActivityTaskCompleted`. This version allows clients to record completions by\nnamespace/workflow id/activity id instead of task token.",
|
|
5107
|
+
"operationId": "RespondActivityTaskCompletedById",
|
|
4814
5108
|
"responses": {
|
|
4815
5109
|
"200": {
|
|
4816
5110
|
"description": "A successful response.",
|
|
4817
5111
|
"schema": {
|
|
4818
|
-
"$ref": "#/definitions/
|
|
5112
|
+
"$ref": "#/definitions/v1RespondActivityTaskCompletedByIdResponse"
|
|
4819
5113
|
}
|
|
4820
5114
|
},
|
|
4821
5115
|
"default": {
|
|
@@ -4827,8 +5121,15 @@
|
|
|
4827
5121
|
},
|
|
4828
5122
|
"parameters": [
|
|
4829
5123
|
{
|
|
4830
|
-
"name": "namespace",
|
|
4831
|
-
"description": "Namespace of the workflow which scheduled this activity
|
|
5124
|
+
"name": "namespace",
|
|
5125
|
+
"description": "Namespace of the workflow which scheduled this activity",
|
|
5126
|
+
"in": "path",
|
|
5127
|
+
"required": true,
|
|
5128
|
+
"type": "string"
|
|
5129
|
+
},
|
|
5130
|
+
{
|
|
5131
|
+
"name": "activityId",
|
|
5132
|
+
"description": "Id of the activity to complete",
|
|
4832
5133
|
"in": "path",
|
|
4833
5134
|
"required": true,
|
|
4834
5135
|
"type": "string"
|
|
@@ -4838,7 +5139,7 @@
|
|
|
4838
5139
|
"in": "body",
|
|
4839
5140
|
"required": true,
|
|
4840
5141
|
"schema": {
|
|
4841
|
-
"$ref": "#/definitions/
|
|
5142
|
+
"$ref": "#/definitions/WorkflowServiceRespondActivityTaskCompletedByIdBody"
|
|
4842
5143
|
}
|
|
4843
5144
|
}
|
|
4844
5145
|
],
|
|
@@ -4847,16 +5148,15 @@
|
|
|
4847
5148
|
]
|
|
4848
5149
|
}
|
|
4849
5150
|
},
|
|
4850
|
-
"/namespaces/{namespace}/activities/
|
|
5151
|
+
"/namespaces/{namespace}/activities/{activityId}/fail": {
|
|
4851
5152
|
"post": {
|
|
4852
|
-
"summary": "
|
|
4853
|
-
"
|
|
4854
|
-
"operationId": "UnpauseActivity",
|
|
5153
|
+
"summary": "See `RecordActivityTaskFailed`. This version allows clients to record failures by\nnamespace/workflow id/activity id instead of task token.",
|
|
5154
|
+
"operationId": "RespondActivityTaskFailedById",
|
|
4855
5155
|
"responses": {
|
|
4856
5156
|
"200": {
|
|
4857
5157
|
"description": "A successful response.",
|
|
4858
5158
|
"schema": {
|
|
4859
|
-
"$ref": "#/definitions/
|
|
5159
|
+
"$ref": "#/definitions/v1RespondActivityTaskFailedByIdResponse"
|
|
4860
5160
|
}
|
|
4861
5161
|
},
|
|
4862
5162
|
"default": {
|
|
@@ -4869,7 +5169,14 @@
|
|
|
4869
5169
|
"parameters": [
|
|
4870
5170
|
{
|
|
4871
5171
|
"name": "namespace",
|
|
4872
|
-
"description": "Namespace of the workflow which scheduled this activity
|
|
5172
|
+
"description": "Namespace of the workflow which scheduled this activity",
|
|
5173
|
+
"in": "path",
|
|
5174
|
+
"required": true,
|
|
5175
|
+
"type": "string"
|
|
5176
|
+
},
|
|
5177
|
+
{
|
|
5178
|
+
"name": "activityId",
|
|
5179
|
+
"description": "Id of the activity to fail",
|
|
4873
5180
|
"in": "path",
|
|
4874
5181
|
"required": true,
|
|
4875
5182
|
"type": "string"
|
|
@@ -4879,7 +5186,7 @@
|
|
|
4879
5186
|
"in": "body",
|
|
4880
5187
|
"required": true,
|
|
4881
5188
|
"schema": {
|
|
4882
|
-
"$ref": "#/definitions/
|
|
5189
|
+
"$ref": "#/definitions/WorkflowServiceRespondActivityTaskFailedByIdBody"
|
|
4883
5190
|
}
|
|
4884
5191
|
}
|
|
4885
5192
|
],
|
|
@@ -4888,15 +5195,15 @@
|
|
|
4888
5195
|
]
|
|
4889
5196
|
}
|
|
4890
5197
|
},
|
|
4891
|
-
"/namespaces/{namespace}/activities/
|
|
5198
|
+
"/namespaces/{namespace}/activities/{activityId}/heartbeat": {
|
|
4892
5199
|
"post": {
|
|
4893
|
-
"summary": "
|
|
4894
|
-
"operationId": "
|
|
5200
|
+
"summary": "See `RecordActivityTaskHeartbeat`. This version allows clients to record heartbeats by\nnamespace/workflow id/activity id instead of task token.",
|
|
5201
|
+
"operationId": "RecordActivityTaskHeartbeatById",
|
|
4895
5202
|
"responses": {
|
|
4896
5203
|
"200": {
|
|
4897
5204
|
"description": "A successful response.",
|
|
4898
5205
|
"schema": {
|
|
4899
|
-
"$ref": "#/definitions/
|
|
5206
|
+
"$ref": "#/definitions/v1RecordActivityTaskHeartbeatByIdResponse"
|
|
4900
5207
|
}
|
|
4901
5208
|
},
|
|
4902
5209
|
"default": {
|
|
@@ -4914,12 +5221,19 @@
|
|
|
4914
5221
|
"required": true,
|
|
4915
5222
|
"type": "string"
|
|
4916
5223
|
},
|
|
5224
|
+
{
|
|
5225
|
+
"name": "activityId",
|
|
5226
|
+
"description": "Id of the activity we're heartbeating",
|
|
5227
|
+
"in": "path",
|
|
5228
|
+
"required": true,
|
|
5229
|
+
"type": "string"
|
|
5230
|
+
},
|
|
4917
5231
|
{
|
|
4918
5232
|
"name": "body",
|
|
4919
5233
|
"in": "body",
|
|
4920
5234
|
"required": true,
|
|
4921
5235
|
"schema": {
|
|
4922
|
-
"$ref": "#/definitions/
|
|
5236
|
+
"$ref": "#/definitions/WorkflowServiceRecordActivityTaskHeartbeatByIdBody"
|
|
4923
5237
|
}
|
|
4924
5238
|
}
|
|
4925
5239
|
],
|
|
@@ -4928,15 +5242,15 @@
|
|
|
4928
5242
|
]
|
|
4929
5243
|
}
|
|
4930
5244
|
},
|
|
4931
|
-
"/namespaces/{namespace}/activities/{activityId}": {
|
|
5245
|
+
"/namespaces/{namespace}/activities/{activityId}/outcome": {
|
|
4932
5246
|
"get": {
|
|
4933
|
-
"summary": "
|
|
4934
|
-
"operationId": "
|
|
5247
|
+
"summary": "PollActivityExecution long-polls for an activity execution to complete and returns the\noutcome (result or failure).",
|
|
5248
|
+
"operationId": "PollActivityExecution",
|
|
4935
5249
|
"responses": {
|
|
4936
5250
|
"200": {
|
|
4937
5251
|
"description": "A successful response.",
|
|
4938
5252
|
"schema": {
|
|
4939
|
-
"$ref": "#/definitions/
|
|
5253
|
+
"$ref": "#/definitions/v1PollActivityExecutionResponse"
|
|
4940
5254
|
}
|
|
4941
5255
|
},
|
|
4942
5256
|
"default": {
|
|
@@ -4965,43 +5279,22 @@
|
|
|
4965
5279
|
"in": "query",
|
|
4966
5280
|
"required": false,
|
|
4967
5281
|
"type": "string"
|
|
4968
|
-
},
|
|
4969
|
-
{
|
|
4970
|
-
"name": "includeInput",
|
|
4971
|
-
"description": "Include the input field in the response.",
|
|
4972
|
-
"in": "query",
|
|
4973
|
-
"required": false,
|
|
4974
|
-
"type": "boolean"
|
|
4975
|
-
},
|
|
4976
|
-
{
|
|
4977
|
-
"name": "includeOutcome",
|
|
4978
|
-
"description": "Include the outcome (result/failure) in the response if the activity has completed.",
|
|
4979
|
-
"in": "query",
|
|
4980
|
-
"required": false,
|
|
4981
|
-
"type": "boolean"
|
|
4982
|
-
},
|
|
4983
|
-
{
|
|
4984
|
-
"name": "longPollToken",
|
|
4985
|
-
"description": "Token from a previous DescribeActivityExecutionResponse. If present, long-poll until activity\nstate changes from the state encoded in this token. If absent, return current state immediately.\nIf present, run_id must also be present.\nNote that activity state may change multiple times between requests, therefore it is not\nguaranteed that a client making a sequence of long-poll requests will see a complete\nsequence of state changes.",
|
|
4986
|
-
"in": "query",
|
|
4987
|
-
"required": false,
|
|
4988
|
-
"type": "string",
|
|
4989
|
-
"format": "byte"
|
|
4990
5282
|
}
|
|
4991
5283
|
],
|
|
4992
5284
|
"tags": [
|
|
4993
5285
|
"WorkflowService"
|
|
4994
5286
|
]
|
|
4995
|
-
}
|
|
5287
|
+
}
|
|
5288
|
+
},
|
|
5289
|
+
"/namespaces/{namespace}/activities/{activityId}/resolve-as-canceled": {
|
|
4996
5290
|
"post": {
|
|
4997
|
-
"summary": "
|
|
4998
|
-
"
|
|
4999
|
-
"operationId": "StartActivityExecution",
|
|
5291
|
+
"summary": "See `RespondActivityTaskCanceled`. This version allows clients to record failures by\nnamespace/workflow id/activity id instead of task token.",
|
|
5292
|
+
"operationId": "RespondActivityTaskCanceledById",
|
|
5000
5293
|
"responses": {
|
|
5001
5294
|
"200": {
|
|
5002
5295
|
"description": "A successful response.",
|
|
5003
5296
|
"schema": {
|
|
5004
|
-
"$ref": "#/definitions/
|
|
5297
|
+
"$ref": "#/definitions/v1RespondActivityTaskCanceledByIdResponse"
|
|
5005
5298
|
}
|
|
5006
5299
|
},
|
|
5007
5300
|
"default": {
|
|
@@ -5014,13 +5307,14 @@
|
|
|
5014
5307
|
"parameters": [
|
|
5015
5308
|
{
|
|
5016
5309
|
"name": "namespace",
|
|
5310
|
+
"description": "Namespace of the workflow which scheduled this activity",
|
|
5017
5311
|
"in": "path",
|
|
5018
5312
|
"required": true,
|
|
5019
5313
|
"type": "string"
|
|
5020
5314
|
},
|
|
5021
5315
|
{
|
|
5022
5316
|
"name": "activityId",
|
|
5023
|
-
"description": "
|
|
5317
|
+
"description": "Id of the activity to confirm is cancelled",
|
|
5024
5318
|
"in": "path",
|
|
5025
5319
|
"required": true,
|
|
5026
5320
|
"type": "string"
|
|
@@ -5030,7 +5324,7 @@
|
|
|
5030
5324
|
"in": "body",
|
|
5031
5325
|
"required": true,
|
|
5032
5326
|
"schema": {
|
|
5033
|
-
"$ref": "#/definitions/
|
|
5327
|
+
"$ref": "#/definitions/WorkflowServiceRespondActivityTaskCanceledByIdBody"
|
|
5034
5328
|
}
|
|
5035
5329
|
}
|
|
5036
5330
|
],
|
|
@@ -5039,16 +5333,16 @@
|
|
|
5039
5333
|
]
|
|
5040
5334
|
}
|
|
5041
5335
|
},
|
|
5042
|
-
"/namespaces/{namespace}/activities/{activityId}/
|
|
5336
|
+
"/namespaces/{namespace}/activities/{activityId}/terminate": {
|
|
5043
5337
|
"post": {
|
|
5044
|
-
"summary": "
|
|
5045
|
-
"description": "
|
|
5046
|
-
"operationId": "
|
|
5338
|
+
"summary": "TerminateActivityExecution terminates an existing activity execution immediately.",
|
|
5339
|
+
"description": "Termination does not reach the worker and the activity code cannot react to it. A terminated activity may have a\nrunning attempt.",
|
|
5340
|
+
"operationId": "TerminateActivityExecution",
|
|
5047
5341
|
"responses": {
|
|
5048
5342
|
"200": {
|
|
5049
5343
|
"description": "A successful response.",
|
|
5050
5344
|
"schema": {
|
|
5051
|
-
"$ref": "#/definitions/
|
|
5345
|
+
"$ref": "#/definitions/v1TerminateActivityExecutionResponse"
|
|
5052
5346
|
}
|
|
5053
5347
|
},
|
|
5054
5348
|
"default": {
|
|
@@ -5076,7 +5370,7 @@
|
|
|
5076
5370
|
"in": "body",
|
|
5077
5371
|
"required": true,
|
|
5078
5372
|
"schema": {
|
|
5079
|
-
"$ref": "#/definitions/
|
|
5373
|
+
"$ref": "#/definitions/WorkflowServiceTerminateActivityExecutionBody"
|
|
5080
5374
|
}
|
|
5081
5375
|
}
|
|
5082
5376
|
],
|
|
@@ -5085,15 +5379,16 @@
|
|
|
5085
5379
|
]
|
|
5086
5380
|
}
|
|
5087
5381
|
},
|
|
5088
|
-
"/namespaces/{namespace}/
|
|
5089
|
-
"
|
|
5090
|
-
"summary": "
|
|
5091
|
-
"
|
|
5382
|
+
"/namespaces/{namespace}/activity-complete": {
|
|
5383
|
+
"post": {
|
|
5384
|
+
"summary": "RespondActivityTaskCompleted is called by workers when they successfully complete an activity\ntask.",
|
|
5385
|
+
"description": "For workflow activities, this results in a new `ACTIVITY_TASK_COMPLETED` event being written to the workflow history\nand a new workflow task created for the workflow. Fails with `NotFound` if the task token is\nno longer valid due to activity timeout, already being completed, or never having existed.",
|
|
5386
|
+
"operationId": "RespondActivityTaskCompleted",
|
|
5092
5387
|
"responses": {
|
|
5093
5388
|
"200": {
|
|
5094
5389
|
"description": "A successful response.",
|
|
5095
5390
|
"schema": {
|
|
5096
|
-
"$ref": "#/definitions/
|
|
5391
|
+
"$ref": "#/definitions/v1RespondActivityTaskCompletedResponse"
|
|
5097
5392
|
}
|
|
5098
5393
|
},
|
|
5099
5394
|
"default": {
|
|
@@ -5111,14 +5406,47 @@
|
|
|
5111
5406
|
"type": "string"
|
|
5112
5407
|
},
|
|
5113
5408
|
{
|
|
5114
|
-
"name": "
|
|
5409
|
+
"name": "body",
|
|
5410
|
+
"in": "body",
|
|
5411
|
+
"required": true,
|
|
5412
|
+
"schema": {
|
|
5413
|
+
"$ref": "#/definitions/WorkflowServiceRespondActivityTaskCompletedBody"
|
|
5414
|
+
}
|
|
5415
|
+
}
|
|
5416
|
+
],
|
|
5417
|
+
"tags": [
|
|
5418
|
+
"WorkflowService"
|
|
5419
|
+
]
|
|
5420
|
+
}
|
|
5421
|
+
},
|
|
5422
|
+
"/namespaces/{namespace}/activity-count": {
|
|
5423
|
+
"get": {
|
|
5424
|
+
"summary": "CountActivityExecutions is a visibility API to count activity executions in a specific namespace.",
|
|
5425
|
+
"operationId": "CountActivityExecutions",
|
|
5426
|
+
"responses": {
|
|
5427
|
+
"200": {
|
|
5428
|
+
"description": "A successful response.",
|
|
5429
|
+
"schema": {
|
|
5430
|
+
"$ref": "#/definitions/v1CountActivityExecutionsResponse"
|
|
5431
|
+
}
|
|
5432
|
+
},
|
|
5433
|
+
"default": {
|
|
5434
|
+
"description": "An unexpected error response.",
|
|
5435
|
+
"schema": {
|
|
5436
|
+
"$ref": "#/definitions/rpcStatus"
|
|
5437
|
+
}
|
|
5438
|
+
}
|
|
5439
|
+
},
|
|
5440
|
+
"parameters": [
|
|
5441
|
+
{
|
|
5442
|
+
"name": "namespace",
|
|
5115
5443
|
"in": "path",
|
|
5116
5444
|
"required": true,
|
|
5117
5445
|
"type": "string"
|
|
5118
5446
|
},
|
|
5119
5447
|
{
|
|
5120
|
-
"name": "
|
|
5121
|
-
"description": "
|
|
5448
|
+
"name": "query",
|
|
5449
|
+
"description": "Visibility query, see https://docs.temporal.io/list-filter for the syntax.",
|
|
5122
5450
|
"in": "query",
|
|
5123
5451
|
"required": false,
|
|
5124
5452
|
"type": "string"
|
|
@@ -5129,16 +5457,16 @@
|
|
|
5129
5457
|
]
|
|
5130
5458
|
}
|
|
5131
5459
|
},
|
|
5132
|
-
"/namespaces/{namespace}/
|
|
5460
|
+
"/namespaces/{namespace}/activity-fail": {
|
|
5133
5461
|
"post": {
|
|
5134
|
-
"summary": "
|
|
5135
|
-
"description": "
|
|
5136
|
-
"operationId": "
|
|
5462
|
+
"summary": "RespondActivityTaskFailed is called by workers when processing an activity task fails.",
|
|
5463
|
+
"description": "This results in a new `ACTIVITY_TASK_FAILED` event being written to the workflow history and\na new workflow task created for the workflow. Fails with `NotFound` if the task token is no\nlonger valid due to activity timeout, already being completed, or never having existed.",
|
|
5464
|
+
"operationId": "RespondActivityTaskFailed",
|
|
5137
5465
|
"responses": {
|
|
5138
5466
|
"200": {
|
|
5139
5467
|
"description": "A successful response.",
|
|
5140
5468
|
"schema": {
|
|
5141
|
-
"$ref": "#/definitions/
|
|
5469
|
+
"$ref": "#/definitions/v1RespondActivityTaskFailedResponse"
|
|
5142
5470
|
}
|
|
5143
5471
|
},
|
|
5144
5472
|
"default": {
|
|
@@ -5156,7 +5484,41 @@
|
|
|
5156
5484
|
"type": "string"
|
|
5157
5485
|
},
|
|
5158
5486
|
{
|
|
5159
|
-
"name": "
|
|
5487
|
+
"name": "body",
|
|
5488
|
+
"in": "body",
|
|
5489
|
+
"required": true,
|
|
5490
|
+
"schema": {
|
|
5491
|
+
"$ref": "#/definitions/WorkflowServiceRespondActivityTaskFailedBody"
|
|
5492
|
+
}
|
|
5493
|
+
}
|
|
5494
|
+
],
|
|
5495
|
+
"tags": [
|
|
5496
|
+
"WorkflowService"
|
|
5497
|
+
]
|
|
5498
|
+
}
|
|
5499
|
+
},
|
|
5500
|
+
"/namespaces/{namespace}/activity-heartbeat": {
|
|
5501
|
+
"post": {
|
|
5502
|
+
"summary": "RecordActivityTaskHeartbeat is optionally called by workers while they execute activities.",
|
|
5503
|
+
"description": "If a worker fails to heartbeat within the `heartbeat_timeout` interval for the activity task,\nthen the current attempt times out. Depending on RetryPolicy, this may trigger a retry or\ntime out the activity.\n\nFor workflow activities, an `ACTIVITY_TASK_TIMED_OUT` event will be written to the workflow\nhistory. Calling `RecordActivityTaskHeartbeat` will fail with `NotFound` in such situations,\nin that event, the SDK should request cancellation of the activity.\n\nThe request may contain response `details` which will be persisted by the server and may be\nused by the activity to checkpoint progress. The `cancel_requested` field in the response\nindicates whether cancellation has been requested for the activity.",
|
|
5504
|
+
"operationId": "RecordActivityTaskHeartbeat",
|
|
5505
|
+
"responses": {
|
|
5506
|
+
"200": {
|
|
5507
|
+
"description": "A successful response.",
|
|
5508
|
+
"schema": {
|
|
5509
|
+
"$ref": "#/definitions/v1RecordActivityTaskHeartbeatResponse"
|
|
5510
|
+
}
|
|
5511
|
+
},
|
|
5512
|
+
"default": {
|
|
5513
|
+
"description": "An unexpected error response.",
|
|
5514
|
+
"schema": {
|
|
5515
|
+
"$ref": "#/definitions/rpcStatus"
|
|
5516
|
+
}
|
|
5517
|
+
}
|
|
5518
|
+
},
|
|
5519
|
+
"parameters": [
|
|
5520
|
+
{
|
|
5521
|
+
"name": "namespace",
|
|
5160
5522
|
"in": "path",
|
|
5161
5523
|
"required": true,
|
|
5162
5524
|
"type": "string"
|
|
@@ -5166,7 +5528,7 @@
|
|
|
5166
5528
|
"in": "body",
|
|
5167
5529
|
"required": true,
|
|
5168
5530
|
"schema": {
|
|
5169
|
-
"$ref": "#/definitions/
|
|
5531
|
+
"$ref": "#/definitions/WorkflowServiceRecordActivityTaskHeartbeatBody"
|
|
5170
5532
|
}
|
|
5171
5533
|
}
|
|
5172
5534
|
],
|
|
@@ -5175,15 +5537,16 @@
|
|
|
5175
5537
|
]
|
|
5176
5538
|
}
|
|
5177
5539
|
},
|
|
5178
|
-
"/namespaces/{namespace}/activity-
|
|
5179
|
-
"
|
|
5180
|
-
"summary": "
|
|
5181
|
-
"
|
|
5540
|
+
"/namespaces/{namespace}/activity-resolve-as-canceled": {
|
|
5541
|
+
"post": {
|
|
5542
|
+
"summary": "RespondActivityTaskFailed is called by workers when processing an activity task fails.",
|
|
5543
|
+
"description": "For workflow activities, this results in a new `ACTIVITY_TASK_CANCELED` event being written to the workflow history\nand a new workflow task created for the workflow. Fails with `NotFound` if the task token is\nno longer valid due to activity timeout, already being completed, or never having existed.",
|
|
5544
|
+
"operationId": "RespondActivityTaskCanceled",
|
|
5182
5545
|
"responses": {
|
|
5183
5546
|
"200": {
|
|
5184
5547
|
"description": "A successful response.",
|
|
5185
5548
|
"schema": {
|
|
5186
|
-
"$ref": "#/definitions/
|
|
5549
|
+
"$ref": "#/definitions/v1RespondActivityTaskCanceledResponse"
|
|
5187
5550
|
}
|
|
5188
5551
|
},
|
|
5189
5552
|
"default": {
|
|
@@ -5201,11 +5564,12 @@
|
|
|
5201
5564
|
"type": "string"
|
|
5202
5565
|
},
|
|
5203
5566
|
{
|
|
5204
|
-
"name": "
|
|
5205
|
-
"
|
|
5206
|
-
"
|
|
5207
|
-
"
|
|
5208
|
-
|
|
5567
|
+
"name": "body",
|
|
5568
|
+
"in": "body",
|
|
5569
|
+
"required": true,
|
|
5570
|
+
"schema": {
|
|
5571
|
+
"$ref": "#/definitions/WorkflowServiceRespondActivityTaskCanceledBody"
|
|
5572
|
+
}
|
|
5209
5573
|
}
|
|
5210
5574
|
],
|
|
5211
5575
|
"tags": [
|
|
@@ -5580,13 +5944,58 @@
|
|
|
5580
5944
|
},
|
|
5581
5945
|
"/namespaces/{namespace}/deployments/{deployment.seriesName}/{deployment.buildId}": {
|
|
5582
5946
|
"get": {
|
|
5583
|
-
"summary": "Describes a worker deployment.\nExperimental. This API might significantly change or be removed in a future release.\nDeprecated. Replaced with `DescribeWorkerDeploymentVersion`.",
|
|
5584
|
-
"operationId": "DescribeDeployment",
|
|
5947
|
+
"summary": "Describes a worker deployment.\nExperimental. This API might significantly change or be removed in a future release.\nDeprecated. Replaced with `DescribeWorkerDeploymentVersion`.",
|
|
5948
|
+
"operationId": "DescribeDeployment",
|
|
5949
|
+
"responses": {
|
|
5950
|
+
"200": {
|
|
5951
|
+
"description": "A successful response.",
|
|
5952
|
+
"schema": {
|
|
5953
|
+
"$ref": "#/definitions/v1DescribeDeploymentResponse"
|
|
5954
|
+
}
|
|
5955
|
+
},
|
|
5956
|
+
"default": {
|
|
5957
|
+
"description": "An unexpected error response.",
|
|
5958
|
+
"schema": {
|
|
5959
|
+
"$ref": "#/definitions/rpcStatus"
|
|
5960
|
+
}
|
|
5961
|
+
}
|
|
5962
|
+
},
|
|
5963
|
+
"parameters": [
|
|
5964
|
+
{
|
|
5965
|
+
"name": "namespace",
|
|
5966
|
+
"in": "path",
|
|
5967
|
+
"required": true,
|
|
5968
|
+
"type": "string"
|
|
5969
|
+
},
|
|
5970
|
+
{
|
|
5971
|
+
"name": "deployment.seriesName",
|
|
5972
|
+
"description": "Different versions of the same worker service/application are related together by having a\nshared series name.\nOut of all deployments of a series, one can be designated as the current deployment, which\nreceives new workflow executions and new tasks of workflows with\n`VERSIONING_BEHAVIOR_AUTO_UPGRADE` versioning behavior.",
|
|
5973
|
+
"in": "path",
|
|
5974
|
+
"required": true,
|
|
5975
|
+
"type": "string"
|
|
5976
|
+
},
|
|
5977
|
+
{
|
|
5978
|
+
"name": "deployment.buildId",
|
|
5979
|
+
"description": "Build ID changes with each version of the worker when the worker program code and/or config\nchanges.",
|
|
5980
|
+
"in": "path",
|
|
5981
|
+
"required": true,
|
|
5982
|
+
"type": "string"
|
|
5983
|
+
}
|
|
5984
|
+
],
|
|
5985
|
+
"tags": [
|
|
5986
|
+
"WorkflowService"
|
|
5987
|
+
]
|
|
5988
|
+
}
|
|
5989
|
+
},
|
|
5990
|
+
"/namespaces/{namespace}/deployments/{deployment.seriesName}/{deployment.buildId}/reachability": {
|
|
5991
|
+
"get": {
|
|
5992
|
+
"summary": "Returns the reachability level of a worker deployment to help users decide when it is time\nto decommission a deployment. Reachability level is calculated based on the deployment's\n`status` and existing workflows that depend on the given deployment for their execution.\nCalculating reachability is relatively expensive. Therefore, server might return a recently\ncached value. In such a case, the `last_update_time` will inform you about the actual\nreachability calculation time.\nExperimental. This API might significantly change or be removed in a future release.\nDeprecated. Replaced with `DrainageInfo` returned by `DescribeWorkerDeploymentVersion`.",
|
|
5993
|
+
"operationId": "GetDeploymentReachability",
|
|
5585
5994
|
"responses": {
|
|
5586
5995
|
"200": {
|
|
5587
5996
|
"description": "A successful response.",
|
|
5588
5997
|
"schema": {
|
|
5589
|
-
"$ref": "#/definitions/
|
|
5998
|
+
"$ref": "#/definitions/v1GetDeploymentReachabilityResponse"
|
|
5590
5999
|
}
|
|
5591
6000
|
},
|
|
5592
6001
|
"default": {
|
|
@@ -5623,15 +6032,15 @@
|
|
|
5623
6032
|
]
|
|
5624
6033
|
}
|
|
5625
6034
|
},
|
|
5626
|
-
"/namespaces/{namespace}/
|
|
6035
|
+
"/namespaces/{namespace}/schedule-count": {
|
|
5627
6036
|
"get": {
|
|
5628
|
-
"summary": "
|
|
5629
|
-
"operationId": "
|
|
6037
|
+
"summary": "CountSchedules is a visibility API to count schedules in a specific namespace.",
|
|
6038
|
+
"operationId": "CountSchedules",
|
|
5630
6039
|
"responses": {
|
|
5631
6040
|
"200": {
|
|
5632
6041
|
"description": "A successful response.",
|
|
5633
6042
|
"schema": {
|
|
5634
|
-
"$ref": "#/definitions/
|
|
6043
|
+
"$ref": "#/definitions/v1CountSchedulesResponse"
|
|
5635
6044
|
}
|
|
5636
6045
|
},
|
|
5637
6046
|
"default": {
|
|
@@ -5649,17 +6058,10 @@
|
|
|
5649
6058
|
"type": "string"
|
|
5650
6059
|
},
|
|
5651
6060
|
{
|
|
5652
|
-
"name": "
|
|
5653
|
-
"description": "
|
|
5654
|
-
"in": "
|
|
5655
|
-
"required":
|
|
5656
|
-
"type": "string"
|
|
5657
|
-
},
|
|
5658
|
-
{
|
|
5659
|
-
"name": "deployment.buildId",
|
|
5660
|
-
"description": "Build ID changes with each version of the worker when the worker program code and/or config\nchanges.",
|
|
5661
|
-
"in": "path",
|
|
5662
|
-
"required": true,
|
|
6061
|
+
"name": "query",
|
|
6062
|
+
"description": "Visibility query, see https://docs.temporal.io/list-filter for the syntax.",
|
|
6063
|
+
"in": "query",
|
|
6064
|
+
"required": false,
|
|
5663
6065
|
"type": "string"
|
|
5664
6066
|
}
|
|
5665
6067
|
],
|
|
@@ -7240,46 +7642,6 @@
|
|
|
7240
7642
|
]
|
|
7241
7643
|
}
|
|
7242
7644
|
},
|
|
7243
|
-
"/namespaces/{namespace}/workflows/execute-multi-operation": {
|
|
7244
|
-
"post": {
|
|
7245
|
-
"summary": "ExecuteMultiOperation executes multiple operations within a single workflow.",
|
|
7246
|
-
"description": "Operations are started atomically, meaning if *any* operation fails to be started, none are,\nand the request fails. Upon start, the API returns only when *all* operations have a response.\n\nUpon failure, it returns `MultiOperationExecutionFailure` where the status code\nequals the status code of the *first* operation that failed to be started.\n\nNOTE: Experimental API.",
|
|
7247
|
-
"operationId": "ExecuteMultiOperation",
|
|
7248
|
-
"responses": {
|
|
7249
|
-
"200": {
|
|
7250
|
-
"description": "A successful response.",
|
|
7251
|
-
"schema": {
|
|
7252
|
-
"$ref": "#/definitions/v1ExecuteMultiOperationResponse"
|
|
7253
|
-
}
|
|
7254
|
-
},
|
|
7255
|
-
"default": {
|
|
7256
|
-
"description": "An unexpected error response.",
|
|
7257
|
-
"schema": {
|
|
7258
|
-
"$ref": "#/definitions/rpcStatus"
|
|
7259
|
-
}
|
|
7260
|
-
}
|
|
7261
|
-
},
|
|
7262
|
-
"parameters": [
|
|
7263
|
-
{
|
|
7264
|
-
"name": "namespace",
|
|
7265
|
-
"in": "path",
|
|
7266
|
-
"required": true,
|
|
7267
|
-
"type": "string"
|
|
7268
|
-
},
|
|
7269
|
-
{
|
|
7270
|
-
"name": "body",
|
|
7271
|
-
"in": "body",
|
|
7272
|
-
"required": true,
|
|
7273
|
-
"schema": {
|
|
7274
|
-
"$ref": "#/definitions/WorkflowServiceExecuteMultiOperationBody"
|
|
7275
|
-
}
|
|
7276
|
-
}
|
|
7277
|
-
],
|
|
7278
|
-
"tags": [
|
|
7279
|
-
"WorkflowService"
|
|
7280
|
-
]
|
|
7281
|
-
}
|
|
7282
|
-
},
|
|
7283
7645
|
"/namespaces/{namespace}/workflows/{execution.workflowId}": {
|
|
7284
7646
|
"get": {
|
|
7285
7647
|
"summary": "DescribeWorkflowExecution returns information about the specified workflow execution.",
|
|
@@ -7817,20 +8179,228 @@
|
|
|
7817
8179
|
"parameters": [
|
|
7818
8180
|
{
|
|
7819
8181
|
"name": "namespace",
|
|
7820
|
-
"description": "The namespace name of the target Workflow.",
|
|
8182
|
+
"description": "The namespace name of the target Workflow.",
|
|
8183
|
+
"in": "path",
|
|
8184
|
+
"required": true,
|
|
8185
|
+
"type": "string"
|
|
8186
|
+
},
|
|
8187
|
+
{
|
|
8188
|
+
"name": "workflowExecution.workflowId",
|
|
8189
|
+
"in": "path",
|
|
8190
|
+
"required": true,
|
|
8191
|
+
"type": "string"
|
|
8192
|
+
},
|
|
8193
|
+
{
|
|
8194
|
+
"name": "request.input.name",
|
|
8195
|
+
"description": "The name of the Update handler to invoke on the target Workflow.",
|
|
8196
|
+
"in": "path",
|
|
8197
|
+
"required": true,
|
|
8198
|
+
"type": "string"
|
|
8199
|
+
},
|
|
8200
|
+
{
|
|
8201
|
+
"name": "body",
|
|
8202
|
+
"in": "body",
|
|
8203
|
+
"required": true,
|
|
8204
|
+
"schema": {
|
|
8205
|
+
"$ref": "#/definitions/WorkflowServiceUpdateWorkflowExecutionBody"
|
|
8206
|
+
}
|
|
8207
|
+
}
|
|
8208
|
+
],
|
|
8209
|
+
"tags": [
|
|
8210
|
+
"WorkflowService"
|
|
8211
|
+
]
|
|
8212
|
+
}
|
|
8213
|
+
},
|
|
8214
|
+
"/namespaces/{namespace}/workflows/{workflowId}": {
|
|
8215
|
+
"post": {
|
|
8216
|
+
"summary": "StartWorkflowExecution starts a new workflow execution.",
|
|
8217
|
+
"description": "It will create the execution with a `WORKFLOW_EXECUTION_STARTED` event in its history and\nalso schedule the first workflow task. Returns `WorkflowExecutionAlreadyStarted`, if an\ninstance already exists with same workflow id.",
|
|
8218
|
+
"operationId": "StartWorkflowExecution",
|
|
8219
|
+
"responses": {
|
|
8220
|
+
"200": {
|
|
8221
|
+
"description": "A successful response.",
|
|
8222
|
+
"schema": {
|
|
8223
|
+
"$ref": "#/definitions/v1StartWorkflowExecutionResponse"
|
|
8224
|
+
}
|
|
8225
|
+
},
|
|
8226
|
+
"default": {
|
|
8227
|
+
"description": "An unexpected error response.",
|
|
8228
|
+
"schema": {
|
|
8229
|
+
"$ref": "#/definitions/rpcStatus"
|
|
8230
|
+
}
|
|
8231
|
+
}
|
|
8232
|
+
},
|
|
8233
|
+
"parameters": [
|
|
8234
|
+
{
|
|
8235
|
+
"name": "namespace",
|
|
8236
|
+
"in": "path",
|
|
8237
|
+
"required": true,
|
|
8238
|
+
"type": "string"
|
|
8239
|
+
},
|
|
8240
|
+
{
|
|
8241
|
+
"name": "workflowId",
|
|
8242
|
+
"in": "path",
|
|
8243
|
+
"required": true,
|
|
8244
|
+
"type": "string"
|
|
8245
|
+
},
|
|
8246
|
+
{
|
|
8247
|
+
"name": "body",
|
|
8248
|
+
"in": "body",
|
|
8249
|
+
"required": true,
|
|
8250
|
+
"schema": {
|
|
8251
|
+
"$ref": "#/definitions/WorkflowServiceStartWorkflowExecutionBody"
|
|
8252
|
+
}
|
|
8253
|
+
}
|
|
8254
|
+
],
|
|
8255
|
+
"tags": [
|
|
8256
|
+
"WorkflowService"
|
|
8257
|
+
]
|
|
8258
|
+
}
|
|
8259
|
+
},
|
|
8260
|
+
"/namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}/complete": {
|
|
8261
|
+
"post": {
|
|
8262
|
+
"summary": "See `RespondActivityTaskCompleted`. This version allows clients to record completions by\nnamespace/workflow id/activity id instead of task token.",
|
|
8263
|
+
"operationId": "RespondActivityTaskCompletedById3",
|
|
8264
|
+
"responses": {
|
|
8265
|
+
"200": {
|
|
8266
|
+
"description": "A successful response.",
|
|
8267
|
+
"schema": {
|
|
8268
|
+
"$ref": "#/definitions/v1RespondActivityTaskCompletedByIdResponse"
|
|
8269
|
+
}
|
|
8270
|
+
},
|
|
8271
|
+
"default": {
|
|
8272
|
+
"description": "An unexpected error response.",
|
|
8273
|
+
"schema": {
|
|
8274
|
+
"$ref": "#/definitions/rpcStatus"
|
|
8275
|
+
}
|
|
8276
|
+
}
|
|
8277
|
+
},
|
|
8278
|
+
"parameters": [
|
|
8279
|
+
{
|
|
8280
|
+
"name": "namespace",
|
|
8281
|
+
"description": "Namespace of the workflow which scheduled this activity",
|
|
8282
|
+
"in": "path",
|
|
8283
|
+
"required": true,
|
|
8284
|
+
"type": "string"
|
|
8285
|
+
},
|
|
8286
|
+
{
|
|
8287
|
+
"name": "workflowId",
|
|
8288
|
+
"description": "Id of the workflow which scheduled this activity, leave empty to target a standalone activity",
|
|
8289
|
+
"in": "path",
|
|
8290
|
+
"required": true,
|
|
8291
|
+
"type": "string"
|
|
8292
|
+
},
|
|
8293
|
+
{
|
|
8294
|
+
"name": "activityId",
|
|
8295
|
+
"description": "Id of the activity to complete",
|
|
8296
|
+
"in": "path",
|
|
8297
|
+
"required": true,
|
|
8298
|
+
"type": "string"
|
|
8299
|
+
},
|
|
8300
|
+
{
|
|
8301
|
+
"name": "body",
|
|
8302
|
+
"in": "body",
|
|
8303
|
+
"required": true,
|
|
8304
|
+
"schema": {
|
|
8305
|
+
"$ref": "#/definitions/WorkflowServiceRespondActivityTaskCompletedByIdBody"
|
|
8306
|
+
}
|
|
8307
|
+
}
|
|
8308
|
+
],
|
|
8309
|
+
"tags": [
|
|
8310
|
+
"WorkflowService"
|
|
8311
|
+
]
|
|
8312
|
+
}
|
|
8313
|
+
},
|
|
8314
|
+
"/namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}/fail": {
|
|
8315
|
+
"post": {
|
|
8316
|
+
"summary": "See `RecordActivityTaskFailed`. This version allows clients to record failures by\nnamespace/workflow id/activity id instead of task token.",
|
|
8317
|
+
"operationId": "RespondActivityTaskFailedById3",
|
|
8318
|
+
"responses": {
|
|
8319
|
+
"200": {
|
|
8320
|
+
"description": "A successful response.",
|
|
8321
|
+
"schema": {
|
|
8322
|
+
"$ref": "#/definitions/v1RespondActivityTaskFailedByIdResponse"
|
|
8323
|
+
}
|
|
8324
|
+
},
|
|
8325
|
+
"default": {
|
|
8326
|
+
"description": "An unexpected error response.",
|
|
8327
|
+
"schema": {
|
|
8328
|
+
"$ref": "#/definitions/rpcStatus"
|
|
8329
|
+
}
|
|
8330
|
+
}
|
|
8331
|
+
},
|
|
8332
|
+
"parameters": [
|
|
8333
|
+
{
|
|
8334
|
+
"name": "namespace",
|
|
8335
|
+
"description": "Namespace of the workflow which scheduled this activity",
|
|
8336
|
+
"in": "path",
|
|
8337
|
+
"required": true,
|
|
8338
|
+
"type": "string"
|
|
8339
|
+
},
|
|
8340
|
+
{
|
|
8341
|
+
"name": "workflowId",
|
|
8342
|
+
"description": "Id of the workflow which scheduled this activity, leave empty to target a standalone activity",
|
|
8343
|
+
"in": "path",
|
|
8344
|
+
"required": true,
|
|
8345
|
+
"type": "string"
|
|
8346
|
+
},
|
|
8347
|
+
{
|
|
8348
|
+
"name": "activityId",
|
|
8349
|
+
"description": "Id of the activity to fail",
|
|
8350
|
+
"in": "path",
|
|
8351
|
+
"required": true,
|
|
8352
|
+
"type": "string"
|
|
8353
|
+
},
|
|
8354
|
+
{
|
|
8355
|
+
"name": "body",
|
|
8356
|
+
"in": "body",
|
|
8357
|
+
"required": true,
|
|
8358
|
+
"schema": {
|
|
8359
|
+
"$ref": "#/definitions/WorkflowServiceRespondActivityTaskFailedByIdBody"
|
|
8360
|
+
}
|
|
8361
|
+
}
|
|
8362
|
+
],
|
|
8363
|
+
"tags": [
|
|
8364
|
+
"WorkflowService"
|
|
8365
|
+
]
|
|
8366
|
+
}
|
|
8367
|
+
},
|
|
8368
|
+
"/namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}/heartbeat": {
|
|
8369
|
+
"post": {
|
|
8370
|
+
"summary": "See `RecordActivityTaskHeartbeat`. This version allows clients to record heartbeats by\nnamespace/workflow id/activity id instead of task token.",
|
|
8371
|
+
"operationId": "RecordActivityTaskHeartbeatById3",
|
|
8372
|
+
"responses": {
|
|
8373
|
+
"200": {
|
|
8374
|
+
"description": "A successful response.",
|
|
8375
|
+
"schema": {
|
|
8376
|
+
"$ref": "#/definitions/v1RecordActivityTaskHeartbeatByIdResponse"
|
|
8377
|
+
}
|
|
8378
|
+
},
|
|
8379
|
+
"default": {
|
|
8380
|
+
"description": "An unexpected error response.",
|
|
8381
|
+
"schema": {
|
|
8382
|
+
"$ref": "#/definitions/rpcStatus"
|
|
8383
|
+
}
|
|
8384
|
+
}
|
|
8385
|
+
},
|
|
8386
|
+
"parameters": [
|
|
8387
|
+
{
|
|
8388
|
+
"name": "namespace",
|
|
8389
|
+
"description": "Namespace of the workflow which scheduled this activity",
|
|
7821
8390
|
"in": "path",
|
|
7822
8391
|
"required": true,
|
|
7823
8392
|
"type": "string"
|
|
7824
8393
|
},
|
|
7825
8394
|
{
|
|
7826
|
-
"name": "
|
|
8395
|
+
"name": "workflowId",
|
|
8396
|
+
"description": "Id of the workflow which scheduled this activity, leave empty to target a standalone activity",
|
|
7827
8397
|
"in": "path",
|
|
7828
8398
|
"required": true,
|
|
7829
8399
|
"type": "string"
|
|
7830
8400
|
},
|
|
7831
8401
|
{
|
|
7832
|
-
"name": "
|
|
7833
|
-
"description": "
|
|
8402
|
+
"name": "activityId",
|
|
8403
|
+
"description": "Id of the activity we're heartbeating",
|
|
7834
8404
|
"in": "path",
|
|
7835
8405
|
"required": true,
|
|
7836
8406
|
"type": "string"
|
|
@@ -7840,7 +8410,7 @@
|
|
|
7840
8410
|
"in": "body",
|
|
7841
8411
|
"required": true,
|
|
7842
8412
|
"schema": {
|
|
7843
|
-
"$ref": "#/definitions/
|
|
8413
|
+
"$ref": "#/definitions/WorkflowServiceRecordActivityTaskHeartbeatByIdBody"
|
|
7844
8414
|
}
|
|
7845
8415
|
}
|
|
7846
8416
|
],
|
|
@@ -7849,16 +8419,15 @@
|
|
|
7849
8419
|
]
|
|
7850
8420
|
}
|
|
7851
8421
|
},
|
|
7852
|
-
"/namespaces/{namespace}/workflows/{workflowId}": {
|
|
8422
|
+
"/namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}/resolve-as-canceled": {
|
|
7853
8423
|
"post": {
|
|
7854
|
-
"summary": "
|
|
7855
|
-
"
|
|
7856
|
-
"operationId": "StartWorkflowExecution",
|
|
8424
|
+
"summary": "See `RespondActivityTaskCanceled`. This version allows clients to record failures by\nnamespace/workflow id/activity id instead of task token.",
|
|
8425
|
+
"operationId": "RespondActivityTaskCanceledById3",
|
|
7857
8426
|
"responses": {
|
|
7858
8427
|
"200": {
|
|
7859
8428
|
"description": "A successful response.",
|
|
7860
8429
|
"schema": {
|
|
7861
|
-
"$ref": "#/definitions/
|
|
8430
|
+
"$ref": "#/definitions/v1RespondActivityTaskCanceledByIdResponse"
|
|
7862
8431
|
}
|
|
7863
8432
|
},
|
|
7864
8433
|
"default": {
|
|
@@ -7871,12 +8440,21 @@
|
|
|
7871
8440
|
"parameters": [
|
|
7872
8441
|
{
|
|
7873
8442
|
"name": "namespace",
|
|
8443
|
+
"description": "Namespace of the workflow which scheduled this activity",
|
|
7874
8444
|
"in": "path",
|
|
7875
8445
|
"required": true,
|
|
7876
8446
|
"type": "string"
|
|
7877
8447
|
},
|
|
7878
8448
|
{
|
|
7879
8449
|
"name": "workflowId",
|
|
8450
|
+
"description": "Id of the workflow which scheduled this activity, leave empty to target a standalone activity",
|
|
8451
|
+
"in": "path",
|
|
8452
|
+
"required": true,
|
|
8453
|
+
"type": "string"
|
|
8454
|
+
},
|
|
8455
|
+
{
|
|
8456
|
+
"name": "activityId",
|
|
8457
|
+
"description": "Id of the activity to confirm is cancelled",
|
|
7880
8458
|
"in": "path",
|
|
7881
8459
|
"required": true,
|
|
7882
8460
|
"type": "string"
|
|
@@ -7886,7 +8464,7 @@
|
|
|
7886
8464
|
"in": "body",
|
|
7887
8465
|
"required": true,
|
|
7888
8466
|
"schema": {
|
|
7889
|
-
"$ref": "#/definitions/
|
|
8467
|
+
"$ref": "#/definitions/WorkflowServiceRespondActivityTaskCanceledByIdBody"
|
|
7890
8468
|
}
|
|
7891
8469
|
}
|
|
7892
8470
|
],
|
|
@@ -8182,30 +8760,6 @@
|
|
|
8182
8760
|
},
|
|
8183
8761
|
"description": "Target a worker polling on a Nexus task queue in a specific namespace."
|
|
8184
8762
|
},
|
|
8185
|
-
"ExecuteMultiOperationRequestOperation": {
|
|
8186
|
-
"type": "object",
|
|
8187
|
-
"properties": {
|
|
8188
|
-
"startWorkflow": {
|
|
8189
|
-
"$ref": "#/definitions/v1StartWorkflowExecutionRequest",
|
|
8190
|
-
"title": "Additional restrictions:\n- setting `cron_schedule` is invalid\n- setting `request_eager_execution` is invalid\n- setting `workflow_start_delay` is invalid"
|
|
8191
|
-
},
|
|
8192
|
-
"updateWorkflow": {
|
|
8193
|
-
"$ref": "#/definitions/v1UpdateWorkflowExecutionRequest",
|
|
8194
|
-
"title": "Additional restrictions:\n- setting `first_execution_run_id` is invalid\n- setting `workflow_execution.run_id` is invalid"
|
|
8195
|
-
}
|
|
8196
|
-
}
|
|
8197
|
-
},
|
|
8198
|
-
"ExecuteMultiOperationResponseResponse": {
|
|
8199
|
-
"type": "object",
|
|
8200
|
-
"properties": {
|
|
8201
|
-
"startWorkflow": {
|
|
8202
|
-
"$ref": "#/definitions/v1StartWorkflowExecutionResponse"
|
|
8203
|
-
},
|
|
8204
|
-
"updateWorkflow": {
|
|
8205
|
-
"$ref": "#/definitions/v1UpdateWorkflowExecutionResponse"
|
|
8206
|
-
}
|
|
8207
|
-
}
|
|
8208
|
-
},
|
|
8209
8763
|
"LinkBatchJob": {
|
|
8210
8764
|
"type": "object",
|
|
8211
8765
|
"properties": {
|
|
@@ -8615,19 +9169,6 @@
|
|
|
8615
9169
|
}
|
|
8616
9170
|
}
|
|
8617
9171
|
},
|
|
8618
|
-
"WorkflowServiceExecuteMultiOperationBody": {
|
|
8619
|
-
"type": "object",
|
|
8620
|
-
"properties": {
|
|
8621
|
-
"operations": {
|
|
8622
|
-
"type": "array",
|
|
8623
|
-
"items": {
|
|
8624
|
-
"type": "object",
|
|
8625
|
-
"$ref": "#/definitions/ExecuteMultiOperationRequestOperation"
|
|
8626
|
-
},
|
|
8627
|
-
"description": "List of operations to execute within a single workflow.\n\nPreconditions:\n- The list of operations must not be empty.\n- The workflow ids must match across operations.\n- The only valid list of operations at this time is [StartWorkflow, UpdateWorkflow], in this order.\n\nNote that additional operation-specific restrictions have to be considered."
|
|
8628
|
-
}
|
|
8629
|
-
}
|
|
8630
|
-
},
|
|
8631
9172
|
"WorkflowServiceFetchWorkerConfigBody": {
|
|
8632
9173
|
"type": "object",
|
|
8633
9174
|
"properties": {
|
|
@@ -8761,18 +9302,10 @@
|
|
|
8761
9302
|
"WorkflowServiceRecordActivityTaskHeartbeatByIdBody": {
|
|
8762
9303
|
"type": "object",
|
|
8763
9304
|
"properties": {
|
|
8764
|
-
"workflowId": {
|
|
8765
|
-
"type": "string",
|
|
8766
|
-
"title": "Id of the workflow which scheduled this activity, leave empty to target a standalone activity"
|
|
8767
|
-
},
|
|
8768
9305
|
"runId": {
|
|
8769
9306
|
"type": "string",
|
|
8770
9307
|
"description": "For a workflow activity - the run ID of the workflow which scheduled this activity.\nFor a standalone activity - the run ID of the activity."
|
|
8771
9308
|
},
|
|
8772
|
-
"activityId": {
|
|
8773
|
-
"type": "string",
|
|
8774
|
-
"title": "Id of the activity we're heartbeating"
|
|
8775
|
-
},
|
|
8776
9309
|
"details": {
|
|
8777
9310
|
"$ref": "#/definitions/v1Payloads",
|
|
8778
9311
|
"title": "Arbitrary data, of which the most recent call is kept, to store for this activity"
|
|
@@ -8982,18 +9515,10 @@
|
|
|
8982
9515
|
"WorkflowServiceRespondActivityTaskCanceledByIdBody": {
|
|
8983
9516
|
"type": "object",
|
|
8984
9517
|
"properties": {
|
|
8985
|
-
"workflowId": {
|
|
8986
|
-
"type": "string",
|
|
8987
|
-
"title": "Id of the workflow which scheduled this activity, leave empty to target a standalone activity"
|
|
8988
|
-
},
|
|
8989
9518
|
"runId": {
|
|
8990
9519
|
"type": "string",
|
|
8991
9520
|
"description": "For a workflow activity - the run ID of the workflow which scheduled this activity.\nFor a standalone activity - the run ID of the activity."
|
|
8992
9521
|
},
|
|
8993
|
-
"activityId": {
|
|
8994
|
-
"type": "string",
|
|
8995
|
-
"title": "Id of the activity to confirm is cancelled"
|
|
8996
|
-
},
|
|
8997
9522
|
"details": {
|
|
8998
9523
|
"$ref": "#/definitions/v1Payloads",
|
|
8999
9524
|
"title": "Serialized additional information to attach to the cancellation"
|
|
@@ -9041,18 +9566,10 @@
|
|
|
9041
9566
|
"WorkflowServiceRespondActivityTaskCompletedByIdBody": {
|
|
9042
9567
|
"type": "object",
|
|
9043
9568
|
"properties": {
|
|
9044
|
-
"workflowId": {
|
|
9045
|
-
"type": "string",
|
|
9046
|
-
"title": "Id of the workflow which scheduled this activity, leave empty to target a standalone activity"
|
|
9047
|
-
},
|
|
9048
9569
|
"runId": {
|
|
9049
9570
|
"type": "string",
|
|
9050
9571
|
"description": "For a workflow activity - the run ID of the workflow which scheduled this activity.\nFor a standalone activity - the run ID of the activity."
|
|
9051
9572
|
},
|
|
9052
|
-
"activityId": {
|
|
9053
|
-
"type": "string",
|
|
9054
|
-
"title": "Id of the activity to complete"
|
|
9055
|
-
},
|
|
9056
9573
|
"result": {
|
|
9057
9574
|
"$ref": "#/definitions/v1Payloads",
|
|
9058
9575
|
"title": "The serialized result of activity execution"
|
|
@@ -9100,18 +9617,10 @@
|
|
|
9100
9617
|
"WorkflowServiceRespondActivityTaskFailedByIdBody": {
|
|
9101
9618
|
"type": "object",
|
|
9102
9619
|
"properties": {
|
|
9103
|
-
"workflowId": {
|
|
9104
|
-
"type": "string",
|
|
9105
|
-
"title": "Id of the workflow which scheduled this activity, leave empty to target a standalone activity"
|
|
9106
|
-
},
|
|
9107
9620
|
"runId": {
|
|
9108
9621
|
"type": "string",
|
|
9109
9622
|
"description": "For a workflow activity - the run ID of the workflow which scheduled this activity.\nFor a standalone activity - the run ID of the activity."
|
|
9110
9623
|
},
|
|
9111
|
-
"activityId": {
|
|
9112
|
-
"type": "string",
|
|
9113
|
-
"title": "Id of the activity to fail"
|
|
9114
|
-
},
|
|
9115
9624
|
"failure": {
|
|
9116
9625
|
"$ref": "#/definitions/apiFailureV1Failure",
|
|
9117
9626
|
"title": "Detailed failure information"
|
|
@@ -11411,6 +11920,40 @@
|
|
|
11411
11920
|
}
|
|
11412
11921
|
}
|
|
11413
11922
|
},
|
|
11923
|
+
"v1CountSchedulesResponse": {
|
|
11924
|
+
"type": "object",
|
|
11925
|
+
"properties": {
|
|
11926
|
+
"count": {
|
|
11927
|
+
"type": "string",
|
|
11928
|
+
"format": "int64",
|
|
11929
|
+
"description": "If `query` is not grouping by any field, the count is an approximate number\nof schedules that match the query.\nIf `query` is grouping by a field, the count is simply the sum of the counts\nof the groups returned in the response. This number can be smaller than the\ntotal number of schedules matching the query."
|
|
11930
|
+
},
|
|
11931
|
+
"groups": {
|
|
11932
|
+
"type": "array",
|
|
11933
|
+
"items": {
|
|
11934
|
+
"type": "object",
|
|
11935
|
+
"$ref": "#/definitions/v1CountSchedulesResponseAggregationGroup"
|
|
11936
|
+
},
|
|
11937
|
+
"description": "Contains the groups if the request is grouping by a field.\nThe list might not be complete, and the counts of each group is approximate."
|
|
11938
|
+
}
|
|
11939
|
+
}
|
|
11940
|
+
},
|
|
11941
|
+
"v1CountSchedulesResponseAggregationGroup": {
|
|
11942
|
+
"type": "object",
|
|
11943
|
+
"properties": {
|
|
11944
|
+
"groupValues": {
|
|
11945
|
+
"type": "array",
|
|
11946
|
+
"items": {
|
|
11947
|
+
"type": "object",
|
|
11948
|
+
"$ref": "#/definitions/v1Payload"
|
|
11949
|
+
}
|
|
11950
|
+
},
|
|
11951
|
+
"count": {
|
|
11952
|
+
"type": "string",
|
|
11953
|
+
"format": "int64"
|
|
11954
|
+
}
|
|
11955
|
+
}
|
|
11956
|
+
},
|
|
11414
11957
|
"v1CountWorkflowExecutionsResponse": {
|
|
11415
11958
|
"type": "object",
|
|
11416
11959
|
"properties": {
|
|
@@ -12033,19 +12576,6 @@
|
|
|
12033
12576
|
"description": "- EVENT_TYPE_UNSPECIFIED: Place holder and should never appear in a Workflow execution history\n - EVENT_TYPE_WORKFLOW_EXECUTION_STARTED: Workflow execution has been triggered/started\nIt contains Workflow execution inputs, as well as Workflow timeout configurations\n - EVENT_TYPE_WORKFLOW_EXECUTION_COMPLETED: Workflow execution has successfully completed and contains Workflow execution results\n - EVENT_TYPE_WORKFLOW_EXECUTION_FAILED: Workflow execution has unsuccessfully completed and contains the Workflow execution error\n - EVENT_TYPE_WORKFLOW_EXECUTION_TIMED_OUT: Workflow execution has timed out by the Temporal Server\nUsually due to the Workflow having not been completed within timeout settings\n - EVENT_TYPE_WORKFLOW_TASK_SCHEDULED: Workflow Task has been scheduled and the SDK client should now be able to process any new history events\n - EVENT_TYPE_WORKFLOW_TASK_STARTED: Workflow Task has started and the SDK client has picked up the Workflow Task and is processing new history events\n - EVENT_TYPE_WORKFLOW_TASK_COMPLETED: Workflow Task has completed\nThe SDK client picked up the Workflow Task and processed new history events\nSDK client may or may not ask the Temporal Server to do additional work, such as:\nEVENT_TYPE_ACTIVITY_TASK_SCHEDULED\nEVENT_TYPE_TIMER_STARTED\nEVENT_TYPE_UPSERT_WORKFLOW_SEARCH_ATTRIBUTES\nEVENT_TYPE_MARKER_RECORDED\nEVENT_TYPE_START_CHILD_WORKFLOW_EXECUTION_INITIATED\nEVENT_TYPE_REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED\nEVENT_TYPE_SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED\nEVENT_TYPE_WORKFLOW_EXECUTION_COMPLETED\nEVENT_TYPE_WORKFLOW_EXECUTION_FAILED\nEVENT_TYPE_WORKFLOW_EXECUTION_CANCELED\nEVENT_TYPE_WORKFLOW_EXECUTION_CONTINUED_AS_NEW\n - EVENT_TYPE_WORKFLOW_TASK_TIMED_OUT: Workflow Task encountered a timeout\nEither an SDK client with a local cache was not available at the time, or it took too long for the SDK client to process the task\n - EVENT_TYPE_WORKFLOW_TASK_FAILED: Workflow Task encountered a failure\nUsually this means that the Workflow was non-deterministic\nHowever, the Workflow reset functionality also uses this event\n - EVENT_TYPE_ACTIVITY_TASK_SCHEDULED: Activity Task was scheduled\nThe SDK client should pick up this activity task and execute\nThis event type contains activity inputs, as well as activity timeout configurations\n - EVENT_TYPE_ACTIVITY_TASK_STARTED: Activity Task has started executing\nThe SDK client has picked up the Activity Task and is processing the Activity invocation\n - EVENT_TYPE_ACTIVITY_TASK_COMPLETED: Activity Task has finished successfully\nThe SDK client has picked up and successfully completed the Activity Task\nThis event type contains Activity execution results\n - EVENT_TYPE_ACTIVITY_TASK_FAILED: Activity Task has finished unsuccessfully\nThe SDK picked up the Activity Task but unsuccessfully completed it\nThis event type contains Activity execution errors\n - EVENT_TYPE_ACTIVITY_TASK_TIMED_OUT: Activity has timed out according to the Temporal Server\nActivity did not complete within the timeout settings\n - EVENT_TYPE_ACTIVITY_TASK_CANCEL_REQUESTED: A request to cancel the Activity has occurred\nThe SDK client will be able to confirm cancellation of an Activity during an Activity heartbeat\n - EVENT_TYPE_ACTIVITY_TASK_CANCELED: Activity has been cancelled\n - EVENT_TYPE_TIMER_STARTED: A timer has started\n - EVENT_TYPE_TIMER_FIRED: A timer has fired\n - EVENT_TYPE_TIMER_CANCELED: A time has been cancelled\n - EVENT_TYPE_WORKFLOW_EXECUTION_CANCEL_REQUESTED: A request has been made to cancel the Workflow execution\n - EVENT_TYPE_WORKFLOW_EXECUTION_CANCELED: SDK client has confirmed the cancellation request and the Workflow execution has been cancelled\n - EVENT_TYPE_REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED: Workflow has requested that the Temporal Server try to cancel another Workflow\n - EVENT_TYPE_REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_FAILED: Temporal Server could not cancel the targeted Workflow\nThis is usually because the target Workflow could not be found\n - EVENT_TYPE_EXTERNAL_WORKFLOW_EXECUTION_CANCEL_REQUESTED: Temporal Server has successfully requested the cancellation of the target Workflow\n - EVENT_TYPE_MARKER_RECORDED: A marker has been recorded.\nThis event type is transparent to the Temporal Server\nThe Server will only store it and will not try to understand it.\n - EVENT_TYPE_WORKFLOW_EXECUTION_SIGNALED: Workflow has received a Signal event\nThe event type contains the Signal name, as well as a Signal payload\n - EVENT_TYPE_WORKFLOW_EXECUTION_TERMINATED: Workflow execution has been forcefully terminated\nThis is usually because the terminate Workflow API was called\n - EVENT_TYPE_WORKFLOW_EXECUTION_CONTINUED_AS_NEW: Workflow has successfully completed and a new Workflow has been started within the same transaction\nContains last Workflow execution results as well as new Workflow execution inputs\n - EVENT_TYPE_START_CHILD_WORKFLOW_EXECUTION_INITIATED: Temporal Server will try to start a child Workflow\n - EVENT_TYPE_START_CHILD_WORKFLOW_EXECUTION_FAILED: Child Workflow execution cannot be started/triggered\nUsually due to a child Workflow ID collision\n - EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_STARTED: Child Workflow execution has successfully started/triggered\n - EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_COMPLETED: Child Workflow execution has successfully completed\n - EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_FAILED: Child Workflow execution has unsuccessfully completed\n - EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_CANCELED: Child Workflow execution has been cancelled\n - EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_TIMED_OUT: Child Workflow execution has timed out by the Temporal Server\n - EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_TERMINATED: Child Workflow execution has been terminated\n - EVENT_TYPE_SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED: Temporal Server will try to Signal the targeted Workflow\nContains the Signal name, as well as a Signal payload\n - EVENT_TYPE_SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_FAILED: Temporal Server cannot Signal the targeted Workflow\nUsually because the Workflow could not be found\n - EVENT_TYPE_EXTERNAL_WORKFLOW_EXECUTION_SIGNALED: Temporal Server has successfully Signaled the targeted Workflow\n - EVENT_TYPE_UPSERT_WORKFLOW_SEARCH_ATTRIBUTES: Workflow search attributes should be updated and synchronized with the visibility store\n - EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_ADMITTED: An update was admitted. Note that not all admitted updates result in this\nevent. See UpdateAdmittedEventOrigin for situations in which this event\nis created.\n - EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_ACCEPTED: An update was accepted (i.e. passed validation, perhaps because no validator was defined)\n - EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_REJECTED: This event is never written to history.\n - EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_COMPLETED: An update completed\n - EVENT_TYPE_WORKFLOW_PROPERTIES_MODIFIED_EXTERNALLY: Some property or properties of the workflow as a whole have changed by non-workflow code.\nThe distinction of external vs. command-based modification is important so the SDK can\nmaintain determinism when using the command-based approach.\n - EVENT_TYPE_ACTIVITY_PROPERTIES_MODIFIED_EXTERNALLY: Some property or properties of an already-scheduled activity have changed by non-workflow code.\nThe distinction of external vs. command-based modification is important so the SDK can\nmaintain determinism when using the command-based approach.\n - EVENT_TYPE_WORKFLOW_PROPERTIES_MODIFIED: Workflow properties modified by user workflow code\n - EVENT_TYPE_NEXUS_OPERATION_SCHEDULED: A Nexus operation was scheduled using a ScheduleNexusOperation command.\n - EVENT_TYPE_NEXUS_OPERATION_STARTED: An asynchronous Nexus operation was started by a Nexus handler.\n - EVENT_TYPE_NEXUS_OPERATION_COMPLETED: A Nexus operation completed successfully.\n - EVENT_TYPE_NEXUS_OPERATION_FAILED: A Nexus operation failed.\n - EVENT_TYPE_NEXUS_OPERATION_CANCELED: A Nexus operation completed as canceled.\n - EVENT_TYPE_NEXUS_OPERATION_TIMED_OUT: A Nexus operation timed out.\n - EVENT_TYPE_NEXUS_OPERATION_CANCEL_REQUESTED: A Nexus operation was requested to be canceled using a RequestCancelNexusOperation command.\n - EVENT_TYPE_WORKFLOW_EXECUTION_OPTIONS_UPDATED: Workflow execution options updated by user.\n - EVENT_TYPE_NEXUS_OPERATION_CANCEL_REQUEST_COMPLETED: A cancellation request for a Nexus operation was successfully delivered to the Nexus handler.\n - EVENT_TYPE_NEXUS_OPERATION_CANCEL_REQUEST_FAILED: A cancellation request for a Nexus operation resulted in an error.\n - EVENT_TYPE_WORKFLOW_EXECUTION_PAUSED: An event that indicates that the workflow execution has been paused.\n - EVENT_TYPE_WORKFLOW_EXECUTION_UNPAUSED: An event that indicates that the previously paused workflow execution has been unpaused.",
|
|
12034
12577
|
"title": "Whenever this list of events is changed do change the function shouldBufferEvent in mutableStateBuilder.go to make sure to do the correct event ordering"
|
|
12035
12578
|
},
|
|
12036
|
-
"v1ExecuteMultiOperationResponse": {
|
|
12037
|
-
"type": "object",
|
|
12038
|
-
"properties": {
|
|
12039
|
-
"responses": {
|
|
12040
|
-
"type": "array",
|
|
12041
|
-
"items": {
|
|
12042
|
-
"type": "object",
|
|
12043
|
-
"$ref": "#/definitions/ExecuteMultiOperationResponseResponse"
|
|
12044
|
-
}
|
|
12045
|
-
}
|
|
12046
|
-
},
|
|
12047
|
-
"description": "IMPORTANT: For [StartWorkflow, UpdateWorkflow] combination (\"Update-with-Start\") when both\n 1. the workflow update for the requested update ID has already completed, and\n 2. the workflow for the requested workflow ID has already been closed,\nthen you'll receive\n - an update response containing the update's outcome, and\n - a start response with a `status` field that reflects the workflow's current state."
|
|
12048
|
-
},
|
|
12049
12579
|
"v1ExternalWorkflowExecutionCancelRequestedEventAttributes": {
|
|
12050
12580
|
"type": "object",
|
|
12051
12581
|
"properties": {
|
|
@@ -13140,6 +13670,10 @@
|
|
|
13140
13670
|
"standaloneActivities": {
|
|
13141
13671
|
"type": "boolean",
|
|
13142
13672
|
"title": "True if the namespace supports standalone activities"
|
|
13673
|
+
},
|
|
13674
|
+
"workerPollCompleteOnShutdown": {
|
|
13675
|
+
"type": "boolean",
|
|
13676
|
+
"description": "True if the namespace supports server-side completion of outstanding worker polls on shutdown.\nWhen enabled, the server will complete polls for workers that send WorkerInstanceKey in their\npoll requests and call ShutdownWorker with the same WorkerInstanceKey. The poll will return\nan empty response. When this flag is true, workers should allow polls to return gracefully\nrather than terminating any open polls on shutdown."
|
|
13143
13677
|
}
|
|
13144
13678
|
},
|
|
13145
13679
|
"description": "Namespace capability details. Should contain what features are enabled in a namespace."
|
|
@@ -13454,7 +13988,8 @@
|
|
|
13454
13988
|
"type": "string",
|
|
13455
13989
|
"description": "Operation token - may be empty if the operation completed synchronously."
|
|
13456
13990
|
}
|
|
13457
|
-
}
|
|
13991
|
+
},
|
|
13992
|
+
"description": "Representation of the Temporal SDK NexusOperationError object that is returned to workflow callers."
|
|
13458
13993
|
},
|
|
13459
13994
|
"v1NexusOperationScheduledEventAttributes": {
|
|
13460
13995
|
"type": "object",
|
|
@@ -15301,123 +15836,6 @@
|
|
|
15301
15836
|
}
|
|
15302
15837
|
}
|
|
15303
15838
|
},
|
|
15304
|
-
"v1StartWorkflowExecutionRequest": {
|
|
15305
|
-
"type": "object",
|
|
15306
|
-
"properties": {
|
|
15307
|
-
"namespace": {
|
|
15308
|
-
"type": "string"
|
|
15309
|
-
},
|
|
15310
|
-
"workflowId": {
|
|
15311
|
-
"type": "string"
|
|
15312
|
-
},
|
|
15313
|
-
"workflowType": {
|
|
15314
|
-
"$ref": "#/definitions/v1WorkflowType"
|
|
15315
|
-
},
|
|
15316
|
-
"taskQueue": {
|
|
15317
|
-
"$ref": "#/definitions/v1TaskQueue"
|
|
15318
|
-
},
|
|
15319
|
-
"input": {
|
|
15320
|
-
"$ref": "#/definitions/v1Payloads",
|
|
15321
|
-
"description": "Serialized arguments to the workflow. These are passed as arguments to the workflow function."
|
|
15322
|
-
},
|
|
15323
|
-
"workflowExecutionTimeout": {
|
|
15324
|
-
"type": "string",
|
|
15325
|
-
"description": "Total workflow execution timeout including retries and continue as new."
|
|
15326
|
-
},
|
|
15327
|
-
"workflowRunTimeout": {
|
|
15328
|
-
"type": "string",
|
|
15329
|
-
"description": "Timeout of a single workflow run."
|
|
15330
|
-
},
|
|
15331
|
-
"workflowTaskTimeout": {
|
|
15332
|
-
"type": "string",
|
|
15333
|
-
"description": "Timeout of a single workflow task."
|
|
15334
|
-
},
|
|
15335
|
-
"identity": {
|
|
15336
|
-
"type": "string",
|
|
15337
|
-
"title": "The identity of the client who initiated this request"
|
|
15338
|
-
},
|
|
15339
|
-
"requestId": {
|
|
15340
|
-
"type": "string",
|
|
15341
|
-
"description": "A unique identifier for this start request. Typically UUIDv4."
|
|
15342
|
-
},
|
|
15343
|
-
"workflowIdReusePolicy": {
|
|
15344
|
-
"$ref": "#/definitions/v1WorkflowIdReusePolicy",
|
|
15345
|
-
"description": "Defines whether to allow re-using the workflow id from a previously *closed* workflow.\nThe default policy is WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.\n\nSee `workflow_id_conflict_policy` for handling a workflow id duplication with a *running* workflow."
|
|
15346
|
-
},
|
|
15347
|
-
"workflowIdConflictPolicy": {
|
|
15348
|
-
"$ref": "#/definitions/v1WorkflowIdConflictPolicy",
|
|
15349
|
-
"description": "Defines how to resolve a workflow id conflict with a *running* workflow.\nThe default policy is WORKFLOW_ID_CONFLICT_POLICY_FAIL.\n\nSee `workflow_id_reuse_policy` for handling a workflow id duplication with a *closed* workflow."
|
|
15350
|
-
},
|
|
15351
|
-
"retryPolicy": {
|
|
15352
|
-
"$ref": "#/definitions/v1RetryPolicy",
|
|
15353
|
-
"description": "The retry policy for the workflow. Will never exceed `workflow_execution_timeout`."
|
|
15354
|
-
},
|
|
15355
|
-
"cronSchedule": {
|
|
15356
|
-
"type": "string",
|
|
15357
|
-
"title": "See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/"
|
|
15358
|
-
},
|
|
15359
|
-
"memo": {
|
|
15360
|
-
"$ref": "#/definitions/v1Memo"
|
|
15361
|
-
},
|
|
15362
|
-
"searchAttributes": {
|
|
15363
|
-
"$ref": "#/definitions/v1SearchAttributes"
|
|
15364
|
-
},
|
|
15365
|
-
"header": {
|
|
15366
|
-
"$ref": "#/definitions/v1Header"
|
|
15367
|
-
},
|
|
15368
|
-
"requestEagerExecution": {
|
|
15369
|
-
"type": "boolean",
|
|
15370
|
-
"description": "Request to get the first workflow task inline in the response bypassing matching service and worker polling.\nIf set to `true` the caller is expected to have a worker available and capable of processing the task.\nThe returned task will be marked as started and is expected to be completed by the specified\n`workflow_task_timeout`."
|
|
15371
|
-
},
|
|
15372
|
-
"continuedFailure": {
|
|
15373
|
-
"$ref": "#/definitions/v1Failure",
|
|
15374
|
-
"description": "These values will be available as ContinuedFailure and LastCompletionResult in the\nWorkflowExecutionStarted event and through SDKs. The are currently only used by the\nserver itself (for the schedules feature) and are not intended to be exposed in\nStartWorkflowExecution."
|
|
15375
|
-
},
|
|
15376
|
-
"lastCompletionResult": {
|
|
15377
|
-
"$ref": "#/definitions/v1Payloads"
|
|
15378
|
-
},
|
|
15379
|
-
"workflowStartDelay": {
|
|
15380
|
-
"type": "string",
|
|
15381
|
-
"description": "Time to wait before dispatching the first workflow task. Cannot be used with `cron_schedule`.\nIf the workflow gets a signal before the delay, a workflow task will be dispatched and the rest\nof the delay will be ignored."
|
|
15382
|
-
},
|
|
15383
|
-
"completionCallbacks": {
|
|
15384
|
-
"type": "array",
|
|
15385
|
-
"items": {
|
|
15386
|
-
"type": "object",
|
|
15387
|
-
"$ref": "#/definitions/v1Callback"
|
|
15388
|
-
},
|
|
15389
|
-
"description": "Callbacks to be called by the server when this workflow reaches a terminal state.\nIf the workflow continues-as-new, these callbacks will be carried over to the new execution.\nCallback addresses must be whitelisted in the server's dynamic configuration."
|
|
15390
|
-
},
|
|
15391
|
-
"userMetadata": {
|
|
15392
|
-
"$ref": "#/definitions/v1UserMetadata",
|
|
15393
|
-
"description": "Metadata on the workflow if it is started. This is carried over to the WorkflowExecutionInfo\nfor use by user interfaces to display the fixed as-of-start summary and details of the\nworkflow."
|
|
15394
|
-
},
|
|
15395
|
-
"links": {
|
|
15396
|
-
"type": "array",
|
|
15397
|
-
"items": {
|
|
15398
|
-
"type": "object",
|
|
15399
|
-
"$ref": "#/definitions/v1Link"
|
|
15400
|
-
},
|
|
15401
|
-
"description": "Links to be associated with the workflow."
|
|
15402
|
-
},
|
|
15403
|
-
"versioningOverride": {
|
|
15404
|
-
"$ref": "#/definitions/v1VersioningOverride",
|
|
15405
|
-
"description": "If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion.\nTo unset the override after the workflow is running, use UpdateWorkflowExecutionOptions."
|
|
15406
|
-
},
|
|
15407
|
-
"onConflictOptions": {
|
|
15408
|
-
"$ref": "#/definitions/v1OnConflictOptions",
|
|
15409
|
-
"description": "Defines actions to be done to the existing running workflow when the conflict policy\nWORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING is used. If not set (ie., nil value) or set to a\nempty object (ie., all options with default value), it won't do anything to the existing\nrunning workflow. If set, it will add a history event to the running workflow."
|
|
15410
|
-
},
|
|
15411
|
-
"priority": {
|
|
15412
|
-
"$ref": "#/definitions/v1Priority",
|
|
15413
|
-
"title": "Priority metadata"
|
|
15414
|
-
},
|
|
15415
|
-
"eagerWorkerDeploymentOptions": {
|
|
15416
|
-
"$ref": "#/definitions/v1WorkerDeploymentOptions",
|
|
15417
|
-
"description": "Deployment Options of the worker who will process the eager task. Passed when `request_eager_execution=true`."
|
|
15418
|
-
}
|
|
15419
|
-
}
|
|
15420
|
-
},
|
|
15421
15839
|
"v1StartWorkflowExecutionResponse": {
|
|
15422
15840
|
"type": "object",
|
|
15423
15841
|
"properties": {
|
|
@@ -15518,11 +15936,10 @@
|
|
|
15518
15936
|
"SUGGEST_CONTINUE_AS_NEW_REASON_UNSPECIFIED",
|
|
15519
15937
|
"SUGGEST_CONTINUE_AS_NEW_REASON_HISTORY_SIZE_TOO_LARGE",
|
|
15520
15938
|
"SUGGEST_CONTINUE_AS_NEW_REASON_TOO_MANY_HISTORY_EVENTS",
|
|
15521
|
-
"SUGGEST_CONTINUE_AS_NEW_REASON_TOO_MANY_UPDATES"
|
|
15522
|
-
"SUGGEST_CONTINUE_AS_NEW_REASON_TARGET_WORKER_DEPLOYMENT_VERSION_CHANGED"
|
|
15939
|
+
"SUGGEST_CONTINUE_AS_NEW_REASON_TOO_MANY_UPDATES"
|
|
15523
15940
|
],
|
|
15524
15941
|
"default": "SUGGEST_CONTINUE_AS_NEW_REASON_UNSPECIFIED",
|
|
15525
|
-
"description": "SuggestContinueAsNewReason specifies why SuggestContinueAsNew is true.\n\n - SUGGEST_CONTINUE_AS_NEW_REASON_HISTORY_SIZE_TOO_LARGE: Workflow History size is getting too large.\n - SUGGEST_CONTINUE_AS_NEW_REASON_TOO_MANY_HISTORY_EVENTS: Workflow History event count is getting too large.\n - SUGGEST_CONTINUE_AS_NEW_REASON_TOO_MANY_UPDATES: Workflow's count of completed plus in-flight updates is too large
|
|
15942
|
+
"description": "SuggestContinueAsNewReason specifies why SuggestContinueAsNew is true.\n\n - SUGGEST_CONTINUE_AS_NEW_REASON_HISTORY_SIZE_TOO_LARGE: Workflow History size is getting too large.\n - SUGGEST_CONTINUE_AS_NEW_REASON_TOO_MANY_HISTORY_EVENTS: Workflow History event count is getting too large.\n - SUGGEST_CONTINUE_AS_NEW_REASON_TOO_MANY_UPDATES: Workflow's count of completed plus in-flight updates is too large."
|
|
15526
15943
|
},
|
|
15527
15944
|
"v1TaskIdBlock": {
|
|
15528
15945
|
"type": "object",
|
|
@@ -16049,31 +16466,6 @@
|
|
|
16049
16466
|
}
|
|
16050
16467
|
}
|
|
16051
16468
|
},
|
|
16052
|
-
"v1UpdateWorkflowExecutionRequest": {
|
|
16053
|
-
"type": "object",
|
|
16054
|
-
"properties": {
|
|
16055
|
-
"namespace": {
|
|
16056
|
-
"type": "string",
|
|
16057
|
-
"description": "The namespace name of the target Workflow."
|
|
16058
|
-
},
|
|
16059
|
-
"workflowExecution": {
|
|
16060
|
-
"$ref": "#/definitions/v1WorkflowExecution",
|
|
16061
|
-
"description": "The target Workflow Id and (optionally) a specific Run Id thereof."
|
|
16062
|
-
},
|
|
16063
|
-
"firstExecutionRunId": {
|
|
16064
|
-
"type": "string",
|
|
16065
|
-
"description": "If set, this call will error if the most recent (if no Run Id is set on\n`workflow_execution`), or specified (if it is) Workflow Execution is not\npart of the same execution chain as this Id."
|
|
16066
|
-
},
|
|
16067
|
-
"waitPolicy": {
|
|
16068
|
-
"$ref": "#/definitions/v1WaitPolicy",
|
|
16069
|
-
"description": "Specifies client's intent to wait for Update results.\nNOTE: This field works together with API call timeout which is limited by\nserver timeout (maximum wait time). If server timeout is expired before\nuser specified timeout, API call returns even if specified stage is not reached.\nActual reached stage will be included in the response."
|
|
16070
|
-
},
|
|
16071
|
-
"request": {
|
|
16072
|
-
"$ref": "#/definitions/v1Request",
|
|
16073
|
-
"description": "The request information that will be delivered all the way down to the\nWorkflow Execution."
|
|
16074
|
-
}
|
|
16075
|
-
}
|
|
16076
|
-
},
|
|
16077
16469
|
"v1UpdateWorkflowExecutionResponse": {
|
|
16078
16470
|
"type": "object",
|
|
16079
16471
|
"properties": {
|
|
@@ -16289,7 +16681,7 @@
|
|
|
16289
16681
|
"properties": {
|
|
16290
16682
|
"deploymentName": {
|
|
16291
16683
|
"type": "string",
|
|
16292
|
-
"description": "Required
|
|
16684
|
+
"description": "Required when `worker_versioning_mode==VERSIONED`."
|
|
16293
16685
|
},
|
|
16294
16686
|
"buildId": {
|
|
16295
16687
|
"type": "string",
|
|
@@ -17783,6 +18175,10 @@
|
|
|
17783
18175
|
},
|
|
17784
18176
|
"description": "The reason(s) that suggest_continue_as_new is true, if it is.\nUnset if suggest_continue_as_new is false."
|
|
17785
18177
|
},
|
|
18178
|
+
"targetWorkerDeploymentVersionChanged": {
|
|
18179
|
+
"type": "boolean",
|
|
18180
|
+
"description": "True if Workflow's Target Worker Deployment Version is different from its Pinned Version and\nthe workflow is Pinned.\nExperimental."
|
|
18181
|
+
},
|
|
17786
18182
|
"historySizeBytes": {
|
|
17787
18183
|
"type": "string",
|
|
17788
18184
|
"format": "int64",
|