Skip to content

Add API for GetWorkflowExecutionResult #778

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
long-nt-tran wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Add API for GetWorkflowExecutionResult #778

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
161 changes: 161 additions & 0 deletions openapi/openapiv2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4134,6 +4134,62 @@
]
}
},
"/api/v1/namespaces/{namespace}/workflows/{execution.workflowId}/result": {
"get": {
"summary": "GetWorkflowExecutionResult returns the result of a workflow execution. If the workflow\nis still running, returns a NotCompleted response and optionally registers callbacks\nto be invoked when the workflow completes.",
"operationId": "GetWorkflowExecutionResult2",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1GetWorkflowExecutionResultResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/rpcStatus"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "execution.workflowId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "execution.runId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "requestId",
"description": "Used to de-dup requests (i.e., so we don't register the same callbacks multiple times).",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "identity",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"WorkflowService"
]
}
},
"/api/v1/namespaces/{namespace}/workflows/{execution.workflowId}/trigger-rule": {
"post": {
"summary": "TriggerWorkflowRule allows to:\n * trigger existing rule for a specific workflow execution;\n * trigger rule for a specific workflow execution without creating a rule;\nThis is useful for one-off operations.",
Expand Down Expand Up @@ -9609,6 +9665,62 @@
]
}
},
"/namespaces/{namespace}/workflows/{execution.workflowId}/result": {
"get": {
"summary": "GetWorkflowExecutionResult returns the result of a workflow execution. If the workflow\nis still running, returns a NotCompleted response and optionally registers callbacks\nto be invoked when the workflow completes.",
"operationId": "GetWorkflowExecutionResult",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1GetWorkflowExecutionResultResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/rpcStatus"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "execution.workflowId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "execution.runId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "requestId",
"description": "Used to de-dup requests (i.e., so we don't register the same callbacks multiple times).",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "identity",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"WorkflowService"
]
}
},
"/namespaces/{namespace}/workflows/{execution.workflowId}/trigger-rule": {
"post": {
"summary": "TriggerWorkflowRule allows to:\n * trigger existing rule for a specific workflow execution;\n * trigger rule for a specific workflow execution without creating a rule;\nThis is useful for one-off operations.",
Expand Down Expand Up @@ -10706,6 +10818,36 @@
},
"description": "Target a worker polling on a Nexus task queue in a specific namespace."
},
"GetWorkflowExecutionResultResponseCompleted": {
"type": "object",
"properties": {
"execution": {
"$ref": "#/definitions/v1WorkflowExecution"
},
"status": {
"$ref": "#/definitions/v1WorkflowExecutionStatus"
},
"result": {
"$ref": "#/definitions/v1Payloads",
"description": "Set only when status = COMPLETED."
},
"failure": {
"$ref": "#/definitions/v1Failure",
"description": "Set for FAILED / CANCELED / TERMINATED / TIMED_OUT."
}
}
},
"GetWorkflowExecutionResultResponseNotCompleted": {
"type": "object",
"properties": {
"execution": {
"$ref": "#/definitions/v1WorkflowExecution"
},
"status": {
"$ref": "#/definitions/v1WorkflowExecutionStatus"
}
}
},
"LinkActivity": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -15655,6 +15797,25 @@
}
}
},
"v1GetWorkflowExecutionResultResponse": {
"type": "object",
"properties": {
"links": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/v1Link"
},
"title": "Link to the relevant history event:\n- completion event, if the workflow has finished\n- options-updated event, if callbacks were registered on a running workflow"
},
"notCompleted": {
"$ref": "#/definitions/GetWorkflowExecutionResultResponseNotCompleted"
},
"completed": {
"$ref": "#/definitions/GetWorkflowExecutionResultResponseCompleted"
}
}
},
"v1Header": {
"type": "object",
"properties": {
Expand Down
159 changes: 159 additions & 0 deletions openapi/openapiv3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3714,6 +3714,56 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Status'
/api/v1/namespaces/{namespace}/workflows/{execution.workflow_id}/result:
get:
tags:
- WorkflowService
description: |-
GetWorkflowExecutionResult returns the result of a workflow execution. If the workflow
is still running, returns a NotCompleted response and optionally registers callbacks
to be invoked when the workflow completes.
operationId: GetWorkflowExecutionResult
parameters:
- name: namespace
in: path
required: true
schema:
type: string
- name: execution.workflow_id
in: path
required: true
schema:
type: string
- name: execution.workflowId
in: query
schema:
type: string
- name: execution.runId
in: query
schema:
type: string
- name: requestId
in: query
description: Used to de-dup requests (i.e., so we don't register the same callbacks multiple times).
schema:
type: string
- name: identity
in: query
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetWorkflowExecutionResultResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/api/v1/namespaces/{namespace}/workflows/{execution.workflow_id}/trigger-rule:
post:
tags:
Expand Down Expand Up @@ -8659,6 +8709,56 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Status'
/namespaces/{namespace}/workflows/{execution.workflow_id}/result:
get:
tags:
- WorkflowService
description: |-
GetWorkflowExecutionResult returns the result of a workflow execution. If the workflow
is still running, returns a NotCompleted response and optionally registers callbacks
to be invoked when the workflow completes.
operationId: GetWorkflowExecutionResult
parameters:
- name: namespace
in: path
required: true
schema:
type: string
- name: execution.workflow_id
in: path
required: true
schema:
type: string
- name: execution.workflowId
in: query
schema:
type: string
- name: execution.runId
in: query
schema:
type: string
- name: requestId
in: query
description: Used to de-dup requests (i.e., so we don't register the same callbacks multiple times).
schema:
type: string
- name: identity
in: query
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetWorkflowExecutionResultResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/namespaces/{namespace}/workflows/{execution.workflow_id}/trigger-rule:
post:
tags:
Expand Down Expand Up @@ -12149,6 +12249,65 @@ components:
type: string
description: Will be set if there are more history events than were included in this response
format: bytes
GetWorkflowExecutionResultResponse:
type: object
properties:
links:
type: array
items:
$ref: '#/components/schemas/Link'
description: |-
Link to the relevant history event:
- completion event, if the workflow has finished
- options-updated event, if callbacks were registered on a running workflow
notCompleted:
$ref: '#/components/schemas/GetWorkflowExecutionResultResponse_NotCompleted'
completed:
$ref: '#/components/schemas/GetWorkflowExecutionResultResponse_Completed'
GetWorkflowExecutionResultResponse_Completed:
type: object
properties:
execution:
$ref: '#/components/schemas/WorkflowExecution'
status:
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
result:
allOf:
- $ref: '#/components/schemas/Payloads'
description: Set only when status = COMPLETED.
failure:
allOf:
- $ref: '#/components/schemas/Failure'
description: Set for FAILED / CANCELED / TERMINATED / TIMED_OUT.
GetWorkflowExecutionResultResponse_NotCompleted:
type: object
properties:
execution:
$ref: '#/components/schemas/WorkflowExecution'
status:
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
GoogleProtobufAny:
type: object
properties:
Expand Down
Loading
Loading