langgenius/dify-docs
1
0
Fork 0
mirror of https://github.com/langgenius/dify-docs.git synced 2026-07-22 04:15:24 -04:00
Code Issues 10 Packages Projects Releases Wiki Activity

[DOCS]: Fix incorrect parameter name in workflow API documentation (workflow_id should be workflow_run_id) #188

New Issue
Closed
opened 2026-02-16 05:19:24 -05:00 by yindo · 1 comment
yindo commented 2026-02-16 05:19:24 -05:00
Owner
Copy Link
Copy Source

Originally created by @kawabata-mcl on GitHub (Jul 17, 2025).

Type of Documentation Change

Error/Typo fix

Documentation Page URL or Path

https://github.com/langgenius/dify/blob/1.6.0/web/app/components/develop/template/template_workflow.ja.mdx

Current Content

Description

There is an inconsistency in the workflow API documentation across different language versions. The "Get Workflow Run Detail" endpoint documentation incorrectly uses workflow_id as the path parameter in Japanese and English versions, while the actual implementation and Chinese documentation correctly use workflow_run_id.

Current Behavior

Japanese documentation :

  • URL: /workflows/run/:workflow_id
  • Parameter: workflow_id (string)

English documentation :

  • URL: /workflows/run/:workflow_id
  • Parameter: workflow_id (string)

Expected Behavior

The documentation should match the actual API implementation and the correct Chinese documentation :

  • URL: /workflows/run/:workflow_run_id
  • Parameter: workflow_run_id (string)

Evidence

The actual API implementation confirms that workflow_run_id is the correct parameter:

  1. api/controllers/service_api/app/workflow.py(lines 55-67)
  2. sdks/python-client/dify_client/client.py(lines 157-158)

Files to Fix

  • web/app/components/develop/template/template_workflow.ja.mdx (lines 337, 346)
  • web/app/components/develop/template/template_workflow.en.mdx (lines 336, 345)

Impact

This documentation error could cause confusion for developers integrating with the Dify API, as they might use the incorrect parameter name and receive API errors.

Suggested Changes

For Japanese Documentation (template_workflow.ja.mdx)

Current (incorrect) section:

<Heading
  url='/workflows/run/:workflow_id'
  method='GET'
  title='ワークフロー実行詳細を取得'
  name='#get-workflow-run-detail'
/>

Should be corrected to:

<Heading
  url='/workflows/run/:workflow_run_id'
  method='GET'
  title='ワークフロー実行詳細を取得'
  name='#get-workflow-run-detail'
/>

Current (incorrect) parameter description:

- `workflow_id` (string) ワークフローID、ストリーミングチャンクの返り値から取得可能

Should be corrected to:

- `workflow_run_id` (string) ワークフロー実行ID、ストリーミングチャンクの返り値から取得可能

For English Documentation (template_workflow.en.mdx)

Current (incorrect) section:

<Heading
  url='/workflows/run/:workflow_id'
  method='GET'
  title='Get Workflow Run Detail'
  name='#get-workflow-run-detail'
/>

Should be corrected to:

<Heading
  url='/workflows/run/:workflow_run_id'
  method='GET'
  title='Get Workflow Run Detail'
  name='#get-workflow-run-detail'
/>

Current (incorrect) parameter description:

- `workflow_id` (string) Workflow ID, can be obtained from the streaming chunk return

Should be corrected to:

- `workflow_run_id` (string) Workflow run ID, can be obtained from the streaming chunk return

Reason for Change

No response

Code of Conduct

Originally created by @kawabata-mcl on GitHub (Jul 17, 2025). ### Type of Documentation Change Error/Typo fix ### Documentation Page URL or Path https://github.com/langgenius/dify/blob/1.6.0/web/app/components/develop/template/template_workflow.ja.mdx ### Current Content ### Description There is an inconsistency in the workflow API documentation across different language versions. The "Get Workflow Run Detail" endpoint documentation incorrectly uses `workflow_id` as the path parameter in Japanese and English versions, while the actual implementation and Chinese documentation correctly use `workflow_run_id`. ### Current Behavior **Japanese documentation** : - URL: `/workflows/run/:workflow_id` - Parameter: `workflow_id` (string) **English documentation** : - URL: `/workflows/run/:workflow_id` - Parameter: `workflow_id` (string) ### Expected Behavior The documentation should match the actual API implementation and the correct Chinese documentation : - URL: `/workflows/run/:workflow_run_id` - Parameter: `workflow_run_id` (string) ### Evidence The actual API implementation confirms that `workflow_run_id` is the correct parameter: 1. **api/controllers/service_api/app/workflow.py**(lines 55-67) 2. **sdks/python-client/dify_client/client.py**(lines 157-158) ### Files to Fix - `web/app/components/develop/template/template_workflow.ja.mdx` (lines 337, 346) - `web/app/components/develop/template/template_workflow.en.mdx` (lines 336, 345) ### Impact This documentation error could cause confusion for developers integrating with the Dify API, as they might use the incorrect parameter name and receive API errors. ### Suggested Changes ### For Japanese Documentation (`template_workflow.ja.mdx`) **Current (incorrect) section:** ```markdown <Heading url='/workflows/run/:workflow_id' method='GET' title='ワークフロー実行詳細を取得' name='#get-workflow-run-detail' /> ``` **Should be corrected to:** ```markdown <Heading url='/workflows/run/:workflow_run_id' method='GET' title='ワークフロー実行詳細を取得' name='#get-workflow-run-detail' /> ``` **Current (incorrect) parameter description:** ```markdown - `workflow_id` (string) ワークフローID、ストリーミングチャンクの返り値から取得可能 ``` **Should be corrected to:** ```markdown - `workflow_run_id` (string) ワークフロー実行ID、ストリーミングチャンクの返り値から取得可能 ``` ### For English Documentation (`template_workflow.en.mdx`) **Current (incorrect) section:** ```markdown <Heading url='/workflows/run/:workflow_id' method='GET' title='Get Workflow Run Detail' name='#get-workflow-run-detail' /> ``` **Should be corrected to:** ```markdown <Heading url='/workflows/run/:workflow_run_id' method='GET' title='Get Workflow Run Detail' name='#get-workflow-run-detail' /> ``` **Current (incorrect) parameter description:** ```markdown - `workflow_id` (string) Workflow ID, can be obtained from the streaming chunk return ``` **Should be corrected to:** ```markdown - `workflow_run_id` (string) Workflow run ID, can be obtained from the streaming chunk return ``` ### Reason for Change _No response_ ### Code of Conduct - [x] I agree to follow Dify's documentation [contribution guidelines](https://github.com/langgenius/dify/blob/0277a37fcad5ad86aeb239485c27fffd5cd90043/CONTRIBUTING.md)
yindo added the documentation label 2026-02-16 05:19:24 -05:00
yindo closed this issue 2026-02-16 05:19:24 -05:00
yindo commented 2026-02-16 05:19:25 -05:00
Author
Owner
Copy Link
Copy Source

@kawabata-mcl commented on GitHub (Jul 17, 2025):

The curl sample commands in both Japanese and English documentation also need to be updated to use :workflow_run_id instead of :workflow_id.

Current Incorrect Curl Commands

Japanese documentation:

curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_id' \

English documentation:

curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_id' \

Should be corrected to:

For Japanese documentation:

curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_run_id' \
-H 'Authorization: Bearer {api_key}' \
-H 'Content-Type: application/json'

For English documentation:

curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_run_id' \
-H 'Authorization: Bearer {api_key}' \
-H 'Content-Type: application/json'

Reference Implementation

The Chinese documentation already has the correct curl command:

curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_run_id' \

This ensures consistency across all documentation languages and prevents API integration errors for developers following the curl examples.

@kawabata-mcl commented on GitHub (Jul 17, 2025): The curl sample commands in both Japanese and English documentation also need to be updated to use `:workflow_run_id` instead of `:workflow_id`. ### Current Incorrect Curl Commands **Japanese documentation**: ```bash curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_id' \ ``` **English documentation**: ```bash curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_id' \ ``` ### Should be corrected to: **For Japanese documentation:** ```bash curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_run_id' \ -H 'Authorization: Bearer {api_key}' \ -H 'Content-Type: application/json' ``` **For English documentation:** ```bash curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_run_id' \ -H 'Authorization: Bearer {api_key}' \ -H 'Content-Type: application/json' ``` ### Reference Implementation The Chinese documentation already has the correct curl command: ```bash curl -X GET '${props.appDetail.api_base_url}/workflows/run/:workflow_run_id' \ ``` This ensures consistency across all documentation languages and prevents API integration errors for developers following the curl examples.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
documentation
documentation
enhancement
pull-request
Mirrored from GitHub Pull Request
 question
stale
No Label documentation
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langgenius/dify-docs#188
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?