Release/1.16.0#848
Open
RiskeyL wants to merge 16 commits into
Open
Conversation
* docs: add Snippets feature guide Document the Snippets feature on the self-host tree in English, Chinese, and Japanese: creating snippets, the node and Input Variables differences from a standard workflow, the draft-and-publish model, adding a snippet to a workflow, and role-based permissions. Add the pages to docs.json. Community Edition ships first; the Cloud copy follows when Cloud reaches 1.16. * fix: correct outdated workspace role names in glossary Workspace role names are no longer localized: the member UI renders role.name directly from RBAC/backend data, and the localized name keys were removed. Replace the stale zh/ja translation table with a note to use the English role names in all languages. * docs: add descriptions to zh/ja Snippets frontmatter New pages require a description field per the formatting guide; add translated descriptions to the manually-translated Chinese and Japanese pages. * chore: regenerate termbase after glossary role-name update Re-derive termbase_i18n.md so it matches the glossary after the Workspace Roles table was replaced with a note. Drops the stale localized role-name entries.
…#843) * docs: update docker compose container list and add tool prerequisites - Add api_websocket and init_permissions to the started-container list per the current compose defaults - Remove outdated sample outputs for docker compose up and docker compose ps - Add a callout noting the clone command requires git, curl, and jq, with recovery guidance on command not found errors - Mirror all changes to zh and ja * docs: note expected exited status for init_permissions container
The Studio control (studio.viewSnippets) was relabeled from "View Snippets" to "Snippets"; update the label in the English, Chinese, and Japanese Snippets pages.
…rafts Add an explicit sentence to the Publish section: a workflow always uses the published version, never a draft. Applied to the English, Chinese, and Japanese pages.
Shorten the Swagger and Workflow tab titles ("Swagger API as Tool" ->
"Swagger API", "Workflow as Tool" -> "Workflow") in en, zh, and ja so all
three languages generate the same tab anchors. Update the inbound links in
output.mdx that pointed at the old Workflow-tab anchor (#workflow-as-tool,
#工作流作为工具, #ワークフローをツールとして利用) to #workflow.
* docs: document NEXT_PUBLIC_ENABLE_FEATURE_PREVIEW toggle * docs: document difyctl version-compatibility gate for Dify 1.16.0 * fix: correct version-gate wording and --insecure TLS behavior * docs: note --think captures separated reasoning streams * fix: address review nits (trailing ws, grammar, --insecure consistency) * fix: clarify compat cache scope, soften version-match guidance, install wording * fix: separate --insecure uses, cover both version-skew directions at login, scope cache claim * fix: align --insecure cert wording in authenticate with the flag definition * fix: frame Dify 1.15.0 as difyctl's introduction, not a compat range
* docs: correct HITL API integration flow and sync translations
- Fix the claim that the resume endpoint differs per app type (same
endpoint; only the entry endpoint differs)
- Tie workflow_run_id guidance to the human_input_required event
(chatflow message chunks don't carry it)
- Require the same user when resuming the event stream (mismatch
returns 404); add include_state_snapshot and continue_on_pause
guidance
- Note at the capture step that a null form_token means Email delivery
- Soften the upload-time validation claim to file size limits
- Split long paragraphs; align zh endpoint name with the reference page
* fix: correct API references against verified backend behavior
Audit of the Service API specs against dify hotfix/1.15.0-fix.1, with
every change code-verified and the serious items adversarially
confirmed. Applies to en/zh/ja.
- Add curl samples for GET endpoints with required query params
(Mintlify omits query params from generated snippets)
- Document 401 once in every spec's auth scheme description
- Correct wrong facts: workflow run detail returns inputs as a JSON
string; DELETE /conversations requires a JSON body; audio-to-text
accepts audio/{mp3,m4a,wav,amr,mpga} by MIME type; workflow log
created_by_account filters by email; triggered_from values are
app-run/webhook/schedule/plugin; stop endpoints' user semantics
differ per app type
- Remove unreachable docs: phantom text_replace SSE event, annotation
403, file preview endpoint in the workflow spec, invented
score_threshold bounds
- Make upload user optional (DEFAULT-USER fallback), fix upload
response example, add missing invalid_param error
- Declare text_to_speech.autoPlay in parameters responses (prose
values, no response-field enums)
* fix: complete API reference audit for knowledge and completion specs
* feat: add API spec consolidation pipeline
Phase-1 of the API docs consolidation: tooling that merges the five per-app-type Service API specs into one openapi_service.json per language, with every divergence resolved explicitly in resolutions.json and rendering-preserving namespacing for mode-scoped schema families. Includes the audit lint and parity checks (lint taught the new language-prefixed href scheme), hand-merged mode-aware SSE documentation for POST /chat-messages in en/zh/ja, and the New Agent (Beta) virtual nav group with code-verified mode notes.
* feat: consolidate API reference into one spec per language
Emit {en,zh,ja}/api-reference/openapi_service.json (82 ops, 130 components) from the audit-fixed per-app-type specs; wire docs.json to them with explicit per-app-type endpoint lists, x-mint.href URLs (/{lang}/api-reference/{tag}/{summary} with shared English slugs for in-place language switching), 265 redirects covering the legacy en and CJK URLs, per-app-type overview pages including New Agent (Beta), and rewritten legacy API links in 21 MDX bodies. The old five specs per language stay as pipeline input; they are no longer rendered.
* fix: remove dead conversation_completed error from chat specs
ConversationCompletedError is never raised anywhere at the verified 1.15.0 ref (7a4252b3de): controllers catch it, but no service code raises it, so the documented 400 conversation_completed can never fire. Remove the bullet and example from the chat and chatflow /chat-messages docs in en/zh/ja. Found and adversarially confirmed during the New Agent (PR #836) verification; filed on the upstream bug list.
* feat: add membership matrix and restructure nav config
* feat: rename resource tags and update all references
* feat: stamp per-operation availability lines
* feat: wire three-group API navigation
* feat: add app-type page coverage lint
* docs: rewrite chatflow overview as app-type API guide
* docs: polish chatflow overview zh and ja wording
* docs: rewrite workflow overview as app-type API guide
* docs: align workflow overview details across languages
* docs: expand new agent overview into app-type API guide
* docs: use task-oriented heading on new agent overview
* docs: rewrite chatbot and agent overview as app-type API guide
* docs: rewrite text generator overview as app-type API guide
* docs: match end user link text to merged spec summary
* docs: rewrite knowledge overview as app-type API guide
* docs: move knowledge api guide into api reference
* docs: localize ui labels on knowledge overview
* docs: refresh pipeline readme for restructure modes
* docs: name app-type pages in the guides sidebar
* feat: rename zh completion messages tag to match resource framing
* docs: prototype endpoints-first layout on chatflow overview
* docs: correct detail accuracy on chatflow overview
* docs: move human input flow guide into api reference
Move the shared HITL API integration walkthrough from its six per-product
copies into {en,zh,ja}/api-reference/guides/human-input-flow as the first
task guide in the API docs. Guides gains an App Types subgroup (expanded
by default) with the flow guide after it; six redirects cover the old
paths; the Human Input node docs and the chatflow overview link to the
new home.
* fix: update spec links to the moved human input guide
* fix: let spec lint accept mdx guide pages under api-reference
* docs: align chatflow zh and ja overviews to endpoints-first layout
* docs: polish chatflow zh and ja mode terms and hitl wording
* docs: align workflow overviews to endpoints-first layout
* docs: document form expiry path in human input flow guide
* docs: align new agent overviews to endpoints-first layout
* docs: align chatbot and agent overviews to endpoints-first layout
* docs: align text generator overviews to endpoints-first layout
* docs: align knowledge overviews to endpoints-first layout
* docs: correct built-in metadata examples and agent heading
* docs: flatten app-type pages directly under guides
* docs: make guide pages self-contained and trim reference detail
* docs: add get started guide and retire developing-with-apis
* docs: update new agent api behavior for latest main
New Agent behavior re-verified against dify origin/main (f3ba2846):
agent_thought events now stream through the Service API carrying the
model's reasoning steps and tool calls; a new agent_not_published 400
fires on Send Chat Message and Get App Parameters; the files claim is
softened to contents-not-processed (raw references now reach the prompt;
runtime confirmation pending). Streaming-only, message_end metadata, and
the endpoint surface are unchanged.
* docs: audit fixes for get started and human input flow guides
* docs: fix em dash spacing and ja sentence length in get started
* docs: move message_end note to the send endpoint line
* docs: update writing guides and API skill for app-type naming
- Glossary and zh/ja translation guides: Workflow and Chatflow app types stay English (Workflow 应用 / Chatflow アプリ); lowercase workflow localizes to 工作流 / ワークフロー.
- formatting-guide: API reference links use the language prefix with English slugs.
- dify-docs-api-reference skill: Spec Structure documents source specs merged into openapi_service.json by the pipeline.
* feat: add operation sidebar titles and simplify API redirects
- merge_specs stamps x-mint.metadata.sidebarTitle per operation so translated summaries show in the sidebar.
- Redirects reduced to a catch-all to the English API home plus three knowledge-base exceptions.
- memberships, strings, and SSE overrides carry app-type labels (Workflow/Chatflow English, New Agent, API Overviews group).
* docs: correct app-type naming and translations across API specs
- English mode enum labels Chatflow and Workflow apps.
- zh/ja app references use Workflow/Chatflow; New Agent is 新 Agent / 新しい Agent.
- ja knowledge tag データセット becomes ナレッジベース; zh 模型提供商 becomes 模型供应商.
- Regenerate merged openapi_service.json with per-operation sidebar titles.
* docs: add streaming, errors, and end-user identity API guides
- Consume Streaming Responses: response modes, SSE parsing, event dispatch, and reconnect.
- Handle Errors and Rate Limits: the error envelope, status classes, and retry guidance.
- End User Identity: what the user field scopes and why it stays consistent.
- English source with zh and ja translations.
* docs: reconcile API guides and apply app-type naming
- Reader-test fixes and content audit on get-started and the app-type overview pages.
- zh/ja reconciled to the English source.
- Workflow/Chatflow and New Agent naming applied in prose.
* feat: wire API nav and redirects for consolidated guides
- Rename the guides group to API Overviews and register the new guide pages.
- Redirects: catch-all to the English API home plus three product-embedded knowledge-base links to the Knowledge guide.
* fix: normalize zh model-provider term to 模型供应商
Aligns the POSITION_PROVIDER_* descriptions with the canonical glossary term.
* docs: use Info callouts for guide forward-link notes
Wrap the authentication, base URL, and `user` field forward-reference in each app-type guide (agent, chat, chatflow, completion, workflow; en/zh/ja) in an `<Info>` callout.
* refactor: remove one-time analyze mode and verification compose
- Drop the `analyze` mode (design-time spec-overlap analysis) and its helpers; the merge is stable and nothing invokes it.
- Delete `compose.swagger.yml`, the throwaway local code-vs-spec verification stack (flagged in review for inline credentials).
- README: drop the analyze entry and correct the redirect description.
* fix: correct Chatflow naming and reasoning wording in SSE overrides
- Use "Chatflow" (English) for the app type in the `/chat-messages` SSE tables instead of 对话流/チャットフロー, and fix the legacy zh chatflow "对话流工作流" description. Standalone table cells were missed by the earlier app-type rename.
- Describe `reasoning_chunk` as "reasoning content" in en/ja (matching the `reasoning` field and the zh wording) instead of "chain-of-thought".
* docs: refine API guide wording and simplify the human-input example
* docs: standardize Workflow and Chatflow app-type capitalization
Capitalize Chatflow and Workflow when they name an app type; keep "workflow" lowercase for the general engine, graph, or run sense.
* fix: use 供应商 for model provider in the zh Knowledge spec
* fix: rename the Knowledge API nav group to "Knowledge APIs"
* fix: un-deprecate Update Document by Text in the Knowledge spec
* translate: un-deprecate Update Document by Text in zh/ja specs
Mirror the en fix (6802d5e) into the zh and ja Knowledge specs, source and merged: drop the deprecated flag and the leading Deprecated notice from the update-by-text operation. It is the canonical text-update route; only Update Document by File stays deprecated.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR syncs the Dify Docs set for the 1.16.0 release by updating terminology, link schemes, and feature/API documentation across English, Chinese, and Japanese, and by adding an API-docs build/validation pipeline under tools/api-pipeline/.
Changes:
- Standardize API-reference internal links to language-prefixed paths with English slugs, and update many cross-page references accordingly.
- Add new API Guides pages (EN + translated ZH/JA) and supporting pipeline tooling/docs for spec merging, relinking, and parity/lint checks.
- Update glossary/translation guidance and various docs (Tools, WebApp settings, CLI troubleshooting, deployment/env vars) to reflect 1.16.0 behavior and UI terminology.
Reviewed changes
Copilot reviewed 178 out of 184 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| zh/self-host/use-dify/workspace/tools.mdx | Update tool tabs and expand MCP advanced options (custom headers placeholders, timeouts). |
| zh/self-host/use-dify/publish/webapp/web-app-settings.mdx | Document new WebApp “输入框提示语” setting. |
| zh/self-host/use-dify/publish/README.mdx | Point “API 集成” card to new API Get Started guide. |
| zh/self-host/use-dify/nodes/output.mdx | Update anchor link for “Workflow as Tool” section. |
| zh/self-host/use-dify/nodes/llm.mdx | Update API reference links to new language-prefixed scheme. |
| zh/self-host/use-dify/nodes/human-input.mdx | Point Human Input API flow link to API guide. |
| zh/self-host/use-dify/nodes/doc-extractor.mdx | Simplify PDF extractor description. |
| zh/self-host/use-dify/knowledge/manage-knowledge/maintain-dataset-via-api.mdx | Remove legacy “maintain dataset via API” page. |
| zh/self-host/use-dify/build/snippet.mdx | Add translated Snippets page. |
| zh/self-host/deploy/quick-start/docker-compose.mdx | Clarify prerequisites and container list (api_websocket, init_permissions). |
| zh/home.mdx | Update API reference card link to new API URL. |
| zh/cloud/use-dify/workspace/tools.mdx | Rename tool tabs (Swagger API, Workflow). |
| zh/cloud/use-dify/publish/README.mdx | Point “API 集成” card to new API Get Started guide. |
| zh/cloud/use-dify/nodes/output.mdx | Update anchor link for “Workflow as Tool” section. |
| zh/cloud/use-dify/nodes/llm.mdx | Update API reference links to new language-prefixed scheme. |
| zh/cloud/use-dify/nodes/human-input.mdx | Point Human Input API flow link to API guide. |
| zh/cloud/use-dify/knowledge/manage-knowledge/maintain-dataset-via-api.mdx | Remove legacy “maintain dataset via API” page. |
| zh/cli/troubleshooting.mdx | Add version_skew troubleshooting section. |
| zh/cli/reference/output-formats-and-exit-codes.mdx | Expand exit code 6 semantics to include version_skew. |
| zh/cli/reference/auth-and-contexts.mdx | Clarify --insecure behavior and exit code 6 cases. |
| zh/cli/reference/apps.mdx | Update --think flag description (inline + separated reasoning). |
| zh/cli/install.mdx | Clarify difyctl release/version matching guidance. |
| zh/cli/authenticate.mdx | Clarify host rejection and --insecure guidance. |
| zh/api-reference/guides/workflow.mdx | Add translated Workflow API overview guide. |
| zh/api-reference/guides/get-started.mdx | Add translated API Get Started guide. |
| zh/api-reference/guides/errors.mdx | Add translated Errors & Rate Limits guide. |
| zh/api-reference/guides/end-user-identity.mdx | Add translated End User Identity guide. |
| zh/api-reference/guides/completion.mdx | Add translated Completion API overview guide. |
| zh/api-reference/guides/chat.mdx | Add translated Chat (Chatbot/Agent) API overview guide. |
| zh/api-reference/guides/agent.mdx | Add translated New Agent API overview guide. |
| writing-guides/glossary.md | Update app-type terminology (Workflow/Chatflow stay English in zh/ja) and role-name guidance; add WebApp setting term. |
| writing-guides/formatting-guide.md | Update rule: API reference links use language prefix + English slugs. |
| tools/translate/termbase_i18n.md | Add/adjust translation termbase entries (needs alignment with updated glossary). |
| tools/translate/formatting-zh.md | Add explicit rule for Workflow/Chatflow app-type naming in zh. |
| tools/translate/formatting-ja.md | Add explicit rule for Workflow/Chatflow app-type naming in ja. |
| tools/api-pipeline/swagger_diff.py | Add code-vs-spec swagger diff helper script. |
| tools/api-pipeline/README.md | Document API pipeline layout, usage, and URL scheme. |
| tools/api-pipeline/parity_check.py | Add cross-language OpenAPI parity checker. |
| tools/api-pipeline/overrides/chat-messages-sse.zh.md | Add zh SSE override content for chat-messages. |
| tools/api-pipeline/overrides/chat-messages-sse.en.md | Add en SSE override content for chat-messages. |
| tools/api-pipeline/nav_labels.json | Add guides ordering, labels, and op ordering configuration. |
| tools/api-pipeline/coverage_matrix.py | Add code/spec coverage inventory script. |
| ja/self-host/use-dify/workspace/tools.mdx | Mirror tools tab rename + MCP advanced options expansion in ja. |
| ja/self-host/use-dify/publish/webapp/web-app-settings.mdx | Document new input placeholder setting in ja. |
| ja/self-host/use-dify/publish/README.mdx | Point “API 統合” card to new API Get Started guide. |
| ja/self-host/use-dify/nodes/output.mdx | Update anchor link for “Workflow as Tool” section. |
| ja/self-host/use-dify/nodes/llm.mdx | Update API reference links to new language-prefixed scheme. |
| ja/self-host/use-dify/nodes/human-input.mdx | Point Human Input API flow link to API guide. |
| ja/self-host/use-dify/nodes/doc-extractor.mdx | Simplify PDF extractor description. |
| ja/self-host/use-dify/knowledge/manage-knowledge/maintain-dataset-via-api.mdx | Remove legacy “maintain dataset via API” page. |
| ja/self-host/use-dify/build/snippet.mdx | Add translated Snippets page in ja. |
| ja/self-host/deploy/quick-start/docker-compose.mdx | Clarify prerequisites and container list changes in ja. |
| ja/self-host/deploy/configuration/environments.mdx | Document api_websocket tuning and feature preview flag in ja env vars. |
| ja/home.mdx | Update API reference card link to new API URL. |
| ja/cloud/use-dify/workspace/tools.mdx | Rename tool tabs (Swagger API, Workflow) in ja cloud docs. |
| ja/cloud/use-dify/publish/README.mdx | Point “API 統合” card to new API Get Started guide. |
| ja/cloud/use-dify/nodes/output.mdx | Update anchor link for “Workflow as Tool” section. |
| ja/cloud/use-dify/nodes/llm.mdx | Update API reference links to new language-prefixed scheme. |
| ja/cloud/use-dify/nodes/human-input.mdx | Point Human Input API flow link to API guide. |
| ja/cloud/use-dify/knowledge/manage-knowledge/maintain-dataset-via-api.mdx | Remove legacy “maintain dataset via API” page. |
| ja/cli/troubleshooting.mdx | Add version_skew troubleshooting section in ja. |
| ja/cli/reference/output-formats-and-exit-codes.mdx | Expand exit code 6 semantics to include version_skew in ja. |
| ja/cli/reference/auth-and-contexts.mdx | Clarify --insecure behavior and exit code 6 cases in ja. |
| ja/cli/reference/apps.mdx | Update --think flag description in ja. |
| ja/cli/install.mdx | Clarify difyctl release/version matching guidance in ja. |
| ja/cli/authenticate.mdx | Clarify host rejection and --insecure guidance in ja. |
| ja/api-reference/guides/get-started.mdx | Add translated API Get Started guide in ja. |
| ja/api-reference/guides/errors.mdx | Add translated Errors & Rate Limits guide in ja. |
| ja/api-reference/guides/end-user-identity.mdx | Add translated End User Identity guide in ja. |
| ja/api-reference/guides/completion.mdx | Add translated Completion API overview guide in ja. |
| ja/api-reference/guides/agent.mdx | Add translated New Agent API overview guide in ja. |
| en/self-host/use-dify/workspace/tools.mdx | Rename tool tabs and expand MCP advanced options (custom headers placeholders, timeouts). |
| en/self-host/use-dify/publish/webapp/workflow-webapp.mdx | Update terminology to “Workflow apps” where it refers to the app type. |
| en/self-host/use-dify/publish/webapp/web-app-settings.mdx | Document new “Input Placeholder” setting. |
| en/self-host/use-dify/publish/webapp/chatflow-webapp.mdx | Update terminology to “Chatflow” app type capitalization. |
| en/self-host/use-dify/publish/README.mdx | Point “API Integration” card to new API Get Started guide. |
| en/self-host/use-dify/publish/developing-with-apis.mdx | Remove legacy API integration page. |
| en/self-host/use-dify/nodes/variable-assigner.mdx | Update terminology to “Chatflow applications”. |
| en/self-host/use-dify/nodes/user-input.mdx | Update terminology to “Workflow and Chatflow applications”. |
| en/self-host/use-dify/nodes/trigger/webhook-trigger.mdx | Update terminology to “Workflow applications”. |
| en/self-host/use-dify/nodes/trigger/schedule-trigger.mdx | Update terminology to “Workflow applications”. |
| en/self-host/use-dify/nodes/trigger/plugin-trigger.mdx | Update terminology to “Workflow applications”. |
| en/self-host/use-dify/nodes/trigger/overview.mdx | Update terminology to “Workflow applications”. |
| en/self-host/use-dify/nodes/output.mdx | Update tools page anchor link. |
| en/self-host/use-dify/nodes/llm.mdx | Update API reference links + Chatflow terminology. |
| en/self-host/use-dify/nodes/human-input.mdx | Point Human Input API flow link to API guide. |
| en/self-host/use-dify/nodes/hitl-api-integration-flow.mdx | Remove legacy Human Input API flow page. |
| en/self-host/use-dify/nodes/doc-extractor.mdx | Simplify PDF extractor description. |
| en/self-host/use-dify/nodes/answer.mdx | Update terminology to “Chatflow applications”. |
| en/self-host/use-dify/monitor/integrations/integrate-langfuse.mdx | Capitalization/terminology update for Workflow/Chatflow. |
| en/self-host/use-dify/knowledge/manage-knowledge/maintain-dataset-via-api.mdx | Remove legacy “maintain dataset via API” page. |
| en/self-host/use-dify/build/snippet.mdx | Add new Snippets feature page. |
| en/self-host/deploy/quick-start/docker-compose.mdx | Clarify prerequisites and container list (api_websocket, init_permissions). |
| en/self-host/deploy/configuration/environments.mdx | Document api_websocket tuning and feature preview flag. |
| en/learn/tutorials/twitter-chatflow.mdx | Update tutorial wording/capitalization for Chatflow. |
| en/home.mdx | Update API reference card link to new API URL. |
| en/develop-plugin/features-and-specs/plugin-types/tool.mdx | Update app-type terminology references. |
| en/develop-plugin/dev-guides-and-walkthroughs/develop-a-slack-bot-plugin.mdx | Update scope description to “Chatflow” capitalization. |
| en/cloud/use-dify/workspace/tools.mdx | Rename tool tabs (Swagger API, Workflow). |
| en/cloud/use-dify/publish/webapp/workflow-webapp.mdx | Update terminology to “Workflow apps” where it refers to the app type. |
| en/cloud/use-dify/publish/webapp/chatflow-webapp.mdx | Update terminology to “Chatflow” app type capitalization. |
| en/cloud/use-dify/publish/README.mdx | Point “API Integration” card to new API Get Started guide. |
| en/cloud/use-dify/publish/developing-with-apis.mdx | Remove legacy API integration page. |
| en/cloud/use-dify/nodes/variable-assigner.mdx | Update terminology to “Chatflow applications”. |
| en/cloud/use-dify/nodes/user-input.mdx | Update terminology to “Workflow and Chatflow applications”. |
| en/cloud/use-dify/nodes/trigger/webhook-trigger.mdx | Update terminology to “Workflow applications”. |
| en/cloud/use-dify/nodes/trigger/schedule-trigger.mdx | Update terminology to “Workflow applications”. |
| en/cloud/use-dify/nodes/trigger/schedule-trigger.mdx | Update terminology to “Workflow applications”. |
| en/cloud/use-dify/nodes/trigger/plugin-trigger.mdx | Update terminology to “Workflow applications”. |
| en/cloud/use-dify/nodes/trigger/overview.mdx | Update terminology to “Workflow applications”. |
| en/cloud/use-dify/nodes/output.mdx | Update tools page anchor link. |
| en/cloud/use-dify/nodes/llm.mdx | Update API reference links + Chatflow terminology. |
| en/cloud/use-dify/nodes/human-input.mdx | Point Human Input API flow link to API guide. |
| en/cloud/use-dify/nodes/hitl-api-integration-flow.mdx | Remove legacy Human Input API flow page. |
| en/cloud/use-dify/nodes/answer.mdx | Update terminology to “Chatflow applications”. |
| en/cloud/use-dify/monitor/integrations/integrate-langfuse.mdx | Capitalization/terminology update for Workflow/Chatflow. |
| en/cloud/use-dify/knowledge/manage-knowledge/maintain-dataset-via-api.mdx | Remove legacy “maintain dataset via API” page. |
| en/cli/troubleshooting.mdx | Add version_skew troubleshooting and update Workflow wording in an error section. |
| en/cli/reference/output-formats-and-exit-codes.mdx | Expand exit code 6 semantics to include version_skew. |
| en/cli/reference/auth-and-contexts.mdx | Clarify --insecure behavior and exit code 6 cases. |
| en/cli/reference/apps.mdx | Update --think flag description (inline + separated reasoning). |
| en/cli/install.mdx | Clarify difyctl release/version matching guidance. |
| en/cli/authenticate.mdx | Clarify host rejection and --insecure guidance. |
| en/api-reference/guides/workflow.mdx | Add Workflow App API overview guide. |
| en/api-reference/guides/streaming.mdx | Add SSE streaming consumption guide. |
| en/api-reference/guides/get-started.mdx | Add API Get Started guide. |
| en/api-reference/guides/errors.mdx | Add Errors & Rate Limits guide. |
| en/api-reference/guides/end-user-identity.mdx | Add End User Identity guide. |
| en/api-reference/guides/completion.mdx | Add Completion App API overview guide. |
| en/api-reference/guides/chatflow.mdx | Add Chatflow App API overview guide. |
| en/api-reference/guides/chat.mdx | Add Chat App API overview guide. |
| en/api-reference/guides/agent.mdx | Add New Agent API overview guide. |
| .claude/skills/dify-docs-env-vars/ignored-vars.md | Adjust env-var ignore list to reflect new documentation scope. |
| .claude/skills/dify-docs-env-vars/deep-dive.md | Add traced 1.16 env-var deep dives (api_websocket workers, feature preview flag). |
| .claude/skills/dify-docs-api-reference/SKILL.md | Update API-reference skill guidance to reflect pipeline/source-spec workflow. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
9
to
11
| | Workflow | 工作流 | ワークフロー | | ||
| | Chatflow | 对话流 | チャットフロー | | ||
| | workflow | 工作流 | ワークフロー | |
| | Delete snippets | Owner, Admin | | ||
| | Add a published snippet to a workflow | Anyone who can edit the target workflow | | ||
|
|
||
| Normal members don't see the snippet list. |
| Send additional HTTP headers with every request to the server. Commonly used for servers that authenticate with a static token or API key (e.g., `Authorization: Bearer <token>`) rather than OAuth, but applicable whenever the server expects custom headers. | ||
|
|
||
| **Timeouts**: Control how long Dify waits on the server. Raise the request timeout when the server is slow to respond, and the SSE read timeout for long-running, streamed results. Change them only if you hit timeout errors. | ||
| Header values can also be dynamic: `{{request.headers.X-Custom-Auth}}` is replaced at call time with the `X-Custom-Auth` header of the HTTP request that triggered the run (a Service API call, for example), letting you pass each caller's credentials through to the server. |
| | Builder | 构建器 | ビルダー | common.members.builder | REVIEW: ZH "构建器" seems unusual for a role name | | ||
| | Knowledge Admin | 知识库管理员 | ナレッジ管理員 | common.members.datasetOperator | Formerly "Dataset Operator" in code | | ||
| | Normal | 成员 | 通常 | common.members.normal | REVIEW: ZH uses "成员" (member); verify intended translation | | ||
| Role **names are not localized**. The member UI renders `role.name` raw from RBAC/backend data (`web/app/components/header/account-setting/members-page/member-row.tsx`); the `common.members.<role>` name keys were removed, leaving only the `common.members.<role>Tip` descriptions. Built-in roles display as English identifiers in every language, and custom RBAC roles show their own names. **In docs, use the English role names in all languages** (zh/ja included) to match the UI. |
Comment on lines
+31
to
32
| <Tab title="Workflow"> | ||
| 将任意以用户输入节点开始的工作流转化为工具,从而在多个应用间共享多步逻辑。对话流无法用作工具。 |
Comment on lines
+31
to
32
| <Tab title="Workflow"> | ||
| 将任意以用户输入节点开始的工作流转化为工具,从而在多个应用间共享多步逻辑。对话流无法用作工具。 |
Comment on lines
+31
to
32
| <Tab title="Workflow"> | ||
| ユーザー入力ノードで始まるワークフローをツールに変換し、マルチステップのロジックを複数のアプリで共有できます。チャットフローはツールとして使用できません。 |
Comment on lines
+31
to
32
| <Tab title="Workflow"> | ||
| ユーザー入力ノードで始まるワークフローをツールに変換し、マルチステップのロジックを複数のアプリで共有できます。チャットフローはツールとして使用できません。 |
Comment on lines
9
to
+13
| | Workflow | 工作流 | ワークフロー | | ||
| | Chatflow | 对话流 | チャットフロー | | ||
| | workflow | 工作流 | ワークフロー | | ||
| | Agent | Agent | Agent | | ||
| | Agent app | Agent 应用 | Agent アプリ | |
| Send additional HTTP headers with every request to the server. Commonly used for servers that authenticate with a static token or API key (e.g., `Authorization: Bearer <token>`) rather than OAuth, but applicable whenever the server expects custom headers. | ||
|
|
||
| **Timeouts**: Control how long Dify waits on the server. Raise the request timeout when the server is slow to respond, and the SSE read timeout for long-running, streamed results. Change them only if you hit timeout errors. | ||
| Header values can also be dynamic: `{{request.headers.X-Custom-Auth}}` is replaced at call time with the `X-Custom-Auth` header of the HTTP request that triggered the run (a Service API call, for example), letting you pass each caller's credentials through to the server. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.