@temporalio/core-bridge 1.11.2 → 1.11.4

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.
Files changed (119) hide show
  1. package/Cargo.lock +396 -489
  2. package/Cargo.toml +3 -2
  3. package/lib/errors.d.ts +2 -0
  4. package/lib/errors.js +7 -3
  5. package/lib/errors.js.map +1 -1
  6. package/lib/index.d.ts +8 -2
  7. package/lib/index.js.map +1 -1
  8. package/lib/worker-tuner.d.ts +111 -1
  9. package/package.json +3 -3
  10. package/releases/aarch64-apple-darwin/index.node +0 -0
  11. package/releases/aarch64-unknown-linux-gnu/index.node +0 -0
  12. package/releases/x86_64-apple-darwin/index.node +0 -0
  13. package/releases/x86_64-pc-windows-msvc/index.node +0 -0
  14. package/releases/x86_64-unknown-linux-gnu/index.node +0 -0
  15. package/sdk-core/.github/workflows/per-pr.yml +3 -3
  16. package/sdk-core/Cargo.toml +0 -1
  17. package/sdk-core/client/Cargo.toml +1 -2
  18. package/sdk-core/client/src/lib.rs +21 -13
  19. package/sdk-core/client/src/metrics.rs +1 -1
  20. package/sdk-core/client/src/raw.rs +46 -1
  21. package/sdk-core/core/Cargo.toml +7 -7
  22. package/sdk-core/core/benches/workflow_replay.rs +1 -1
  23. package/sdk-core/core/src/abstractions/take_cell.rs +1 -1
  24. package/sdk-core/core/src/abstractions.rs +98 -10
  25. package/sdk-core/core/src/core_tests/activity_tasks.rs +8 -2
  26. package/sdk-core/core/src/core_tests/local_activities.rs +1 -1
  27. package/sdk-core/core/src/core_tests/mod.rs +3 -3
  28. package/sdk-core/core/src/core_tests/updates.rs +104 -9
  29. package/sdk-core/core/src/core_tests/workers.rs +72 -3
  30. package/sdk-core/core/src/core_tests/workflow_tasks.rs +6 -7
  31. package/sdk-core/core/src/debug_client.rs +78 -0
  32. package/sdk-core/core/src/ephemeral_server/mod.rs +15 -5
  33. package/sdk-core/core/src/lib.rs +30 -4
  34. package/sdk-core/core/src/pollers/mod.rs +1 -1
  35. package/sdk-core/core/src/pollers/poll_buffer.rs +7 -7
  36. package/sdk-core/core/src/replay/mod.rs +4 -4
  37. package/sdk-core/core/src/telemetry/log_export.rs +2 -2
  38. package/sdk-core/core/src/telemetry/metrics.rs +69 -1
  39. package/sdk-core/core/src/telemetry/otel.rs +2 -2
  40. package/sdk-core/core/src/test_help/mod.rs +3 -3
  41. package/sdk-core/core/src/worker/activities/activity_heartbeat_manager.rs +3 -3
  42. package/sdk-core/core/src/worker/activities/activity_task_poller_stream.rs +1 -1
  43. package/sdk-core/core/src/worker/activities/local_activities.rs +68 -24
  44. package/sdk-core/core/src/worker/activities.rs +26 -15
  45. package/sdk-core/core/src/worker/client/mocks.rs +10 -4
  46. package/sdk-core/core/src/worker/client.rs +17 -0
  47. package/sdk-core/core/src/worker/mod.rs +71 -13
  48. package/sdk-core/core/src/worker/slot_provider.rs +5 -7
  49. package/sdk-core/core/src/worker/tuner/fixed_size.rs +4 -3
  50. package/sdk-core/core/src/worker/tuner/resource_based.rs +171 -32
  51. package/sdk-core/core/src/worker/tuner.rs +18 -6
  52. package/sdk-core/core/src/worker/workflow/history_update.rs +43 -13
  53. package/sdk-core/core/src/worker/workflow/machines/transition_coverage.rs +6 -6
  54. package/sdk-core/core/src/worker/workflow/machines/workflow_machines.rs +6 -5
  55. package/sdk-core/core/src/worker/workflow/managed_run.rs +3 -3
  56. package/sdk-core/core/src/worker/workflow/mod.rs +13 -7
  57. package/sdk-core/core/src/worker/workflow/wft_extraction.rs +7 -7
  58. package/sdk-core/core/src/worker/workflow/wft_poller.rs +2 -2
  59. package/sdk-core/core/src/worker/workflow/workflow_stream.rs +11 -11
  60. package/sdk-core/core-api/Cargo.toml +1 -0
  61. package/sdk-core/core-api/src/worker.rs +84 -30
  62. package/sdk-core/sdk/Cargo.toml +1 -2
  63. package/sdk-core/sdk/src/lib.rs +1 -1
  64. package/sdk-core/sdk/src/workflow_context.rs +9 -8
  65. package/sdk-core/sdk/src/workflow_future.rs +19 -14
  66. package/sdk-core/sdk-core-protos/Cargo.toml +2 -0
  67. package/sdk-core/sdk-core-protos/build.rs +6 -1
  68. package/sdk-core/sdk-core-protos/protos/api_upstream/buf.yaml +1 -0
  69. package/sdk-core/sdk-core-protos/protos/api_upstream/openapi/openapiv2.json +3207 -158
  70. package/sdk-core/sdk-core-protos/protos/api_upstream/openapi/openapiv3.yaml +2934 -118
  71. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/activity/v1/message.proto +67 -0
  72. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/common/v1/message.proto +47 -1
  73. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/event_type.proto +6 -7
  74. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/failed_cause.proto +2 -0
  75. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/reset.proto +5 -3
  76. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/task_queue.proto +3 -3
  77. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/update.proto +14 -13
  78. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/failure/v1/message.proto +1 -3
  79. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/history/v1/message.proto +22 -0
  80. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/nexus/v1/message.proto +13 -2
  81. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/operatorservice/v1/service.proto +26 -6
  82. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/schedule/v1/message.proto +5 -0
  83. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/sdk/v1/workflow_metadata.proto +6 -0
  84. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/taskqueue/v1/message.proto +46 -12
  85. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/update/v1/message.proto +18 -19
  86. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/workflow/v1/message.proto +27 -0
  87. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/workflowservice/v1/request_response.proto +192 -19
  88. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/workflowservice/v1/service.proto +279 -12
  89. package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/activity_result/activity_result.proto +1 -1
  90. package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/activity_task/activity_task.proto +1 -1
  91. package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/child_workflow/child_workflow.proto +1 -1
  92. package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/common/common.proto +1 -1
  93. package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/core_interface.proto +17 -1
  94. package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/external_data/external_data.proto +1 -1
  95. package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/workflow_activation/workflow_activation.proto +1 -1
  96. package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/workflow_commands/workflow_commands.proto +1 -1
  97. package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/workflow_completion/workflow_completion.proto +1 -1
  98. package/sdk-core/sdk-core-protos/src/lib.rs +30 -6
  99. package/sdk-core/test-utils/Cargo.toml +1 -2
  100. package/sdk-core/test-utils/src/lib.rs +2 -2
  101. package/sdk-core/tests/heavy_tests.rs +1 -1
  102. package/sdk-core/tests/integ_tests/ephemeral_server_tests.rs +2 -2
  103. package/sdk-core/tests/integ_tests/metrics_tests.rs +144 -7
  104. package/sdk-core/tests/integ_tests/queries_tests.rs +1 -1
  105. package/sdk-core/tests/integ_tests/update_tests.rs +109 -5
  106. package/sdk-core/tests/integ_tests/worker_tests.rs +44 -8
  107. package/sdk-core/tests/integ_tests/workflow_tests/local_activities.rs +1 -1
  108. package/sdk-core/tests/integ_tests/workflow_tests/resets.rs +1 -1
  109. package/sdk-core/tests/integ_tests/workflow_tests/signals.rs +1 -1
  110. package/sdk-core/tests/integ_tests/workflow_tests.rs +3 -2
  111. package/src/conversions/slot_supplier_bridge.rs +287 -0
  112. package/src/conversions.rs +23 -15
  113. package/src/helpers.rs +35 -1
  114. package/src/runtime.rs +7 -3
  115. package/src/worker.rs +1 -1
  116. package/ts/errors.ts +9 -2
  117. package/ts/index.ts +19 -4
  118. package/ts/worker-tuner.ts +123 -1
  119. package/sdk-core/sdk-core-protos/protos/api_upstream/.gitmodules +0 -3
@@ -19,10 +19,10 @@
19
19
  "application/json"
20
20
  ],
21
21
  "paths": {
22
- "/cluster-info": {
22
+ "/api/v1/cluster-info": {
23
23
  "get": {
24
24
  "summary": "GetClusterInfo returns information about temporal cluster",
25
- "operationId": "GetClusterInfo",
25
+ "operationId": "GetClusterInfo2",
26
26
  "responses": {
27
27
  "200": {
28
28
  "description": "A successful response.",
@@ -42,10 +42,10 @@
42
42
  ]
43
43
  }
44
44
  },
45
- "/namespaces": {
45
+ "/api/v1/namespaces": {
46
46
  "get": {
47
47
  "summary": "ListNamespaces returns the information and configuration for all namespaces.",
48
- "operationId": "ListNamespaces",
48
+ "operationId": "ListNamespaces2",
49
49
  "responses": {
50
50
  "200": {
51
51
  "description": "A successful response.",
@@ -90,7 +90,7 @@
90
90
  "post": {
91
91
  "summary": "RegisterNamespace creates a new namespace which can be used as a container for all resources.",
92
92
  "description": "A Namespace is a top level entity within Temporal, and is used as a container for resources\nlike workflow executions, task queues, etc. A Namespace acts as a sandbox and provides\nisolation for all resources within the namespace. All resources belongs to exactly one\nnamespace.",
93
- "operationId": "RegisterNamespace",
93
+ "operationId": "RegisterNamespace2",
94
94
  "responses": {
95
95
  "200": {
96
96
  "description": "A successful response.",
@@ -120,10 +120,10 @@
120
120
  ]
121
121
  }
122
122
  },
123
- "/namespaces/{namespace}": {
123
+ "/api/v1/namespaces/{namespace}": {
124
124
  "get": {
125
125
  "summary": "DescribeNamespace returns the information and configuration for a registered namespace.",
126
- "operationId": "DescribeNamespace",
126
+ "operationId": "DescribeNamespace2",
127
127
  "responses": {
128
128
  "200": {
129
129
  "description": "A successful response.",
@@ -157,11 +157,11 @@
157
157
  ]
158
158
  }
159
159
  },
160
- "/namespaces/{namespace}/activities/cancel": {
160
+ "/api/v1/namespaces/{namespace}/activities/cancel": {
161
161
  "post": {
162
162
  "summary": "RespondActivityTaskFailed is called by workers when processing an activity task fails.",
163
163
  "description": "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.",
164
- "operationId": "RespondActivityTaskCanceled",
164
+ "operationId": "RespondActivityTaskCanceled2",
165
165
  "responses": {
166
166
  "200": {
167
167
  "description": "A successful response.",
@@ -197,10 +197,10 @@
197
197
  ]
198
198
  }
199
199
  },
200
- "/namespaces/{namespace}/activities/cancel-by-id": {
200
+ "/api/v1/namespaces/{namespace}/activities/cancel-by-id": {
201
201
  "post": {
202
202
  "summary": "See `RecordActivityTaskCanceled`. This version allows clients to record failures by\nnamespace/workflow id/activity id instead of task token.",
203
- "operationId": "RespondActivityTaskCanceledById",
203
+ "operationId": "RespondActivityTaskCanceledById2",
204
204
  "responses": {
205
205
  "200": {
206
206
  "description": "A successful response.",
@@ -237,11 +237,11 @@
237
237
  ]
238
238
  }
239
239
  },
240
- "/namespaces/{namespace}/activities/complete": {
240
+ "/api/v1/namespaces/{namespace}/activities/complete": {
241
241
  "post": {
242
242
  "summary": "RespondActivityTaskCompleted is called by workers when they successfully complete an activity\ntask.",
243
243
  "description": "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.",
244
- "operationId": "RespondActivityTaskCompleted",
244
+ "operationId": "RespondActivityTaskCompleted2",
245
245
  "responses": {
246
246
  "200": {
247
247
  "description": "A successful response.",
@@ -277,10 +277,10 @@
277
277
  ]
278
278
  }
279
279
  },
280
- "/namespaces/{namespace}/activities/complete-by-id": {
280
+ "/api/v1/namespaces/{namespace}/activities/complete-by-id": {
281
281
  "post": {
282
282
  "summary": "See `RecordActivityTaskCompleted`. This version allows clients to record completions by\nnamespace/workflow id/activity id instead of task token.",
283
- "operationId": "RespondActivityTaskCompletedById",
283
+ "operationId": "RespondActivityTaskCompletedById2",
284
284
  "responses": {
285
285
  "200": {
286
286
  "description": "A successful response.",
@@ -317,11 +317,11 @@
317
317
  ]
318
318
  }
319
319
  },
320
- "/namespaces/{namespace}/activities/fail": {
320
+ "/api/v1/namespaces/{namespace}/activities/fail": {
321
321
  "post": {
322
322
  "summary": "RespondActivityTaskFailed is called by workers when processing an activity task fails.",
323
323
  "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.",
324
- "operationId": "RespondActivityTaskFailed",
324
+ "operationId": "RespondActivityTaskFailed2",
325
325
  "responses": {
326
326
  "200": {
327
327
  "description": "A successful response.",
@@ -357,10 +357,10 @@
357
357
  ]
358
358
  }
359
359
  },
360
- "/namespaces/{namespace}/activities/fail-by-id": {
360
+ "/api/v1/namespaces/{namespace}/activities/fail-by-id": {
361
361
  "post": {
362
362
  "summary": "See `RecordActivityTaskFailed`. This version allows clients to record failures by\nnamespace/workflow id/activity id instead of task token.",
363
- "operationId": "RespondActivityTaskFailedById",
363
+ "operationId": "RespondActivityTaskFailedById2",
364
364
  "responses": {
365
365
  "200": {
366
366
  "description": "A successful response.",
@@ -397,11 +397,11 @@
397
397
  ]
398
398
  }
399
399
  },
400
- "/namespaces/{namespace}/activities/heartbeat": {
400
+ "/api/v1/namespaces/{namespace}/activities/heartbeat": {
401
401
  "post": {
402
402
  "summary": "RecordActivityTaskHeartbeat is optionally called by workers while they execute activities.",
403
403
  "description": "If worker fails to heartbeat within the `heartbeat_timeout` interval for the activity task,\nthen it will be marked as timed out and an `ACTIVITY_TASK_TIMED_OUT` event will be written to\nthe workflow history. Calling `RecordActivityTaskHeartbeat` will fail with `NotFound` in\nsuch situations, in that event, the SDK should request cancellation of the activity.",
404
- "operationId": "RecordActivityTaskHeartbeat",
404
+ "operationId": "RecordActivityTaskHeartbeat2",
405
405
  "responses": {
406
406
  "200": {
407
407
  "description": "A successful response.",
@@ -437,10 +437,10 @@
437
437
  ]
438
438
  }
439
439
  },
440
- "/namespaces/{namespace}/activities/heartbeat-by-id": {
440
+ "/api/v1/namespaces/{namespace}/activities/heartbeat-by-id": {
441
441
  "post": {
442
442
  "summary": "See `RecordActivityTaskHeartbeat`. This version allows clients to record heartbeats by\nnamespace/workflow id/activity id instead of task token.",
443
- "operationId": "RecordActivityTaskHeartbeatById",
443
+ "operationId": "RecordActivityTaskHeartbeatById2",
444
444
  "responses": {
445
445
  "200": {
446
446
  "description": "A successful response.",
@@ -477,10 +477,171 @@
477
477
  ]
478
478
  }
479
479
  },
480
- "/namespaces/{namespace}/archived-workflows": {
480
+ "/api/v1/namespaces/{namespace}/activities/pause-by-id": {
481
+ "post": {
482
+ "summary": "PauseActivityById pauses the execution of an activity specified by its ID.\nReturns a `NotFound` error if there is no pending activity with the provided ID.",
483
+ "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.",
484
+ "operationId": "PauseActivityById2",
485
+ "responses": {
486
+ "200": {
487
+ "description": "A successful response.",
488
+ "schema": {
489
+ "$ref": "#/definitions/v1PauseActivityByIdResponse"
490
+ }
491
+ },
492
+ "default": {
493
+ "description": "An unexpected error response.",
494
+ "schema": {
495
+ "$ref": "#/definitions/rpcStatus"
496
+ }
497
+ }
498
+ },
499
+ "parameters": [
500
+ {
501
+ "name": "namespace",
502
+ "description": "Namespace of the workflow which scheduled this activity.",
503
+ "in": "path",
504
+ "required": true,
505
+ "type": "string"
506
+ },
507
+ {
508
+ "name": "body",
509
+ "in": "body",
510
+ "required": true,
511
+ "schema": {
512
+ "$ref": "#/definitions/WorkflowServicePauseActivityByIdBody"
513
+ }
514
+ }
515
+ ],
516
+ "tags": [
517
+ "WorkflowService"
518
+ ]
519
+ }
520
+ },
521
+ "/api/v1/namespaces/{namespace}/activities/reset-by-id": {
522
+ "post": {
523
+ "summary": "ResetActivityById unpauses the execution of an activity specified by its ID.\nReturns a `NotFound` error if there is no pending activity with the provided ID.\nResetting an activity means:\n* number of attempts will be reset to 0.\n* activity timeouts will be resetted.\nIf the activity currently running:\n* if 'no_wait' flag is provided, a new instance of the activity will be scheduled immediately.\n* if 'no_wait' flag is not provided, a new instance of the activity will be scheduled after current instance completes if needed.\nIf 'reset_heartbeats' flag is set, the activity heartbeat timer and heartbeats will be reset.",
524
+ "operationId": "ResetActivityById2",
525
+ "responses": {
526
+ "200": {
527
+ "description": "A successful response.",
528
+ "schema": {
529
+ "$ref": "#/definitions/v1ResetActivityByIdResponse"
530
+ }
531
+ },
532
+ "default": {
533
+ "description": "An unexpected error response.",
534
+ "schema": {
535
+ "$ref": "#/definitions/rpcStatus"
536
+ }
537
+ }
538
+ },
539
+ "parameters": [
540
+ {
541
+ "name": "namespace",
542
+ "description": "Namespace of the workflow which scheduled this activity.",
543
+ "in": "path",
544
+ "required": true,
545
+ "type": "string"
546
+ },
547
+ {
548
+ "name": "body",
549
+ "in": "body",
550
+ "required": true,
551
+ "schema": {
552
+ "$ref": "#/definitions/WorkflowServiceResetActivityByIdBody"
553
+ }
554
+ }
555
+ ],
556
+ "tags": [
557
+ "WorkflowService"
558
+ ]
559
+ }
560
+ },
561
+ "/api/v1/namespaces/{namespace}/activities/unpause-by-id": {
562
+ "post": {
563
+ "summary": "UnpauseActivityById unpauses the execution of an activity specified by its ID.\nReturns a `NotFound` error if there is no pending activity with the provided ID.\nThere are two 'modes' of unpausing an activity:\n'resume' - If the activity is paused, it will be resumed and scheduled for execution.\n * If the activity is currently running Unpause with 'resume' has no effect.\n * if 'no_wait' flag is set and the activity is waiting, the activity will be scheduled immediately.\n'reset' - If the activity is paused, it will be reset to its initial state and (depending on parameters) scheduled for execution.\n * If the activity is currently running, Unpause with 'reset' will reset the number of attempts.\n * if 'no_wait' flag is set, the activity will be scheduled immediately.\n * if 'reset_heartbeats' flag is set, the activity heartbeat timer and heartbeats will be reset.\nIf the activity is in waiting for retry and past it retry timeout, it will be scheduled immediately.\nOnce the activity is unpaused, all timeout timers will be regenerated.",
564
+ "operationId": "UnpauseActivityById2",
565
+ "responses": {
566
+ "200": {
567
+ "description": "A successful response.",
568
+ "schema": {
569
+ "$ref": "#/definitions/v1UnpauseActivityByIdResponse"
570
+ }
571
+ },
572
+ "default": {
573
+ "description": "An unexpected error response.",
574
+ "schema": {
575
+ "$ref": "#/definitions/rpcStatus"
576
+ }
577
+ }
578
+ },
579
+ "parameters": [
580
+ {
581
+ "name": "namespace",
582
+ "description": "Namespace of the workflow which scheduled this activity.",
583
+ "in": "path",
584
+ "required": true,
585
+ "type": "string"
586
+ },
587
+ {
588
+ "name": "body",
589
+ "in": "body",
590
+ "required": true,
591
+ "schema": {
592
+ "$ref": "#/definitions/WorkflowServiceUnpauseActivityByIdBody"
593
+ }
594
+ }
595
+ ],
596
+ "tags": [
597
+ "WorkflowService"
598
+ ]
599
+ }
600
+ },
601
+ "/api/v1/namespaces/{namespace}/activities/update-options-by-id": {
602
+ "post": {
603
+ "summary": "UpdateActivityOptionsById is called by the client to update the options of an activity",
604
+ "operationId": "UpdateActivityOptionsById2",
605
+ "responses": {
606
+ "200": {
607
+ "description": "A successful response.",
608
+ "schema": {
609
+ "$ref": "#/definitions/v1UpdateActivityOptionsByIdResponse"
610
+ }
611
+ },
612
+ "default": {
613
+ "description": "An unexpected error response.",
614
+ "schema": {
615
+ "$ref": "#/definitions/rpcStatus"
616
+ }
617
+ }
618
+ },
619
+ "parameters": [
620
+ {
621
+ "name": "namespace",
622
+ "description": "Namespace of the workflow which scheduled this activity",
623
+ "in": "path",
624
+ "required": true,
625
+ "type": "string"
626
+ },
627
+ {
628
+ "name": "body",
629
+ "in": "body",
630
+ "required": true,
631
+ "schema": {
632
+ "$ref": "#/definitions/WorkflowServiceUpdateActivityOptionsByIdBody"
633
+ }
634
+ }
635
+ ],
636
+ "tags": [
637
+ "WorkflowService"
638
+ ]
639
+ }
640
+ },
641
+ "/api/v1/namespaces/{namespace}/archived-workflows": {
481
642
  "get": {
482
643
  "summary": "ListArchivedWorkflowExecutions is a visibility API to list archived workflow executions in a specific namespace.",
483
- "operationId": "ListArchivedWorkflowExecutions",
644
+ "operationId": "ListArchivedWorkflowExecutions2",
484
645
  "responses": {
485
646
  "200": {
486
647
  "description": "A successful response.",
@@ -528,10 +689,10 @@
528
689
  ]
529
690
  }
530
691
  },
531
- "/namespaces/{namespace}/batch-operations": {
692
+ "/api/v1/namespaces/{namespace}/batch-operations": {
532
693
  "get": {
533
694
  "summary": "ListBatchOperations returns a list of batch operations",
534
- "operationId": "ListBatchOperations",
695
+ "operationId": "ListBatchOperations2",
535
696
  "responses": {
536
697
  "200": {
537
698
  "description": "A successful response.",
@@ -576,10 +737,10 @@
576
737
  ]
577
738
  }
578
739
  },
579
- "/namespaces/{namespace}/batch-operations/{jobId}": {
740
+ "/api/v1/namespaces/{namespace}/batch-operations/{jobId}": {
580
741
  "get": {
581
742
  "summary": "DescribeBatchOperation returns the information about a batch operation",
582
- "operationId": "DescribeBatchOperation",
743
+ "operationId": "DescribeBatchOperation2",
583
744
  "responses": {
584
745
  "200": {
585
746
  "description": "A successful response.",
@@ -616,7 +777,7 @@
616
777
  },
617
778
  "post": {
618
779
  "summary": "StartBatchOperation starts a new batch operation",
619
- "operationId": "StartBatchOperation",
780
+ "operationId": "StartBatchOperation2",
620
781
  "responses": {
621
782
  "200": {
622
783
  "description": "A successful response.",
@@ -660,10 +821,10 @@
660
821
  ]
661
822
  }
662
823
  },
663
- "/namespaces/{namespace}/batch-operations/{jobId}/stop": {
824
+ "/api/v1/namespaces/{namespace}/batch-operations/{jobId}/stop": {
664
825
  "post": {
665
826
  "summary": "StopBatchOperation stops a batch operation",
666
- "operationId": "StopBatchOperation",
827
+ "operationId": "StopBatchOperation2",
667
828
  "responses": {
668
829
  "200": {
669
830
  "description": "A successful response.",
@@ -707,10 +868,10 @@
707
868
  ]
708
869
  }
709
870
  },
710
- "/namespaces/{namespace}/schedules": {
871
+ "/api/v1/namespaces/{namespace}/schedules": {
711
872
  "get": {
712
873
  "summary": "List all schedules in a namespace.",
713
- "operationId": "ListSchedules",
874
+ "operationId": "ListSchedules2",
714
875
  "responses": {
715
876
  "200": {
716
877
  "description": "A successful response.",
@@ -762,10 +923,10 @@
762
923
  ]
763
924
  }
764
925
  },
765
- "/namespaces/{namespace}/schedules/{scheduleId}": {
926
+ "/api/v1/namespaces/{namespace}/schedules/{scheduleId}": {
766
927
  "get": {
767
928
  "summary": "Returns the schedule description and current state of an existing schedule.",
768
- "operationId": "DescribeSchedule",
929
+ "operationId": "DescribeSchedule2",
769
930
  "responses": {
770
931
  "200": {
771
932
  "description": "A successful response.",
@@ -802,7 +963,7 @@
802
963
  },
803
964
  "delete": {
804
965
  "summary": "Deletes a schedule, removing it from the system.",
805
- "operationId": "DeleteSchedule",
966
+ "operationId": "DeleteSchedule2",
806
967
  "responses": {
807
968
  "200": {
808
969
  "description": "A successful response.",
@@ -846,7 +1007,7 @@
846
1007
  },
847
1008
  "post": {
848
1009
  "summary": "Creates a new schedule.",
849
- "operationId": "CreateSchedule",
1010
+ "operationId": "CreateSchedule2",
850
1011
  "responses": {
851
1012
  "200": {
852
1013
  "description": "A successful response.",
@@ -890,10 +1051,10 @@
890
1051
  ]
891
1052
  }
892
1053
  },
893
- "/namespaces/{namespace}/schedules/{scheduleId}/matching-times": {
1054
+ "/api/v1/namespaces/{namespace}/schedules/{scheduleId}/matching-times": {
894
1055
  "get": {
895
1056
  "summary": "Lists matching times within a range.",
896
- "operationId": "ListScheduleMatchingTimes",
1057
+ "operationId": "ListScheduleMatchingTimes2",
897
1058
  "responses": {
898
1059
  "200": {
899
1060
  "description": "A successful response.",
@@ -944,10 +1105,10 @@
944
1105
  ]
945
1106
  }
946
1107
  },
947
- "/namespaces/{namespace}/schedules/{scheduleId}/patch": {
1108
+ "/api/v1/namespaces/{namespace}/schedules/{scheduleId}/patch": {
948
1109
  "post": {
949
1110
  "summary": "Makes a specific change to a schedule or triggers an immediate action.",
950
- "operationId": "PatchSchedule",
1111
+ "operationId": "PatchSchedule2",
951
1112
  "responses": {
952
1113
  "200": {
953
1114
  "description": "A successful response.",
@@ -991,10 +1152,10 @@
991
1152
  ]
992
1153
  }
993
1154
  },
994
- "/namespaces/{namespace}/schedules/{scheduleId}/update": {
1155
+ "/api/v1/namespaces/{namespace}/schedules/{scheduleId}/update": {
995
1156
  "post": {
996
1157
  "summary": "Changes the configuration or state of an existing schedule.",
997
- "operationId": "UpdateSchedule",
1158
+ "operationId": "UpdateSchedule2",
998
1159
  "responses": {
999
1160
  "200": {
1000
1161
  "description": "A successful response.",
@@ -1038,10 +1199,10 @@
1038
1199
  ]
1039
1200
  }
1040
1201
  },
1041
- "/namespaces/{namespace}/search-attributes": {
1202
+ "/api/v1/namespaces/{namespace}/search-attributes": {
1042
1203
  "get": {
1043
1204
  "summary": "ListSearchAttributes returns comprehensive information about search attributes.",
1044
- "operationId": "ListSearchAttributes",
1205
+ "operationId": "ListSearchAttributes2",
1045
1206
  "responses": {
1046
1207
  "200": {
1047
1208
  "description": "A successful response.",
@@ -1069,10 +1230,10 @@
1069
1230
  ]
1070
1231
  }
1071
1232
  },
1072
- "/namespaces/{namespace}/task-queues/{taskQueue.name}": {
1233
+ "/api/v1/namespaces/{namespace}/task-queues/{taskQueue.name}": {
1073
1234
  "get": {
1074
1235
  "summary": "DescribeTaskQueue returns the following information about the target task queue, broken down by Build ID:\n - List of pollers\n - Workflow Reachability status\n - Backlog info for Workflow and/or Activity tasks",
1075
- "operationId": "DescribeTaskQueue",
1236
+ "operationId": "DescribeTaskQueue2",
1076
1237
  "responses": {
1077
1238
  "200": {
1078
1239
  "description": "A successful response.",
@@ -1173,7 +1334,7 @@
1173
1334
  },
1174
1335
  {
1175
1336
  "name": "versions.allActive",
1176
- "description": "Include all active versions. A version is considered active if it has had new\ntasks or polls recently.",
1337
+ "description": "Include all active versions. A version is considered active if, in the last few minutes,\nit has had new tasks or polls, or it has been the subject of certain task queue API calls.",
1177
1338
  "in": "query",
1178
1339
  "required": false,
1179
1340
  "type": "boolean"
@@ -1222,10 +1383,10 @@
1222
1383
  ]
1223
1384
  }
1224
1385
  },
1225
- "/namespaces/{namespace}/task-queues/{taskQueue}/worker-build-id-compatibility": {
1386
+ "/api/v1/namespaces/{namespace}/task-queues/{taskQueue}/worker-build-id-compatibility": {
1226
1387
  "get": {
1227
1388
  "summary": "Deprecated. Use `GetWorkerVersioningRules`.\nFetches the worker build id versioning sets for a task queue.",
1228
- "operationId": "GetWorkerBuildIdCompatibility",
1389
+ "operationId": "GetWorkerBuildIdCompatibility2",
1229
1390
  "responses": {
1230
1391
  "200": {
1231
1392
  "description": "A successful response.",
@@ -1268,10 +1429,10 @@
1268
1429
  ]
1269
1430
  }
1270
1431
  },
1271
- "/namespaces/{namespace}/task-queues/{taskQueue}/worker-versioning-rules": {
1432
+ "/api/v1/namespaces/{namespace}/task-queues/{taskQueue}/worker-versioning-rules": {
1272
1433
  "get": {
1273
1434
  "summary": "Fetches the Build ID assignment and redirect rules for a Task Queue.\nWARNING: Worker Versioning is not yet stable and the API and behavior may change incompatibly.",
1274
- "operationId": "GetWorkerVersioningRules",
1435
+ "operationId": "GetWorkerVersioningRules2",
1275
1436
  "responses": {
1276
1437
  "200": {
1277
1438
  "description": "A successful response.",
@@ -1305,10 +1466,10 @@
1305
1466
  ]
1306
1467
  }
1307
1468
  },
1308
- "/namespaces/{namespace}/update": {
1469
+ "/api/v1/namespaces/{namespace}/update": {
1309
1470
  "post": {
1310
1471
  "summary": "UpdateNamespace is used to update the information and configuration of a registered\nnamespace.",
1311
- "operationId": "UpdateNamespace",
1472
+ "operationId": "UpdateNamespace2",
1312
1473
  "responses": {
1313
1474
  "200": {
1314
1475
  "description": "A successful response.",
@@ -1344,11 +1505,11 @@
1344
1505
  ]
1345
1506
  }
1346
1507
  },
1347
- "/namespaces/{namespace}/worker-task-reachability": {
1508
+ "/api/v1/namespaces/{namespace}/worker-task-reachability": {
1348
1509
  "get": {
1349
1510
  "summary": "Deprecated. Use `DescribeTaskQueue`.",
1350
1511
  "description": "Fetches task reachability to determine whether a worker may be retired.\nThe request may specify task queues to query for or let the server fetch all task queues mapped to the given\nbuild IDs.\n\nWhen requesting a large number of task queues or all task queues associated with the given build ids in a\nnamespace, all task queues will be listed in the response but some of them may not contain reachability\ninformation due to a server enforced limit. When reaching the limit, task queues that reachability information\ncould not be retrieved for will be marked with a single TASK_REACHABILITY_UNSPECIFIED entry. The caller may issue\nanother call to get the reachability for those task queues.\n\nOpen source users can adjust this limit by setting the server's dynamic config value for\n`limit.reachabilityTaskQueueScan` with the caveat that this call can strain the visibility store.",
1351
- "operationId": "GetWorkerTaskReachability",
1512
+ "operationId": "GetWorkerTaskReachability2",
1352
1513
  "responses": {
1353
1514
  "200": {
1354
1515
  "description": "A successful response.",
@@ -1413,10 +1574,10 @@
1413
1574
  ]
1414
1575
  }
1415
1576
  },
1416
- "/namespaces/{namespace}/workflow-count": {
1577
+ "/api/v1/namespaces/{namespace}/workflow-count": {
1417
1578
  "get": {
1418
1579
  "summary": "CountWorkflowExecutions is a visibility API to count of workflow executions in a specific namespace.",
1419
- "operationId": "CountWorkflowExecutions",
1580
+ "operationId": "CountWorkflowExecutions2",
1420
1581
  "responses": {
1421
1582
  "200": {
1422
1583
  "description": "A successful response.",
@@ -1450,10 +1611,10 @@
1450
1611
  ]
1451
1612
  }
1452
1613
  },
1453
- "/namespaces/{namespace}/workflows": {
1614
+ "/api/v1/namespaces/{namespace}/workflows": {
1454
1615
  "get": {
1455
1616
  "summary": "ListWorkflowExecutions is a visibility API to list workflow executions in a specific namespace.",
1456
- "operationId": "ListWorkflowExecutions",
1617
+ "operationId": "ListWorkflowExecutions2",
1457
1618
  "responses": {
1458
1619
  "200": {
1459
1620
  "description": "A successful response.",
@@ -1501,11 +1662,11 @@
1501
1662
  ]
1502
1663
  }
1503
1664
  },
1504
- "/namespaces/{namespace}/workflows/execute-multi-operation": {
1665
+ "/api/v1/namespaces/{namespace}/workflows/execute-multi-operation": {
1505
1666
  "post": {
1506
1667
  "summary": "ExecuteMultiOperation executes multiple operations within a single workflow.",
1507
1668
  "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.",
1508
- "operationId": "ExecuteMultiOperation",
1669
+ "operationId": "ExecuteMultiOperation2",
1509
1670
  "responses": {
1510
1671
  "200": {
1511
1672
  "description": "A successful response.",
@@ -1541,10 +1702,10 @@
1541
1702
  ]
1542
1703
  }
1543
1704
  },
1544
- "/namespaces/{namespace}/workflows/{execution.workflowId}": {
1705
+ "/api/v1/namespaces/{namespace}/workflows/{execution.workflowId}": {
1545
1706
  "get": {
1546
1707
  "summary": "DescribeWorkflowExecution returns information about the specified workflow execution.",
1547
- "operationId": "DescribeWorkflowExecution",
1708
+ "operationId": "DescribeWorkflowExecution2",
1548
1709
  "responses": {
1549
1710
  "200": {
1550
1711
  "description": "A successful response.",
@@ -1584,10 +1745,10 @@
1584
1745
  ]
1585
1746
  }
1586
1747
  },
1587
- "/namespaces/{namespace}/workflows/{execution.workflowId}/history": {
1748
+ "/api/v1/namespaces/{namespace}/workflows/{execution.workflowId}/history": {
1588
1749
  "get": {
1589
1750
  "summary": "GetWorkflowExecutionHistory returns the history of specified workflow execution. Fails with\n`NotFound` if the specified workflow execution is unknown to the service.",
1590
- "operationId": "GetWorkflowExecutionHistory",
1751
+ "operationId": "GetWorkflowExecutionHistory2",
1591
1752
  "responses": {
1592
1753
  "200": {
1593
1754
  "description": "A successful response.",
@@ -1668,10 +1829,10 @@
1668
1829
  ]
1669
1830
  }
1670
1831
  },
1671
- "/namespaces/{namespace}/workflows/{execution.workflowId}/history-reverse": {
1832
+ "/api/v1/namespaces/{namespace}/workflows/{execution.workflowId}/history-reverse": {
1672
1833
  "get": {
1673
1834
  "summary": "GetWorkflowExecutionHistoryReverse returns the history of specified workflow execution in reverse \norder (starting from last event). Fails with`NotFound` if the specified workflow execution is \nunknown to the service.",
1674
- "operationId": "GetWorkflowExecutionHistoryReverse",
1835
+ "operationId": "GetWorkflowExecutionHistoryReverse2",
1675
1836
  "responses": {
1676
1837
  "200": {
1677
1838
  "description": "A successful response.",
@@ -1725,10 +1886,10 @@
1725
1886
  ]
1726
1887
  }
1727
1888
  },
1728
- "/namespaces/{namespace}/workflows/{execution.workflowId}/query/{query.queryType}": {
1889
+ "/api/v1/namespaces/{namespace}/workflows/{execution.workflowId}/query/{query.queryType}": {
1729
1890
  "post": {
1730
1891
  "summary": "QueryWorkflow requests a query be executed for a specified workflow execution.",
1731
- "operationId": "QueryWorkflow",
1892
+ "operationId": "QueryWorkflow2",
1732
1893
  "responses": {
1733
1894
  "200": {
1734
1895
  "description": "A successful response.",
@@ -1777,11 +1938,11 @@
1777
1938
  ]
1778
1939
  }
1779
1940
  },
1780
- "/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/cancel": {
1941
+ "/api/v1/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/cancel": {
1781
1942
  "post": {
1782
1943
  "summary": "RequestCancelWorkflowExecution is called by workers when they want to request cancellation of\na workflow execution.",
1783
1944
  "description": "This results in a new `WORKFLOW_EXECUTION_CANCEL_REQUESTED` event being written to the\nworkflow history and a new workflow task created for the workflow. It returns success if the requested\nworkflow is already closed. It fails with 'NotFound' if the requested workflow doesn't exist.",
1784
- "operationId": "RequestCancelWorkflowExecution",
1945
+ "operationId": "RequestCancelWorkflowExecution2",
1785
1946
  "responses": {
1786
1947
  "200": {
1787
1948
  "description": "A successful response.",
@@ -1823,10 +1984,10 @@
1823
1984
  ]
1824
1985
  }
1825
1986
  },
1826
- "/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/reset": {
1987
+ "/api/v1/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/reset": {
1827
1988
  "post": {
1828
1989
  "summary": "ResetWorkflowExecution will reset an existing workflow execution to a specified\n`WORKFLOW_TASK_COMPLETED` event (exclusive). It will immediately terminate the current\nexecution instance.\nTODO: Does exclusive here mean *just* the completed event, or also WFT started? Otherwise the task is doomed to time out?",
1829
- "operationId": "ResetWorkflowExecution",
1990
+ "operationId": "ResetWorkflowExecution2",
1830
1991
  "responses": {
1831
1992
  "200": {
1832
1993
  "description": "A successful response.",
@@ -1868,11 +2029,11 @@
1868
2029
  ]
1869
2030
  }
1870
2031
  },
1871
- "/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/signal/{signalName}": {
2032
+ "/api/v1/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/signal/{signalName}": {
1872
2033
  "post": {
1873
2034
  "summary": "SignalWorkflowExecution is used to send a signal to a running workflow execution.",
1874
2035
  "description": "This results in a `WORKFLOW_EXECUTION_SIGNALED` event recorded in the history and a workflow\ntask being created for the execution.",
1875
- "operationId": "SignalWorkflowExecution",
2036
+ "operationId": "SignalWorkflowExecution2",
1876
2037
  "responses": {
1877
2038
  "200": {
1878
2039
  "description": "A successful response.",
@@ -1921,10 +2082,10 @@
1921
2082
  ]
1922
2083
  }
1923
2084
  },
1924
- "/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/terminate": {
2085
+ "/api/v1/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/terminate": {
1925
2086
  "post": {
1926
2087
  "summary": "TerminateWorkflowExecution terminates an existing workflow execution by recording a\n`WORKFLOW_EXECUTION_TERMINATED` event in the history and immediately terminating the\nexecution instance.",
1927
- "operationId": "TerminateWorkflowExecution",
2088
+ "operationId": "TerminateWorkflowExecution2",
1928
2089
  "responses": {
1929
2090
  "200": {
1930
2091
  "description": "A successful response.",
@@ -1966,10 +2127,10 @@
1966
2127
  ]
1967
2128
  }
1968
2129
  },
1969
- "/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/update/{request.input.name}": {
2130
+ "/api/v1/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/update/{request.input.name}": {
1970
2131
  "post": {
1971
- "summary": "Invokes the specified update function on user workflow code.",
1972
- "operationId": "UpdateWorkflowExecution",
2132
+ "summary": "Invokes the specified Update function on user Workflow code.",
2133
+ "operationId": "UpdateWorkflowExecution2",
1973
2134
  "responses": {
1974
2135
  "200": {
1975
2136
  "description": "A successful response.",
@@ -1987,7 +2148,7 @@
1987
2148
  "parameters": [
1988
2149
  {
1989
2150
  "name": "namespace",
1990
- "description": "The namespace name of the target workflow",
2151
+ "description": "The namespace name of the target Workflow.",
1991
2152
  "in": "path",
1992
2153
  "required": true,
1993
2154
  "type": "string"
@@ -2000,7 +2161,7 @@
2000
2161
  },
2001
2162
  {
2002
2163
  "name": "request.input.name",
2003
- "description": "The name of the input handler to invoke on the target workflow",
2164
+ "description": "The name of the Update handler to invoke on the target Workflow.",
2004
2165
  "in": "path",
2005
2166
  "required": true,
2006
2167
  "type": "string"
@@ -2019,11 +2180,11 @@
2019
2180
  ]
2020
2181
  }
2021
2182
  },
2022
- "/namespaces/{namespace}/workflows/{workflowId}": {
2183
+ "/api/v1/namespaces/{namespace}/workflows/{workflowId}": {
2023
2184
  "post": {
2024
2185
  "summary": "StartWorkflowExecution starts a new workflow execution.",
2025
2186
  "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.",
2026
- "operationId": "StartWorkflowExecution",
2187
+ "operationId": "StartWorkflowExecution2",
2027
2188
  "responses": {
2028
2189
  "200": {
2029
2190
  "description": "A successful response.",
@@ -2065,11 +2226,11 @@
2065
2226
  ]
2066
2227
  }
2067
2228
  },
2068
- "/namespaces/{namespace}/workflows/{workflowId}/signal-with-start/{signalName}": {
2229
+ "/api/v1/namespaces/{namespace}/workflows/{workflowId}/signal-with-start/{signalName}": {
2069
2230
  "post": {
2070
2231
  "summary": "SignalWithStartWorkflowExecution is used to ensure a signal is sent to a workflow, even if\nit isn't yet started.",
2071
2232
  "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.",
2072
- "operationId": "SignalWithStartWorkflowExecution",
2233
+ "operationId": "SignalWithStartWorkflowExecution2",
2073
2234
  "responses": {
2074
2235
  "200": {
2075
2236
  "description": "A successful response.",
@@ -2118,10 +2279,10 @@
2118
2279
  ]
2119
2280
  }
2120
2281
  },
2121
- "/nexus/endpoints": {
2282
+ "/api/v1/nexus/endpoints": {
2122
2283
  "get": {
2123
2284
  "summary": "List all Nexus endpoints for the cluster, sorted by ID in ascending order. Set page_token in the request to the\nnext_page_token field of the previous response to get the next page of results. An empty next_page_token\nindicates that there are no more results. During pagination, a newly added service with an ID lexicographically\nearlier than the previous page's last endpoint's ID may be missed.",
2124
- "operationId": "ListNexusEndpoints",
2285
+ "operationId": "ListNexusEndpoints2",
2125
2286
  "responses": {
2126
2287
  "200": {
2127
2288
  "description": "A successful response.",
@@ -2166,7 +2327,7 @@
2166
2327
  },
2167
2328
  "post": {
2168
2329
  "summary": "Create a Nexus endpoint. This will fail if an endpoint with the same name is already registered with a status of\nALREADY_EXISTS.\nReturns the created endpoint with its initial version. You may use this version for subsequent updates.",
2169
- "operationId": "CreateNexusEndpoint",
2330
+ "operationId": "CreateNexusEndpoint2",
2170
2331
  "responses": {
2171
2332
  "200": {
2172
2333
  "description": "A successful response.",
@@ -2196,10 +2357,10 @@
2196
2357
  ]
2197
2358
  }
2198
2359
  },
2199
- "/nexus/endpoints/{id}": {
2360
+ "/api/v1/nexus/endpoints/{id}": {
2200
2361
  "get": {
2201
2362
  "summary": "Get a registered Nexus endpoint by ID. The returned version can be used for optimistic updates.",
2202
- "operationId": "GetNexusEndpoint",
2363
+ "operationId": "GetNexusEndpoint2",
2203
2364
  "responses": {
2204
2365
  "200": {
2205
2366
  "description": "A successful response.",
@@ -2229,7 +2390,7 @@
2229
2390
  },
2230
2391
  "delete": {
2231
2392
  "summary": "Delete an incoming Nexus service by ID.",
2232
- "operationId": "DeleteNexusEndpoint",
2393
+ "operationId": "DeleteNexusEndpoint2",
2233
2394
  "responses": {
2234
2395
  "200": {
2235
2396
  "description": "A successful response.",
@@ -2266,10 +2427,10 @@
2266
2427
  ]
2267
2428
  }
2268
2429
  },
2269
- "/nexus/endpoints/{id}/update": {
2430
+ "/api/v1/nexus/endpoints/{id}/update": {
2270
2431
  "post": {
2271
2432
  "summary": "Optimistically update a Nexus endpoint based on provided version as obtained via the `GetNexusEndpoint` or\n`ListNexusEndpointResponse` APIs. This will fail with a status of FAILED_PRECONDITION if the version does not\nmatch.\nReturns the updated endpoint with its updated version. You may use this version for subsequent updates. You don't\nneed to increment the version yourself. The server will increment the version for you after each update.",
2272
- "operationId": "UpdateNexusEndpoint",
2433
+ "operationId": "UpdateNexusEndpoint2",
2273
2434
  "responses": {
2274
2435
  "200": {
2275
2436
  "description": "A successful response.",
@@ -2306,10 +2467,10 @@
2306
2467
  ]
2307
2468
  }
2308
2469
  },
2309
- "/system-info": {
2470
+ "/api/v1/system-info": {
2310
2471
  "get": {
2311
2472
  "summary": "GetSystemInfo returns information about the system.",
2312
- "operationId": "GetSystemInfo",
2473
+ "operationId": "GetSystemInfo2",
2313
2474
  "responses": {
2314
2475
  "200": {
2315
2476
  "description": "A successful response.",
@@ -2328,20 +2489,2502 @@
2328
2489
  "WorkflowService"
2329
2490
  ]
2330
2491
  }
2331
- }
2332
- },
2333
- "definitions": {
2334
- "CallbackInfoTrigger": {
2335
- "type": "object",
2336
- "properties": {
2337
- "workflowClosed": {
2338
- "$ref": "#/definitions/CallbackInfoWorkflowClosed"
2339
- }
2492
+ },
2493
+ "/cluster": {
2494
+ "get": {
2495
+ "summary": "GetClusterInfo returns information about temporal cluster",
2496
+ "operationId": "GetClusterInfo",
2497
+ "responses": {
2498
+ "200": {
2499
+ "description": "A successful response.",
2500
+ "schema": {
2501
+ "$ref": "#/definitions/v1GetClusterInfoResponse"
2502
+ }
2503
+ },
2504
+ "default": {
2505
+ "description": "An unexpected error response.",
2506
+ "schema": {
2507
+ "$ref": "#/definitions/rpcStatus"
2508
+ }
2509
+ }
2510
+ },
2511
+ "tags": [
2512
+ "WorkflowService"
2513
+ ]
2340
2514
  }
2341
2515
  },
2342
- "CallbackInfoWorkflowClosed": {
2343
- "type": "object",
2344
- "description": "Trigger for when the workflow is closed."
2516
+ "/cluster/namespaces": {
2517
+ "get": {
2518
+ "summary": "ListNamespaces returns the information and configuration for all namespaces.",
2519
+ "operationId": "ListNamespaces",
2520
+ "responses": {
2521
+ "200": {
2522
+ "description": "A successful response.",
2523
+ "schema": {
2524
+ "$ref": "#/definitions/v1ListNamespacesResponse"
2525
+ }
2526
+ },
2527
+ "default": {
2528
+ "description": "An unexpected error response.",
2529
+ "schema": {
2530
+ "$ref": "#/definitions/rpcStatus"
2531
+ }
2532
+ }
2533
+ },
2534
+ "parameters": [
2535
+ {
2536
+ "name": "pageSize",
2537
+ "in": "query",
2538
+ "required": false,
2539
+ "type": "integer",
2540
+ "format": "int32"
2541
+ },
2542
+ {
2543
+ "name": "nextPageToken",
2544
+ "in": "query",
2545
+ "required": false,
2546
+ "type": "string",
2547
+ "format": "byte"
2548
+ },
2549
+ {
2550
+ "name": "namespaceFilter.includeDeleted",
2551
+ "description": "By default namespaces in NAMESPACE_STATE_DELETED state are not included.\nSetting include_deleted to true will include deleted namespaces.\nNote: Namespace is in NAMESPACE_STATE_DELETED state when it was deleted from the system but associated data is not deleted yet.",
2552
+ "in": "query",
2553
+ "required": false,
2554
+ "type": "boolean"
2555
+ }
2556
+ ],
2557
+ "tags": [
2558
+ "WorkflowService"
2559
+ ]
2560
+ },
2561
+ "post": {
2562
+ "summary": "RegisterNamespace creates a new namespace which can be used as a container for all resources.",
2563
+ "description": "A Namespace is a top level entity within Temporal, and is used as a container for resources\nlike workflow executions, task queues, etc. A Namespace acts as a sandbox and provides\nisolation for all resources within the namespace. All resources belongs to exactly one\nnamespace.",
2564
+ "operationId": "RegisterNamespace",
2565
+ "responses": {
2566
+ "200": {
2567
+ "description": "A successful response.",
2568
+ "schema": {
2569
+ "$ref": "#/definitions/v1RegisterNamespaceResponse"
2570
+ }
2571
+ },
2572
+ "default": {
2573
+ "description": "An unexpected error response.",
2574
+ "schema": {
2575
+ "$ref": "#/definitions/rpcStatus"
2576
+ }
2577
+ }
2578
+ },
2579
+ "parameters": [
2580
+ {
2581
+ "name": "body",
2582
+ "in": "body",
2583
+ "required": true,
2584
+ "schema": {
2585
+ "$ref": "#/definitions/v1RegisterNamespaceRequest"
2586
+ }
2587
+ }
2588
+ ],
2589
+ "tags": [
2590
+ "WorkflowService"
2591
+ ]
2592
+ }
2593
+ },
2594
+ "/cluster/namespaces/{namespace}": {
2595
+ "get": {
2596
+ "summary": "DescribeNamespace returns the information and configuration for a registered namespace.",
2597
+ "operationId": "DescribeNamespace",
2598
+ "responses": {
2599
+ "200": {
2600
+ "description": "A successful response.",
2601
+ "schema": {
2602
+ "$ref": "#/definitions/v1DescribeNamespaceResponse"
2603
+ }
2604
+ },
2605
+ "default": {
2606
+ "description": "An unexpected error response.",
2607
+ "schema": {
2608
+ "$ref": "#/definitions/rpcStatus"
2609
+ }
2610
+ }
2611
+ },
2612
+ "parameters": [
2613
+ {
2614
+ "name": "namespace",
2615
+ "in": "path",
2616
+ "required": true,
2617
+ "type": "string"
2618
+ },
2619
+ {
2620
+ "name": "id",
2621
+ "in": "query",
2622
+ "required": false,
2623
+ "type": "string"
2624
+ }
2625
+ ],
2626
+ "tags": [
2627
+ "WorkflowService"
2628
+ ]
2629
+ }
2630
+ },
2631
+ "/cluster/namespaces/{namespace}/search-attributes": {
2632
+ "get": {
2633
+ "summary": "ListSearchAttributes returns comprehensive information about search attributes.",
2634
+ "operationId": "ListSearchAttributes",
2635
+ "responses": {
2636
+ "200": {
2637
+ "description": "A successful response.",
2638
+ "schema": {
2639
+ "$ref": "#/definitions/v1ListSearchAttributesResponse"
2640
+ }
2641
+ },
2642
+ "default": {
2643
+ "description": "An unexpected error response.",
2644
+ "schema": {
2645
+ "$ref": "#/definitions/rpcStatus"
2646
+ }
2647
+ }
2648
+ },
2649
+ "parameters": [
2650
+ {
2651
+ "name": "namespace",
2652
+ "in": "path",
2653
+ "required": true,
2654
+ "type": "string"
2655
+ }
2656
+ ],
2657
+ "tags": [
2658
+ "OperatorService"
2659
+ ]
2660
+ }
2661
+ },
2662
+ "/cluster/namespaces/{namespace}/update": {
2663
+ "post": {
2664
+ "summary": "UpdateNamespace is used to update the information and configuration of a registered\nnamespace.",
2665
+ "operationId": "UpdateNamespace",
2666
+ "responses": {
2667
+ "200": {
2668
+ "description": "A successful response.",
2669
+ "schema": {
2670
+ "$ref": "#/definitions/v1UpdateNamespaceResponse"
2671
+ }
2672
+ },
2673
+ "default": {
2674
+ "description": "An unexpected error response.",
2675
+ "schema": {
2676
+ "$ref": "#/definitions/rpcStatus"
2677
+ }
2678
+ }
2679
+ },
2680
+ "parameters": [
2681
+ {
2682
+ "name": "namespace",
2683
+ "in": "path",
2684
+ "required": true,
2685
+ "type": "string"
2686
+ },
2687
+ {
2688
+ "name": "body",
2689
+ "in": "body",
2690
+ "required": true,
2691
+ "schema": {
2692
+ "$ref": "#/definitions/WorkflowServiceUpdateNamespaceBody"
2693
+ }
2694
+ }
2695
+ ],
2696
+ "tags": [
2697
+ "WorkflowService"
2698
+ ]
2699
+ }
2700
+ },
2701
+ "/cluster/nexus/endpoints": {
2702
+ "get": {
2703
+ "summary": "List all Nexus endpoints for the cluster, sorted by ID in ascending order. Set page_token in the request to the\nnext_page_token field of the previous response to get the next page of results. An empty next_page_token\nindicates that there are no more results. During pagination, a newly added service with an ID lexicographically\nearlier than the previous page's last endpoint's ID may be missed.",
2704
+ "operationId": "ListNexusEndpoints",
2705
+ "responses": {
2706
+ "200": {
2707
+ "description": "A successful response.",
2708
+ "schema": {
2709
+ "$ref": "#/definitions/v1ListNexusEndpointsResponse"
2710
+ }
2711
+ },
2712
+ "default": {
2713
+ "description": "An unexpected error response.",
2714
+ "schema": {
2715
+ "$ref": "#/definitions/rpcStatus"
2716
+ }
2717
+ }
2718
+ },
2719
+ "parameters": [
2720
+ {
2721
+ "name": "pageSize",
2722
+ "in": "query",
2723
+ "required": false,
2724
+ "type": "integer",
2725
+ "format": "int32"
2726
+ },
2727
+ {
2728
+ "name": "nextPageToken",
2729
+ "description": "To get the next page, pass in `ListNexusEndpointsResponse.next_page_token` from the previous page's\nresponse, the token will be empty if there's no other page.\nNote: the last page may be empty if the total number of endpoints registered is a multiple of the page size.",
2730
+ "in": "query",
2731
+ "required": false,
2732
+ "type": "string",
2733
+ "format": "byte"
2734
+ },
2735
+ {
2736
+ "name": "name",
2737
+ "description": "Name of the incoming endpoint to filter on - optional. Specifying this will result in zero or one results.",
2738
+ "in": "query",
2739
+ "required": false,
2740
+ "type": "string"
2741
+ }
2742
+ ],
2743
+ "tags": [
2744
+ "OperatorService"
2745
+ ]
2746
+ },
2747
+ "post": {
2748
+ "summary": "Create a Nexus endpoint. This will fail if an endpoint with the same name is already registered with a status of\nALREADY_EXISTS.\nReturns the created endpoint with its initial version. You may use this version for subsequent updates.",
2749
+ "operationId": "CreateNexusEndpoint",
2750
+ "responses": {
2751
+ "200": {
2752
+ "description": "A successful response.",
2753
+ "schema": {
2754
+ "$ref": "#/definitions/v1CreateNexusEndpointResponse"
2755
+ }
2756
+ },
2757
+ "default": {
2758
+ "description": "An unexpected error response.",
2759
+ "schema": {
2760
+ "$ref": "#/definitions/rpcStatus"
2761
+ }
2762
+ }
2763
+ },
2764
+ "parameters": [
2765
+ {
2766
+ "name": "body",
2767
+ "in": "body",
2768
+ "required": true,
2769
+ "schema": {
2770
+ "$ref": "#/definitions/v1CreateNexusEndpointRequest"
2771
+ }
2772
+ }
2773
+ ],
2774
+ "tags": [
2775
+ "OperatorService"
2776
+ ]
2777
+ }
2778
+ },
2779
+ "/cluster/nexus/endpoints/{id}": {
2780
+ "get": {
2781
+ "summary": "Get a registered Nexus endpoint by ID. The returned version can be used for optimistic updates.",
2782
+ "operationId": "GetNexusEndpoint",
2783
+ "responses": {
2784
+ "200": {
2785
+ "description": "A successful response.",
2786
+ "schema": {
2787
+ "$ref": "#/definitions/v1GetNexusEndpointResponse"
2788
+ }
2789
+ },
2790
+ "default": {
2791
+ "description": "An unexpected error response.",
2792
+ "schema": {
2793
+ "$ref": "#/definitions/rpcStatus"
2794
+ }
2795
+ }
2796
+ },
2797
+ "parameters": [
2798
+ {
2799
+ "name": "id",
2800
+ "description": "Server-generated unique endpoint ID.",
2801
+ "in": "path",
2802
+ "required": true,
2803
+ "type": "string"
2804
+ }
2805
+ ],
2806
+ "tags": [
2807
+ "OperatorService"
2808
+ ]
2809
+ },
2810
+ "delete": {
2811
+ "summary": "Delete an incoming Nexus service by ID.",
2812
+ "operationId": "DeleteNexusEndpoint",
2813
+ "responses": {
2814
+ "200": {
2815
+ "description": "A successful response.",
2816
+ "schema": {
2817
+ "$ref": "#/definitions/v1DeleteNexusEndpointResponse"
2818
+ }
2819
+ },
2820
+ "default": {
2821
+ "description": "An unexpected error response.",
2822
+ "schema": {
2823
+ "$ref": "#/definitions/rpcStatus"
2824
+ }
2825
+ }
2826
+ },
2827
+ "parameters": [
2828
+ {
2829
+ "name": "id",
2830
+ "description": "Server-generated unique endpoint ID.",
2831
+ "in": "path",
2832
+ "required": true,
2833
+ "type": "string"
2834
+ },
2835
+ {
2836
+ "name": "version",
2837
+ "description": "Data version for this endpoint. Must match current version.",
2838
+ "in": "query",
2839
+ "required": false,
2840
+ "type": "string",
2841
+ "format": "int64"
2842
+ }
2843
+ ],
2844
+ "tags": [
2845
+ "OperatorService"
2846
+ ]
2847
+ }
2848
+ },
2849
+ "/cluster/nexus/endpoints/{id}/update": {
2850
+ "post": {
2851
+ "summary": "Optimistically update a Nexus endpoint based on provided version as obtained via the `GetNexusEndpoint` or\n`ListNexusEndpointResponse` APIs. This will fail with a status of FAILED_PRECONDITION if the version does not\nmatch.\nReturns the updated endpoint with its updated version. You may use this version for subsequent updates. You don't\nneed to increment the version yourself. The server will increment the version for you after each update.",
2852
+ "operationId": "UpdateNexusEndpoint",
2853
+ "responses": {
2854
+ "200": {
2855
+ "description": "A successful response.",
2856
+ "schema": {
2857
+ "$ref": "#/definitions/v1UpdateNexusEndpointResponse"
2858
+ }
2859
+ },
2860
+ "default": {
2861
+ "description": "An unexpected error response.",
2862
+ "schema": {
2863
+ "$ref": "#/definitions/rpcStatus"
2864
+ }
2865
+ }
2866
+ },
2867
+ "parameters": [
2868
+ {
2869
+ "name": "id",
2870
+ "description": "Server-generated unique endpoint ID.",
2871
+ "in": "path",
2872
+ "required": true,
2873
+ "type": "string"
2874
+ },
2875
+ {
2876
+ "name": "body",
2877
+ "in": "body",
2878
+ "required": true,
2879
+ "schema": {
2880
+ "$ref": "#/definitions/OperatorServiceUpdateNexusEndpointBody"
2881
+ }
2882
+ }
2883
+ ],
2884
+ "tags": [
2885
+ "OperatorService"
2886
+ ]
2887
+ }
2888
+ },
2889
+ "/namespaces/{namespace}/activities/cancel": {
2890
+ "post": {
2891
+ "summary": "RespondActivityTaskFailed is called by workers when processing an activity task fails.",
2892
+ "description": "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.",
2893
+ "operationId": "RespondActivityTaskCanceled",
2894
+ "responses": {
2895
+ "200": {
2896
+ "description": "A successful response.",
2897
+ "schema": {
2898
+ "$ref": "#/definitions/v1RespondActivityTaskCanceledResponse"
2899
+ }
2900
+ },
2901
+ "default": {
2902
+ "description": "An unexpected error response.",
2903
+ "schema": {
2904
+ "$ref": "#/definitions/rpcStatus"
2905
+ }
2906
+ }
2907
+ },
2908
+ "parameters": [
2909
+ {
2910
+ "name": "namespace",
2911
+ "in": "path",
2912
+ "required": true,
2913
+ "type": "string"
2914
+ },
2915
+ {
2916
+ "name": "body",
2917
+ "in": "body",
2918
+ "required": true,
2919
+ "schema": {
2920
+ "$ref": "#/definitions/WorkflowServiceRespondActivityTaskCanceledBody"
2921
+ }
2922
+ }
2923
+ ],
2924
+ "tags": [
2925
+ "WorkflowService"
2926
+ ]
2927
+ }
2928
+ },
2929
+ "/namespaces/{namespace}/activities/cancel-by-id": {
2930
+ "post": {
2931
+ "summary": "See `RecordActivityTaskCanceled`. This version allows clients to record failures by\nnamespace/workflow id/activity id instead of task token.",
2932
+ "operationId": "RespondActivityTaskCanceledById",
2933
+ "responses": {
2934
+ "200": {
2935
+ "description": "A successful response.",
2936
+ "schema": {
2937
+ "$ref": "#/definitions/v1RespondActivityTaskCanceledByIdResponse"
2938
+ }
2939
+ },
2940
+ "default": {
2941
+ "description": "An unexpected error response.",
2942
+ "schema": {
2943
+ "$ref": "#/definitions/rpcStatus"
2944
+ }
2945
+ }
2946
+ },
2947
+ "parameters": [
2948
+ {
2949
+ "name": "namespace",
2950
+ "description": "Namespace of the workflow which scheduled this activity",
2951
+ "in": "path",
2952
+ "required": true,
2953
+ "type": "string"
2954
+ },
2955
+ {
2956
+ "name": "body",
2957
+ "in": "body",
2958
+ "required": true,
2959
+ "schema": {
2960
+ "$ref": "#/definitions/WorkflowServiceRespondActivityTaskCanceledByIdBody"
2961
+ }
2962
+ }
2963
+ ],
2964
+ "tags": [
2965
+ "WorkflowService"
2966
+ ]
2967
+ }
2968
+ },
2969
+ "/namespaces/{namespace}/activities/complete": {
2970
+ "post": {
2971
+ "summary": "RespondActivityTaskCompleted is called by workers when they successfully complete an activity\ntask.",
2972
+ "description": "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.",
2973
+ "operationId": "RespondActivityTaskCompleted",
2974
+ "responses": {
2975
+ "200": {
2976
+ "description": "A successful response.",
2977
+ "schema": {
2978
+ "$ref": "#/definitions/v1RespondActivityTaskCompletedResponse"
2979
+ }
2980
+ },
2981
+ "default": {
2982
+ "description": "An unexpected error response.",
2983
+ "schema": {
2984
+ "$ref": "#/definitions/rpcStatus"
2985
+ }
2986
+ }
2987
+ },
2988
+ "parameters": [
2989
+ {
2990
+ "name": "namespace",
2991
+ "in": "path",
2992
+ "required": true,
2993
+ "type": "string"
2994
+ },
2995
+ {
2996
+ "name": "body",
2997
+ "in": "body",
2998
+ "required": true,
2999
+ "schema": {
3000
+ "$ref": "#/definitions/WorkflowServiceRespondActivityTaskCompletedBody"
3001
+ }
3002
+ }
3003
+ ],
3004
+ "tags": [
3005
+ "WorkflowService"
3006
+ ]
3007
+ }
3008
+ },
3009
+ "/namespaces/{namespace}/activities/complete-by-id": {
3010
+ "post": {
3011
+ "summary": "See `RecordActivityTaskCompleted`. This version allows clients to record completions by\nnamespace/workflow id/activity id instead of task token.",
3012
+ "operationId": "RespondActivityTaskCompletedById",
3013
+ "responses": {
3014
+ "200": {
3015
+ "description": "A successful response.",
3016
+ "schema": {
3017
+ "$ref": "#/definitions/v1RespondActivityTaskCompletedByIdResponse"
3018
+ }
3019
+ },
3020
+ "default": {
3021
+ "description": "An unexpected error response.",
3022
+ "schema": {
3023
+ "$ref": "#/definitions/rpcStatus"
3024
+ }
3025
+ }
3026
+ },
3027
+ "parameters": [
3028
+ {
3029
+ "name": "namespace",
3030
+ "description": "Namespace of the workflow which scheduled this activity",
3031
+ "in": "path",
3032
+ "required": true,
3033
+ "type": "string"
3034
+ },
3035
+ {
3036
+ "name": "body",
3037
+ "in": "body",
3038
+ "required": true,
3039
+ "schema": {
3040
+ "$ref": "#/definitions/WorkflowServiceRespondActivityTaskCompletedByIdBody"
3041
+ }
3042
+ }
3043
+ ],
3044
+ "tags": [
3045
+ "WorkflowService"
3046
+ ]
3047
+ }
3048
+ },
3049
+ "/namespaces/{namespace}/activities/fail": {
3050
+ "post": {
3051
+ "summary": "RespondActivityTaskFailed is called by workers when processing an activity task fails.",
3052
+ "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.",
3053
+ "operationId": "RespondActivityTaskFailed",
3054
+ "responses": {
3055
+ "200": {
3056
+ "description": "A successful response.",
3057
+ "schema": {
3058
+ "$ref": "#/definitions/v1RespondActivityTaskFailedResponse"
3059
+ }
3060
+ },
3061
+ "default": {
3062
+ "description": "An unexpected error response.",
3063
+ "schema": {
3064
+ "$ref": "#/definitions/rpcStatus"
3065
+ }
3066
+ }
3067
+ },
3068
+ "parameters": [
3069
+ {
3070
+ "name": "namespace",
3071
+ "in": "path",
3072
+ "required": true,
3073
+ "type": "string"
3074
+ },
3075
+ {
3076
+ "name": "body",
3077
+ "in": "body",
3078
+ "required": true,
3079
+ "schema": {
3080
+ "$ref": "#/definitions/WorkflowServiceRespondActivityTaskFailedBody"
3081
+ }
3082
+ }
3083
+ ],
3084
+ "tags": [
3085
+ "WorkflowService"
3086
+ ]
3087
+ }
3088
+ },
3089
+ "/namespaces/{namespace}/activities/fail-by-id": {
3090
+ "post": {
3091
+ "summary": "See `RecordActivityTaskFailed`. This version allows clients to record failures by\nnamespace/workflow id/activity id instead of task token.",
3092
+ "operationId": "RespondActivityTaskFailedById",
3093
+ "responses": {
3094
+ "200": {
3095
+ "description": "A successful response.",
3096
+ "schema": {
3097
+ "$ref": "#/definitions/v1RespondActivityTaskFailedByIdResponse"
3098
+ }
3099
+ },
3100
+ "default": {
3101
+ "description": "An unexpected error response.",
3102
+ "schema": {
3103
+ "$ref": "#/definitions/rpcStatus"
3104
+ }
3105
+ }
3106
+ },
3107
+ "parameters": [
3108
+ {
3109
+ "name": "namespace",
3110
+ "description": "Namespace of the workflow which scheduled this activity",
3111
+ "in": "path",
3112
+ "required": true,
3113
+ "type": "string"
3114
+ },
3115
+ {
3116
+ "name": "body",
3117
+ "in": "body",
3118
+ "required": true,
3119
+ "schema": {
3120
+ "$ref": "#/definitions/WorkflowServiceRespondActivityTaskFailedByIdBody"
3121
+ }
3122
+ }
3123
+ ],
3124
+ "tags": [
3125
+ "WorkflowService"
3126
+ ]
3127
+ }
3128
+ },
3129
+ "/namespaces/{namespace}/activities/heartbeat": {
3130
+ "post": {
3131
+ "summary": "RecordActivityTaskHeartbeat is optionally called by workers while they execute activities.",
3132
+ "description": "If worker fails to heartbeat within the `heartbeat_timeout` interval for the activity task,\nthen it will be marked as timed out and an `ACTIVITY_TASK_TIMED_OUT` event will be written to\nthe workflow history. Calling `RecordActivityTaskHeartbeat` will fail with `NotFound` in\nsuch situations, in that event, the SDK should request cancellation of the activity.",
3133
+ "operationId": "RecordActivityTaskHeartbeat",
3134
+ "responses": {
3135
+ "200": {
3136
+ "description": "A successful response.",
3137
+ "schema": {
3138
+ "$ref": "#/definitions/v1RecordActivityTaskHeartbeatResponse"
3139
+ }
3140
+ },
3141
+ "default": {
3142
+ "description": "An unexpected error response.",
3143
+ "schema": {
3144
+ "$ref": "#/definitions/rpcStatus"
3145
+ }
3146
+ }
3147
+ },
3148
+ "parameters": [
3149
+ {
3150
+ "name": "namespace",
3151
+ "in": "path",
3152
+ "required": true,
3153
+ "type": "string"
3154
+ },
3155
+ {
3156
+ "name": "body",
3157
+ "in": "body",
3158
+ "required": true,
3159
+ "schema": {
3160
+ "$ref": "#/definitions/WorkflowServiceRecordActivityTaskHeartbeatBody"
3161
+ }
3162
+ }
3163
+ ],
3164
+ "tags": [
3165
+ "WorkflowService"
3166
+ ]
3167
+ }
3168
+ },
3169
+ "/namespaces/{namespace}/activities/heartbeat-by-id": {
3170
+ "post": {
3171
+ "summary": "See `RecordActivityTaskHeartbeat`. This version allows clients to record heartbeats by\nnamespace/workflow id/activity id instead of task token.",
3172
+ "operationId": "RecordActivityTaskHeartbeatById",
3173
+ "responses": {
3174
+ "200": {
3175
+ "description": "A successful response.",
3176
+ "schema": {
3177
+ "$ref": "#/definitions/v1RecordActivityTaskHeartbeatByIdResponse"
3178
+ }
3179
+ },
3180
+ "default": {
3181
+ "description": "An unexpected error response.",
3182
+ "schema": {
3183
+ "$ref": "#/definitions/rpcStatus"
3184
+ }
3185
+ }
3186
+ },
3187
+ "parameters": [
3188
+ {
3189
+ "name": "namespace",
3190
+ "description": "Namespace of the workflow which scheduled this activity",
3191
+ "in": "path",
3192
+ "required": true,
3193
+ "type": "string"
3194
+ },
3195
+ {
3196
+ "name": "body",
3197
+ "in": "body",
3198
+ "required": true,
3199
+ "schema": {
3200
+ "$ref": "#/definitions/WorkflowServiceRecordActivityTaskHeartbeatByIdBody"
3201
+ }
3202
+ }
3203
+ ],
3204
+ "tags": [
3205
+ "WorkflowService"
3206
+ ]
3207
+ }
3208
+ },
3209
+ "/namespaces/{namespace}/activities/pause-by-id": {
3210
+ "post": {
3211
+ "summary": "PauseActivityById pauses the execution of an activity specified by its ID.\nReturns a `NotFound` error if there is no pending activity with the provided ID.",
3212
+ "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.",
3213
+ "operationId": "PauseActivityById",
3214
+ "responses": {
3215
+ "200": {
3216
+ "description": "A successful response.",
3217
+ "schema": {
3218
+ "$ref": "#/definitions/v1PauseActivityByIdResponse"
3219
+ }
3220
+ },
3221
+ "default": {
3222
+ "description": "An unexpected error response.",
3223
+ "schema": {
3224
+ "$ref": "#/definitions/rpcStatus"
3225
+ }
3226
+ }
3227
+ },
3228
+ "parameters": [
3229
+ {
3230
+ "name": "namespace",
3231
+ "description": "Namespace of the workflow which scheduled this activity.",
3232
+ "in": "path",
3233
+ "required": true,
3234
+ "type": "string"
3235
+ },
3236
+ {
3237
+ "name": "body",
3238
+ "in": "body",
3239
+ "required": true,
3240
+ "schema": {
3241
+ "$ref": "#/definitions/WorkflowServicePauseActivityByIdBody"
3242
+ }
3243
+ }
3244
+ ],
3245
+ "tags": [
3246
+ "WorkflowService"
3247
+ ]
3248
+ }
3249
+ },
3250
+ "/namespaces/{namespace}/activities/reset-by-id": {
3251
+ "post": {
3252
+ "summary": "ResetActivityById unpauses the execution of an activity specified by its ID.\nReturns a `NotFound` error if there is no pending activity with the provided ID.\nResetting an activity means:\n* number of attempts will be reset to 0.\n* activity timeouts will be resetted.\nIf the activity currently running:\n* if 'no_wait' flag is provided, a new instance of the activity will be scheduled immediately.\n* if 'no_wait' flag is not provided, a new instance of the activity will be scheduled after current instance completes if needed.\nIf 'reset_heartbeats' flag is set, the activity heartbeat timer and heartbeats will be reset.",
3253
+ "operationId": "ResetActivityById",
3254
+ "responses": {
3255
+ "200": {
3256
+ "description": "A successful response.",
3257
+ "schema": {
3258
+ "$ref": "#/definitions/v1ResetActivityByIdResponse"
3259
+ }
3260
+ },
3261
+ "default": {
3262
+ "description": "An unexpected error response.",
3263
+ "schema": {
3264
+ "$ref": "#/definitions/rpcStatus"
3265
+ }
3266
+ }
3267
+ },
3268
+ "parameters": [
3269
+ {
3270
+ "name": "namespace",
3271
+ "description": "Namespace of the workflow which scheduled this activity.",
3272
+ "in": "path",
3273
+ "required": true,
3274
+ "type": "string"
3275
+ },
3276
+ {
3277
+ "name": "body",
3278
+ "in": "body",
3279
+ "required": true,
3280
+ "schema": {
3281
+ "$ref": "#/definitions/WorkflowServiceResetActivityByIdBody"
3282
+ }
3283
+ }
3284
+ ],
3285
+ "tags": [
3286
+ "WorkflowService"
3287
+ ]
3288
+ }
3289
+ },
3290
+ "/namespaces/{namespace}/activities/unpause-by-id": {
3291
+ "post": {
3292
+ "summary": "UnpauseActivityById unpauses the execution of an activity specified by its ID.\nReturns a `NotFound` error if there is no pending activity with the provided ID.\nThere are two 'modes' of unpausing an activity:\n'resume' - If the activity is paused, it will be resumed and scheduled for execution.\n * If the activity is currently running Unpause with 'resume' has no effect.\n * if 'no_wait' flag is set and the activity is waiting, the activity will be scheduled immediately.\n'reset' - If the activity is paused, it will be reset to its initial state and (depending on parameters) scheduled for execution.\n * If the activity is currently running, Unpause with 'reset' will reset the number of attempts.\n * if 'no_wait' flag is set, the activity will be scheduled immediately.\n * if 'reset_heartbeats' flag is set, the activity heartbeat timer and heartbeats will be reset.\nIf the activity is in waiting for retry and past it retry timeout, it will be scheduled immediately.\nOnce the activity is unpaused, all timeout timers will be regenerated.",
3293
+ "operationId": "UnpauseActivityById",
3294
+ "responses": {
3295
+ "200": {
3296
+ "description": "A successful response.",
3297
+ "schema": {
3298
+ "$ref": "#/definitions/v1UnpauseActivityByIdResponse"
3299
+ }
3300
+ },
3301
+ "default": {
3302
+ "description": "An unexpected error response.",
3303
+ "schema": {
3304
+ "$ref": "#/definitions/rpcStatus"
3305
+ }
3306
+ }
3307
+ },
3308
+ "parameters": [
3309
+ {
3310
+ "name": "namespace",
3311
+ "description": "Namespace of the workflow which scheduled this activity.",
3312
+ "in": "path",
3313
+ "required": true,
3314
+ "type": "string"
3315
+ },
3316
+ {
3317
+ "name": "body",
3318
+ "in": "body",
3319
+ "required": true,
3320
+ "schema": {
3321
+ "$ref": "#/definitions/WorkflowServiceUnpauseActivityByIdBody"
3322
+ }
3323
+ }
3324
+ ],
3325
+ "tags": [
3326
+ "WorkflowService"
3327
+ ]
3328
+ }
3329
+ },
3330
+ "/namespaces/{namespace}/activities/update-options-by-id": {
3331
+ "post": {
3332
+ "summary": "UpdateActivityOptionsById is called by the client to update the options of an activity",
3333
+ "operationId": "UpdateActivityOptionsById",
3334
+ "responses": {
3335
+ "200": {
3336
+ "description": "A successful response.",
3337
+ "schema": {
3338
+ "$ref": "#/definitions/v1UpdateActivityOptionsByIdResponse"
3339
+ }
3340
+ },
3341
+ "default": {
3342
+ "description": "An unexpected error response.",
3343
+ "schema": {
3344
+ "$ref": "#/definitions/rpcStatus"
3345
+ }
3346
+ }
3347
+ },
3348
+ "parameters": [
3349
+ {
3350
+ "name": "namespace",
3351
+ "description": "Namespace of the workflow which scheduled this activity",
3352
+ "in": "path",
3353
+ "required": true,
3354
+ "type": "string"
3355
+ },
3356
+ {
3357
+ "name": "body",
3358
+ "in": "body",
3359
+ "required": true,
3360
+ "schema": {
3361
+ "$ref": "#/definitions/WorkflowServiceUpdateActivityOptionsByIdBody"
3362
+ }
3363
+ }
3364
+ ],
3365
+ "tags": [
3366
+ "WorkflowService"
3367
+ ]
3368
+ }
3369
+ },
3370
+ "/namespaces/{namespace}/archived-workflows": {
3371
+ "get": {
3372
+ "summary": "ListArchivedWorkflowExecutions is a visibility API to list archived workflow executions in a specific namespace.",
3373
+ "operationId": "ListArchivedWorkflowExecutions",
3374
+ "responses": {
3375
+ "200": {
3376
+ "description": "A successful response.",
3377
+ "schema": {
3378
+ "$ref": "#/definitions/v1ListArchivedWorkflowExecutionsResponse"
3379
+ }
3380
+ },
3381
+ "default": {
3382
+ "description": "An unexpected error response.",
3383
+ "schema": {
3384
+ "$ref": "#/definitions/rpcStatus"
3385
+ }
3386
+ }
3387
+ },
3388
+ "parameters": [
3389
+ {
3390
+ "name": "namespace",
3391
+ "in": "path",
3392
+ "required": true,
3393
+ "type": "string"
3394
+ },
3395
+ {
3396
+ "name": "pageSize",
3397
+ "in": "query",
3398
+ "required": false,
3399
+ "type": "integer",
3400
+ "format": "int32"
3401
+ },
3402
+ {
3403
+ "name": "nextPageToken",
3404
+ "in": "query",
3405
+ "required": false,
3406
+ "type": "string",
3407
+ "format": "byte"
3408
+ },
3409
+ {
3410
+ "name": "query",
3411
+ "in": "query",
3412
+ "required": false,
3413
+ "type": "string"
3414
+ }
3415
+ ],
3416
+ "tags": [
3417
+ "WorkflowService"
3418
+ ]
3419
+ }
3420
+ },
3421
+ "/namespaces/{namespace}/batch-operations": {
3422
+ "get": {
3423
+ "summary": "ListBatchOperations returns a list of batch operations",
3424
+ "operationId": "ListBatchOperations",
3425
+ "responses": {
3426
+ "200": {
3427
+ "description": "A successful response.",
3428
+ "schema": {
3429
+ "$ref": "#/definitions/v1ListBatchOperationsResponse"
3430
+ }
3431
+ },
3432
+ "default": {
3433
+ "description": "An unexpected error response.",
3434
+ "schema": {
3435
+ "$ref": "#/definitions/rpcStatus"
3436
+ }
3437
+ }
3438
+ },
3439
+ "parameters": [
3440
+ {
3441
+ "name": "namespace",
3442
+ "description": "Namespace that contains the batch operation",
3443
+ "in": "path",
3444
+ "required": true,
3445
+ "type": "string"
3446
+ },
3447
+ {
3448
+ "name": "pageSize",
3449
+ "description": "List page size",
3450
+ "in": "query",
3451
+ "required": false,
3452
+ "type": "integer",
3453
+ "format": "int32"
3454
+ },
3455
+ {
3456
+ "name": "nextPageToken",
3457
+ "description": "Next page token",
3458
+ "in": "query",
3459
+ "required": false,
3460
+ "type": "string",
3461
+ "format": "byte"
3462
+ }
3463
+ ],
3464
+ "tags": [
3465
+ "WorkflowService"
3466
+ ]
3467
+ }
3468
+ },
3469
+ "/namespaces/{namespace}/batch-operations/{jobId}": {
3470
+ "get": {
3471
+ "summary": "DescribeBatchOperation returns the information about a batch operation",
3472
+ "operationId": "DescribeBatchOperation",
3473
+ "responses": {
3474
+ "200": {
3475
+ "description": "A successful response.",
3476
+ "schema": {
3477
+ "$ref": "#/definitions/v1DescribeBatchOperationResponse"
3478
+ }
3479
+ },
3480
+ "default": {
3481
+ "description": "An unexpected error response.",
3482
+ "schema": {
3483
+ "$ref": "#/definitions/rpcStatus"
3484
+ }
3485
+ }
3486
+ },
3487
+ "parameters": [
3488
+ {
3489
+ "name": "namespace",
3490
+ "description": "Namespace that contains the batch operation",
3491
+ "in": "path",
3492
+ "required": true,
3493
+ "type": "string"
3494
+ },
3495
+ {
3496
+ "name": "jobId",
3497
+ "description": "Batch job id",
3498
+ "in": "path",
3499
+ "required": true,
3500
+ "type": "string"
3501
+ }
3502
+ ],
3503
+ "tags": [
3504
+ "WorkflowService"
3505
+ ]
3506
+ },
3507
+ "post": {
3508
+ "summary": "StartBatchOperation starts a new batch operation",
3509
+ "operationId": "StartBatchOperation",
3510
+ "responses": {
3511
+ "200": {
3512
+ "description": "A successful response.",
3513
+ "schema": {
3514
+ "$ref": "#/definitions/v1StartBatchOperationResponse"
3515
+ }
3516
+ },
3517
+ "default": {
3518
+ "description": "An unexpected error response.",
3519
+ "schema": {
3520
+ "$ref": "#/definitions/rpcStatus"
3521
+ }
3522
+ }
3523
+ },
3524
+ "parameters": [
3525
+ {
3526
+ "name": "namespace",
3527
+ "description": "Namespace that contains the batch operation",
3528
+ "in": "path",
3529
+ "required": true,
3530
+ "type": "string"
3531
+ },
3532
+ {
3533
+ "name": "jobId",
3534
+ "description": "Job ID defines the unique ID for the batch job",
3535
+ "in": "path",
3536
+ "required": true,
3537
+ "type": "string"
3538
+ },
3539
+ {
3540
+ "name": "body",
3541
+ "in": "body",
3542
+ "required": true,
3543
+ "schema": {
3544
+ "$ref": "#/definitions/WorkflowServiceStartBatchOperationBody"
3545
+ }
3546
+ }
3547
+ ],
3548
+ "tags": [
3549
+ "WorkflowService"
3550
+ ]
3551
+ }
3552
+ },
3553
+ "/namespaces/{namespace}/batch-operations/{jobId}/stop": {
3554
+ "post": {
3555
+ "summary": "StopBatchOperation stops a batch operation",
3556
+ "operationId": "StopBatchOperation",
3557
+ "responses": {
3558
+ "200": {
3559
+ "description": "A successful response.",
3560
+ "schema": {
3561
+ "$ref": "#/definitions/v1StopBatchOperationResponse"
3562
+ }
3563
+ },
3564
+ "default": {
3565
+ "description": "An unexpected error response.",
3566
+ "schema": {
3567
+ "$ref": "#/definitions/rpcStatus"
3568
+ }
3569
+ }
3570
+ },
3571
+ "parameters": [
3572
+ {
3573
+ "name": "namespace",
3574
+ "description": "Namespace that contains the batch operation",
3575
+ "in": "path",
3576
+ "required": true,
3577
+ "type": "string"
3578
+ },
3579
+ {
3580
+ "name": "jobId",
3581
+ "description": "Batch job id",
3582
+ "in": "path",
3583
+ "required": true,
3584
+ "type": "string"
3585
+ },
3586
+ {
3587
+ "name": "body",
3588
+ "in": "body",
3589
+ "required": true,
3590
+ "schema": {
3591
+ "$ref": "#/definitions/WorkflowServiceStopBatchOperationBody"
3592
+ }
3593
+ }
3594
+ ],
3595
+ "tags": [
3596
+ "WorkflowService"
3597
+ ]
3598
+ }
3599
+ },
3600
+ "/namespaces/{namespace}/schedules": {
3601
+ "get": {
3602
+ "summary": "List all schedules in a namespace.",
3603
+ "operationId": "ListSchedules",
3604
+ "responses": {
3605
+ "200": {
3606
+ "description": "A successful response.",
3607
+ "schema": {
3608
+ "$ref": "#/definitions/v1ListSchedulesResponse"
3609
+ }
3610
+ },
3611
+ "default": {
3612
+ "description": "An unexpected error response.",
3613
+ "schema": {
3614
+ "$ref": "#/definitions/rpcStatus"
3615
+ }
3616
+ }
3617
+ },
3618
+ "parameters": [
3619
+ {
3620
+ "name": "namespace",
3621
+ "description": "The namespace to list schedules in.",
3622
+ "in": "path",
3623
+ "required": true,
3624
+ "type": "string"
3625
+ },
3626
+ {
3627
+ "name": "maximumPageSize",
3628
+ "description": "How many to return at once.",
3629
+ "in": "query",
3630
+ "required": false,
3631
+ "type": "integer",
3632
+ "format": "int32"
3633
+ },
3634
+ {
3635
+ "name": "nextPageToken",
3636
+ "description": "Token to get the next page of results.",
3637
+ "in": "query",
3638
+ "required": false,
3639
+ "type": "string",
3640
+ "format": "byte"
3641
+ },
3642
+ {
3643
+ "name": "query",
3644
+ "description": "Query to filter schedules.",
3645
+ "in": "query",
3646
+ "required": false,
3647
+ "type": "string"
3648
+ }
3649
+ ],
3650
+ "tags": [
3651
+ "WorkflowService"
3652
+ ]
3653
+ }
3654
+ },
3655
+ "/namespaces/{namespace}/schedules/{scheduleId}": {
3656
+ "get": {
3657
+ "summary": "Returns the schedule description and current state of an existing schedule.",
3658
+ "operationId": "DescribeSchedule",
3659
+ "responses": {
3660
+ "200": {
3661
+ "description": "A successful response.",
3662
+ "schema": {
3663
+ "$ref": "#/definitions/v1DescribeScheduleResponse"
3664
+ }
3665
+ },
3666
+ "default": {
3667
+ "description": "An unexpected error response.",
3668
+ "schema": {
3669
+ "$ref": "#/definitions/rpcStatus"
3670
+ }
3671
+ }
3672
+ },
3673
+ "parameters": [
3674
+ {
3675
+ "name": "namespace",
3676
+ "description": "The namespace of the schedule to describe.",
3677
+ "in": "path",
3678
+ "required": true,
3679
+ "type": "string"
3680
+ },
3681
+ {
3682
+ "name": "scheduleId",
3683
+ "description": "The id of the schedule to describe.",
3684
+ "in": "path",
3685
+ "required": true,
3686
+ "type": "string"
3687
+ }
3688
+ ],
3689
+ "tags": [
3690
+ "WorkflowService"
3691
+ ]
3692
+ },
3693
+ "delete": {
3694
+ "summary": "Deletes a schedule, removing it from the system.",
3695
+ "operationId": "DeleteSchedule",
3696
+ "responses": {
3697
+ "200": {
3698
+ "description": "A successful response.",
3699
+ "schema": {
3700
+ "$ref": "#/definitions/v1DeleteScheduleResponse"
3701
+ }
3702
+ },
3703
+ "default": {
3704
+ "description": "An unexpected error response.",
3705
+ "schema": {
3706
+ "$ref": "#/definitions/rpcStatus"
3707
+ }
3708
+ }
3709
+ },
3710
+ "parameters": [
3711
+ {
3712
+ "name": "namespace",
3713
+ "description": "The namespace of the schedule to delete.",
3714
+ "in": "path",
3715
+ "required": true,
3716
+ "type": "string"
3717
+ },
3718
+ {
3719
+ "name": "scheduleId",
3720
+ "description": "The id of the schedule to delete.",
3721
+ "in": "path",
3722
+ "required": true,
3723
+ "type": "string"
3724
+ },
3725
+ {
3726
+ "name": "identity",
3727
+ "description": "The identity of the client who initiated this request.",
3728
+ "in": "query",
3729
+ "required": false,
3730
+ "type": "string"
3731
+ }
3732
+ ],
3733
+ "tags": [
3734
+ "WorkflowService"
3735
+ ]
3736
+ },
3737
+ "post": {
3738
+ "summary": "Creates a new schedule.",
3739
+ "operationId": "CreateSchedule",
3740
+ "responses": {
3741
+ "200": {
3742
+ "description": "A successful response.",
3743
+ "schema": {
3744
+ "$ref": "#/definitions/v1CreateScheduleResponse"
3745
+ }
3746
+ },
3747
+ "default": {
3748
+ "description": "An unexpected error response.",
3749
+ "schema": {
3750
+ "$ref": "#/definitions/rpcStatus"
3751
+ }
3752
+ }
3753
+ },
3754
+ "parameters": [
3755
+ {
3756
+ "name": "namespace",
3757
+ "description": "The namespace the schedule should be created in.",
3758
+ "in": "path",
3759
+ "required": true,
3760
+ "type": "string"
3761
+ },
3762
+ {
3763
+ "name": "scheduleId",
3764
+ "description": "The id of the new schedule.",
3765
+ "in": "path",
3766
+ "required": true,
3767
+ "type": "string"
3768
+ },
3769
+ {
3770
+ "name": "body",
3771
+ "in": "body",
3772
+ "required": true,
3773
+ "schema": {
3774
+ "$ref": "#/definitions/WorkflowServiceCreateScheduleBody"
3775
+ }
3776
+ }
3777
+ ],
3778
+ "tags": [
3779
+ "WorkflowService"
3780
+ ]
3781
+ }
3782
+ },
3783
+ "/namespaces/{namespace}/schedules/{scheduleId}/matching-times": {
3784
+ "get": {
3785
+ "summary": "Lists matching times within a range.",
3786
+ "operationId": "ListScheduleMatchingTimes",
3787
+ "responses": {
3788
+ "200": {
3789
+ "description": "A successful response.",
3790
+ "schema": {
3791
+ "$ref": "#/definitions/v1ListScheduleMatchingTimesResponse"
3792
+ }
3793
+ },
3794
+ "default": {
3795
+ "description": "An unexpected error response.",
3796
+ "schema": {
3797
+ "$ref": "#/definitions/rpcStatus"
3798
+ }
3799
+ }
3800
+ },
3801
+ "parameters": [
3802
+ {
3803
+ "name": "namespace",
3804
+ "description": "The namespace of the schedule to query.",
3805
+ "in": "path",
3806
+ "required": true,
3807
+ "type": "string"
3808
+ },
3809
+ {
3810
+ "name": "scheduleId",
3811
+ "description": "The id of the schedule to query.",
3812
+ "in": "path",
3813
+ "required": true,
3814
+ "type": "string"
3815
+ },
3816
+ {
3817
+ "name": "startTime",
3818
+ "description": "Time range to query.",
3819
+ "in": "query",
3820
+ "required": false,
3821
+ "type": "string",
3822
+ "format": "date-time"
3823
+ },
3824
+ {
3825
+ "name": "endTime",
3826
+ "in": "query",
3827
+ "required": false,
3828
+ "type": "string",
3829
+ "format": "date-time"
3830
+ }
3831
+ ],
3832
+ "tags": [
3833
+ "WorkflowService"
3834
+ ]
3835
+ }
3836
+ },
3837
+ "/namespaces/{namespace}/schedules/{scheduleId}/patch": {
3838
+ "post": {
3839
+ "summary": "Makes a specific change to a schedule or triggers an immediate action.",
3840
+ "operationId": "PatchSchedule",
3841
+ "responses": {
3842
+ "200": {
3843
+ "description": "A successful response.",
3844
+ "schema": {
3845
+ "$ref": "#/definitions/v1PatchScheduleResponse"
3846
+ }
3847
+ },
3848
+ "default": {
3849
+ "description": "An unexpected error response.",
3850
+ "schema": {
3851
+ "$ref": "#/definitions/rpcStatus"
3852
+ }
3853
+ }
3854
+ },
3855
+ "parameters": [
3856
+ {
3857
+ "name": "namespace",
3858
+ "description": "The namespace of the schedule to patch.",
3859
+ "in": "path",
3860
+ "required": true,
3861
+ "type": "string"
3862
+ },
3863
+ {
3864
+ "name": "scheduleId",
3865
+ "description": "The id of the schedule to patch.",
3866
+ "in": "path",
3867
+ "required": true,
3868
+ "type": "string"
3869
+ },
3870
+ {
3871
+ "name": "body",
3872
+ "in": "body",
3873
+ "required": true,
3874
+ "schema": {
3875
+ "$ref": "#/definitions/WorkflowServicePatchScheduleBody"
3876
+ }
3877
+ }
3878
+ ],
3879
+ "tags": [
3880
+ "WorkflowService"
3881
+ ]
3882
+ }
3883
+ },
3884
+ "/namespaces/{namespace}/schedules/{scheduleId}/update": {
3885
+ "post": {
3886
+ "summary": "Changes the configuration or state of an existing schedule.",
3887
+ "operationId": "UpdateSchedule",
3888
+ "responses": {
3889
+ "200": {
3890
+ "description": "A successful response.",
3891
+ "schema": {
3892
+ "$ref": "#/definitions/v1UpdateScheduleResponse"
3893
+ }
3894
+ },
3895
+ "default": {
3896
+ "description": "An unexpected error response.",
3897
+ "schema": {
3898
+ "$ref": "#/definitions/rpcStatus"
3899
+ }
3900
+ }
3901
+ },
3902
+ "parameters": [
3903
+ {
3904
+ "name": "namespace",
3905
+ "description": "The namespace of the schedule to update.",
3906
+ "in": "path",
3907
+ "required": true,
3908
+ "type": "string"
3909
+ },
3910
+ {
3911
+ "name": "scheduleId",
3912
+ "description": "The id of the schedule to update.",
3913
+ "in": "path",
3914
+ "required": true,
3915
+ "type": "string"
3916
+ },
3917
+ {
3918
+ "name": "body",
3919
+ "in": "body",
3920
+ "required": true,
3921
+ "schema": {
3922
+ "$ref": "#/definitions/WorkflowServiceUpdateScheduleBody"
3923
+ }
3924
+ }
3925
+ ],
3926
+ "tags": [
3927
+ "WorkflowService"
3928
+ ]
3929
+ }
3930
+ },
3931
+ "/namespaces/{namespace}/task-queues/{taskQueue.name}": {
3932
+ "get": {
3933
+ "summary": "DescribeTaskQueue returns the following information about the target task queue, broken down by Build ID:\n - List of pollers\n - Workflow Reachability status\n - Backlog info for Workflow and/or Activity tasks",
3934
+ "operationId": "DescribeTaskQueue",
3935
+ "responses": {
3936
+ "200": {
3937
+ "description": "A successful response.",
3938
+ "schema": {
3939
+ "$ref": "#/definitions/v1DescribeTaskQueueResponse"
3940
+ }
3941
+ },
3942
+ "default": {
3943
+ "description": "An unexpected error response.",
3944
+ "schema": {
3945
+ "$ref": "#/definitions/rpcStatus"
3946
+ }
3947
+ }
3948
+ },
3949
+ "parameters": [
3950
+ {
3951
+ "name": "namespace",
3952
+ "in": "path",
3953
+ "required": true,
3954
+ "type": "string"
3955
+ },
3956
+ {
3957
+ "name": "taskQueue.name",
3958
+ "in": "path",
3959
+ "required": true,
3960
+ "type": "string"
3961
+ },
3962
+ {
3963
+ "name": "taskQueue.kind",
3964
+ "description": "Default: TASK_QUEUE_KIND_NORMAL.\n\n - TASK_QUEUE_KIND_NORMAL: Tasks from a normal workflow task queue always include complete workflow history\n\nThe task queue specified by the user is always a normal task queue. There can be as many\nworkers as desired for a single normal task queue. All those workers may pick up tasks from\nthat queue.\n - TASK_QUEUE_KIND_STICKY: A sticky queue only includes new history since the last workflow task, and they are\nper-worker.\n\nSticky queues are created dynamically by each worker during their start up. They only exist\nfor the lifetime of the worker process. Tasks in a sticky task queue are only available to\nthe worker that created the sticky queue.\n\nSticky queues are only for workflow tasks. There are no sticky task queues for activities.",
3965
+ "in": "query",
3966
+ "required": false,
3967
+ "type": "string",
3968
+ "enum": [
3969
+ "TASK_QUEUE_KIND_UNSPECIFIED",
3970
+ "TASK_QUEUE_KIND_NORMAL",
3971
+ "TASK_QUEUE_KIND_STICKY"
3972
+ ],
3973
+ "default": "TASK_QUEUE_KIND_UNSPECIFIED"
3974
+ },
3975
+ {
3976
+ "name": "taskQueue.normalName",
3977
+ "description": "Iff kind == TASK_QUEUE_KIND_STICKY, then this field contains the name of\nthe normal task queue that the sticky worker is running on.",
3978
+ "in": "query",
3979
+ "required": false,
3980
+ "type": "string"
3981
+ },
3982
+ {
3983
+ "name": "taskQueueType",
3984
+ "description": "Deprecated. Use `ENHANCED` mode with `task_queue_types`. Ignored in `ENHANCED` mode.\nIf unspecified (TASK_QUEUE_TYPE_UNSPECIFIED), then default value (TASK_QUEUE_TYPE_WORKFLOW) will be used.\n\n - TASK_QUEUE_TYPE_WORKFLOW: Workflow type of task queue.\n - TASK_QUEUE_TYPE_ACTIVITY: Activity type of task queue.\n - TASK_QUEUE_TYPE_NEXUS: Task queue type for dispatching Nexus requests.",
3985
+ "in": "query",
3986
+ "required": false,
3987
+ "type": "string",
3988
+ "enum": [
3989
+ "TASK_QUEUE_TYPE_UNSPECIFIED",
3990
+ "TASK_QUEUE_TYPE_WORKFLOW",
3991
+ "TASK_QUEUE_TYPE_ACTIVITY",
3992
+ "TASK_QUEUE_TYPE_NEXUS"
3993
+ ],
3994
+ "default": "TASK_QUEUE_TYPE_UNSPECIFIED"
3995
+ },
3996
+ {
3997
+ "name": "includeTaskQueueStatus",
3998
+ "description": "Deprecated. Ignored in `ENHANCED` mode.",
3999
+ "in": "query",
4000
+ "required": false,
4001
+ "type": "boolean"
4002
+ },
4003
+ {
4004
+ "name": "apiMode",
4005
+ "description": "All options except `task_queue_type` and `include_task_queue_status` are only available in the `ENHANCED` mode.\n\n - DESCRIBE_TASK_QUEUE_MODE_UNSPECIFIED: Unspecified means legacy behavior.\n - DESCRIBE_TASK_QUEUE_MODE_ENHANCED: Enhanced mode reports aggregated results for all partitions, supports Build IDs, and reports richer info.",
4006
+ "in": "query",
4007
+ "required": false,
4008
+ "type": "string",
4009
+ "enum": [
4010
+ "DESCRIBE_TASK_QUEUE_MODE_UNSPECIFIED",
4011
+ "DESCRIBE_TASK_QUEUE_MODE_ENHANCED"
4012
+ ],
4013
+ "default": "DESCRIBE_TASK_QUEUE_MODE_UNSPECIFIED"
4014
+ },
4015
+ {
4016
+ "name": "versions.buildIds",
4017
+ "description": "Include specific Build IDs.",
4018
+ "in": "query",
4019
+ "required": false,
4020
+ "type": "array",
4021
+ "items": {
4022
+ "type": "string"
4023
+ },
4024
+ "collectionFormat": "multi"
4025
+ },
4026
+ {
4027
+ "name": "versions.unversioned",
4028
+ "description": "Include the unversioned queue.",
4029
+ "in": "query",
4030
+ "required": false,
4031
+ "type": "boolean"
4032
+ },
4033
+ {
4034
+ "name": "versions.allActive",
4035
+ "description": "Include all active versions. A version is considered active if, in the last few minutes,\nit has had new tasks or polls, or it has been the subject of certain task queue API calls.",
4036
+ "in": "query",
4037
+ "required": false,
4038
+ "type": "boolean"
4039
+ },
4040
+ {
4041
+ "name": "taskQueueTypes",
4042
+ "description": "Task queue types to report info about. If not specified, all types are considered.\n\n - TASK_QUEUE_TYPE_WORKFLOW: Workflow type of task queue.\n - TASK_QUEUE_TYPE_ACTIVITY: Activity type of task queue.\n - TASK_QUEUE_TYPE_NEXUS: Task queue type for dispatching Nexus requests.",
4043
+ "in": "query",
4044
+ "required": false,
4045
+ "type": "array",
4046
+ "items": {
4047
+ "type": "string",
4048
+ "enum": [
4049
+ "TASK_QUEUE_TYPE_UNSPECIFIED",
4050
+ "TASK_QUEUE_TYPE_WORKFLOW",
4051
+ "TASK_QUEUE_TYPE_ACTIVITY",
4052
+ "TASK_QUEUE_TYPE_NEXUS"
4053
+ ]
4054
+ },
4055
+ "collectionFormat": "multi"
4056
+ },
4057
+ {
4058
+ "name": "reportStats",
4059
+ "description": "Report stats for the requested task queue types and versions",
4060
+ "in": "query",
4061
+ "required": false,
4062
+ "type": "boolean"
4063
+ },
4064
+ {
4065
+ "name": "reportPollers",
4066
+ "description": "Report list of pollers for requested task queue types and versions",
4067
+ "in": "query",
4068
+ "required": false,
4069
+ "type": "boolean"
4070
+ },
4071
+ {
4072
+ "name": "reportTaskReachability",
4073
+ "description": "Report task reachability for the requested versions and all task types (task reachability is not reported\nper task type).",
4074
+ "in": "query",
4075
+ "required": false,
4076
+ "type": "boolean"
4077
+ }
4078
+ ],
4079
+ "tags": [
4080
+ "WorkflowService"
4081
+ ]
4082
+ }
4083
+ },
4084
+ "/namespaces/{namespace}/task-queues/{taskQueue}/worker-build-id-compatibility": {
4085
+ "get": {
4086
+ "summary": "Deprecated. Use `GetWorkerVersioningRules`.\nFetches the worker build id versioning sets for a task queue.",
4087
+ "operationId": "GetWorkerBuildIdCompatibility",
4088
+ "responses": {
4089
+ "200": {
4090
+ "description": "A successful response.",
4091
+ "schema": {
4092
+ "$ref": "#/definitions/v1GetWorkerBuildIdCompatibilityResponse"
4093
+ }
4094
+ },
4095
+ "default": {
4096
+ "description": "An unexpected error response.",
4097
+ "schema": {
4098
+ "$ref": "#/definitions/rpcStatus"
4099
+ }
4100
+ }
4101
+ },
4102
+ "parameters": [
4103
+ {
4104
+ "name": "namespace",
4105
+ "in": "path",
4106
+ "required": true,
4107
+ "type": "string"
4108
+ },
4109
+ {
4110
+ "name": "taskQueue",
4111
+ "description": "Must be set, the task queue to interrogate about worker id compatibility.",
4112
+ "in": "path",
4113
+ "required": true,
4114
+ "type": "string"
4115
+ },
4116
+ {
4117
+ "name": "maxSets",
4118
+ "description": "Limits how many compatible sets will be returned. Specify 1 to only return the current\ndefault major version set. 0 returns all sets.",
4119
+ "in": "query",
4120
+ "required": false,
4121
+ "type": "integer",
4122
+ "format": "int32"
4123
+ }
4124
+ ],
4125
+ "tags": [
4126
+ "WorkflowService"
4127
+ ]
4128
+ }
4129
+ },
4130
+ "/namespaces/{namespace}/task-queues/{taskQueue}/worker-versioning-rules": {
4131
+ "get": {
4132
+ "summary": "Fetches the Build ID assignment and redirect rules for a Task Queue.\nWARNING: Worker Versioning is not yet stable and the API and behavior may change incompatibly.",
4133
+ "operationId": "GetWorkerVersioningRules",
4134
+ "responses": {
4135
+ "200": {
4136
+ "description": "A successful response.",
4137
+ "schema": {
4138
+ "$ref": "#/definitions/v1GetWorkerVersioningRulesResponse"
4139
+ }
4140
+ },
4141
+ "default": {
4142
+ "description": "An unexpected error response.",
4143
+ "schema": {
4144
+ "$ref": "#/definitions/rpcStatus"
4145
+ }
4146
+ }
4147
+ },
4148
+ "parameters": [
4149
+ {
4150
+ "name": "namespace",
4151
+ "in": "path",
4152
+ "required": true,
4153
+ "type": "string"
4154
+ },
4155
+ {
4156
+ "name": "taskQueue",
4157
+ "in": "path",
4158
+ "required": true,
4159
+ "type": "string"
4160
+ }
4161
+ ],
4162
+ "tags": [
4163
+ "WorkflowService"
4164
+ ]
4165
+ }
4166
+ },
4167
+ "/namespaces/{namespace}/worker-task-reachability": {
4168
+ "get": {
4169
+ "summary": "Deprecated. Use `DescribeTaskQueue`.",
4170
+ "description": "Fetches task reachability to determine whether a worker may be retired.\nThe request may specify task queues to query for or let the server fetch all task queues mapped to the given\nbuild IDs.\n\nWhen requesting a large number of task queues or all task queues associated with the given build ids in a\nnamespace, all task queues will be listed in the response but some of them may not contain reachability\ninformation due to a server enforced limit. When reaching the limit, task queues that reachability information\ncould not be retrieved for will be marked with a single TASK_REACHABILITY_UNSPECIFIED entry. The caller may issue\nanother call to get the reachability for those task queues.\n\nOpen source users can adjust this limit by setting the server's dynamic config value for\n`limit.reachabilityTaskQueueScan` with the caveat that this call can strain the visibility store.",
4171
+ "operationId": "GetWorkerTaskReachability",
4172
+ "responses": {
4173
+ "200": {
4174
+ "description": "A successful response.",
4175
+ "schema": {
4176
+ "$ref": "#/definitions/v1GetWorkerTaskReachabilityResponse"
4177
+ }
4178
+ },
4179
+ "default": {
4180
+ "description": "An unexpected error response.",
4181
+ "schema": {
4182
+ "$ref": "#/definitions/rpcStatus"
4183
+ }
4184
+ }
4185
+ },
4186
+ "parameters": [
4187
+ {
4188
+ "name": "namespace",
4189
+ "in": "path",
4190
+ "required": true,
4191
+ "type": "string"
4192
+ },
4193
+ {
4194
+ "name": "buildIds",
4195
+ "description": "Build ids to retrieve reachability for. An empty string will be interpreted as an unversioned worker.\nThe number of build ids that can be queried in a single API call is limited.\nOpen source users can adjust this limit by setting the server's dynamic config value for\n`limit.reachabilityQueryBuildIds` with the caveat that this call can strain the visibility store.",
4196
+ "in": "query",
4197
+ "required": false,
4198
+ "type": "array",
4199
+ "items": {
4200
+ "type": "string"
4201
+ },
4202
+ "collectionFormat": "multi"
4203
+ },
4204
+ {
4205
+ "name": "taskQueues",
4206
+ "description": "Task queues to retrieve reachability for. Leave this empty to query for all task queues associated with given\nbuild ids in the namespace.\nMust specify at least one task queue if querying for an unversioned worker.\nThe number of task queues that the server will fetch reachability information for is limited.\nSee the `GetWorkerTaskReachabilityResponse` documentation for more information.",
4207
+ "in": "query",
4208
+ "required": false,
4209
+ "type": "array",
4210
+ "items": {
4211
+ "type": "string"
4212
+ },
4213
+ "collectionFormat": "multi"
4214
+ },
4215
+ {
4216
+ "name": "reachability",
4217
+ "description": "Type of reachability to query for.\n`TASK_REACHABILITY_NEW_WORKFLOWS` is always returned in the response.\nUse `TASK_REACHABILITY_EXISTING_WORKFLOWS` if your application needs to respond to queries on closed workflows.\nOtherwise, use `TASK_REACHABILITY_OPEN_WORKFLOWS`. Default is `TASK_REACHABILITY_EXISTING_WORKFLOWS` if left\nunspecified.\nSee the TaskReachability docstring for information about each enum variant.\n\n - TASK_REACHABILITY_NEW_WORKFLOWS: There's a possiblity for a worker to receive new workflow tasks. Workers should *not* be retired.\n - TASK_REACHABILITY_EXISTING_WORKFLOWS: There's a possiblity for a worker to receive existing workflow and activity tasks from existing workflows. Workers\nshould *not* be retired.\nThis enum value does not distinguish between open and closed workflows.\n - TASK_REACHABILITY_OPEN_WORKFLOWS: There's a possiblity for a worker to receive existing workflow and activity tasks from open workflows. Workers\nshould *not* be retired.\n - TASK_REACHABILITY_CLOSED_WORKFLOWS: There's a possiblity for a worker to receive existing workflow tasks from closed workflows. Workers may be\nretired dependending on application requirements. For example, if there's no need to query closed workflows.",
4218
+ "in": "query",
4219
+ "required": false,
4220
+ "type": "string",
4221
+ "enum": [
4222
+ "TASK_REACHABILITY_UNSPECIFIED",
4223
+ "TASK_REACHABILITY_NEW_WORKFLOWS",
4224
+ "TASK_REACHABILITY_EXISTING_WORKFLOWS",
4225
+ "TASK_REACHABILITY_OPEN_WORKFLOWS",
4226
+ "TASK_REACHABILITY_CLOSED_WORKFLOWS"
4227
+ ],
4228
+ "default": "TASK_REACHABILITY_UNSPECIFIED"
4229
+ }
4230
+ ],
4231
+ "tags": [
4232
+ "WorkflowService"
4233
+ ]
4234
+ }
4235
+ },
4236
+ "/namespaces/{namespace}/workflow-count": {
4237
+ "get": {
4238
+ "summary": "CountWorkflowExecutions is a visibility API to count of workflow executions in a specific namespace.",
4239
+ "operationId": "CountWorkflowExecutions",
4240
+ "responses": {
4241
+ "200": {
4242
+ "description": "A successful response.",
4243
+ "schema": {
4244
+ "$ref": "#/definitions/v1CountWorkflowExecutionsResponse"
4245
+ }
4246
+ },
4247
+ "default": {
4248
+ "description": "An unexpected error response.",
4249
+ "schema": {
4250
+ "$ref": "#/definitions/rpcStatus"
4251
+ }
4252
+ }
4253
+ },
4254
+ "parameters": [
4255
+ {
4256
+ "name": "namespace",
4257
+ "in": "path",
4258
+ "required": true,
4259
+ "type": "string"
4260
+ },
4261
+ {
4262
+ "name": "query",
4263
+ "in": "query",
4264
+ "required": false,
4265
+ "type": "string"
4266
+ }
4267
+ ],
4268
+ "tags": [
4269
+ "WorkflowService"
4270
+ ]
4271
+ }
4272
+ },
4273
+ "/namespaces/{namespace}/workflows": {
4274
+ "get": {
4275
+ "summary": "ListWorkflowExecutions is a visibility API to list workflow executions in a specific namespace.",
4276
+ "operationId": "ListWorkflowExecutions",
4277
+ "responses": {
4278
+ "200": {
4279
+ "description": "A successful response.",
4280
+ "schema": {
4281
+ "$ref": "#/definitions/v1ListWorkflowExecutionsResponse"
4282
+ }
4283
+ },
4284
+ "default": {
4285
+ "description": "An unexpected error response.",
4286
+ "schema": {
4287
+ "$ref": "#/definitions/rpcStatus"
4288
+ }
4289
+ }
4290
+ },
4291
+ "parameters": [
4292
+ {
4293
+ "name": "namespace",
4294
+ "in": "path",
4295
+ "required": true,
4296
+ "type": "string"
4297
+ },
4298
+ {
4299
+ "name": "pageSize",
4300
+ "in": "query",
4301
+ "required": false,
4302
+ "type": "integer",
4303
+ "format": "int32"
4304
+ },
4305
+ {
4306
+ "name": "nextPageToken",
4307
+ "in": "query",
4308
+ "required": false,
4309
+ "type": "string",
4310
+ "format": "byte"
4311
+ },
4312
+ {
4313
+ "name": "query",
4314
+ "in": "query",
4315
+ "required": false,
4316
+ "type": "string"
4317
+ }
4318
+ ],
4319
+ "tags": [
4320
+ "WorkflowService"
4321
+ ]
4322
+ }
4323
+ },
4324
+ "/namespaces/{namespace}/workflows/execute-multi-operation": {
4325
+ "post": {
4326
+ "summary": "ExecuteMultiOperation executes multiple operations within a single workflow.",
4327
+ "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.",
4328
+ "operationId": "ExecuteMultiOperation",
4329
+ "responses": {
4330
+ "200": {
4331
+ "description": "A successful response.",
4332
+ "schema": {
4333
+ "$ref": "#/definitions/v1ExecuteMultiOperationResponse"
4334
+ }
4335
+ },
4336
+ "default": {
4337
+ "description": "An unexpected error response.",
4338
+ "schema": {
4339
+ "$ref": "#/definitions/rpcStatus"
4340
+ }
4341
+ }
4342
+ },
4343
+ "parameters": [
4344
+ {
4345
+ "name": "namespace",
4346
+ "in": "path",
4347
+ "required": true,
4348
+ "type": "string"
4349
+ },
4350
+ {
4351
+ "name": "body",
4352
+ "in": "body",
4353
+ "required": true,
4354
+ "schema": {
4355
+ "$ref": "#/definitions/WorkflowServiceExecuteMultiOperationBody"
4356
+ }
4357
+ }
4358
+ ],
4359
+ "tags": [
4360
+ "WorkflowService"
4361
+ ]
4362
+ }
4363
+ },
4364
+ "/namespaces/{namespace}/workflows/{execution.workflowId}": {
4365
+ "get": {
4366
+ "summary": "DescribeWorkflowExecution returns information about the specified workflow execution.",
4367
+ "operationId": "DescribeWorkflowExecution",
4368
+ "responses": {
4369
+ "200": {
4370
+ "description": "A successful response.",
4371
+ "schema": {
4372
+ "$ref": "#/definitions/v1DescribeWorkflowExecutionResponse"
4373
+ }
4374
+ },
4375
+ "default": {
4376
+ "description": "An unexpected error response.",
4377
+ "schema": {
4378
+ "$ref": "#/definitions/rpcStatus"
4379
+ }
4380
+ }
4381
+ },
4382
+ "parameters": [
4383
+ {
4384
+ "name": "namespace",
4385
+ "in": "path",
4386
+ "required": true,
4387
+ "type": "string"
4388
+ },
4389
+ {
4390
+ "name": "execution.workflowId",
4391
+ "in": "path",
4392
+ "required": true,
4393
+ "type": "string"
4394
+ },
4395
+ {
4396
+ "name": "execution.runId",
4397
+ "in": "query",
4398
+ "required": false,
4399
+ "type": "string"
4400
+ }
4401
+ ],
4402
+ "tags": [
4403
+ "WorkflowService"
4404
+ ]
4405
+ }
4406
+ },
4407
+ "/namespaces/{namespace}/workflows/{execution.workflowId}/history": {
4408
+ "get": {
4409
+ "summary": "GetWorkflowExecutionHistory returns the history of specified workflow execution. Fails with\n`NotFound` if the specified workflow execution is unknown to the service.",
4410
+ "operationId": "GetWorkflowExecutionHistory",
4411
+ "responses": {
4412
+ "200": {
4413
+ "description": "A successful response.",
4414
+ "schema": {
4415
+ "$ref": "#/definitions/v1GetWorkflowExecutionHistoryResponse"
4416
+ }
4417
+ },
4418
+ "default": {
4419
+ "description": "An unexpected error response.",
4420
+ "schema": {
4421
+ "$ref": "#/definitions/rpcStatus"
4422
+ }
4423
+ }
4424
+ },
4425
+ "parameters": [
4426
+ {
4427
+ "name": "namespace",
4428
+ "in": "path",
4429
+ "required": true,
4430
+ "type": "string"
4431
+ },
4432
+ {
4433
+ "name": "execution.workflowId",
4434
+ "in": "path",
4435
+ "required": true,
4436
+ "type": "string"
4437
+ },
4438
+ {
4439
+ "name": "execution.runId",
4440
+ "in": "query",
4441
+ "required": false,
4442
+ "type": "string"
4443
+ },
4444
+ {
4445
+ "name": "maximumPageSize",
4446
+ "in": "query",
4447
+ "required": false,
4448
+ "type": "integer",
4449
+ "format": "int32"
4450
+ },
4451
+ {
4452
+ "name": "nextPageToken",
4453
+ "description": "If a `GetWorkflowExecutionHistoryResponse` or a `PollWorkflowTaskQueueResponse` had one of\nthese, it should be passed here to fetch the next page.",
4454
+ "in": "query",
4455
+ "required": false,
4456
+ "type": "string",
4457
+ "format": "byte"
4458
+ },
4459
+ {
4460
+ "name": "waitNewEvent",
4461
+ "description": "If set to true, the RPC call will not resolve until there is a new event which matches\nthe `history_event_filter_type`, or a timeout is hit.",
4462
+ "in": "query",
4463
+ "required": false,
4464
+ "type": "boolean"
4465
+ },
4466
+ {
4467
+ "name": "historyEventFilterType",
4468
+ "description": "Filter returned events such that they match the specified filter type.\nDefault: HISTORY_EVENT_FILTER_TYPE_ALL_EVENT.",
4469
+ "in": "query",
4470
+ "required": false,
4471
+ "type": "string",
4472
+ "enum": [
4473
+ "HISTORY_EVENT_FILTER_TYPE_UNSPECIFIED",
4474
+ "HISTORY_EVENT_FILTER_TYPE_ALL_EVENT",
4475
+ "HISTORY_EVENT_FILTER_TYPE_CLOSE_EVENT"
4476
+ ],
4477
+ "default": "HISTORY_EVENT_FILTER_TYPE_UNSPECIFIED"
4478
+ },
4479
+ {
4480
+ "name": "skipArchival",
4481
+ "in": "query",
4482
+ "required": false,
4483
+ "type": "boolean"
4484
+ }
4485
+ ],
4486
+ "tags": [
4487
+ "WorkflowService"
4488
+ ]
4489
+ }
4490
+ },
4491
+ "/namespaces/{namespace}/workflows/{execution.workflowId}/history-reverse": {
4492
+ "get": {
4493
+ "summary": "GetWorkflowExecutionHistoryReverse returns the history of specified workflow execution in reverse \norder (starting from last event). Fails with`NotFound` if the specified workflow execution is \nunknown to the service.",
4494
+ "operationId": "GetWorkflowExecutionHistoryReverse",
4495
+ "responses": {
4496
+ "200": {
4497
+ "description": "A successful response.",
4498
+ "schema": {
4499
+ "$ref": "#/definitions/v1GetWorkflowExecutionHistoryReverseResponse"
4500
+ }
4501
+ },
4502
+ "default": {
4503
+ "description": "An unexpected error response.",
4504
+ "schema": {
4505
+ "$ref": "#/definitions/rpcStatus"
4506
+ }
4507
+ }
4508
+ },
4509
+ "parameters": [
4510
+ {
4511
+ "name": "namespace",
4512
+ "in": "path",
4513
+ "required": true,
4514
+ "type": "string"
4515
+ },
4516
+ {
4517
+ "name": "execution.workflowId",
4518
+ "in": "path",
4519
+ "required": true,
4520
+ "type": "string"
4521
+ },
4522
+ {
4523
+ "name": "execution.runId",
4524
+ "in": "query",
4525
+ "required": false,
4526
+ "type": "string"
4527
+ },
4528
+ {
4529
+ "name": "maximumPageSize",
4530
+ "in": "query",
4531
+ "required": false,
4532
+ "type": "integer",
4533
+ "format": "int32"
4534
+ },
4535
+ {
4536
+ "name": "nextPageToken",
4537
+ "in": "query",
4538
+ "required": false,
4539
+ "type": "string",
4540
+ "format": "byte"
4541
+ }
4542
+ ],
4543
+ "tags": [
4544
+ "WorkflowService"
4545
+ ]
4546
+ }
4547
+ },
4548
+ "/namespaces/{namespace}/workflows/{execution.workflowId}/query/{query.queryType}": {
4549
+ "post": {
4550
+ "summary": "QueryWorkflow requests a query be executed for a specified workflow execution.",
4551
+ "operationId": "QueryWorkflow",
4552
+ "responses": {
4553
+ "200": {
4554
+ "description": "A successful response.",
4555
+ "schema": {
4556
+ "$ref": "#/definitions/v1QueryWorkflowResponse"
4557
+ }
4558
+ },
4559
+ "default": {
4560
+ "description": "An unexpected error response.",
4561
+ "schema": {
4562
+ "$ref": "#/definitions/rpcStatus"
4563
+ }
4564
+ }
4565
+ },
4566
+ "parameters": [
4567
+ {
4568
+ "name": "namespace",
4569
+ "in": "path",
4570
+ "required": true,
4571
+ "type": "string"
4572
+ },
4573
+ {
4574
+ "name": "execution.workflowId",
4575
+ "in": "path",
4576
+ "required": true,
4577
+ "type": "string"
4578
+ },
4579
+ {
4580
+ "name": "query.queryType",
4581
+ "description": "The workflow-author-defined identifier of the query. Typically a function name.",
4582
+ "in": "path",
4583
+ "required": true,
4584
+ "type": "string"
4585
+ },
4586
+ {
4587
+ "name": "body",
4588
+ "in": "body",
4589
+ "required": true,
4590
+ "schema": {
4591
+ "$ref": "#/definitions/WorkflowServiceQueryWorkflowBody"
4592
+ }
4593
+ }
4594
+ ],
4595
+ "tags": [
4596
+ "WorkflowService"
4597
+ ]
4598
+ }
4599
+ },
4600
+ "/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/cancel": {
4601
+ "post": {
4602
+ "summary": "RequestCancelWorkflowExecution is called by workers when they want to request cancellation of\na workflow execution.",
4603
+ "description": "This results in a new `WORKFLOW_EXECUTION_CANCEL_REQUESTED` event being written to the\nworkflow history and a new workflow task created for the workflow. It returns success if the requested\nworkflow is already closed. It fails with 'NotFound' if the requested workflow doesn't exist.",
4604
+ "operationId": "RequestCancelWorkflowExecution",
4605
+ "responses": {
4606
+ "200": {
4607
+ "description": "A successful response.",
4608
+ "schema": {
4609
+ "$ref": "#/definitions/v1RequestCancelWorkflowExecutionResponse"
4610
+ }
4611
+ },
4612
+ "default": {
4613
+ "description": "An unexpected error response.",
4614
+ "schema": {
4615
+ "$ref": "#/definitions/rpcStatus"
4616
+ }
4617
+ }
4618
+ },
4619
+ "parameters": [
4620
+ {
4621
+ "name": "namespace",
4622
+ "in": "path",
4623
+ "required": true,
4624
+ "type": "string"
4625
+ },
4626
+ {
4627
+ "name": "workflowExecution.workflowId",
4628
+ "in": "path",
4629
+ "required": true,
4630
+ "type": "string"
4631
+ },
4632
+ {
4633
+ "name": "body",
4634
+ "in": "body",
4635
+ "required": true,
4636
+ "schema": {
4637
+ "$ref": "#/definitions/WorkflowServiceRequestCancelWorkflowExecutionBody"
4638
+ }
4639
+ }
4640
+ ],
4641
+ "tags": [
4642
+ "WorkflowService"
4643
+ ]
4644
+ }
4645
+ },
4646
+ "/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/reset": {
4647
+ "post": {
4648
+ "summary": "ResetWorkflowExecution will reset an existing workflow execution to a specified\n`WORKFLOW_TASK_COMPLETED` event (exclusive). It will immediately terminate the current\nexecution instance.\nTODO: Does exclusive here mean *just* the completed event, or also WFT started? Otherwise the task is doomed to time out?",
4649
+ "operationId": "ResetWorkflowExecution",
4650
+ "responses": {
4651
+ "200": {
4652
+ "description": "A successful response.",
4653
+ "schema": {
4654
+ "$ref": "#/definitions/v1ResetWorkflowExecutionResponse"
4655
+ }
4656
+ },
4657
+ "default": {
4658
+ "description": "An unexpected error response.",
4659
+ "schema": {
4660
+ "$ref": "#/definitions/rpcStatus"
4661
+ }
4662
+ }
4663
+ },
4664
+ "parameters": [
4665
+ {
4666
+ "name": "namespace",
4667
+ "in": "path",
4668
+ "required": true,
4669
+ "type": "string"
4670
+ },
4671
+ {
4672
+ "name": "workflowExecution.workflowId",
4673
+ "in": "path",
4674
+ "required": true,
4675
+ "type": "string"
4676
+ },
4677
+ {
4678
+ "name": "body",
4679
+ "in": "body",
4680
+ "required": true,
4681
+ "schema": {
4682
+ "$ref": "#/definitions/WorkflowServiceResetWorkflowExecutionBody"
4683
+ }
4684
+ }
4685
+ ],
4686
+ "tags": [
4687
+ "WorkflowService"
4688
+ ]
4689
+ }
4690
+ },
4691
+ "/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/signal/{signalName}": {
4692
+ "post": {
4693
+ "summary": "SignalWorkflowExecution is used to send a signal to a running workflow execution.",
4694
+ "description": "This results in a `WORKFLOW_EXECUTION_SIGNALED` event recorded in the history and a workflow\ntask being created for the execution.",
4695
+ "operationId": "SignalWorkflowExecution",
4696
+ "responses": {
4697
+ "200": {
4698
+ "description": "A successful response.",
4699
+ "schema": {
4700
+ "$ref": "#/definitions/v1SignalWorkflowExecutionResponse"
4701
+ }
4702
+ },
4703
+ "default": {
4704
+ "description": "An unexpected error response.",
4705
+ "schema": {
4706
+ "$ref": "#/definitions/rpcStatus"
4707
+ }
4708
+ }
4709
+ },
4710
+ "parameters": [
4711
+ {
4712
+ "name": "namespace",
4713
+ "in": "path",
4714
+ "required": true,
4715
+ "type": "string"
4716
+ },
4717
+ {
4718
+ "name": "workflowExecution.workflowId",
4719
+ "in": "path",
4720
+ "required": true,
4721
+ "type": "string"
4722
+ },
4723
+ {
4724
+ "name": "signalName",
4725
+ "description": "The workflow author-defined name of the signal to send to the workflow",
4726
+ "in": "path",
4727
+ "required": true,
4728
+ "type": "string"
4729
+ },
4730
+ {
4731
+ "name": "body",
4732
+ "in": "body",
4733
+ "required": true,
4734
+ "schema": {
4735
+ "$ref": "#/definitions/WorkflowServiceSignalWorkflowExecutionBody"
4736
+ }
4737
+ }
4738
+ ],
4739
+ "tags": [
4740
+ "WorkflowService"
4741
+ ]
4742
+ }
4743
+ },
4744
+ "/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/terminate": {
4745
+ "post": {
4746
+ "summary": "TerminateWorkflowExecution terminates an existing workflow execution by recording a\n`WORKFLOW_EXECUTION_TERMINATED` event in the history and immediately terminating the\nexecution instance.",
4747
+ "operationId": "TerminateWorkflowExecution",
4748
+ "responses": {
4749
+ "200": {
4750
+ "description": "A successful response.",
4751
+ "schema": {
4752
+ "$ref": "#/definitions/v1TerminateWorkflowExecutionResponse"
4753
+ }
4754
+ },
4755
+ "default": {
4756
+ "description": "An unexpected error response.",
4757
+ "schema": {
4758
+ "$ref": "#/definitions/rpcStatus"
4759
+ }
4760
+ }
4761
+ },
4762
+ "parameters": [
4763
+ {
4764
+ "name": "namespace",
4765
+ "in": "path",
4766
+ "required": true,
4767
+ "type": "string"
4768
+ },
4769
+ {
4770
+ "name": "workflowExecution.workflowId",
4771
+ "in": "path",
4772
+ "required": true,
4773
+ "type": "string"
4774
+ },
4775
+ {
4776
+ "name": "body",
4777
+ "in": "body",
4778
+ "required": true,
4779
+ "schema": {
4780
+ "$ref": "#/definitions/WorkflowServiceTerminateWorkflowExecutionBody"
4781
+ }
4782
+ }
4783
+ ],
4784
+ "tags": [
4785
+ "WorkflowService"
4786
+ ]
4787
+ }
4788
+ },
4789
+ "/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/update/{request.input.name}": {
4790
+ "post": {
4791
+ "summary": "Invokes the specified Update function on user Workflow code.",
4792
+ "operationId": "UpdateWorkflowExecution",
4793
+ "responses": {
4794
+ "200": {
4795
+ "description": "A successful response.",
4796
+ "schema": {
4797
+ "$ref": "#/definitions/v1UpdateWorkflowExecutionResponse"
4798
+ }
4799
+ },
4800
+ "default": {
4801
+ "description": "An unexpected error response.",
4802
+ "schema": {
4803
+ "$ref": "#/definitions/rpcStatus"
4804
+ }
4805
+ }
4806
+ },
4807
+ "parameters": [
4808
+ {
4809
+ "name": "namespace",
4810
+ "description": "The namespace name of the target Workflow.",
4811
+ "in": "path",
4812
+ "required": true,
4813
+ "type": "string"
4814
+ },
4815
+ {
4816
+ "name": "workflowExecution.workflowId",
4817
+ "in": "path",
4818
+ "required": true,
4819
+ "type": "string"
4820
+ },
4821
+ {
4822
+ "name": "request.input.name",
4823
+ "description": "The name of the Update handler to invoke on the target Workflow.",
4824
+ "in": "path",
4825
+ "required": true,
4826
+ "type": "string"
4827
+ },
4828
+ {
4829
+ "name": "body",
4830
+ "in": "body",
4831
+ "required": true,
4832
+ "schema": {
4833
+ "$ref": "#/definitions/WorkflowServiceUpdateWorkflowExecutionBody"
4834
+ }
4835
+ }
4836
+ ],
4837
+ "tags": [
4838
+ "WorkflowService"
4839
+ ]
4840
+ }
4841
+ },
4842
+ "/namespaces/{namespace}/workflows/{workflowId}": {
4843
+ "post": {
4844
+ "summary": "StartWorkflowExecution starts a new workflow execution.",
4845
+ "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.",
4846
+ "operationId": "StartWorkflowExecution",
4847
+ "responses": {
4848
+ "200": {
4849
+ "description": "A successful response.",
4850
+ "schema": {
4851
+ "$ref": "#/definitions/v1StartWorkflowExecutionResponse"
4852
+ }
4853
+ },
4854
+ "default": {
4855
+ "description": "An unexpected error response.",
4856
+ "schema": {
4857
+ "$ref": "#/definitions/rpcStatus"
4858
+ }
4859
+ }
4860
+ },
4861
+ "parameters": [
4862
+ {
4863
+ "name": "namespace",
4864
+ "in": "path",
4865
+ "required": true,
4866
+ "type": "string"
4867
+ },
4868
+ {
4869
+ "name": "workflowId",
4870
+ "in": "path",
4871
+ "required": true,
4872
+ "type": "string"
4873
+ },
4874
+ {
4875
+ "name": "body",
4876
+ "in": "body",
4877
+ "required": true,
4878
+ "schema": {
4879
+ "$ref": "#/definitions/WorkflowServiceStartWorkflowExecutionBody"
4880
+ }
4881
+ }
4882
+ ],
4883
+ "tags": [
4884
+ "WorkflowService"
4885
+ ]
4886
+ }
4887
+ },
4888
+ "/namespaces/{namespace}/workflows/{workflowId}/signal-with-start/{signalName}": {
4889
+ "post": {
4890
+ "summary": "SignalWithStartWorkflowExecution is used to ensure a signal is sent to a workflow, even if\nit isn't yet started.",
4891
+ "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.",
4892
+ "operationId": "SignalWithStartWorkflowExecution",
4893
+ "responses": {
4894
+ "200": {
4895
+ "description": "A successful response.",
4896
+ "schema": {
4897
+ "$ref": "#/definitions/v1SignalWithStartWorkflowExecutionResponse"
4898
+ }
4899
+ },
4900
+ "default": {
4901
+ "description": "An unexpected error response.",
4902
+ "schema": {
4903
+ "$ref": "#/definitions/rpcStatus"
4904
+ }
4905
+ }
4906
+ },
4907
+ "parameters": [
4908
+ {
4909
+ "name": "namespace",
4910
+ "in": "path",
4911
+ "required": true,
4912
+ "type": "string"
4913
+ },
4914
+ {
4915
+ "name": "workflowId",
4916
+ "in": "path",
4917
+ "required": true,
4918
+ "type": "string"
4919
+ },
4920
+ {
4921
+ "name": "signalName",
4922
+ "description": "The workflow author-defined name of the signal to send to the workflow",
4923
+ "in": "path",
4924
+ "required": true,
4925
+ "type": "string"
4926
+ },
4927
+ {
4928
+ "name": "body",
4929
+ "in": "body",
4930
+ "required": true,
4931
+ "schema": {
4932
+ "$ref": "#/definitions/WorkflowServiceSignalWithStartWorkflowExecutionBody"
4933
+ }
4934
+ }
4935
+ ],
4936
+ "tags": [
4937
+ "WorkflowService"
4938
+ ]
4939
+ }
4940
+ },
4941
+ "/system-info": {
4942
+ "get": {
4943
+ "summary": "GetSystemInfo returns information about the system.",
4944
+ "operationId": "GetSystemInfo",
4945
+ "responses": {
4946
+ "200": {
4947
+ "description": "A successful response.",
4948
+ "schema": {
4949
+ "$ref": "#/definitions/v1GetSystemInfoResponse"
4950
+ }
4951
+ },
4952
+ "default": {
4953
+ "description": "An unexpected error response.",
4954
+ "schema": {
4955
+ "$ref": "#/definitions/rpcStatus"
4956
+ }
4957
+ }
4958
+ },
4959
+ "tags": [
4960
+ "WorkflowService"
4961
+ ]
4962
+ }
4963
+ }
4964
+ },
4965
+ "definitions": {
4966
+ "CallbackInfoTrigger": {
4967
+ "type": "object",
4968
+ "properties": {
4969
+ "workflowClosed": {
4970
+ "$ref": "#/definitions/CallbackInfoWorkflowClosed"
4971
+ }
4972
+ }
4973
+ },
4974
+ "CallbackInfoWorkflowClosed": {
4975
+ "type": "object",
4976
+ "description": "Trigger for when the workflow is closed."
4977
+ },
4978
+ "CallbackInternal": {
4979
+ "type": "object",
4980
+ "properties": {
4981
+ "data": {
4982
+ "type": "string",
4983
+ "format": "byte",
4984
+ "description": "Opaque internal data."
4985
+ }
4986
+ },
4987
+ "description": "Callbacks to be delivered internally within the system.\nThis variant is not settable in the API and will be rejected by the service with an INVALID_ARGUMENT error.\nThe only reason that this is exposed is because callbacks are replicated across clusters via the\nWorkflowExecutionStarted event, which is defined in the public API."
2345
4988
  },
2346
4989
  "CallbackNexus": {
2347
4990
  "type": "object",
@@ -2404,10 +5047,37 @@
2404
5047
  "properties": {
2405
5048
  "startWorkflow": {
2406
5049
  "$ref": "#/definitions/v1StartWorkflowExecutionRequest",
2407
- "title": "Additional restrictions:\n- setting `cron_schedule` is invalid\n- setting `request_eager_execution` is invalid"
5050
+ "title": "Additional restrictions:\n- setting `cron_schedule` is invalid\n- setting `request_eager_execution` is invalid\n- setting `workflow_start_delay` is invalid"
2408
5051
  },
2409
5052
  "updateWorkflow": {
2410
- "$ref": "#/definitions/v1UpdateWorkflowExecutionRequest"
5053
+ "$ref": "#/definitions/v1UpdateWorkflowExecutionRequest",
5054
+ "title": "Additional restrictions:\n- setting `first_execution_run_id` is invalid\n- setting `workflow_execution.run_id` is invalid"
5055
+ }
5056
+ }
5057
+ },
5058
+ "LinkBatchJob": {
5059
+ "type": "object",
5060
+ "properties": {
5061
+ "jobId": {
5062
+ "type": "string"
5063
+ }
5064
+ },
5065
+ "description": "A link to a built-in batch job.\nBatch jobs can be used to perform operations on a set of workflows (e.g. terminate, signal, cancel, etc).\nThis link can be put on workflow history events generated by actions taken by a batch job."
5066
+ },
5067
+ "LinkWorkflowEvent": {
5068
+ "type": "object",
5069
+ "properties": {
5070
+ "namespace": {
5071
+ "type": "string"
5072
+ },
5073
+ "workflowId": {
5074
+ "type": "string"
5075
+ },
5076
+ "runId": {
5077
+ "type": "string"
5078
+ },
5079
+ "eventRef": {
5080
+ "$ref": "#/definitions/WorkflowEventEventReference"
2411
5081
  }
2412
5082
  }
2413
5083
  },
@@ -2429,6 +5099,13 @@
2429
5099
  "properties": {
2430
5100
  "operationId": {
2431
5101
  "type": "string"
5102
+ },
5103
+ "links": {
5104
+ "type": "array",
5105
+ "items": {
5106
+ "type": "object",
5107
+ "$ref": "#/definitions/apinexusv1Link"
5108
+ }
2432
5109
  }
2433
5110
  },
2434
5111
  "description": "The operation will complete asynchronously.\nThe returned ID can be used to reference this operation."
@@ -2439,8 +5116,30 @@
2439
5116
  "payload": {
2440
5117
  "$ref": "#/definitions/v1Payload"
2441
5118
  }
2442
- },
2443
- "description": "An operation completed successfully."
5119
+ },
5120
+ "description": "An operation completed successfully."
5121
+ },
5122
+ "UnpauseActivityByIdRequestResetOperation": {
5123
+ "type": "object",
5124
+ "properties": {
5125
+ "noWait": {
5126
+ "type": "boolean",
5127
+ "description": "Indicates that the activity should be scheduled immediately.\nNote that this may run simultaneously with any existing executions of the activity."
5128
+ },
5129
+ "resetHeartbeat": {
5130
+ "type": "boolean",
5131
+ "title": "If set, the Heartbeat Details will be cleared out to make the Activity start over from the beginning"
5132
+ }
5133
+ }
5134
+ },
5135
+ "UnpauseActivityByIdRequestResumeOperation": {
5136
+ "type": "object",
5137
+ "properties": {
5138
+ "noWait": {
5139
+ "type": "boolean",
5140
+ "description": "Indicates that if the activity is waiting to retry, it will be scheduled immediately."
5141
+ }
5142
+ }
2444
5143
  },
2445
5144
  "UpdateWorkerBuildIdCompatibilityRequestAddNewCompatibleVersion": {
2446
5145
  "type": "object",
@@ -2555,6 +5254,18 @@
2555
5254
  },
2556
5255
  "description": "Replaces the routing rule with the given source Build ID."
2557
5256
  },
5257
+ "WorkflowEventEventReference": {
5258
+ "type": "object",
5259
+ "properties": {
5260
+ "eventId": {
5261
+ "type": "string",
5262
+ "format": "int64"
5263
+ },
5264
+ "eventType": {
5265
+ "$ref": "#/definitions/v1EventType"
5266
+ }
5267
+ }
5268
+ },
2558
5269
  "WorkflowServiceCreateScheduleBody": {
2559
5270
  "type": "object",
2560
5271
  "properties": {
@@ -2612,6 +5323,31 @@
2612
5323
  }
2613
5324
  }
2614
5325
  },
5326
+ "WorkflowServicePauseActivityByIdBody": {
5327
+ "type": "object",
5328
+ "properties": {
5329
+ "workflowId": {
5330
+ "type": "string",
5331
+ "description": "ID of the workflow which scheduled this activity."
5332
+ },
5333
+ "runId": {
5334
+ "type": "string",
5335
+ "description": "Run ID of the workflow which scheduled this activity.\nIf empty - latest workflow is used."
5336
+ },
5337
+ "activityId": {
5338
+ "type": "string",
5339
+ "description": "ID of the activity we're updating."
5340
+ },
5341
+ "identity": {
5342
+ "type": "string",
5343
+ "description": "The identity of the client who initiated this request."
5344
+ },
5345
+ "requestId": {
5346
+ "type": "string",
5347
+ "description": "Used to de-dupe requests."
5348
+ }
5349
+ }
5350
+ },
2615
5351
  "WorkflowServiceQueryWorkflowBody": {
2616
5352
  "type": "object",
2617
5353
  "properties": {
@@ -2714,6 +5450,47 @@
2714
5450
  "reason": {
2715
5451
  "type": "string",
2716
5452
  "title": "Reason for requesting the cancellation"
5453
+ },
5454
+ "links": {
5455
+ "type": "array",
5456
+ "items": {
5457
+ "type": "object",
5458
+ "$ref": "#/definitions/apicommonv1Link"
5459
+ },
5460
+ "description": "Links to be associated with the WorkflowExecutionCanceled event."
5461
+ }
5462
+ }
5463
+ },
5464
+ "WorkflowServiceResetActivityByIdBody": {
5465
+ "type": "object",
5466
+ "properties": {
5467
+ "workflowId": {
5468
+ "type": "string",
5469
+ "description": "ID of the workflow which scheduled this activity."
5470
+ },
5471
+ "runId": {
5472
+ "type": "string",
5473
+ "description": "Run ID of the workflow which scheduled this activity.\nIf empty - latest workflow is used."
5474
+ },
5475
+ "activityId": {
5476
+ "type": "string",
5477
+ "description": "ID of the activity we're updating."
5478
+ },
5479
+ "identity": {
5480
+ "type": "string",
5481
+ "description": "The identity of the client who initiated this request."
5482
+ },
5483
+ "requestId": {
5484
+ "type": "string",
5485
+ "description": "Used to de-dupe requests."
5486
+ },
5487
+ "noWait": {
5488
+ "type": "boolean",
5489
+ "description": "Indicates that activity should be scheduled immediately.\nIf this flag doesn't set, and activity currently running - temporal will wait until activity is completed."
5490
+ },
5491
+ "resetHeartbeat": {
5492
+ "type": "boolean",
5493
+ "description": "Indicates that activity should reset heartbeat details.\nThis flag will be applied only to the new instance of the activity."
2717
5494
  }
2718
5495
  }
2719
5496
  },
@@ -2981,6 +5758,14 @@
2981
5758
  "userMetadata": {
2982
5759
  "$ref": "#/definitions/v1UserMetadata",
2983
5760
  "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."
5761
+ },
5762
+ "links": {
5763
+ "type": "array",
5764
+ "items": {
5765
+ "type": "object",
5766
+ "$ref": "#/definitions/apicommonv1Link"
5767
+ },
5768
+ "description": "Links to be associated with the WorkflowExecutionStarted and WorkflowExecutionSignaled events."
2984
5769
  }
2985
5770
  }
2986
5771
  },
@@ -3019,6 +5804,14 @@
3019
5804
  "skipGenerateWorkflowTask": {
3020
5805
  "type": "boolean",
3021
5806
  "description": "Indicates that a new workflow task should not be generated when this signal is received."
5807
+ },
5808
+ "links": {
5809
+ "type": "array",
5810
+ "items": {
5811
+ "type": "object",
5812
+ "$ref": "#/definitions/apicommonv1Link"
5813
+ },
5814
+ "description": "Links to be associated with the WorkflowExecutionSignaled event."
3022
5815
  }
3023
5816
  }
3024
5817
  },
@@ -3147,6 +5940,14 @@
3147
5940
  "userMetadata": {
3148
5941
  "$ref": "#/definitions/v1UserMetadata",
3149
5942
  "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."
5943
+ },
5944
+ "links": {
5945
+ "type": "array",
5946
+ "items": {
5947
+ "type": "object",
5948
+ "$ref": "#/definitions/apicommonv1Link"
5949
+ },
5950
+ "description": "Links to be associated with the workflow."
3150
5951
  }
3151
5952
  }
3152
5953
  },
@@ -3189,6 +5990,78 @@
3189
5990
  "firstExecutionRunId": {
3190
5991
  "type": "string",
3191
5992
  "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 part of the same\nexecution chain as this id."
5993
+ },
5994
+ "links": {
5995
+ "type": "array",
5996
+ "items": {
5997
+ "type": "object",
5998
+ "$ref": "#/definitions/apicommonv1Link"
5999
+ },
6000
+ "description": "Links to be associated with the WorkflowExecutionTerminated event."
6001
+ }
6002
+ }
6003
+ },
6004
+ "WorkflowServiceUnpauseActivityByIdBody": {
6005
+ "type": "object",
6006
+ "properties": {
6007
+ "workflowId": {
6008
+ "type": "string",
6009
+ "description": "ID of the workflow which scheduled this activity."
6010
+ },
6011
+ "runId": {
6012
+ "type": "string",
6013
+ "description": "Run ID of the workflow which scheduled this activity.\nIf empty - latest workflow is used."
6014
+ },
6015
+ "activityId": {
6016
+ "type": "string",
6017
+ "description": "ID of the activity we're updating."
6018
+ },
6019
+ "identity": {
6020
+ "type": "string",
6021
+ "description": "The identity of the client who initiated this request."
6022
+ },
6023
+ "requestId": {
6024
+ "type": "string",
6025
+ "description": "Used to de-dupe requests."
6026
+ },
6027
+ "resume": {
6028
+ "$ref": "#/definitions/UnpauseActivityByIdRequestResumeOperation"
6029
+ },
6030
+ "reset": {
6031
+ "$ref": "#/definitions/UnpauseActivityByIdRequestResetOperation"
6032
+ }
6033
+ }
6034
+ },
6035
+ "WorkflowServiceUpdateActivityOptionsByIdBody": {
6036
+ "type": "object",
6037
+ "properties": {
6038
+ "workflowId": {
6039
+ "type": "string",
6040
+ "title": "ID of the workflow which scheduled this activity"
6041
+ },
6042
+ "runId": {
6043
+ "type": "string",
6044
+ "title": "Run ID of the workflow which scheduled this activity\nif empty - latest workflow is used"
6045
+ },
6046
+ "activityId": {
6047
+ "type": "string",
6048
+ "title": "ID of the activity we're updating"
6049
+ },
6050
+ "identity": {
6051
+ "type": "string",
6052
+ "title": "The identity of the client who initiated this request"
6053
+ },
6054
+ "activityOptions": {
6055
+ "$ref": "#/definitions/v1ActivityOptions",
6056
+ "title": "Activity options. Partial updates are accepted and controlled by update_mask"
6057
+ },
6058
+ "updateMask": {
6059
+ "type": "string",
6060
+ "title": "Controls which fields from `activity_options` will be applied"
6061
+ },
6062
+ "requestId": {
6063
+ "type": "string",
6064
+ "title": "Used to de-dupe requests"
3192
6065
  }
3193
6066
  }
3194
6067
  },
@@ -3252,15 +6125,16 @@
3252
6125
  "type": "string"
3253
6126
  }
3254
6127
  },
3255
- "title": "The target workflow id and (optionally) a specific run thereof"
6128
+ "description": "The target Workflow Id and (optionally) a specific Run Id thereof.",
6129
+ "title": "The target Workflow Id and (optionally) a specific Run Id thereof."
3256
6130
  },
3257
6131
  "firstExecutionRunId": {
3258
6132
  "type": "string",
3259
- "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."
6133
+ "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."
3260
6134
  },
3261
6135
  "waitPolicy": {
3262
6136
  "$ref": "#/definitions/v1WaitPolicy",
3263
- "description": "Describes when this request should return - basically whether the\nupdate is synchronous, asynchronous, or somewhere in between."
6137
+ "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."
3264
6138
  },
3265
6139
  "request": {
3266
6140
  "type": "object",
@@ -3273,20 +6147,32 @@
3273
6147
  "properties": {
3274
6148
  "header": {
3275
6149
  "$ref": "#/definitions/v1Header",
3276
- "description": "Headers that are passed with the update from the requesting entity.\nThese can include things like auth or tracing tokens."
6150
+ "description": "Headers that are passed with the Update from the requesting entity.\nThese can include things like auth or tracing tokens."
3277
6151
  },
3278
6152
  "args": {
3279
6153
  "$ref": "#/definitions/v1Payloads",
3280
- "description": "The arguments to pass to the named handler."
6154
+ "description": "The arguments to pass to the named Update handler."
3281
6155
  }
3282
6156
  }
3283
6157
  }
3284
6158
  },
3285
- "description": "The request information that will be delivered all the way down to the\nworkflow execution.",
3286
- "title": "The request information that will be delivered all the way down to the\nworkflow execution."
6159
+ "description": "The request information that will be delivered all the way down to the\nWorkflow Execution.",
6160
+ "title": "The request information that will be delivered all the way down to the\nWorkflow Execution."
3287
6161
  }
3288
6162
  }
3289
6163
  },
6164
+ "apicommonv1Link": {
6165
+ "type": "object",
6166
+ "properties": {
6167
+ "workflowEvent": {
6168
+ "$ref": "#/definitions/LinkWorkflowEvent"
6169
+ },
6170
+ "batchJob": {
6171
+ "$ref": "#/definitions/LinkBatchJob"
6172
+ }
6173
+ },
6174
+ "description": "Link can be associated with history events. It might contain information about an external entity\nrelated to the history event. For example, workflow A makes a Nexus call that starts workflow B:\nin this case, a history event in workflow A could contain a Link to the workflow started event in\nworkflow B, and vice-versa."
6175
+ },
3290
6176
  "apifailurev1Failure": {
3291
6177
  "type": "object",
3292
6178
  "properties": {
@@ -3302,7 +6188,7 @@
3302
6188
  },
3303
6189
  "encodedAttributes": {
3304
6190
  "$ref": "#/definitions/v1Payload",
3305
- "description": "Alternative way to supply `message` and `stack_trace` and possibly other attributes, used for encryption of\nerrors originating in user code which might contain sensitive information.\nThe `encoded_attributes` Payload could represent any serializable object, e.g. JSON object or a `Failure` proto\nmessage.\n\nSDK authors: \n- The SDK should provide a default `encodeFailureAttributes` and `decodeFailureAttributes` implementation that:\n - Uses a JSON object to represent `{ message, stack_trace }`.\n - Overwrites the original message with \"Encoded failure\" to indicate that more information could be extracted.\n - Overwrites the original stack_trace with an empty string.\n - The resulting JSON object is converted to Payload using the default PayloadConverter and should be processed\n by the user-provided PayloadCodec\n\n- If there's demand, we could allow overriding the default SDK implementation to encode other opaque Failure attributes."
6191
+ "description": "Alternative way to supply `message` and `stack_trace` and possibly other attributes, used for encryption of\nerrors originating in user code which might contain sensitive information.\nThe `encoded_attributes` Payload could represent any serializable object, e.g. JSON object or a `Failure` proto\nmessage.\n\nSDK authors:\n- The SDK should provide a default `encodeFailureAttributes` and `decodeFailureAttributes` implementation that:\n - Uses a JSON object to represent `{ message, stack_trace }`.\n - Overwrites the original message with \"Encoded failure\" to indicate that more information could be extracted.\n - Overwrites the original stack_trace with an empty string.\n - The resulting JSON object is converted to Payload using the default PayloadConverter and should be processed\n by the user-provided PayloadCodec\n\n- If there's demand, we could allow overriding the default SDK implementation to encode other opaque Failure attributes."
3306
6192
  },
3307
6193
  "cause": {
3308
6194
  "$ref": "#/definitions/apifailurev1Failure"
@@ -3355,6 +6241,18 @@
3355
6241
  },
3356
6242
  "title": "A general purpose failure message.\nSee: https://github.com/nexus-rpc/api/blob/main/SPEC.md#failure"
3357
6243
  },
6244
+ "apinexusv1Link": {
6245
+ "type": "object",
6246
+ "properties": {
6247
+ "url": {
6248
+ "type": "string",
6249
+ "description": "See https://github.com/nexus-rpc/api/blob/main/SPEC.md#links."
6250
+ },
6251
+ "type": {
6252
+ "type": "string"
6253
+ }
6254
+ }
6255
+ },
3358
6256
  "apinexusv1Request": {
3359
6257
  "type": "object",
3360
6258
  "properties": {
@@ -3401,7 +6299,7 @@
3401
6299
  "$ref": "#/definitions/v1Input"
3402
6300
  }
3403
6301
  },
3404
- "title": "The client request that triggers a workflow execution update"
6302
+ "description": "The client request that triggers a Workflow Update."
3405
6303
  },
3406
6304
  "protobufAny": {
3407
6305
  "type": "object",
@@ -3458,6 +6356,33 @@
3458
6356
  }
3459
6357
  }
3460
6358
  },
6359
+ "v1ActivityOptions": {
6360
+ "type": "object",
6361
+ "properties": {
6362
+ "taskQueue": {
6363
+ "$ref": "#/definitions/v1TaskQueue"
6364
+ },
6365
+ "scheduleToCloseTimeout": {
6366
+ "type": "string",
6367
+ "description": "Indicates how long the caller is willing to wait for an activity completion. Limits how long\nretries will be attempted. Either this or `start_to_close_timeout` must be specified.\n"
6368
+ },
6369
+ "scheduleToStartTimeout": {
6370
+ "type": "string",
6371
+ "description": "Limits time an activity task can stay in a task queue before a worker picks it up. This\ntimeout is always non retryable, as all a retry would achieve is to put it back into the same\nqueue. Defaults to `schedule_to_close_timeout` or workflow execution timeout if not\nspecified.\n"
6372
+ },
6373
+ "startToCloseTimeout": {
6374
+ "type": "string",
6375
+ "description": "Maximum time an activity is allowed to execute after being picked up by a worker. This\ntimeout is always retryable. Either this or `schedule_to_close_timeout` must be\nspecified.\n"
6376
+ },
6377
+ "heartbeatTimeout": {
6378
+ "type": "string",
6379
+ "description": "Maximum permitted time between successful worker heartbeats."
6380
+ },
6381
+ "retryPolicy": {
6382
+ "$ref": "#/definitions/v1RetryPolicy"
6383
+ }
6384
+ }
6385
+ },
3461
6386
  "v1ActivityPropertiesModifiedExternallyEventAttributes": {
3462
6387
  "type": "object",
3463
6388
  "properties": {
@@ -3725,7 +6650,7 @@
3725
6650
  },
3726
6651
  "nextRetryDelay": {
3727
6652
  "type": "string",
3728
- "description": "next_retry_delay can be used by the client to override the activity\nretry interval calculated by the retry policy. Retry attempts will\nstill be subject to the maximum retries limit and total time limit\ndefined by the policy.\nATTENTION: this value will be ignored if set for failures produced by\nthe workflow."
6653
+ "description": "next_retry_delay can be used by the client to override the activity\nretry interval calculated by the retry policy. Retry attempts will\nstill be subject to the maximum retries limit and total time limit\ndefined by the policy."
3729
6654
  }
3730
6655
  }
3731
6656
  },
@@ -3945,7 +6870,7 @@
3945
6870
  "BUILD_ID_TASK_REACHABILITY_UNREACHABLE"
3946
6871
  ],
3947
6872
  "default": "BUILD_ID_TASK_REACHABILITY_UNSPECIFIED",
3948
- "description": "Specifies which category of tasks may reach a versioned worker of a certain Build ID.\n\nTask Reachability is eventually consistent; there may be a delay until it converges to the most\naccurate value but it is designed in a way to take the more conservative side until it converges.\nFor example REACHABLE is more conservative than CLOSED_WORKFLOWS_ONLY.\n\nNote: future activities who inherit their workflow's Build ID but not its Task Queue will not be\naccounted for reachability as server cannot know if they'll happen as they do not use\nassignment rules of their Task Queue. Same goes for Child Workflows or Continue-As-New Workflows\nwho inherit the parent/previous workflow's Build ID but not its Task Queue. In those cases, make\nsure to query reachability for the parent/previous workflow's Task Queue as well.\n\n - BUILD_ID_TASK_REACHABILITY_UNSPECIFIED: Task reachability is not reported\n - BUILD_ID_TASK_REACHABILITY_REACHABLE: Build ID may be used by new workflows or activities (base on versioning rules), or there MAY\nbe open workflows or backlogged activities assigned to it.\n - BUILD_ID_TASK_REACHABILITY_CLOSED_WORKFLOWS_ONLY: Build ID does not have open workflows and is not reachable by new workflows,\nbut MAY have closed workflows within the namespace retention period.\nNot applicable to activity-only task queues.\n - BUILD_ID_TASK_REACHABILITY_UNREACHABLE: Build ID is not used for new executions, nor it has been used by any existing execution\nwithin the retention period."
6873
+ "description": "Specifies which category of tasks may reach a versioned worker of a certain Build ID.\n\nTask Reachability is eventually consistent; there may be a delay (up to few minutes) until it\nconverges to the most accurate value but it is designed in a way to take the more conservative\nside until it converges. For example REACHABLE is more conservative than CLOSED_WORKFLOWS_ONLY.\n\nNote: future activities who inherit their workflow's Build ID but not its Task Queue will not be\naccounted for reachability as server cannot know if they'll happen as they do not use\nassignment rules of their Task Queue. Same goes for Child Workflows or Continue-As-New Workflows\nwho inherit the parent/previous workflow's Build ID but not its Task Queue. In those cases, make\nsure to query reachability for the parent/previous workflow's Task Queue as well.\n\n - BUILD_ID_TASK_REACHABILITY_UNSPECIFIED: Task reachability is not reported\n - BUILD_ID_TASK_REACHABILITY_REACHABLE: Build ID may be used by new workflows or activities (base on versioning rules), or there MAY\nbe open workflows or backlogged activities assigned to it.\n - BUILD_ID_TASK_REACHABILITY_CLOSED_WORKFLOWS_ONLY: Build ID does not have open workflows and is not reachable by new workflows,\nbut MAY have closed workflows within the namespace retention period.\nNot applicable to activity-only task queues.\n - BUILD_ID_TASK_REACHABILITY_UNREACHABLE: Build ID is not used for new executions, nor it has been used by any existing execution\nwithin the retention period."
3949
6874
  },
3950
6875
  "v1CalendarSpec": {
3951
6876
  "type": "object",
@@ -3990,6 +6915,9 @@
3990
6915
  "properties": {
3991
6916
  "nexus": {
3992
6917
  "$ref": "#/definitions/CallbackNexus"
6918
+ },
6919
+ "internal": {
6920
+ "$ref": "#/definitions/CallbackInternal"
3993
6921
  }
3994
6922
  },
3995
6923
  "description": "Callback to attach to various events in the system, e.g. workflow run completion."
@@ -4852,8 +7780,9 @@
4852
7780
  "type": "string",
4853
7781
  "description": "Endpoint name, unique for this cluster. Must match `[a-zA-Z_][a-zA-Z0-9_]*`.\nRenaming an endpoint breaks all workflow callers that reference this endpoint, causing operations to fail."
4854
7782
  },
4855
- "metadata": {
4856
- "$ref": "#/definitions/v1UserMetadata"
7783
+ "description": {
7784
+ "$ref": "#/definitions/v1Payload",
7785
+ "description": "Markdown description serialized as a single JSON string.\nIf the Payload is encrypted, the UI and CLI may decrypt with the configured codec server endpoint.\nBy default, the server enforces a limit of 20,000 bytes for this entire payload."
4857
7786
  },
4858
7787
  "target": {
4859
7788
  "$ref": "#/definitions/v1EndpointTarget",
@@ -4918,13 +7847,13 @@
4918
7847
  "EVENT_TYPE_SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_FAILED",
4919
7848
  "EVENT_TYPE_EXTERNAL_WORKFLOW_EXECUTION_SIGNALED",
4920
7849
  "EVENT_TYPE_UPSERT_WORKFLOW_SEARCH_ATTRIBUTES",
7850
+ "EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_ADMITTED",
4921
7851
  "EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_ACCEPTED",
4922
7852
  "EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_REJECTED",
4923
7853
  "EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_COMPLETED",
4924
7854
  "EVENT_TYPE_WORKFLOW_PROPERTIES_MODIFIED_EXTERNALLY",
4925
7855
  "EVENT_TYPE_ACTIVITY_PROPERTIES_MODIFIED_EXTERNALLY",
4926
7856
  "EVENT_TYPE_WORKFLOW_PROPERTIES_MODIFIED",
4927
- "EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_ADMITTED",
4928
7857
  "EVENT_TYPE_NEXUS_OPERATION_SCHEDULED",
4929
7858
  "EVENT_TYPE_NEXUS_OPERATION_STARTED",
4930
7859
  "EVENT_TYPE_NEXUS_OPERATION_COMPLETED",
@@ -4934,7 +7863,7 @@
4934
7863
  "EVENT_TYPE_NEXUS_OPERATION_CANCEL_REQUESTED"
4935
7864
  ],
4936
7865
  "default": "EVENT_TYPE_UNSPECIFIED",
4937
- "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_ACCEPTED: An update was accepted (i.e. validated)\n - EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_REJECTED: An update was rejected (i.e. failed validation)\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_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_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.",
7866
+ "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.",
4938
7867
  "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"
4939
7868
  },
4940
7869
  "v1ExecuteMultiOperationResponse": {
@@ -5136,6 +8065,10 @@
5136
8065
  "countGroupByExecutionStatus": {
5137
8066
  "type": "boolean",
5138
8067
  "title": "True if the server supports count group by execution status"
8068
+ },
8069
+ "nexus": {
8070
+ "type": "boolean",
8071
+ "description": "True if the server supports Nexus operations.\nThis flag is dependent both on server version and for Nexus to be enabled via server configuration."
5139
8072
  }
5140
8073
  },
5141
8074
  "description": "System capability details."
@@ -5297,6 +8230,14 @@
5297
8230
  "$ref": "#/definitions/v1UserMetadata",
5298
8231
  "description": "Metadata on the event. This is often carried over from commands and client calls. Most events\nwon't have this information, and how this information is used is dependent upon the interface\nthat reads it.\n\nCurrent well-known uses:\n * workflow_execution_started_event_attributes - summary and details from start workflow.\n * timer_started_event_attributes - summary represents an identifier for the timer for use by\n user interfaces."
5299
8232
  },
8233
+ "links": {
8234
+ "type": "array",
8235
+ "items": {
8236
+ "type": "object",
8237
+ "$ref": "#/definitions/apicommonv1Link"
8238
+ },
8239
+ "description": "Links associated with the event."
8240
+ },
5300
8241
  "workflowExecutionStartedEventAttributes": {
5301
8242
  "$ref": "#/definitions/v1WorkflowExecutionStartedEventAttributes"
5302
8243
  },
@@ -5490,15 +8431,15 @@
5490
8431
  "properties": {
5491
8432
  "header": {
5492
8433
  "$ref": "#/definitions/v1Header",
5493
- "description": "Headers that are passed with the update from the requesting entity.\nThese can include things like auth or tracing tokens."
8434
+ "description": "Headers that are passed with the Update from the requesting entity.\nThese can include things like auth or tracing tokens."
5494
8435
  },
5495
8436
  "name": {
5496
8437
  "type": "string",
5497
- "title": "The name of the input handler to invoke on the target workflow"
8438
+ "description": "The name of the Update handler to invoke on the target Workflow."
5498
8439
  },
5499
8440
  "args": {
5500
8441
  "$ref": "#/definitions/v1Payloads",
5501
- "description": "The arguments to pass to the named handler."
8442
+ "description": "The arguments to pass to the named Update handler."
5502
8443
  }
5503
8444
  }
5504
8445
  },
@@ -5788,14 +8729,14 @@
5788
8729
  "properties": {
5789
8730
  "updateId": {
5790
8731
  "type": "string",
5791
- "title": "An ID with workflow-scoped uniqueness for this update"
8732
+ "description": "An ID with workflow-scoped uniqueness for this Update."
5792
8733
  },
5793
8734
  "identity": {
5794
8735
  "type": "string",
5795
- "description": "A string identifying the agent that requested this update."
8736
+ "description": "A string identifying the agent that requested this Update."
5796
8737
  }
5797
8738
  },
5798
- "description": "Metadata about a workflow execution update."
8739
+ "description": "Metadata about a Workflow Update."
5799
8740
  },
5800
8741
  "v1MeteringMetadata": {
5801
8742
  "type": "object",
@@ -6021,6 +8962,10 @@
6021
8962
  "failure": {
6022
8963
  "$ref": "#/definitions/apifailurev1Failure",
6023
8964
  "description": "Cancellation details."
8965
+ },
8966
+ "requestId": {
8967
+ "type": "string",
8968
+ "description": "The request ID allocated at schedule time."
6024
8969
  }
6025
8970
  },
6026
8971
  "description": "Nexus operation completed as canceled. May or may not have been due to a cancellation request by the workflow."
@@ -6082,6 +9027,10 @@
6082
9027
  "result": {
6083
9028
  "$ref": "#/definitions/v1Payload",
6084
9029
  "description": "Serialized result of the Nexus operation. The response of the Nexus handler.\nDelivered either via a completion callback or as a response to a synchronous operation."
9030
+ },
9031
+ "requestId": {
9032
+ "type": "string",
9033
+ "description": "The request ID allocated at schedule time."
6085
9034
  }
6086
9035
  },
6087
9036
  "description": "Nexus operation completed successfully."
@@ -6097,6 +9046,10 @@
6097
9046
  "failure": {
6098
9047
  "$ref": "#/definitions/apifailurev1Failure",
6099
9048
  "description": "Failure details. A NexusOperationFailureInfo wrapping an ApplicationFailureInfo."
9049
+ },
9050
+ "requestId": {
9051
+ "type": "string",
9052
+ "description": "The request ID allocated at schedule time."
6100
9053
  }
6101
9054
  },
6102
9055
  "description": "Nexus operation failed."
@@ -6165,6 +9118,10 @@
6165
9118
  "requestId": {
6166
9119
  "type": "string",
6167
9120
  "description": "A unique ID generated by the history service upon creation of this event.\nThe ID will be transmitted with all nexus StartOperation requests and is used as an idempotentency key."
9121
+ },
9122
+ "endpointId": {
9123
+ "type": "string",
9124
+ "description": "Endpoint ID as resolved in the endpoint registry at the time this event was generated.\nThis is stored on the event and used internally by the server in case the endpoint is renamed from the time the\nevent was originally scheduled."
6168
9125
  }
6169
9126
  },
6170
9127
  "description": "Event marking that an operation was scheduled by a workflow via the ScheduleNexusOperation command."
@@ -6180,6 +9137,10 @@
6180
9137
  "operationId": {
6181
9138
  "type": "string",
6182
9139
  "description": "The operation ID returned by the Nexus handler in the response to the StartOperation request.\nThis ID is used when canceling the operation."
9140
+ },
9141
+ "requestId": {
9142
+ "type": "string",
9143
+ "description": "The request ID allocated at schedule time."
6183
9144
  }
6184
9145
  },
6185
9146
  "description": "Event marking an asynchronous operation was started by the responding Nexus handler.\nIf the operation completes synchronously, this event is not generated.\nIn rare situations, such as request timeouts, the service may fail to record the actual start time and will fabricate\nthis event upon receiving the operation completion via callback."
@@ -6195,6 +9156,10 @@
6195
9156
  "failure": {
6196
9157
  "$ref": "#/definitions/apifailurev1Failure",
6197
9158
  "description": "Failure details. A NexusOperationFailureInfo wrapping a CanceledFailureInfo."
9159
+ },
9160
+ "requestId": {
9161
+ "type": "string",
9162
+ "description": "The request ID allocated at schedule time."
6198
9163
  }
6199
9164
  },
6200
9165
  "description": "Nexus operation timed out."
@@ -6209,7 +9174,7 @@
6209
9174
  "$ref": "#/definitions/apifailurev1Failure"
6210
9175
  }
6211
9176
  },
6212
- "description": "The outcome of a workflow update - success or failure."
9177
+ "description": "The outcome of a Workflow Update: success or failure."
6213
9178
  },
6214
9179
  "v1ParentClosePolicy": {
6215
9180
  "type": "string",
@@ -6226,6 +9191,9 @@
6226
9191
  "v1PatchScheduleResponse": {
6227
9192
  "type": "object"
6228
9193
  },
9194
+ "v1PauseActivityByIdResponse": {
9195
+ "type": "object"
9196
+ },
6229
9197
  "v1Payload": {
6230
9198
  "description": "Arbitrary payload data in an unconstrained format.\nThis may be activity input parameters, a workflow result, a memo, etc.\n"
6231
9199
  },
@@ -6299,6 +9267,24 @@
6299
9267
  "lastWorkerVersionStamp": {
6300
9268
  "$ref": "#/definitions/v1WorkerVersionStamp",
6301
9269
  "title": "The version stamp of the worker to whom this activity was most recently dispatched"
9270
+ },
9271
+ "currentRetryInterval": {
9272
+ "type": "string",
9273
+ "description": "The time activity will wait until the next retry.\nIf activity is currently running it will be next retry interval if activity failed.\nIf activity is currently waiting it will be current retry interval.\nIf there will be no retry it will be null."
9274
+ },
9275
+ "lastAttemptCompleteTime": {
9276
+ "type": "string",
9277
+ "format": "date-time",
9278
+ "description": "The time when the last activity attempt was completed. If activity has not been completed yet then it will be null."
9279
+ },
9280
+ "nextAttemptScheduleTime": {
9281
+ "type": "string",
9282
+ "format": "date-time",
9283
+ "description": "Next time when activity will be scheduled.\nIf activity is currently scheduled or started it will be null."
9284
+ },
9285
+ "paused": {
9286
+ "type": "boolean",
9287
+ "description": "Indicates if activity is paused."
6302
9288
  }
6303
9289
  }
6304
9290
  },
@@ -6386,6 +9372,11 @@
6386
9372
  },
6387
9373
  "cancellationInfo": {
6388
9374
  "$ref": "#/definitions/v1NexusOperationCancellationInfo"
9375
+ },
9376
+ "scheduledEventId": {
9377
+ "type": "string",
9378
+ "format": "int64",
9379
+ "description": "The event ID of the NexusOperationScheduled event. Can be used to correlate an operation in the\nDescribeWorkflowExecution response with workflow history."
6389
9380
  }
6390
9381
  },
6391
9382
  "description": "PendingNexusOperationInfo contains the state of a pending Nexus operation."
@@ -6539,7 +9530,7 @@
6539
9530
  },
6540
9531
  "updateRef": {
6541
9532
  "$ref": "#/definitions/v1UpdateRef",
6542
- "description": "Sufficient information to address this update."
9533
+ "description": "Sufficient information to address this Update."
6543
9534
  }
6544
9535
  }
6545
9536
  },
@@ -6735,6 +9726,10 @@
6735
9726
  "cancelRequested": {
6736
9727
  "type": "boolean",
6737
9728
  "description": "Will be set to true if the activity has been asked to cancel itself. The SDK should then\nnotify the activity of cancellation if it is still running."
9729
+ },
9730
+ "activityPaused": {
9731
+ "type": "boolean",
9732
+ "description": "Will be set to true if the activity is paused."
6738
9733
  }
6739
9734
  }
6740
9735
  },
@@ -6959,6 +9954,9 @@
6959
9954
  "v1RequestCancelWorkflowExecutionResponse": {
6960
9955
  "type": "object"
6961
9956
  },
9957
+ "v1ResetActivityByIdResponse": {
9958
+ "type": "object"
9959
+ },
6962
9960
  "v1ResetOptions": {
6963
9961
  "type": "object",
6964
9962
  "properties": {
@@ -7052,10 +10050,11 @@
7052
10050
  "enum": [
7053
10051
  "RESET_REAPPLY_EXCLUDE_TYPE_UNSPECIFIED",
7054
10052
  "RESET_REAPPLY_EXCLUDE_TYPE_SIGNAL",
7055
- "RESET_REAPPLY_EXCLUDE_TYPE_UPDATE"
10053
+ "RESET_REAPPLY_EXCLUDE_TYPE_UPDATE",
10054
+ "RESET_REAPPLY_EXCLUDE_TYPE_NEXUS"
7056
10055
  ],
7057
10056
  "default": "RESET_REAPPLY_EXCLUDE_TYPE_UNSPECIFIED",
7058
- "description": "Event types to exclude when reapplying events.\n\n - RESET_REAPPLY_EXCLUDE_TYPE_SIGNAL: Exclude signals when reapplying events.\n - RESET_REAPPLY_EXCLUDE_TYPE_UPDATE: Exclude updates when reapplying events."
10057
+ "description": "Event types to exclude when reapplying events beyond the reset point.\n\n - RESET_REAPPLY_EXCLUDE_TYPE_SIGNAL: Exclude signals when reapplying events beyond the reset point.\n - RESET_REAPPLY_EXCLUDE_TYPE_UPDATE: Exclude updates when reapplying events beyond the reset point.\n - RESET_REAPPLY_EXCLUDE_TYPE_NEXUS: Exclude nexus events when reapplying events beyond the reset point."
7059
10058
  },
7060
10059
  "v1ResetReapplyType": {
7061
10060
  "type": "string",
@@ -7144,6 +10143,16 @@
7144
10143
  "v1RespondQueryTaskCompletedResponse": {
7145
10144
  "type": "object"
7146
10145
  },
10146
+ "v1RespondWorkflowTaskCompletedRequestCapabilities": {
10147
+ "type": "object",
10148
+ "properties": {
10149
+ "discardSpeculativeWorkflowTaskWithEvents": {
10150
+ "type": "boolean",
10151
+ "title": "True if the SDK can handle speculative workflow task with command events.\nIf true, the server may chosse, at its discretion, to discard a speculative workflow task\neven if that speculative task included command events the SDK had not previouly processed"
10152
+ }
10153
+ },
10154
+ "description": "SDK capability details."
10155
+ },
7147
10156
  "v1RespondWorkflowTaskCompletedResponse": {
7148
10157
  "type": "object",
7149
10158
  "properties": {
@@ -7157,11 +10166,12 @@
7157
10166
  "type": "object",
7158
10167
  "$ref": "#/definitions/v1PollActivityTaskQueueResponse"
7159
10168
  },
7160
- "title": "See `ScheduleActivityTaskCommandAttributes::request_start`"
10169
+ "title": "See `ScheduleActivityTaskCommandAttributes::request_eager_execution`"
7161
10170
  },
7162
10171
  "resetHistoryEventId": {
7163
10172
  "type": "string",
7164
- "format": "int64"
10173
+ "format": "int64",
10174
+ "description": "If non zero, indicates the server has discarded the workflow task that was being responded to.\nWill be the event ID of the last workflow task started event in the history before the new workflow task.\nServer is only expected to discard a workflow task if it could not have modified the workflow state."
7165
10175
  }
7166
10176
  }
7167
10177
  },
@@ -7271,6 +10281,10 @@
7271
10281
  "startWorkflowResult": {
7272
10282
  "$ref": "#/definitions/v1WorkflowExecution",
7273
10283
  "title": "If action was start_workflow:"
10284
+ },
10285
+ "startWorkflowStatus": {
10286
+ "$ref": "#/definitions/v1WorkflowExecutionStatus",
10287
+ "description": "If the action was start_workflow, this field will reflect an\neventually-consistent view of the started workflow's status."
7274
10288
  }
7275
10289
  }
7276
10290
  },
@@ -7658,6 +10672,9 @@
7658
10672
  ],
7659
10673
  "default": "SEVERITY_UNSPECIFIED"
7660
10674
  },
10675
+ "v1ShutdownWorkerResponse": {
10676
+ "type": "object"
10677
+ },
7661
10678
  "v1SignalExternalWorkflowExecutionCommandAttributes": {
7662
10679
  "type": "object",
7663
10680
  "properties": {
@@ -7998,6 +11015,14 @@
7998
11015
  "type": "string"
7999
11016
  },
8000
11017
  "description": "Header that is expected to be attached to the callback request when the operation completes."
11018
+ },
11019
+ "links": {
11020
+ "type": "array",
11021
+ "items": {
11022
+ "type": "object",
11023
+ "$ref": "#/definitions/apinexusv1Link"
11024
+ },
11025
+ "description": "Links contain caller information and can be attached to the operations started by the handler."
8001
11026
  }
8002
11027
  },
8003
11028
  "description": "A request to start an operation."
@@ -8134,6 +11159,14 @@
8134
11159
  "userMetadata": {
8135
11160
  "$ref": "#/definitions/v1UserMetadata",
8136
11161
  "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."
11162
+ },
11163
+ "links": {
11164
+ "type": "array",
11165
+ "items": {
11166
+ "type": "object",
11167
+ "$ref": "#/definitions/apicommonv1Link"
11168
+ },
11169
+ "description": "Links to be associated with the workflow."
8137
11170
  }
8138
11171
  }
8139
11172
  },
@@ -8327,24 +11360,24 @@
8327
11360
  "approximateBacklogCount": {
8328
11361
  "type": "string",
8329
11362
  "format": "int64",
8330
- "description": "The approximate number of tasks backlogged in this task queue. May count expired tasks but eventually converges\nto the right value."
11363
+ "description": "The approximate number of tasks backlogged in this task queue. May count expired tasks but eventually\nconverges to the right value. Can be relied upon for scaling decisions.\n\nSpecial note for workflow task queue type: this metric does not count sticky queue tasks. However, because\nthose tasks only remain valid for a few seconds, the inaccuracy becomes less significant as the backlog size\ngrows."
8331
11364
  },
8332
11365
  "approximateBacklogAge": {
8333
11366
  "type": "string",
8334
- "description": "Approximate age of the oldest task in the backlog based on the create timestamp of the task at the head of the queue."
11367
+ "description": "Approximate age of the oldest task in the backlog based on the creation time of the task at the head of\nthe queue. Can be relied upon for scaling decisions.\n\nSpecial note for workflow task queue type: this metric does not count sticky queue tasks. However, because\nthose tasks only remain valid for a few seconds, they should not affect the result when backlog is older than\nfew seconds."
8335
11368
  },
8336
11369
  "tasksAddRate": {
8337
11370
  "type": "number",
8338
11371
  "format": "float",
8339
- "description": "Approximate tasks per second added to the task queue based on activity within a fixed window. This includes both backlogged and\nsync-matched tasks."
11372
+ "description": "The approximate tasks per second added to the task queue, averaging the last 30 seconds. These includes tasks\nwhether or not they were added to/dispatched from the backlog or they were dispatched immediately without going\nto the backlog (sync-matched).\n\nThe difference between `tasks_add_rate` and `tasks_dispatch_rate` is a reliable metric for the rate at which\nbacklog grows/shrinks.\n\nNote: the actual tasks delivered to the workers may significantly be higher than the numbers reported by\ntasks_add_rate, because:\n- Tasks can be sent to workers without going to the task queue. This is called Eager dispatch. Eager dispatch is\n enable for activities by default in the latest SDKs.\n- Tasks going to Sticky queue are not accounted for. Note that, typically, only the first workflow task of each\n workflow goes to a normal queue, and the rest workflow tasks go to the Sticky queue associated with a specific\n worker instance."
8340
11373
  },
8341
11374
  "tasksDispatchRate": {
8342
11375
  "type": "number",
8343
11376
  "format": "float",
8344
- "description": "Approximate tasks per second dispatched to workers based on activity within a fixed window. This includes both backlogged and\nsync-matched tasks."
11377
+ "description": "The approximate tasks per second dispatched from the task queue, averaging the last 30 seconds. These includes\ntasks whether or not they were added to/dispatched from the backlog or they were dispatched immediately without\ngoing to the backlog (sync-matched).\n\nThe difference between `tasks_add_rate` and `tasks_dispatch_rate` is a reliable metric for the rate at which\nbacklog grows/shrinks.\n\nNote: the actual tasks delivered to the workers may significantly be higher than the numbers reported by\ntasks_dispatch_rate, because:\n- Tasks can be sent to workers without going to the task queue. This is called Eager dispatch. Eager dispatch is\n enable for activities by default in the latest SDKs.\n- Tasks going to Sticky queue are not accounted for. Note that, typically, only the first workflow task of each\n workflow goes to a normal queue, and the rest workflow tasks go to the Sticky queue associated with a specific\n worker instance."
8345
11378
  }
8346
11379
  },
8347
- "description": "For workflow task queues, we only report the normal queue stats, not sticky queues. This means the stats\nreported here do not count all workflow tasks. However, because the tasks queued in sticky queues only remain\nvalid for a few seconds, the inaccuracy becomes less significant as the backlog age grows."
11380
+ "description": "TaskQueueStats contains statistics about task queue backlog and activity.\n\nFor workflow task queue type, this result is partial because tasks sent to sticky queues are not included. Read\ncomments above each metric to understand the impact of sticky queue exclusion on that metric accuracy."
8348
11381
  },
8349
11382
  "v1TaskQueueStatus": {
8350
11383
  "type": "object",
@@ -8430,7 +11463,7 @@
8430
11463
  },
8431
11464
  "allActive": {
8432
11465
  "type": "boolean",
8433
- "description": "Include all active versions. A version is considered active if it has had new\ntasks or polls recently."
11466
+ "description": "Include all active versions. A version is considered active if, in the last few minutes,\nit has had new tasks or polls, or it has been the subject of certain task queue API calls."
8434
11467
  }
8435
11468
  },
8436
11469
  "description": "Used for specifying versions the caller is interested in."
@@ -8563,6 +11596,9 @@
8563
11596
  }
8564
11597
  }
8565
11598
  },
11599
+ "v1UnpauseActivityByIdResponse": {
11600
+ "type": "object"
11601
+ },
8566
11602
  "v1UnsuccessfulOperationError": {
8567
11603
  "type": "object",
8568
11604
  "properties": {
@@ -8575,6 +11611,15 @@
8575
11611
  }
8576
11612
  }
8577
11613
  },
11614
+ "v1UpdateActivityOptionsByIdResponse": {
11615
+ "type": "object",
11616
+ "properties": {
11617
+ "activityOptions": {
11618
+ "$ref": "#/definitions/v1ActivityOptions",
11619
+ "title": "Activity options after an update"
11620
+ }
11621
+ }
11622
+ },
8578
11623
  "v1UpdateAdmittedEventOrigin": {
8579
11624
  "type": "string",
8580
11625
  "enum": [
@@ -8582,7 +11627,7 @@
8582
11627
  "UPDATE_ADMITTED_EVENT_ORIGIN_REAPPLY"
8583
11628
  ],
8584
11629
  "default": "UPDATE_ADMITTED_EVENT_ORIGIN_UNSPECIFIED",
8585
- "description": "Records why a WorkflowExecutionUpdateAdmittedEvent was written to history.\nNote that not all admitted updates result in this event.\n\n - UPDATE_ADMITTED_EVENT_ORIGIN_REAPPLY: The UpdateAdmitted event was created when reapplying events during reset\nor replication. I.e. an accepted update on one branch of workflow history\nwas converted into an admitted update on a different branch."
11630
+ "description": "Records why a WorkflowExecutionUpdateAdmittedEvent was written to history.\nNote that not all admitted Updates result in this event.\n\n - UPDATE_ADMITTED_EVENT_ORIGIN_REAPPLY: The UpdateAdmitted event was created when reapplying events during reset\nor replication. I.e. an accepted Update on one branch of Workflow history\nwas converted into an admitted Update on a different branch."
8586
11631
  },
8587
11632
  "v1UpdateNamespaceInfo": {
8588
11633
  "type": "object",
@@ -8646,7 +11691,7 @@
8646
11691
  "type": "string"
8647
11692
  }
8648
11693
  },
8649
- "description": "The data needed by a client to refer to a previously invoked workflow\nexecution update process."
11694
+ "description": "The data needed by a client to refer to a previously invoked Workflow Update."
8650
11695
  },
8651
11696
  "v1UpdateScheduleResponse": {
8652
11697
  "type": "object"
@@ -8687,30 +11732,30 @@
8687
11732
  "UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED"
8688
11733
  ],
8689
11734
  "default": "UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED",
8690
- "description": "UpdateWorkflowExecutionLifecycleStage is specified by clients invoking\nworkflow execution updates and used to indicate to the server how long the\nclient wishes to wait for a return value from the RPC. If any value other\nthan UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED is sent by the\nclient then the RPC will complete before the update is finished and will\nreturn a handle to the running update so that it can later be polled for\ncompletion.\n\n - UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED: An unspecified vale for this enum.\n - UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ADMITTED: The gRPC call will not return until the update request has been admitted\nby the server - it may be the case that due to a considerations like load\nor resource limits that an update is made to wait before the server will\nindicate that it has been received and will be processed. This value\ndoes not wait for any sort of acknowledgement from a worker.\n - UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED: The gRPC call will not return until the update has passed validation on\na worker.\n - UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED: The gRPC call will not return until the update has executed to completion\non a worker and has either been rejected or returned a value or an error."
11735
+ "description": "UpdateWorkflowExecutionLifecycleStage is specified by clients invoking\nWorkflow Updates and used to indicate to the server how long the\nclient wishes to wait for a return value from the API. If any value other\nthan UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED is sent by the\nclient then the API will complete before the Update is finished and will\nreturn a handle to the running Update so that it can later be polled for\ncompletion.\nIf specified stage wasn't reached before server timeout, server returns\nactual stage reached.\n\n - UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED: An unspecified value for this enum.\n - UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ADMITTED: The API call will not return until the Update request has been admitted\nby the server - it may be the case that due to a considerations like load\nor resource limits that an Update is made to wait before the server will\nindicate that it has been received and will be processed. This value\ndoes not wait for any sort of acknowledgement from a worker.\n - UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED: The API call will not return until the Update has passed validation on a worker.\n - UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED: The API call will not return until the Update has executed to completion\non a worker and has either been rejected or returned a value or an error."
8691
11736
  },
8692
11737
  "v1UpdateWorkflowExecutionRequest": {
8693
11738
  "type": "object",
8694
11739
  "properties": {
8695
11740
  "namespace": {
8696
11741
  "type": "string",
8697
- "title": "The namespace name of the target workflow"
11742
+ "description": "The namespace name of the target Workflow."
8698
11743
  },
8699
11744
  "workflowExecution": {
8700
11745
  "$ref": "#/definitions/v1WorkflowExecution",
8701
- "title": "The target workflow id and (optionally) a specific run thereof"
11746
+ "description": "The target Workflow Id and (optionally) a specific Run Id thereof."
8702
11747
  },
8703
11748
  "firstExecutionRunId": {
8704
11749
  "type": "string",
8705
- "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."
11750
+ "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."
8706
11751
  },
8707
11752
  "waitPolicy": {
8708
11753
  "$ref": "#/definitions/v1WaitPolicy",
8709
- "description": "Describes when this request should return - basically whether the\nupdate is synchronous, asynchronous, or somewhere in between."
11754
+ "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."
8710
11755
  },
8711
11756
  "request": {
8712
11757
  "$ref": "#/definitions/apiupdatev1Request",
8713
- "description": "The request information that will be delivered all the way down to the\nworkflow execution."
11758
+ "description": "The request information that will be delivered all the way down to the\nWorkflow Execution."
8714
11759
  }
8715
11760
  }
8716
11761
  },
@@ -8723,7 +11768,7 @@
8723
11768
  },
8724
11769
  "outcome": {
8725
11770
  "$ref": "#/definitions/v1Outcome",
8726
- "description": "The outcome of the update if and only if the workflow execution update\nhas completed. If this response is being returned before the update has\ncompleted then this field will not be set."
11771
+ "description": "The outcome of the Update if and only if the Workflow Update\nhas completed. If this response is being returned before the Update has\ncompleted then this field will not be set."
8727
11772
  },
8728
11773
  "stage": {
8729
11774
  "$ref": "#/definitions/v1UpdateWorkflowExecutionLifecycleStage",
@@ -8797,10 +11842,10 @@
8797
11842
  "properties": {
8798
11843
  "lifecycleStage": {
8799
11844
  "$ref": "#/definitions/v1UpdateWorkflowExecutionLifecycleStage",
8800
- "description": "Indicates the update lifecycle stage that the gRPC call should wait for\nbefore returning."
11845
+ "description": "Indicates the Update lifecycle stage that the Update must reach before\nAPI call is returned.\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."
8801
11846
  }
8802
11847
  },
8803
- "description": "Specifies to the gRPC server how long the client wants the an update-related\nRPC call to wait before returning control to the caller."
11848
+ "description": "Specifies client's intent to wait for Update results."
8804
11849
  },
8805
11850
  "v1WorkerVersionCapabilities": {
8806
11851
  "type": "object",
@@ -9079,6 +12124,10 @@
9079
12124
  "inheritedBuildId": {
9080
12125
  "type": "string",
9081
12126
  "description": "Build ID inherited from a previous/parent execution. If present, assigned_build_id will be set to this, instead\nof using the assignment rules."
12127
+ },
12128
+ "firstRunId": {
12129
+ "type": "string",
12130
+ "title": "The first run ID in the execution chain.\nExecutions created via the following operations are considered to be in the same chain\n- ContinueAsNew\n- Workflow Retry\n- Workflow Reset\n- Cron Schedule"
9082
12131
  }
9083
12132
  }
9084
12133
  },