Skip to content

Add extensible schedule action API #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
chaptersix wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

Add extensible schedule action API #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
181d052
Add extensible schedule action API
chaptersix Sep 5, 2026
e4b2f8e
Regenerate schedule OpenAPI schemas
chaptersix Sep 5, 2026
40766d3
Annotate schedule activity timeouts
chaptersix Sep 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
124 changes: 124 additions & 0 deletions openapi/openapiv2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13623,6 +13623,21 @@
}
}
},
"v1ActionExecutionResult": {
"type": "object",
"properties": {
"execution": {
"$ref": "#/definitions/v1Execution"
},
"workflowStatus": {
"$ref": "#/definitions/v1WorkflowExecutionStatus"
},
"activityStatus": {
"$ref": "#/definitions/v1ActivityExecutionStatus"
}
},
"description": "Identifies an execution started by an action and reports its current status."
},
"v1ActivityExecutionInfo": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -14286,6 +14301,10 @@
"overlapPolicy": {
"$ref": "#/definitions/v1ScheduleOverlapPolicy",
"description": "If set, override overlap policy for this request."
},
"customOverlapPolicy": {
"$ref": "#/definitions/v1CustomOverlapPolicy",
"description": "If set, override overlap policy for this request. This may not be set together with overlap_policy."
}
}
},
Expand Down Expand Up @@ -15336,6 +15355,15 @@
}
}
},
"v1CustomOverlapPolicy": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"description": "Selects an overlap policy registered by an action implementation."
},
"v1DataBlob": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -19186,6 +19214,9 @@
"startWorkflow": {
"$ref": "#/definitions/v1NewWorkflowExecutionInfo",
"description": "All fields of NewWorkflowExecutionInfo are valid except for:\n- workflow_id_reuse_policy\n- cron_schedule\nThe workflow id of the started workflow may not match this exactly,\nit may have a timestamp appended for uniqueness."
},
"startActivity": {
"$ref": "#/definitions/v1StartActivityExecutionInfo"
}
}
},
Expand All @@ -19209,6 +19240,15 @@
"startWorkflowStatus": {
"$ref": "#/definitions/v1WorkflowExecutionStatus",
"description": "If the action was start_workflow, this field will reflect an\neventually-consistent view of the started workflow's status."
},
"actionExecutionResult": {
"$ref": "#/definitions/v1ActionExecutionResult",
"description": "The execution started by this action and its current status."
},
"closeTime": {
"type": "string",
"format": "date-time",
"description": "Time the execution reached a terminal status, if known."
}
}
},
Expand Down Expand Up @@ -19281,6 +19321,21 @@
"type": "string",
"format": "int64",
"description": "Size of the schedule's internal state (including payloads) in bytes."
},
"runningExecutions": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/v1Execution"
},
"description": "Currently-running executions started by this schedule."
},
"actionKind": {
"$ref": "#/definitions/v1ExecutionType",
"description": "Kind and registered type of the action."
},
"actionType": {
"type": "string"
}
}
},
Expand Down Expand Up @@ -19339,6 +19394,18 @@
"type": "string",
"format": "int64",
"description": "Size of the schedule's internal state (including payloads) in bytes."
},
"actionKind": {
"$ref": "#/definitions/v1ExecutionType",
"description": "Kind and registered type of the action."
},
"actionType": {
"type": "string"
},
"runningExecutionCount": {
"type": "string",
"format": "int64",
"description": "Number of tracked running executions started by the schedule."
}
},
"description": "ScheduleListInfo is an abbreviated set of values from Schedule and ScheduleInfo\nthat's returned in ListSchedules."
Expand Down Expand Up @@ -19399,6 +19466,10 @@
"keepOriginalWorkflowId": {
"type": "boolean",
"description": "If true, and the action would start a workflow, a timestamp will not be\nappended to the scheduled workflow id."
},
"customOverlapPolicy": {
"$ref": "#/definitions/v1CustomOverlapPolicy",
"description": "A named overlap policy registered by the action implementation. This may not be set together\nwith overlap_policy."
}
}
},
Expand Down Expand Up @@ -19706,6 +19777,55 @@
}
}
},
"v1StartActivityExecutionInfo": {
"type": "object",
"properties": {
"activityId": {
"type": "string",
"description": "The activity ID may have a timestamp appended for uniqueness."
},
"activityType": {
"$ref": "#/definitions/v1ActivityType"
},
"taskQueue": {
"$ref": "#/definitions/v1TaskQueue"
},
"scheduleToCloseTimeout": {
"type": "string"
},
"scheduleToStartTimeout": {
"type": "string"
},
"startToCloseTimeout": {
"type": "string"
},
"heartbeatTimeout": {
"type": "string"
},
"retryPolicy": {
"$ref": "#/definitions/v1RetryPolicy"
},
"input": {
"$ref": "#/definitions/v1Payloads"
},
"searchAttributes": {
"$ref": "#/definitions/v1SearchAttributes"
},
"header": {
"$ref": "#/definitions/v1Header"
},
"userMetadata": {
"$ref": "#/definitions/v1UserMetadata"
},
"priority": {
"$ref": "#/definitions/v1Priority"
},
"startDelay": {
"type": "string"
}
},
"description": "Describes a standalone activity that a schedule starts."
},
"v1StartActivityExecutionResponse": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -20450,6 +20570,10 @@
"type": "string",
"format": "date-time",
"description": "Timestamp used for the identity of the target workflow.\nIf not set the default value is the current time."
},
"customOverlapPolicy": {
"$ref": "#/definitions/v1CustomOverlapPolicy",
"description": "If set, override overlap policy for this request. This may not be set together with overlap_policy."
}
}
},
Expand Down
136 changes: 136 additions & 0 deletions openapi/openapiv3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9722,6 +9722,37 @@ paths:
$ref: '#/components/schemas/Status'
components:
schemas:
ActionExecutionResult:
type: object
properties:
execution:
$ref: '#/components/schemas/Execution'
workflowStatus:
enum:
- WORKFLOW_EXECUTION_STATUS_UNSPECIFIED
- WORKFLOW_EXECUTION_STATUS_RUNNING
- WORKFLOW_EXECUTION_STATUS_COMPLETED
- WORKFLOW_EXECUTION_STATUS_FAILED
- WORKFLOW_EXECUTION_STATUS_CANCELED
- WORKFLOW_EXECUTION_STATUS_TERMINATED
- WORKFLOW_EXECUTION_STATUS_CONTINUED_AS_NEW
- WORKFLOW_EXECUTION_STATUS_TIMED_OUT
- WORKFLOW_EXECUTION_STATUS_PAUSED
type: string
format: enum
activityStatus:
enum:
- ACTIVITY_EXECUTION_STATUS_UNSPECIFIED
- ACTIVITY_EXECUTION_STATUS_RUNNING
- ACTIVITY_EXECUTION_STATUS_COMPLETED
- ACTIVITY_EXECUTION_STATUS_FAILED
- ACTIVITY_EXECUTION_STATUS_CANCELED
- ACTIVITY_EXECUTION_STATUS_TERMINATED
- ACTIVITY_EXECUTION_STATUS_TIMED_OUT
- ACTIVITY_EXECUTION_STATUS_PAUSED
type: string
format: enum
description: Identifies an execution started by an action and reports its current status.
ActivityExecutionInfo:
type: object
properties:
Expand Down Expand Up @@ -10412,6 +10443,10 @@ components:
type: string
description: If set, override overlap policy for this request.
format: enum
customOverlapPolicy:
allOf:
- $ref: '#/components/schemas/CustomOverlapPolicy'
description: If set, override overlap policy for this request. This may not be set together with overlap_policy.
BadBinaries:
type: object
properties:
Expand Down Expand Up @@ -11569,6 +11604,12 @@ components:
jobId:
type: string
description: Batch Job ID if force-scan flag was provided. Otherwise empty.
CustomOverlapPolicy:
type: object
properties:
name:
type: string
description: Selects an overlap policy registered by an action implementation.
DataBlob:
type: object
properties:
Expand Down Expand Up @@ -16091,6 +16132,8 @@ components:
- cron_schedule
The workflow id of the started workflow may not match this exactly,
it may have a timestamp appended for uniqueness.
startActivity:
$ref: '#/components/schemas/StartActivityExecutionInfo'
ScheduleActionResult:
type: object
properties:
Expand Down Expand Up @@ -16122,6 +16165,14 @@ components:
If the action was start_workflow, this field will reflect an
eventually-consistent view of the started workflow's status.
format: enum
actionExecutionResult:
allOf:
- $ref: '#/components/schemas/ActionExecutionResult'
description: The execution started by this action and its current status.
closeTime:
type: string
description: Time the execution reached a terminal status, if known.
format: date-time
ScheduleInfo:
type: object
properties:
Expand Down Expand Up @@ -16177,6 +16228,21 @@ components:
stateSizeBytes:
type: string
description: Size of the schedule's internal state (including payloads) in bytes.
runningExecutions:
type: array
items:
$ref: '#/components/schemas/Execution'
description: Currently-running executions started by this schedule.
actionKind:
enum:
- EXECUTION_TYPE_UNSPECIFIED
- EXECUTION_TYPE_WORKFLOW
- EXECUTION_TYPE_ACTIVITY
type: string
description: Kind and registered type of the action.
format: enum
actionType:
type: string
ScheduleListEntry:
type: object
properties:
Expand Down Expand Up @@ -16223,6 +16289,19 @@ components:
stateSizeBytes:
type: string
description: Size of the schedule's internal state (including payloads) in bytes.
actionKind:
enum:
- EXECUTION_TYPE_UNSPECIFIED
- EXECUTION_TYPE_WORKFLOW
- EXECUTION_TYPE_ACTIVITY
type: string
description: Kind and registered type of the action.
format: enum
actionType:
type: string
runningExecutionCount:
type: string
description: Number of tracked running executions started by the schedule.
description: |-
ScheduleListInfo is an abbreviated set of values from Schedule and ScheduleInfo
that's returned in ListSchedules.
Expand Down Expand Up @@ -16287,6 +16366,12 @@ components:
description: |-
If true, and the action would start a workflow, a timestamp will not be
appended to the scheduled workflow id.
customOverlapPolicy:
allOf:
- $ref: '#/components/schemas/CustomOverlapPolicy'
description: |-
A named overlap policy registered by the action implementation. This may not be set together
with overlap_policy.
ScheduleSpec:
type: object
properties:
Expand Down Expand Up @@ -16924,6 +17009,53 @@ components:
Link to be associated with the WorkflowExecutionSignaled event.
Added on the response to propagate the backlink.
Available from Temporal server 1.31 and up.
StartActivityExecutionInfo:
type: object
properties:
activityId:
type: string
description: The activity ID may have a timestamp appended for uniqueness.
activityType:
$ref: '#/components/schemas/ActivityType'
taskQueue:
$ref: '#/components/schemas/TaskQueue'
scheduleToCloseTimeout:
pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
type: string
description: |-
(-- 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: |-
(-- 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: |-
(-- 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
retryPolicy:
$ref: '#/components/schemas/RetryPolicy'
input:
$ref: '#/components/schemas/Payloads'
searchAttributes:
$ref: '#/components/schemas/SearchAttributes'
header:
$ref: '#/components/schemas/Header'
userMetadata:
$ref: '#/components/schemas/UserMetadata'
priority:
$ref: '#/components/schemas/Priority'
startDelay:
pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
type: string
description: Describes a standalone activity that a schedule starts.
StartActivityExecutionRequest:
type: object
properties:
Expand Down Expand Up @@ -18150,6 +18282,10 @@ components:
Timestamp used for the identity of the target workflow.
If not set the default value is the current time.
format: date-time
customOverlapPolicy:
allOf:
- $ref: '#/components/schemas/CustomOverlapPolicy'
description: If set, override overlap policy for this request. This may not be set together with overlap_policy.
TriggerWorkflowRuleRequest:
type: object
properties:
Expand Down
Loading
Loading