[DOCS]: Correct the documentation of Workflow Run Response data.status #284

Closed
opened 2026-02-16 05:19:44 -05:00 by yindo · 5 comments
Owner

Originally created by @AkiraVoid on GitHub (Nov 27, 2025).

Type of Documentation Change

New documentation

Documentation Page URL or Path

https://docs.dify.ai/api-reference/workflow-execution/execute-workflow

Current Content

Image

Suggested Changes

Actually there's fifth status partial-succeeded, we got this status in our production scheduler platform. (Dify Version 1.10.0)

Also, please explain how a Workflow Run can run into partial-succeeded status.

Reason for Change

The doc should correctly explain all possible values of an enum type field.

Code of Conduct

  • I agree to follow Dify's documentation contribution guidelines
  • I have searched for existing issues search for existing issues, including closed ones.
  • I confirm that I am using English to submit this report, otherwise it will be closed.
  • 【中文用户 & Non English User】请使用英语提交,否则会被关闭 :)
  • Please do not modify this template :) and fill in all the required fields.
Originally created by @AkiraVoid on GitHub (Nov 27, 2025). ### Type of Documentation Change New documentation ### Documentation Page URL or Path https://docs.dify.ai/api-reference/workflow-execution/execute-workflow ### Current Content <img width="870" height="485" alt="Image" src="https://github.com/user-attachments/assets/5d7b7854-84ed-4191-88f4-f19e029671a9" /> ### Suggested Changes Actually there's fifth status `partial-succeeded`, we got this status in our production scheduler platform. (Dify Version 1.10.0) Also, please explain how a Workflow Run can run into `partial-succeeded` status. ### Reason for Change The doc should correctly explain all possible values of an `enum` type field. ### Code of Conduct - [x] I agree to follow Dify's documentation [contribution guidelines](https://github.com/langgenius/dify/blob/0277a37fcad5ad86aeb239485c27fffd5cd90043/CONTRIBUTING.md) - [x] I have searched for existing issues [search for existing issues](https://github.com/langgenius/dify/issues), including closed ones. - [x] I confirm that I am using English to submit this report, otherwise it will be closed. - [x] 【中文用户 & Non English User】请使用英语提交,否则会被关闭 :) - [x] Please do not modify this template :) and fill in all the required fields.
yindo added the documentation label 2026-02-16 05:19:44 -05:00
yindo closed this issue 2026-02-16 05:19:44 -05:00
Author
Owner

@dosubot[bot] commented on GitHub (Dec 8, 2025):

Hi, @AkiraVoid. I'm Dosu (https://dosu.dev), and I'm helping the dify-docs team manage their backlog and am marking this issue as stale.

Issue Summary:

  • You requested an update to the documentation for the Workflow Run Response data.status to include a new fifth status value, partial-succeeded.
  • This status was introduced in version 1.10.0.
  • You also asked for an explanation of the conditions under which a Workflow Run attains this status.
  • There has been no activity or comments on this issue since it was opened.

What's Next:

  • Please let me know if this issue is still relevant to the latest version of the dify-docs repository by commenting here.
  • If I do not hear back within 5 days, this issue will be automatically closed.

Thank you for your understanding and contribution!

@dosubot[bot] commented on GitHub (Dec 8, 2025): Hi, @AkiraVoid. I'm Dosu (https://dosu.dev), and I'm helping the dify-docs team manage their backlog and am marking this issue as stale. **Issue Summary:** - You requested an update to the documentation for the Workflow Run Response `data.status` to include a new fifth status value, `partial-succeeded`. - This status was introduced in version 1.10.0. - You also asked for an explanation of the conditions under which a Workflow Run attains this status. - There has been no activity or comments on this issue since it was opened. **What's Next:** - Please let me know if this issue is still relevant to the latest version of the dify-docs repository by commenting here. - If I do not hear back within 5 days, this issue will be automatically closed. Thank you for your understanding and contribution!
Author
Owner

@AkiraVoid commented on GitHub (Dec 10, 2025):

This issue still exists in latest doc.

@AkiraVoid commented on GitHub (Dec 10, 2025): This issue still exists in latest doc.
Author
Owner

@dosubot[bot] commented on GitHub (Dec 10, 2025):

@crazywoola The user has confirmed that the issue regarding the update for the Workflow Run Response data.status with the partial-succeeded status is still relevant in the newest docs. Could you please assist with this?

@dosubot[bot] commented on GitHub (Dec 10, 2025): @crazywoola The user has confirmed that the issue regarding the update for the Workflow Run Response `data.status` with the `partial-succeeded` status is still relevant in the newest docs. Could you please assist with this?
Author
Owner

@RiskeyL commented on GitHub (Dec 15, 2025):

Hi @AkiraVoid, thanks for your feedback! Thepartial-succeeded status indicates that some errors occurred during the workflow execution, but they were successfully handled via error strategies like "fail branch" or "default value".

We completely agree that concepts like this should be clarified in the docs, and we will add an explanation in the appropriate section. That said, we are holding off on adding this status to the API docs for now, as there are still some ongoing internal discussions regarding its implementation.

@RiskeyL commented on GitHub (Dec 15, 2025): Hi @AkiraVoid, thanks for your feedback! The`partial-succeeded` status indicates that some errors occurred during the workflow execution, but they were successfully handled via error strategies like "fail branch" or "default value". We completely agree that concepts like this should be clarified in the docs, and we will add an explanation in the appropriate section. That said, we are holding off on adding this status to the API docs for now, as there are still some ongoing internal discussions regarding its implementation.
Author
Owner

@dosubot[bot] commented on GitHub (Dec 26, 2025):

Hi, @AkiraVoid. I'm Dosu, and I'm helping the dify-docs team manage their backlog and am marking this issue as stale.

Issue Summary:

  • You requested an update to the documentation for the Workflow Run Response data.status to include the new partial-succeeded status introduced in version 1.10.0.
  • You confirmed the issue remains relevant after a period of inactivity.
  • Maintainer RiskeyL explained that partial-succeeded indicates some errors occurred but were handled via error strategies.
  • RiskeyL agreed the docs should clarify this status but is currently holding off on updating due to ongoing internal discussions about its implementation.

Next Steps:

  • Please let me know if this issue is still relevant to the latest version of the dify-docs repository by commenting here to keep the discussion open.
  • Otherwise, this issue will be automatically closed in 5 days.

Thank you for your understanding and contribution!

@dosubot[bot] commented on GitHub (Dec 26, 2025): Hi, @AkiraVoid. I'm [Dosu](https://dosu.dev), and I'm helping the dify-docs team manage their backlog and am marking this issue as stale. **Issue Summary:** - You requested an update to the documentation for the Workflow Run Response `data.status` to include the new `partial-succeeded` status introduced in version 1.10.0. - You confirmed the issue remains relevant after a period of inactivity. - Maintainer RiskeyL explained that `partial-succeeded` indicates some errors occurred but were handled via error strategies. - RiskeyL agreed the docs should clarify this status but is currently holding off on updating due to ongoing internal discussions about its implementation. **Next Steps:** - Please let me know if this issue is still relevant to the latest version of the dify-docs repository by commenting here to keep the discussion open. - Otherwise, this issue will be automatically closed in 5 days. Thank you for your understanding and contribution!
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langgenius/dify-docs#284