opensource/dify
3
0
Fork 0
mirror of https://github.com/langgenius/dify.git synced 2026-09-24 23:22:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix(agent-v2): complete console API contract schemas (#37210)

Browse Source 
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
This commit is contained in:
yyh
2026-06-09 04:40:32 +00:00
committed by GitHub
co-authored by autofix-ci[bot]
parent a80bba2c35
commit bbdf3d7634
12 changed files with 625 additions and 280 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api/openapi/markdown/console-swagger.md
+135 -20
View File
@@ -3724,9 +3724,10 @@ Snapshot of every node's declared outputs for a draft workflow run.
##### Responses
| Code | Description |
| ---- | ----------- |
| 404 | Workflow run not found |
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow run node outputs | [WorkflowRunSnapshotView](#workflowrunsnapshotview) |
| 404 | Workflow run not found | |
### /apps/{app_id}/workflows/draft/runs/{run_id}/node-outputs/events
@@ -3746,6 +3747,7 @@ Server-Sent Events stream of inspector deltas for a draft workflow run.
| Code | Description |
| ---- | ----------- |
| 200 | Workflow run node output event stream |
| 404 | Workflow run not found |
### /apps/{app_id}/workflows/draft/runs/{run_id}/node-outputs/{node_id}
@@ -3765,9 +3767,10 @@ One node's declared outputs for a draft workflow run.
##### Responses
| Code | Description |
| ---- | ----------- |
| 404 | Workflow run / node not found |
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow run node output detail | [NodeOutputsView](#nodeoutputsview) |
| 404 | Workflow run / node not found | |
### /apps/{app_id}/workflows/draft/runs/{run_id}/node-outputs/{node_id}/{output_name}/preview
@@ -3787,9 +3790,10 @@ Full value for one declared output, including signed download URL for files.
##### Responses
| Code | Description |
| ---- | ----------- |
| 404 | Workflow run / node / output not found |
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow run node output preview | [OutputPreviewView](#outputpreviewview) |
| 404 | Workflow run / node / output not found | |
### /apps/{app_id}/workflows/draft/system-variables
@@ -4044,9 +4048,10 @@ Snapshot of every node's declared outputs for a published workflow run.
##### Responses
| Code | Description |
| ---- | ----------- |
| 404 | Workflow run not found |
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow run node outputs | [WorkflowRunSnapshotView](#workflowrunsnapshotview) |
| 404 | Workflow run not found | |
### /apps/{app_id}/workflows/published/runs/{run_id}/node-outputs/events
@@ -4066,6 +4071,7 @@ Server-Sent Events stream of inspector deltas for a published workflow run.
| Code | Description |
| ---- | ----------- |
| 200 | Workflow run node output event stream |
| 404 | Workflow run not found |
### /apps/{app_id}/workflows/published/runs/{run_id}/node-outputs/{node_id}
@@ -4085,9 +4091,10 @@ One node's declared outputs for a published workflow run.
##### Responses
| Code | Description |
| ---- | ----------- |
| 404 | Workflow run / node not found |
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow run node output detail | [NodeOutputsView](#nodeoutputsview) |
| 404 | Workflow run / node not found | |
### /apps/{app_id}/workflows/published/runs/{run_id}/node-outputs/{node_id}/{output_name}/preview
@@ -4107,9 +4114,10 @@ Full value for one declared output of a published run.
##### Responses
| Code | Description |
| ---- | ----------- |
| 404 | Workflow run / node / output not found |
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow run node output preview | [OutputPreviewView](#outputpreviewview) |
| 404 | Workflow run / node / output not found | |
### /apps/{app_id}/workflows/triggers/webhook
@@ -11835,17 +11843,28 @@ composer/publish validators and skipped by runtime request builders.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| approved | boolean | | No |
| authorization_status | [AgentCliToolAuthorizationStatus](#agentclitoolauthorizationstatus) | | No |
| command | string | | No |
| dangerous | boolean | | No |
| dangerous_accepted | boolean | | No |
| dangerous_acknowledged | boolean | | No |
| dangerous_command | boolean | | No |
| description | string | | No |
| enabled | boolean | | No |
| install | string | | No |
| install_command | string | | No |
| install_commands | [ string ] | | No |
| invoke_metadata | object | | No |
| label | string | | No |
| name | string | | No |
| permission | object | | No |
| permission | [AgentPermissionConfig](#agentpermissionconfig) | | No |
| pre_authorized | boolean | | No |
| requires_confirmation | boolean | | No |
| risk_accepted | boolean | | No |
| risk_level | [AgentCliToolRiskLevel](#agentclitoolrisklevel) | | No |
| setup_command | string | | No |
| tool_name | string | | No |
#### AgentCliToolRiskLevel
@@ -12004,10 +12023,14 @@ Audit operation recorded for Agent Soul version/revision changes.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| default | string<br>integer<br>number<br>boolean<br>[ string ]<br>[ integer ]<br>[ number ]<br>[ boolean ] | | No |
| env_name | string | | No |
| key | string | | No |
| name | string | | No |
| required | boolean | | No |
| type | string | | No |
| value | string<br>integer<br>number<br>boolean<br>[ string ]<br>[ integer ]<br>[ number ]<br>[ boolean ] | | No |
| variable | string | | No |
#### AgentFeatureToggleConfig
@@ -12019,21 +12042,30 @@ Audit operation recorded for Agent Soul version/revision changes.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| file_id | string | | No |
| id | string | | No |
| name | string | | No |
| reference | string | | No |
| remote_url | string | | No |
| tenant_id | string | | No |
| transfer_method | string | | No |
| type | string | | No |
| upload_file_id | string | | No |
| url | string | | No |
#### AgentHumanContactConfig
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| channel | string | | No |
| contact_id | string | | No |
| contact_method | string | | No |
| email | string | | No |
| human_id | string | | No |
| id | string | | No |
| method | string | | No |
| name | string | | No |
| tenant_id | string | | No |
#### AgentHumanToolConfig
@@ -12177,6 +12209,14 @@ the current roster/workflow APIs scoped to Dify Agent.
| keywords | string | | No |
| outputs_config | [AgentModerationIOConfig](#agentmoderationioconfig) | | No |
#### AgentPermissionConfig
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| allowed | boolean | | No |
| state | string | | No |
| status | string | | No |
#### AgentReferencingWorkflowResponse
| Name | Type | Description | Required |
@@ -12233,6 +12273,7 @@ the current roster/workflow APIs scoped to Dify Agent.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cpu | integer | | No |
| env | [ [AgentEnvVariableConfig](#agentenvvariableconfig) ] | | No |
| image | string | | No |
| working_dir | string | | No |
@@ -12249,12 +12290,18 @@ Visibility and lifecycle scope of an Agent record.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credential_id | string | | No |
| env_name | string | | No |
| id | string | | No |
| key | string | | No |
| name | string | | No |
| permission | object | | No |
| permission | [AgentPermissionConfig](#agentpermissionconfig) | | No |
| permission_status | string | | No |
| provider | string | | No |
| provider_credential_id | string | | No |
| ref | string | | No |
| type | string | | No |
| variable | string | | No |
#### AgentSensitiveWordAvoidanceFeatureConfig
@@ -13093,6 +13140,15 @@ Button styles for user actions.
| ---- | ---- | ----------- | -------- |
| email | string | | Yes |
#### CheckResultView
``type_check`` / ``output_check`` per-output summary block.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| passed | boolean | | Yes |
| reason | string | | No |
#### ChildChunkBatchUpdatePayload
| Name | Type | Description | Required |
@@ -15535,6 +15591,38 @@ Enum class for model type.
| ---- | ---- | ----------- | -------- |
| node_id | string | | Yes |
#### NodeOutputStatus
Lifecycle status of a single declared output within a run.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| NodeOutputStatus | string | Lifecycle status of a single declared output within a run. | |
#### NodeOutputView
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string | | Yes |
| output_check | [CheckResultView](#checkresultview) | | No |
| retried | integer | | No |
| status | [NodeOutputStatus](#nodeoutputstatus) | | Yes |
| type | [DeclaredOutputType](#declaredoutputtype) | | No |
| type_check | [CheckResultView](#checkresultview) | | No |
| value_preview | | | No |
#### NodeOutputsView
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| node_completed_at | dateTime | | No |
| node_display_name | string | | Yes |
| node_id | string | | Yes |
| node_kind | string | | Yes |
| node_started_at | dateTime | | No |
| node_status | [NodeStatus](#nodestatus) | | Yes |
| outputs | [ [NodeOutputView](#nodeoutputview) ] | | No |
#### NodeRunPayload
| Name | Type | Description | Required |
@@ -15547,6 +15635,14 @@ Enum class for model type.
| ---- | ---- | ----------- | -------- |
| inputs | object | | Yes |
#### NodeStatus
Coarse node-level status used by Inspector to pick a banner.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| NodeStatus | string | Coarse node-level status used by Inspector to pick a banner. | |
#### NotionEstimatePayload
| Name | Type | Description | Required |
@@ -15637,6 +15733,16 @@ output check fails and any configured retry attempts have been exhausted.
| ---- | ---- | ----------- | -------- |
| OutputErrorStrategy | string | Per-output failure handling strategy. Mirrors ``graphon.ErrorStrategy`` but scoped to a single declared output of a Workflow Agent Node. The runtime applies the strategy after type check or output check fails and any configured retry attempts have been exhausted. | |
#### OutputPreviewView
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| node_id | string | | Yes |
| output_name | string | | Yes |
| status | [NodeOutputStatus](#nodeoutputstatus) | | Yes |
| type | [DeclaredOutputType](#declaredoutputtype) | | No |
| value | | | No |
#### OwnerTransferCheckPayload
| Name | Type | Description | Required |
@@ -17821,6 +17927,7 @@ can reuse its existing handler.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| agent_soul | object | | No |
| file_refs | [ [AgentFileRefConfig](#agentfilerefconfig) ] | | No |
#### WorkflowNodeJobMode
@@ -18078,6 +18185,14 @@ Query parameters for workflow runs.
| files | [ ] | | No |
| inputs | object | | Yes |
#### WorkflowRunSnapshotView
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| node_outputs | [ [NodeOutputsView](#nodeoutputsview) ] | | No |
| workflow_run_id | string | | Yes |
| workflow_run_status | [WorkflowExecutionStatus](#workflowexecutionstatus) | | Yes |
#### WorkflowStatisticQuery
| Name | Type | Description | Required |