refactor(api): migrate console.app.workflow to BaseModel (#36216)

Co-authored-by: WH-2099 <wh2099@pm.me>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
This commit is contained in:
chariri
2026-05-18 16:31:37 +09:00
committed by GitHub
parent 7e8147295b
commit 2eb37caf2e
19 changed files with 1241 additions and 341 deletions

View File

@ -607,9 +607,9 @@ Get workflow online users
##### Responses
| Code | Description |
| ---- | ----------- |
| 200 | Success |
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow online users retrieved successfully | [WorkflowOnlineUsersResponse](#workflowonlineusersresponse) |
### /apps/{app_id}
@ -2720,7 +2720,7 @@ Get all published workflows for an application
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Published workflows retrieved successfully | [WorkflowPagination](#workflowpagination) |
| 200 | Published workflows retrieved successfully | [WorkflowPaginationResponse](#workflowpaginationresponse) |
### /apps/{app_id}/workflows/default-workflow-block-configs
@ -2792,7 +2792,7 @@ Get draft workflow for an application
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Draft workflow retrieved successfully | [Workflow](#workflow) |
| 200 | Draft workflow retrieved successfully | [WorkflowResponse](#workflowresponse) |
| 404 | Draft workflow not found | |
#### POST
@ -3403,8 +3403,7 @@ Get published workflow for an application
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Published workflow retrieved successfully | [Workflow](#workflow) |
| 404 | Published workflow not found | |
| 200 | Published workflow retrieved successfully, or null if not found | [WorkflowResponse](#workflowresponse) |
#### POST
##### Summary
@ -3485,7 +3484,7 @@ Update workflow by ID
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow updated successfully | [Workflow](#workflow) |
| 200 | Workflow updated successfully | [WorkflowResponse](#workflowresponse) |
| 403 | Permission denied | |
| 404 | Workflow not found | |
@ -6685,9 +6684,10 @@ Get published workflows
##### Responses
| Code | Description |
| ---- | ----------- |
| 200 | Success |
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Published workflows retrieved successfully | [WorkflowPaginationResponse](#workflowpaginationresponse) |
| 403 | Permission denied | |
### /rag/pipelines/{pipeline_id}/workflows/default-workflow-block-configs
@ -6743,9 +6743,10 @@ Get draft rag pipeline's workflow
##### Responses
| Code | Description |
| ---- | ----------- |
| 200 | Success |
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Draft workflow retrieved successfully | [WorkflowResponse](#workflowresponse) |
| 404 | Draft workflow not found | |
#### POST
##### Summary
@ -7105,9 +7106,9 @@ Get published pipeline
##### Responses
| Code | Description |
| ---- | ----------- |
| 200 | Success |
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Published workflow retrieved successfully, or null if not exist | [WorkflowResponse](#workflowresponse) |
#### POST
##### Summary
@ -7260,9 +7261,12 @@ Update workflow attributes
##### Responses
| Code | Description |
| ---- | ----------- |
| 200 | Success |
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow updated successfully | [WorkflowResponse](#workflowresponse) |
| 400 | No valid fields to update | |
| 403 | Permission denied | |
| 404 | Workflow not found | |
### /rag/pipelines/{pipeline_id}/workflows/{workflow_id}/restore
@ -10955,16 +10959,6 @@ Condition detail
| auto_generate | boolean | | No |
| name | string | | No |
#### ConversationVariable
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string | | No |
| id | string | | No |
| name | string | | No |
| value | object | | No |
| value_type | string | | No |
#### ConversationVariableResponse
| Name | Type | Description | Required |
@ -12993,24 +12987,24 @@ Form input definition.
| icon_info | object | | No |
| name | string | | Yes |
#### PipelineVariable
#### PipelineVariableResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| allow_file_extension | [ string ] | | No |
| allow_file_upload_methods | [ string ] | | No |
| allowed_file_extensions | [ string ] | | No |
| allowed_file_types | [ string ] | | No |
| belong_to_node_id | string | | No |
| allowed_file_upload_methods | [ string ] | | No |
| belong_to_node_id | string | | Yes |
| default_value | object | | No |
| label | string | | No |
| label | string | | Yes |
| max_length | integer | | No |
| options | [ string ] | | No |
| placeholder | string | | No |
| required | boolean | | No |
| required | boolean | | Yes |
| tooltips | string | | No |
| type | string | | No |
| type | string | | Yes |
| unit | string | | No |
| variable | string | | No |
| variable | string | | Yes |
#### PluginAutoUpgradeSettingsPayload
@ -13906,26 +13900,6 @@ in form definiton, or a variable while the workflow is running.
| embedding_provider_name | string | | Yes |
| vector_weight | number | | Yes |
#### Workflow
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_variables | [ [ConversationVariable](#conversationvariable) ] | | No |
| created_at | object | | No |
| created_by | [SimpleAccount](#simpleaccount) | | No |
| environment_variables | [ object ] | | No |
| features | object | | No |
| graph | object | | No |
| hash | string | | No |
| id | string | | No |
| marked_comment | string | | No |
| marked_name | string | | No |
| rag_pipeline_variables | [ [PipelineVariable](#pipelinevariable) ] | | No |
| tool_published | boolean | | No |
| updated_at | object | | No |
| updated_by | [SimpleAccount](#simpleaccount) | | No |
| version | string | | No |
#### WorkflowAppLogPaginationResponse
| Name | Type | Description | Required |
@ -14124,6 +14098,16 @@ in form definiton, or a variable while the workflow is running.
| position_x | number | Comment X position | No |
| position_y | number | Comment Y position | No |
#### WorkflowConversationVariableResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string | | Yes |
| id | string | | Yes |
| name | string | | Yes |
| value | object | | Yes |
| value_type | string | | Yes |
#### WorkflowDraftEnvVariable
| Name | Type | Description | Required |
@ -14207,6 +14191,16 @@ in form definiton, or a variable while the workflow is running.
| value_type | string | | No |
| visible | boolean | | No |
#### WorkflowEnvironmentVariableResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string | | Yes |
| id | string | | Yes |
| name | string | | Yes |
| value | object | | Yes |
| value_type | string | | Yes |
#### WorkflowExecutionStatus
| Name | Type | Description | Required |
@ -14228,20 +14222,41 @@ in form definiton, or a variable while the workflow is running.
| page | integer | | No |
| user_id | string | | No |
#### WorkflowOnlineUser
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| avatar | string | | No |
| user_id | string | | Yes |
| username | string | | Yes |
#### WorkflowOnlineUsersByApp
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_id | string | | Yes |
| users | [ [WorkflowOnlineUser](#workflowonlineuser) ] | | Yes |
#### WorkflowOnlineUsersPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_ids | [ string ] | App IDs | No |
#### WorkflowPagination
#### WorkflowOnlineUsersResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| has_more | boolean | | No |
| items | [ [Workflow](#workflow) ] | | No |
| limit | integer | | No |
| page | integer | | No |
| data | [ [WorkflowOnlineUsersByApp](#workflowonlineusersbyapp) ] | | Yes |
#### WorkflowPaginationResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| has_more | boolean | | Yes |
| items | [ [WorkflowResponse](#workflowresponse) ] | | Yes |
| limit | integer | | Yes |
| page | integer | | Yes |
#### WorkflowPartial
@ -14260,6 +14275,26 @@ in form definiton, or a variable while the workflow is running.
| paused_at | string | | No |
| paused_nodes | [ [PausedNodeResponse](#pausednoderesponse) ] | | Yes |
#### WorkflowResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_variables | [ [WorkflowConversationVariableResponse](#workflowconversationvariableresponse) ] | | Yes |
| created_at | integer | | Yes |
| created_by | [SimpleAccount](#simpleaccount) | | No |
| environment_variables | [ [WorkflowEnvironmentVariableResponse](#workflowenvironmentvariableresponse) ] | | Yes |
| features | object | | Yes |
| graph | object | | Yes |
| hash | string | | Yes |
| id | string | | Yes |
| marked_comment | string | | Yes |
| marked_name | string | | Yes |
| rag_pipeline_variables | [ [PipelineVariableResponse](#pipelinevariableresponse) ] | | Yes |
| tool_published | boolean | | Yes |
| updated_at | integer | | Yes |
| updated_by | [SimpleAccount](#simpleaccount) | | No |
| version | string | | Yes |
#### WorkflowRunCountQuery
| Name | Type | Description | Required |