From 5c1ffab343cd9fce68e375412f5729023ee6bd04 Mon Sep 17 00:00:00 2001 From: Yuri Date: Thu, 8 Aug 2024 11:55:03 -0700 Subject: [PATCH] update opeapi definitions --- openapi/openapiv2.json | 545 +++++++++++++++++++++++++++++++++++++++++ openapi/openapiv3.yaml | 470 +++++++++++++++++++++++++++++++++++ 2 files changed, 1015 insertions(+) diff --git a/openapi/openapiv2.json b/openapi/openapiv2.json index 4f3c5fcb..34efd14a 100644 --- a/openapi/openapiv2.json +++ b/openapi/openapiv2.json @@ -2065,6 +2065,208 @@ ] } }, + "/api/v1/namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}": { + "post": { + "operationId": "DescribeActivity2", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v1DescribeActivityResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/rpcStatus" + } + } + }, + "parameters": [ + { + "name": "namespace", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "workflowId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "activityId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WorkflowServiceDescribeActivityBody" + } + } + ], + "tags": [ + "WorkflowService" + ] + } + }, + "/api/v1/namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}/pause": { + "post": { + "summary": "PauseActivity will set activity into a paused state. It means if activity is not running, it will not be started.", + "operationId": "PauseActivity2", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v1PauseActivityResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/rpcStatus" + } + } + }, + "parameters": [ + { + "name": "namespace", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "workflowId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "activityId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WorkflowServicePauseActivityBody" + } + } + ], + "tags": [ + "WorkflowService" + ] + } + }, + "/api/v1/namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}/resume": { + "post": { + "summary": "ResumeActivity will basically unpause the activity is the activity is in the paused state.", + "operationId": "ResumeActivity2", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v1ResumeActivityResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/rpcStatus" + } + } + }, + "parameters": [ + { + "name": "namespace", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "workflowId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "activityId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WorkflowServiceResumeActivityBody" + } + } + ], + "tags": [ + "WorkflowService" + ] + } + }, + "/api/v1/namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}/update": { + "post": { + "operationId": "UpdateActivity2", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v1UpdateActivityResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/rpcStatus" + } + } + }, + "parameters": [ + { + "name": "namespace", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "workflowId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "activityId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WorkflowServiceUpdateActivityBody" + } + } + ], + "tags": [ + "WorkflowService" + ] + } + }, "/api/v1/namespaces/{namespace}/workflows/{workflowId}/signal-with-start/{signalName}": { "post": { "summary": "SignalWithStartWorkflowExecution is used to ensure a signal is sent to a workflow, even if\nit isn't yet started.", @@ -4563,6 +4765,208 @@ ] } }, + "/namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}": { + "post": { + "operationId": "DescribeActivity", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v1DescribeActivityResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/rpcStatus" + } + } + }, + "parameters": [ + { + "name": "namespace", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "workflowId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "activityId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WorkflowServiceDescribeActivityBody" + } + } + ], + "tags": [ + "WorkflowService" + ] + } + }, + "/namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}/pause": { + "post": { + "summary": "PauseActivity will set activity into a paused state. It means if activity is not running, it will not be started.", + "operationId": "PauseActivity", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v1PauseActivityResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/rpcStatus" + } + } + }, + "parameters": [ + { + "name": "namespace", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "workflowId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "activityId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WorkflowServicePauseActivityBody" + } + } + ], + "tags": [ + "WorkflowService" + ] + } + }, + "/namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}/resume": { + "post": { + "summary": "ResumeActivity will basically unpause the activity is the activity is in the paused state.", + "operationId": "ResumeActivity", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v1ResumeActivityResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/rpcStatus" + } + } + }, + "parameters": [ + { + "name": "namespace", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "workflowId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "activityId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WorkflowServiceResumeActivityBody" + } + } + ], + "tags": [ + "WorkflowService" + ] + } + }, + "/namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}/update": { + "post": { + "operationId": "UpdateActivity", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v1UpdateActivityResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/rpcStatus" + } + } + }, + "parameters": [ + { + "name": "namespace", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "workflowId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "activityId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WorkflowServiceUpdateActivityBody" + } + } + ], + "tags": [ + "WorkflowService" + ] + } + }, "/namespaces/{namespace}/workflows/{workflowId}/signal-with-start/{signalName}": { "post": { "summary": "SignalWithStartWorkflowExecution is used to ensure a signal is sent to a workflow, even if\nit isn't yet started.", @@ -4904,6 +5308,17 @@ } } }, + "WorkflowServiceDescribeActivityBody": { + "type": "object", + "properties": { + "runId": { + "type": "string" + }, + "identity": { + "type": "string" + } + } + }, "WorkflowServiceExecuteMultiOperationBody": { "type": "object", "properties": { @@ -4933,6 +5348,17 @@ } } }, + "WorkflowServicePauseActivityBody": { + "type": "object", + "properties": { + "runId": { + "type": "string" + }, + "identity": { + "type": "string" + } + } + }, "WorkflowServiceQueryWorkflowBody": { "type": "object", "properties": { @@ -5224,6 +5650,23 @@ } } }, + "WorkflowServiceResumeActivityBody": { + "type": "object", + "properties": { + "runId": { + "type": "string" + }, + "triggerImmediately": { + "type": "boolean" + }, + "resetAttempts": { + "type": "boolean" + }, + "identity": { + "type": "string" + } + } + }, "WorkflowServiceSignalWithStartWorkflowExecutionBody": { "type": "object", "properties": { @@ -5513,6 +5956,21 @@ } } }, + "WorkflowServiceUpdateActivityBody": { + "type": "object", + "properties": { + "runId": { + "type": "string" + }, + "activityUpdate": { + "$ref": "#/definitions/v1ActivityUpdate" + }, + "identity": { + "type": "string", + "title": "The identity of the worker/client/caller" + } + } + }, "WorkflowServiceUpdateNamespaceBody": { "type": "object", "properties": { @@ -5779,6 +6237,20 @@ } } }, + "v1ActivityOptions": { + "type": "object", + "properties": { + "taskQueue": { + "$ref": "#/definitions/v1TaskQueue" + }, + "timeouts": { + "$ref": "#/definitions/v1Timeouts" + }, + "retryPolicy": { + "$ref": "#/definitions/v1RetryPolicy" + } + } + }, "v1ActivityPropertiesModifiedExternallyEventAttributes": { "type": "object", "properties": { @@ -5793,6 +6265,21 @@ } } }, + "v1ActivityState": { + "type": "string", + "enum": [ + "ACTIVITY_STATE_UNSPECIFIED", + "ACTIVITY_STATE_SCHEDULED", + "ACTIVITY_STATE_RUNNING", + "ACTIVITY_STATE_PAUSED", + "ACTIVITY_STATE_SUCCEEDED", + "ACTIVITY_STATE_FAILED", + "ACTIVITY_STATE_TIMED_OUT" + ], + "default": "ACTIVITY_STATE_UNSPECIFIED", + "description": "- ACTIVITY_STATE_UNSPECIFIED: Default value, unspecified state.\n - ACTIVITY_STATE_SCHEDULED: Activity is scheduled for execution\n - ACTIVITY_STATE_RUNNING: Activity is currently running\n - ACTIVITY_STATE_PAUSED: Activity is paused\n - ACTIVITY_STATE_SUCCEEDED: Activity is completed successfully\n - ACTIVITY_STATE_FAILED: Activity is completed, failed\n - ACTIVITY_STATE_TIMED_OUT: Activity is completed, timed out", + "title": "State of the activity" + }, "v1ActivityTaskCancelRequestedEventAttributes": { "type": "object", "properties": { @@ -6014,6 +6501,23 @@ }, "title": "Represents the identifier used by a activity author to define the activity. Typically, the\nname of a function. This is sometimes referred to as the activity's \"name\"" }, + "v1ActivityUpdate": { + "type": "object", + "properties": { + "taskQueue": { + "type": "string" + }, + "timeouts": { + "$ref": "#/definitions/v1Timeouts" + }, + "retryPolicy": { + "$ref": "#/definitions/v1RetryPolicy" + }, + "updateMask": { + "type": "string" + } + } + }, "v1AddOrUpdateRemoteClusterResponse": { "type": "object" }, @@ -6948,6 +7452,17 @@ "type": "object", "description": "Deprecated." }, + "v1DescribeActivityResponse": { + "type": "object", + "properties": { + "activityOptions": { + "$ref": "#/definitions/v1ActivityOptions" + }, + "activityState": { + "$ref": "#/definitions/v1ActivityState" + } + } + }, "v1DescribeBatchOperationResponse": { "type": "object", "properties": { @@ -8579,6 +9094,9 @@ "v1PatchScheduleResponse": { "type": "object" }, + "v1PauseActivityResponse": { + "type": "object" + }, "v1Payload": { "description": "Arbitrary payload data in an unconstrained format.\nThis may be activity input parameters, a workflow result, a memo, etc.\n" }, @@ -9527,6 +10045,9 @@ "v1RespondWorkflowTaskFailedResponse": { "type": "object" }, + "v1ResumeActivityResponse": { + "type": "object" + }, "v1RetryPolicy": { "type": "object", "properties": { @@ -10834,6 +11355,27 @@ ], "default": "TIMEOUT_TYPE_UNSPECIFIED" }, + "v1Timeouts": { + "type": "object", + "properties": { + "scheduleToCloseTimeout": { + "type": "string", + "description": "Indicates how long the caller is willing to wait for activity completion. The \"schedule\" time\nis when the activity is initially scheduled, not when the most recent retry is scheduled.\nLimits how long retries will be attempted. Either this or `start_to_close_timeout` must be\nspecified. When not specified, defaults to the workflow execution timeout.\n" + }, + "scheduleToStartTimeout": { + "type": "string", + "title": "Limits the time an activity task can stay in a task queue before a worker picks it up. The\n\"schedule\" time is when the most recent retry is scheduled. This timeout should usually not\nbe set: it's useful in specific scenarios like worker-specific task queues. This timeout is\nalways non retryable, as all a retry would achieve is to put it back into the same queue.\nDefaults to `schedule_to_close_timeout` or workflow execution timeout if that is not\nspecified. More info:\nhttps://docs.temporal.io/docs/content/what-is-a-schedule-to-start-timeout/" + }, + "startToCloseTimeout": { + "type": "string", + "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 specified.\n" + }, + "heartbeatTimeout": { + "type": "string", + "description": "Maximum permitted time between successful worker heartbeats." + } + } + }, "v1TimerCanceledEventAttributes": { "type": "object", "properties": { @@ -10934,6 +11476,9 @@ } } }, + "v1UpdateActivityResponse": { + "type": "object" + }, "v1UpdateAdmittedEventOrigin": { "type": "string", "enum": [ diff --git a/openapi/openapiv3.yaml b/openapi/openapiv3.yaml index 6083ef41..abdc57ae 100644 --- a/openapi/openapiv3.yaml +++ b/openapi/openapiv3.yaml @@ -1561,6 +1561,168 @@ paths: application/json: schema: $ref: '#/components/schemas/Status' + /api/v1/namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}: + post: + tags: + - WorkflowService + operationId: DescribeActivity + parameters: + - name: namespace + in: path + required: true + schema: + type: string + - name: workflowId + in: path + required: true + schema: + type: string + - name: activityId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DescribeActivityRequest' + required: true + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/DescribeActivityResponse' + default: + description: Default error response + content: + application/json: + schema: + $ref: '#/components/schemas/Status' + /api/v1/namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}/pause: + post: + tags: + - WorkflowService + description: PauseActivity will set activity into a paused state. It means if activity is not running, it will not be started. + operationId: PauseActivity + parameters: + - name: namespace + in: path + required: true + schema: + type: string + - name: workflowId + in: path + required: true + schema: + type: string + - name: activityId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PauseActivityRequest' + required: true + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PauseActivityResponse' + default: + description: Default error response + content: + application/json: + schema: + $ref: '#/components/schemas/Status' + /api/v1/namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}/resume: + post: + tags: + - WorkflowService + description: ResumeActivity will basically unpause the activity is the activity is in the paused state. + operationId: ResumeActivity + parameters: + - name: namespace + in: path + required: true + schema: + type: string + - name: workflowId + in: path + required: true + schema: + type: string + - name: activityId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResumeActivityRequest' + required: true + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ResumeActivityResponse' + default: + description: Default error response + content: + application/json: + schema: + $ref: '#/components/schemas/Status' + /api/v1/namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}/update: + post: + tags: + - WorkflowService + operationId: UpdateActivity + parameters: + - name: namespace + in: path + required: true + schema: + type: string + - name: workflowId + in: path + required: true + schema: + type: string + - name: activityId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateActivityRequest' + required: true + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateActivityResponse' + default: + description: Default error response + content: + application/json: + schema: + $ref: '#/components/schemas/Status' /api/v1/namespaces/{namespace}/workflows/{workflowId}/signal-with-start/{signalName}: post: tags: @@ -3730,6 +3892,168 @@ paths: application/json: schema: $ref: '#/components/schemas/Status' + /namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}: + post: + tags: + - WorkflowService + operationId: DescribeActivity + parameters: + - name: namespace + in: path + required: true + schema: + type: string + - name: workflowId + in: path + required: true + schema: + type: string + - name: activityId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DescribeActivityRequest' + required: true + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/DescribeActivityResponse' + default: + description: Default error response + content: + application/json: + schema: + $ref: '#/components/schemas/Status' + /namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}/pause: + post: + tags: + - WorkflowService + description: PauseActivity will set activity into a paused state. It means if activity is not running, it will not be started. + operationId: PauseActivity + parameters: + - name: namespace + in: path + required: true + schema: + type: string + - name: workflowId + in: path + required: true + schema: + type: string + - name: activityId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PauseActivityRequest' + required: true + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PauseActivityResponse' + default: + description: Default error response + content: + application/json: + schema: + $ref: '#/components/schemas/Status' + /namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}/resume: + post: + tags: + - WorkflowService + description: ResumeActivity will basically unpause the activity is the activity is in the paused state. + operationId: ResumeActivity + parameters: + - name: namespace + in: path + required: true + schema: + type: string + - name: workflowId + in: path + required: true + schema: + type: string + - name: activityId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResumeActivityRequest' + required: true + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ResumeActivityResponse' + default: + description: Default error response + content: + application/json: + schema: + $ref: '#/components/schemas/Status' + /namespaces/{namespace}/workflows/{workflowId}/activities/{activityId}/update: + post: + tags: + - WorkflowService + operationId: UpdateActivity + parameters: + - name: namespace + in: path + required: true + schema: + type: string + - name: workflowId + in: path + required: true + schema: + type: string + - name: activityId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateActivityRequest' + required: true + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateActivityResponse' + default: + description: Default error response + content: + application/json: + schema: + $ref: '#/components/schemas/Status' /namespaces/{namespace}/workflows/{workflowId}/signal-with-start/{signalName}: post: tags: @@ -4039,6 +4363,15 @@ components: - RETRY_STATE_CANCEL_REQUESTED type: string format: enum + ActivityOptions: + type: object + properties: + taskQueue: + $ref: '#/components/schemas/TaskQueue' + timeouts: + $ref: '#/components/schemas/Timeouts' + retryPolicy: + $ref: '#/components/schemas/RetryPolicy' ActivityPropertiesModifiedExternallyEventAttributes: type: object properties: @@ -4272,6 +4605,18 @@ components: description: |- Represents the identifier used by a activity author to define the activity. Typically, the name of a function. This is sometimes referred to as the activity's "name" + ActivityUpdate: + type: object + properties: + taskQueue: + type: string + timeouts: + $ref: '#/components/schemas/Timeouts' + retryPolicy: + $ref: '#/components/schemas/RetryPolicy' + updateMask: + type: string + format: field-mask Alert: type: object properties: @@ -4977,6 +5322,35 @@ components: DeleteScheduleResponse: type: object properties: {} + DescribeActivityRequest: + type: object + properties: + namespace: + type: string + workflowId: + type: string + runId: + type: string + activityId: + type: string + identity: + type: string + DescribeActivityResponse: + type: object + properties: + activityOptions: + $ref: '#/components/schemas/ActivityOptions' + activityState: + enum: + - ACTIVITY_STATE_UNSPECIFIED + - ACTIVITY_STATE_SCHEDULED + - ACTIVITY_STATE_RUNNING + - ACTIVITY_STATE_PAUSED + - ACTIVITY_STATE_SUCCEEDED + - ACTIVITY_STATE_FAILED + - ACTIVITY_STATE_TIMED_OUT + type: string + format: enum DescribeBatchOperationResponse: type: object properties: @@ -6335,6 +6709,22 @@ components: PatchScheduleResponse: type: object properties: {} + PauseActivityRequest: + type: object + properties: + namespace: + type: string + workflowId: + type: string + runId: + type: string + activityId: + type: string + identity: + type: string + PauseActivityResponse: + type: object + properties: {} Payload: description: |- Represents some binary (byte array) data (ex: activity input parameters or workflow result) with @@ -7183,6 +7573,26 @@ components: description: |- Server validation failures could include last_heartbeat_details payload is too large, request failure is too large + ResumeActivityRequest: + type: object + properties: + namespace: + type: string + workflowId: + type: string + runId: + type: string + activityId: + type: string + triggerImmediately: + type: boolean + resetAttempts: + type: boolean + identity: + type: string + ResumeActivityResponse: + type: object + properties: {} RetryPolicy: type: object properties: @@ -8309,6 +8719,47 @@ components: format: enum lastHeartbeatDetails: $ref: '#/components/schemas/Payloads' + Timeouts: + type: object + properties: + scheduleToCloseTimeout: + pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$ + type: string + description: |- + Indicates how long the caller is willing to wait for activity completion. The "schedule" time + is when the activity is initially scheduled, not when the most recent retry is scheduled. + Limits how long retries will be attempted. Either this or `start_to_close_timeout` must be + specified. When not specified, defaults to the workflow execution timeout. + + (-- api-linter: core::0140::prepositions=disabled + aip.dev/not-precedent: "to" is used to indicate interval. --) + scheduleToStartTimeout: + pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$ + type: string + description: |- + Limits the time an activity task can stay in a task queue before a worker picks it up. The + "schedule" time is when the most recent retry is scheduled. This timeout should usually not + be set: it's useful in specific scenarios like worker-specific task queues. This timeout is + always non retryable, as all a retry would achieve is to put it back into the same queue. + Defaults to `schedule_to_close_timeout` or workflow execution timeout if that is not + specified. More info: + https://docs.temporal.io/docs/content/what-is-a-schedule-to-start-timeout/ + + (-- api-linter: core::0140::prepositions=disabled + aip.dev/not-precedent: "to" is used to indicate interval. --) + startToCloseTimeout: + pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$ + type: string + description: |- + Maximum time an activity is allowed to execute after being picked up by a worker. This + timeout is always retryable. Either this or `schedule_to_close_timeout` must be specified. + + (-- api-linter: core::0140::prepositions=disabled + aip.dev/not-precedent: "to" is used to indicate interval. --) + heartbeatTimeout: + pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$ + type: string + description: Maximum permitted time between successful worker heartbeats. TimerCanceledEventAttributes: type: object properties: @@ -8381,6 +8832,25 @@ components: type: string description: If set, override overlap policy for this one request. format: enum + UpdateActivityRequest: + type: object + properties: + namespace: + type: string + workflowId: + type: string + runId: + type: string + activityId: + type: string + activityUpdate: + $ref: '#/components/schemas/ActivityUpdate' + identity: + type: string + description: The identity of the worker/client/caller + UpdateActivityResponse: + type: object + properties: {} UpdateNamespaceInfo: type: object properties: