estel/dify
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

fix(docs): correct workflow API parameter name from workflow_id to workflow_run_id (#22587)

Browse Source
This commit is contained in:
kawabata-mcl
2025-07-18 10:31:33 +09:00
committed by GitHub
parent 1715dd4320
commit d0bece1679
2 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
web/app/components/develop/template/template_workflow.en.mdx
View File

@@ -333,7 +333,7 @@ Workflow applications offers non-session support and is ideal for translation, a
--- ---
<Heading <Heading
url='/workflows/run/:workflow_id' url='/workflows/run/:workflow_run_id'
method='GET' method='GET'
title='Get Workflow Run Detail' title='Get Workflow Run Detail'
name='#get-workflow-run-detail' name='#get-workflow-run-detail'
@@ -342,7 +342,7 @@ Workflow applications offers non-session support and is ideal for translation, a
<Col> <Col>
Retrieve the current execution results of a workflow task based on the workflow execution ID. Retrieve the current execution results of a workflow task based on the workflow execution ID.
### Path ### Path
- `workflow_id` (string) Workflow ID, can be obtained from the streaming chunk return - `workflow_run_id` (string) Workflow run ID, can be obtained from the streaming chunk return
### Response ### Response
- `id` (string) ID of workflow execution - `id` (string) ID of workflow execution
- `workflow_id` (string) ID of related workflow - `workflow_id` (string) ID of related workflow
@@ -358,9 +358,9 @@ Workflow applications offers non-session support and is ideal for translation, a
</Col> </Col>
<Col sticky> <Col sticky>
### Request Example ### Request Example
<CodeGroup title="Request" tag="GET" label="/workflows/run/:workflow_id" targetCode={`curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_id' \\\n-H 'Authorization: Bearer {api_key}' \\\n-H 'Content-Type: application/json'`}> <CodeGroup title="Request" tag="GET" label="/workflows/run/:workflow_run_id" targetCode={`curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_run_id' \\\n-H 'Authorization: Bearer {api_key}' \\\n-H 'Content-Type: application/json'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_id' \ curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_run_id' \
-H 'Authorization: Bearer {api_key}' \ -H 'Authorization: Bearer {api_key}' \
-H 'Content-Type: application/json' -H 'Content-Type: application/json'
``` ```

8
web/app/components/develop/template/template_workflow.ja.mdx
View File

@@ -334,7 +334,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
--- ---
<Heading <Heading
url='/workflows/run/:workflow_id' url='/workflows/run/:workflow_run_id'
method='GET' method='GET'
title='ワークフロー実行詳細を取得' title='ワークフロー実行詳細を取得'
name='#get-workflow-run-detail' name='#get-workflow-run-detail'
@@ -343,7 +343,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
<Col> <Col>
ワークフロー実行 ID に基づいて、ワークフロータスクの現在の実行結果を取得します。 ワークフロー実行 ID に基づいて、ワークフロータスクの現在の実行結果を取得します。
### パス ### パス
- `workflow_id` (string) ワークフローID、ストリーミングチャンクの返り値から取得可能 - `workflow_run_id` (string) ワークフロー実行ID、ストリーミングチャンクの返り値から取得可能
### 応答 ### 応答
- `id` (string) ワークフロー実行の ID - `id` (string) ワークフロー実行の ID
- `workflow_id` (string) 関連するワークフローの ID - `workflow_id` (string) 関連するワークフローの ID
@@ -359,9 +359,9 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
</Col> </Col>
<Col sticky> <Col sticky>
### リクエスト例 ### リクエスト例
<CodeGroup title="リクエスト" tag="GET" label="/workflows/run/:workflow_id" targetCode={`curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_id' \\\n-H 'Authorization: Bearer {api_key}' \\\n-H 'Content-Type: application/json'`}> <CodeGroup title="リクエスト" tag="GET" label="/workflows/run/:workflow_run_id" targetCode={`curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_run_id' \\\n-H 'Authorization: Bearer {api_key}' \\\n-H 'Content-Type: application/json'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_id' \ curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_run_id' \
-H 'Authorization: Bearer {api_key}' \ -H 'Authorization: Bearer {api_key}' \
-H 'Content-Type: application/json' -H 'Content-Type: application/json'
``` ```