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]: API Documentation Missing Content #292

New Issue
Open
opened 2026-02-16 05:19:47 -05:00 by yindo · 7 comments
yindo commented 2026-02-16 05:19:47 -05:00
Owner
Copy Link
Copy Source

Originally created by @pop9s on GitHub (Dec 29, 2025).

Type of Documentation Change

Content update

Documentation Page URL or Path

https://docs.dify.ai/api-reference

Current Content

API Documentation Missing Content

Suggested Changes

The following interfaces are used in practice but not documented:
Datasets module:
GET console/api/datasets/{id}/error-docs
GET console/api/datasets/{id}/metadata
GET console/api/datasets/{id}/related-apps
GET console/api/datasets/{id}/use-check
Explore module:
GET console/api/explore/apps
Features module:
GET console/api/features
Files module:
GET console/api/files/support-type
Apps module:
GET console/api/apps/imports/{uuid}/check-dependencies
GET console/api/apps/{id}/advanced-chat/workflow-runs
GET console/api/apps/{id}/workflows/default-workflow-block-configs
GET console/api/apps/{id}/api-keys
GET console/api/apps/{id}/text-to-audio/voices
GET console/api/apps/{id}/workflows/draft
GET console/api/apps/{id}/workflows/draft/config
GET console/api/apps/{id}/workflows/draft/conversation-variables
GET console/api/apps/{id}/workflows/draft/system-variables
GET console/api/apps/{id}/workflows/publish
GET console/api/apps/{id}/workflows/draft/variables
GET api/webapp/access-mode
GET console/api/account/profile

Reason for Change

A large number of Console-related API interfaces and URL splicing rules are missing from the documentation, and the description of public variables is incomplete

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 @pop9s on GitHub (Dec 29, 2025). ### Type of Documentation Change Content update ### Documentation Page URL or Path https://docs.dify.ai/api-reference ### Current Content API Documentation Missing Content ### Suggested Changes The following interfaces are used in practice but not documented: Datasets module: GET console/api/datasets/{id}/error-docs GET console/api/datasets/{id}/metadata GET console/api/datasets/{id}/related-apps GET console/api/datasets/{id}/use-check Explore module: GET console/api/explore/apps Features module: GET console/api/features Files module: GET console/api/files/support-type Apps module: GET console/api/apps/imports/{uuid}/check-dependencies GET console/api/apps/{id}/advanced-chat/workflow-runs GET console/api/apps/{id}/workflows/default-workflow-block-configs GET console/api/apps/{id}/api-keys GET console/api/apps/{id}/text-to-audio/voices GET console/api/apps/{id}/workflows/draft GET console/api/apps/{id}/workflows/draft/config GET console/api/apps/{id}/workflows/draft/conversation-variables GET console/api/apps/{id}/workflows/draft/system-variables GET console/api/apps/{id}/workflows/publish GET console/api/apps/{id}/workflows/draft/variables GET api/webapp/access-mode GET console/api/account/profile ### Reason for Change A large number of Console-related API interfaces and URL splicing rules are missing from the documentation, and the description of public variables is incomplete ### 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 documentationstale labels 2026-02-16 05:19:47 -05:00
yindo commented 2026-02-16 05:19:47 -05:00
Author
Owner
Copy Link
Copy Source

@hsiong commented on GitHub (Jan 2, 2026):

Related / similar: #540 (API docs discoverability gap)

Impact

  • If someone reads only API Reference, it’s easy to assume the metadata assignment endpoint doesn’t exist.

Suggestion (low effort)

  • Add a short “See also / Related endpoints” note in API Reference → Documents pages linking to:
    • dataset metadata fields endpoints
    • document metadata assignment endpoint
      (cross-link only, no need to duplicate full content)

Expectation

  • Would love to see this cross-link added so API Reference users can find the metadata workflow without jumping between sections.
@hsiong commented on GitHub (Jan 2, 2026): Related / similar: #540 (API docs discoverability gap) - ✅ Document metadata assignment API is documented under “Use Dify”: https://docs.dify.ai/en/use-dify/knowledge/manage-knowledge/maintain-dataset-via-api#modify-metadata-for-a-single-document-assignment - ❌ But it’s not referenced in the API Reference “Knowledge → Documents” section (example page): https://docs.dify.ai/api-reference/documents/create-a-document-from-text Impact - If someone reads only API Reference, it’s easy to assume the metadata assignment endpoint doesn’t exist. Suggestion (low effort) - Add a short “See also / Related endpoints” note in API Reference → Documents pages linking to: - dataset metadata fields endpoints - document metadata assignment endpoint (cross-link only, no need to duplicate full content) Expectation - Would love to see this cross-link added so API Reference users can find the metadata workflow without jumping between sections.
yindo commented 2026-02-16 05:19:47 -05:00
Author
Owner
Copy Link
Copy Source

@RiskeyL commented on GitHub (Jan 7, 2026):

Hi @hsiong @pop9s, thank you for bringing this up. Due to some legacy reasons, our API reference has been out of sync with the code and has some gaps. We're currently working on a solution for batch updates, after which the content under "Use Dify" will be removed to make the API reference the single source of truth. I'll share updates with you here as we make progress.

@RiskeyL commented on GitHub (Jan 7, 2026): Hi @hsiong @pop9s, thank you for bringing this up. Due to some legacy reasons, our API reference has been out of sync with the code and has some gaps. We're currently working on a solution for batch updates, after which the content under "Use Dify" will be removed to make the API reference the single source of truth. I'll share updates with you here as we make progress.
yindo commented 2026-02-16 05:19:47 -05:00
Author
Owner
Copy Link
Copy Source

@dosubot[bot] commented on GitHub (Jan 18, 2026):

Hi, @pop9s. 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 reported missing Console-related endpoints and URL splicing rules in the API documentation.
  • A related issue was noted about metadata assignment APIs being documented inconsistently.
  • The maintainer acknowledged legacy documentation gaps and is working on batch updates to unify the API reference.
  • Progress updates on this unification effort have been promised but not yet provided.

Next Steps:

  • 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 (Jan 18, 2026): Hi, @pop9s. 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 reported missing Console-related endpoints and URL splicing rules in the API documentation. - A related issue was noted about metadata assignment APIs being documented inconsistently. - The maintainer acknowledged legacy documentation gaps and is working on batch updates to unify the API reference. - Progress updates on this unification effort have been promised but not yet provided. **Next Steps:** - 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!
yindo commented 2026-02-16 05:19:47 -05:00
Author
Owner
Copy Link
Copy Source

@pop9s commented on GitHub (Jan 22, 2026):

嗨，。我是Dosu（https://dosu.dev），正在帮dify-docs团队管理积压，并将这个问题标记为陈旧。

问题摘要：

  • 你在 API 文档中报告缺少与 Console 相关的端点和 URL 拼接规则。
  • 相关问题是元数据分配API文档描述不一致。
  • 维护者承认遗留文档存在漏洞，正在进行批量更新以统一API引用。
  • 统一努力的进展已承诺，但尚未公布。

下一步：

  • 请在这里评论告诉我这个问题是否仍然与最新版本的dify-docs仓库相关。
  • 如果5天内没有回复，这个问题将自动关闭。

感谢你的理解和贡献！

Hi @dosubot @RiskeyL @hsiong,This issue is still relevant to the latest version of dify-docs. The Console-related API endpoints I listed (e.g., datasets error-docs, apps api-keys, workflow draft configs) are still missing from the API Reference, and URL splicing rules & public variable descriptions remain incomplete.
We understand the team is working on batch updates to unify the documentation, and we appreciate the effort. We look forward to seeing these practical interfaces added to the API Reference once the update is completed—they’re essential for developers integrating with Dify’s Console features.
Thank you for the progress updates and your work on improving the docs!

@pop9s commented on GitHub (Jan 22, 2026): > 嗨，。我是Dosu（https://dosu.dev），正在帮dify-docs团队管理积压，并将这个问题标记为陈旧。 > > **问题摘要：** > > * 你在 API 文档中报告缺少与 Console 相关的端点和 URL 拼接规则。 > * 相关问题是元数据分配API文档描述不一致。 > * 维护者承认遗留文档存在漏洞，正在进行批量更新以统一API引用。 > * 统一努力的进展已承诺，但尚未公布。 > > **下一步：** > > * 请在这里评论告诉我这个问题是否仍然与最新版本的dify-docs仓库相关。 > * 如果5天内没有回复，这个问题将自动关闭。 > > 感谢你的理解和贡献！ Hi @dosubot @RiskeyL @hsiong,This issue is still relevant to the latest version of dify-docs. The Console-related API endpoints I listed (e.g., datasets error-docs, apps api-keys, workflow draft configs) are still missing from the API Reference, and URL splicing rules & public variable descriptions remain incomplete. We understand the team is working on batch updates to unify the documentation, and we appreciate the effort. We look forward to seeing these practical interfaces added to the API Reference once the update is completed—they’re essential for developers integrating with Dify’s Console features. Thank you for the progress updates and your work on improving the docs!
yindo commented 2026-02-16 05:19:47 -05:00
Author
Owner
Copy Link
Copy Source

@dosubot[bot] commented on GitHub (Jan 22, 2026):

@RiskeyL, the user @pop9s has confirmed that the issue regarding missing Console-related API endpoints and incomplete URL splicing rules in the API Reference is still relevant to the latest dify-docs version and appreciates the ongoing batch update efforts. Could you please assist with this?

@dosubot[bot] commented on GitHub (Jan 22, 2026): @RiskeyL, the user @pop9s has confirmed that the issue regarding missing Console-related API endpoints and incomplete URL splicing rules in the API Reference is still relevant to the latest dify-docs version and appreciates the ongoing batch update efforts. Could you please assist with this?
yindo commented 2026-02-16 05:19:48 -05:00
Author
Owner
Copy Link
Copy Source

@RiskeyL commented on GitHub (Feb 2, 2026):

@dosu Don't close this issue automatically. We're still working on it, thx

@RiskeyL commented on GitHub (Feb 2, 2026): @dosu Don't close this issue automatically. We're still working on it, thx
yindo commented 2026-02-16 05:19:48 -05:00
Author
Owner
Copy Link
Copy Source

@dosubot[bot] commented on GitHub (Feb 14, 2026):

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

Issue Summary:

  • You reported missing Console-related endpoints and URL splicing rules in the API documentation.
  • Maintainer RiskeyL acknowledged these legacy gaps and is working on batch updates to unify the docs.
  • The goal is to make the API Reference the single source of truth for all endpoints.
  • You confirmed the issue remains relevant and appreciated the ongoing efforts.
  • RiskeyL confirmed the work is still in progress and requested the issue not be closed automatically.

Next Steps:

  • 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, the issue will be automatically closed to keep the backlog manageable.

Thank you for your understanding and contribution!

@dosubot[bot] commented on GitHub (Feb 14, 2026): Hi, @pop9s. 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 reported missing Console-related endpoints and URL splicing rules in the API documentation. - Maintainer RiskeyL acknowledged these legacy gaps and is working on batch updates to unify the docs. - The goal is to make the API Reference the single source of truth for all endpoints. - You confirmed the issue remains relevant and appreciated the ongoing efforts. - RiskeyL confirmed the work is still in progress and requested the issue not be closed automatically. **Next Steps:** - 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, the issue will be automatically closed to keep the backlog manageable. Thank you for your understanding and contribution!
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 stale
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#292
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?