mirror of
https://github.com/langgenius/dify-docs.git
synced 2026-07-22 04:15:24 -04:00
fix/workflow-version-403
26 Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
 RiskeyL
|
ccebcfd721 |
docs: document the workflow-version 403 for Sandbox plans
Dify 1.16.0 gates running a specific published workflow version behind paid plans on Cloud (dify#38662 for Workflow apps, dify#38892 for Chatflow workflow_id pinning). Adds the 403 with its trigger and verbatim wire message to Run Workflow by ID and Send Chat Message, a plan note on the workflow_id request field, and the plan-gate Note on the Cloud version-control guide. |
||
|
Riskey
|
a1e7a7dcb3 |
feat: finish API reference Phase 1: code audit and readability overhaul (#857) (#858)
* feat: retire the merge pipeline and delete the legacy source specs
openapi_service.json is now the spec of record per language, edited directly. The build/relink modes, resolutions.json, and overrides/ that consolidated the five per-app-type specs are recoverable from git history when Phase 2 rebuilds the spec from the upstream-generated source.
* fix: make parity_check exit nonzero on failures
* docs: document the direct-edit spec workflow in skills and translation guides
* fix: correct the Service API reference against the code-verified audit
Applies the confirmed findings of a full per-operation audit against dify 3c8e0e2113 / graphon 0.6.0: 9 factual errors (availability lines, phantom fields, wrong enum values, inert parameters, wrong error messages), ~33 omitted-error and example-accuracy gaps, the rate_limit_error recharacterization, provider-identifier format documentation, and New Agent availability on the endpoints its Chat Features support (verified end-to-end in code).
* docs: document New Agent's full endpoint surface in the API guides
* translate: propagate the Service API audit fixes to zh and ja
* docs: rewrite Upload File as the readability pilot
Worked example of the API readability standard: contract-first description, facts on the fields (category size limits with env-var link, blacklist rule), real error triggers (415 corrected to its actual cause), template user sentence, source links on sourceable values, and a hand-written multipart cURL sample. Applied to en/zh/ja.
* docs: update spec-conventions for the live link scheme and code samples
* docs: apply the readability standard across the Service API reference
Rewrites all 82 operations to the agreed standard in en/zh/ja: contract-first descriptions, facts on the fields, trigger-led error bullets, template sentences (user, pagination, provider identifiers), source links on sourceable values, guide links instead of inline concept re-explanations, cURL samples where the playground autogen fails (multipart, SSE), a paragraph ceiling everywhere, and restructured streaming narratives (events-by-app-type map; details stay in the event tables). Also folds in two fact corrections surfaced during review: the legacy securitySchemes text and the stale Cloudflare-timeout claim in response_mode, now using the hedged edge-proxy wording.
* docs: codify the readability standard and audit method in the API skill
* fix: apply the audit-verified corrections deferred from the readability pass
Small factual items evidenced in the audit findings that the readability pass could not touch under its fact-freeze: real wire messages (audio 413, type_mismatch number, dynamic run-by-id 404, werkzeug 500/403 strings, annotation 404 punctuation), schema precision (format: uuid, minimum: 1, six missing Get Available Models response fields), and behavioral completeness (document download/zip/delete 404 message variants, tag_ids silent-ignore note, request-scoped batch-metadata lock wording, reasoning_chunk message_id: null, form default key absent not null). Applied to en/zh/ja; parity 0.
* fix: make spec checkers target openapi_service.json explicitly
After the legacy specs were deleted, the openapi_*.json globs in parity_check and lint_specs would silently pass (match nothing, report 0 issues, exit 0) if the spec of record went missing, and would pick up unintended future openapi_*.json files. Both now name openapi_service.json per language and exit 1 when it is absent.
* fix: address Copilot review on pipeline tooling and example titles
Normalizes example summary separators to the dominant "Request Example - Mode" form (the convention doc had drifted, and 4 em-dash outliers existed per language); lint_specs no longer re-reads the spec it already loaded; all spec reads use explicit UTF-8; coverage_matrix and swagger_diff target openapi_service.json explicitly; README and docstring usage resolve DOCS from the git root so the commands work from any directory.
* fix: use context managers for all pipeline file reads
Copilot flagged unclosed handles in the three checkers; applied consistently across all five pipeline scripts (merge_specs and coverage_matrix had the same pattern unflagged).
* fix: report missing spec ops as coverage failures instead of crashing
* fix: print the full relative path in the parity missing-file message
(cherry picked from commit
|
||
|
Riskey
|
6258bbfb0f |
fix: hedge the Dify Cloud edge-proxy timeout claim in the streaming guide (#851) (#852)
(cherry picked from commit
|
||
|
RiskeyL
|
31cf2ff1ab |
fix: document both New Agent reply events in the streaming contract
The New Agent guide said replies stream as agent_message; the Send Chat Message SSE reference and the streaming guide said message. Verified against dify feat/agent-v2 (agent_app/app_runner.py and its unit tests): both fire — the reply streams incrementally as agent_message deltas, then the turn closes with a single message event carrying the complete answer, then message_end, with agent_thought alongside throughout. Document the full sequence on all three surfaces and tell clients to treat the closing message as the final answer rather than appending it. en/zh/ja; merged specs regenerated via the API pipeline (build + wire, coverage clean). |
||
|
RiskeyL
|
1620d71243 |
docs: use Tip for New Agent availability callouts and tidy API guides
Switch the New Agent availability callouts (overview, build, node) from Note/Info to Tip; the node callout gains the on-by-default sentence. Tighten the API guide beta Info and restructure the get-started API-key section into bullets. zh/ja synced to the en edits. |
||
|
RiskeyL
|
ce3307aa7b |
fix: correct New Agent API guide against the current runtime
Verified against feat/agent-v2: the reply streams as agent_message events (not message), list-message agent_thoughts carries the turn's reasoning steps (not empty), uploaded files are surfaced to the agent as downloadable references (not ignored), and /meta tool_icons is empty for New Agent apps. Adds the 1.16.0-rc1 availability pointer to the beta note. en/zh/ja. |
||
|
RiskeyL
|
df2ae852c3 | translate: sync API-guide copy-edits to zh/ja | ||
|
Riskey
|
32e1b169da |
feat: consolidate and restructure the API reference (Phase 1) (#846)
* 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 (
|
||
|
Riskey
|
2f88f0f7d2 |
docs: sync Cloud documentation for Dify 1.15.0 (#835)
* docs: add Human Input file inputs and Service API to Cloud docs Port the Phase 2 Human Input docs (file inputs and the Service API integration flow) to the Cloud docs, mirroring the self-host pages. - human-input.mdx (en/zh/ja): add the Single File / File List field type and the file-handling notes; the upload-limit callout states Cloud's fixed limits (documents 15 MB, images 10 MB, audio 50 MB, video 100 MB, up to 10 files) instead of self-host env vars. - hitl-api-integration-flow.mdx (en/zh/ja): new; identical to self-host since the Service API is the same. - docs.json: nest the integration-flow under the Human Input group in all three navs. - zh/ja reuse the self-host translations; only the callout and the /self-host/ links changed. * docs: rewrite Cloud model providers around AI Credits * docs: rewrite Cloud subscription management for 1.15.0 * docs: update Cloud code node limits and XLSX image extraction note * docs: rewrite Cloud team members management for 1.15.0 * docs: apply the 1.15.0 Integrations redesign to Cloud docs * docs: fix workflow API reference for run-level logs and streaming * docs: sync self-host use-dify pages and fix translation debt * docs: align shared tutorials and quick start with 1.15.0 * docs: refine difyctl install examples and workspace reference * docs: rewrite hotkeys page to match current shortcuts * fix: correct broken anchor links for badged headings and tabs * fix: correct env link and Human Input resume identifier * feat: handle heading badges in link-checker slugs * fix: repoint publish-mcp cross-links to the merged MCP section * docs: rename plugin dev CLI to Dify Plugin CLI * docs: refine CLI reference readability and expand --agent * feat: stop format checkers flagging indented list-item content * fix: correct zh/ja custom-endpoint spacing and a list blank line * docs: clarify Cloud model provider install and AI Credits coverage |
||
|
Riskey
|
7694a26233 |
docs: document Human Input file inputs and Service API for self-host (#826)
* docs: document Human Input file inputs and API flow for self-host
Cover the Human Input node's file-handling additions in the self-host tree: the Single File and File List field types, how file values render as `[file]` / `[N files]` placeholders in `__rendered_content`, and referencing an upstream file variable in Form Content.
Add an API Integration Flow page for the Service API sequence (run, get form, upload via Upload File, submit, resume listening), register it in the self-host nav, add the Single File and File List glossary entries, and refresh the example images.
Verified against dify 1.15.0 and graphon 0.5.3. Self-host only; the Cloud tree is updated separately.
* docs: align Human Input API with HITL-2 form inputs
Update the Human Input endpoints in the workflow and chatflow Service API specs to dify 1.15.0. Document file-mapping submit inputs, where a `file` or `file-list` value is `{transfer_method: local_file, upload_file_id}` (the id from Upload File) or `{transfer_method: remote_url, url}`, and replace the stale `text_input` type with the real `paragraph`, `select`, `file`, and `file-list` values in both the get-form response and the streaming `human_input_required` event.
Make `expiration_time` nullable, drop the unenforced `action` length and pattern constraints, and align the zh delivery-method term with the product UI (提交方式).
* docs: clarify WORKFLOW_FILE_UPLOAD_LIMIT as a per-field cap
The old description read it as the maximum files per workflow execution. It actually bounds the max-files setting on a single file-upload field, such as a User Input or Human Input File List; the node panel's slider is capped at this value. Reword across en, zh, and ja.
* feat: add code-audit step to api-reference skill
Require an independent subagent audit against the codebase after writing or substantially changing endpoints. The brief pins the dify tag and the pinned graphon version, loads the skill references, and calls out the Service-API-vs-web/console controller distinction so the auditor verifies against the blueprint whose base URL matches the spec's servers.
* docs: document file submission details for Human Input API
Following the in-product docs PR (langgenius/dify#37981) and verified against dify 1.15.0 and graphon 0.5.3: a submitted file object carries a `type` from the field's `allowed_file_types`; a `local_file` upload must use the same `user` as the submit, since uploaded files are scoped to that user; and the get-form and submit examples now cover all four input shapes (paragraph, select, file, file-list).
* feat: harden api-reference audit with data-path and example checks
Add two guards to the post-writing code audit: trace opaque request fields to their resolver for ownership and cross-request rules, and diff the spec against the in-product API templates when the endpoint exists there. Add a mechanical example-and-schema consistency pass that checks example keys against schema fields and that every enum and `oneOf` branch is exercised.
* docs: address PR review feedback on Human Input docs
* docs: clarify Human Input API integration flow
Apply reader-test findings and a code-verified correction to the integration flow page and the workflow/chatflow specs.
- Spell out the submit lifecycle: a successful submit is one-shot (closes the form, resumes the run), a rejected one leaves the form open to retry, and the `action` must be one of the form's actions.
- Note the form's `expiration_time` and that the resumed run streams through to completion.
- Make the remote-file mapping concrete (`{transfer_method: remote_url, url}`).
- Soften the file-upload `user` rule to a consistent-`user` recommendation across the run, upload, and submit (verified: the submit `user` is not matched against the run), in the page and both specs.
- Mirror every change into zh and ja.
* fix: correct field name in zh/ja invalid_form_data examples
The zh/ja error examples still referenced `comment`; the earlier fix only caught the English message. Match the `feedback` request example.
|
||
|
RiskeyL
|
129870e924 |
translate: sync reasoning docs to zh and ja
Translate the LLM node reasoning section and the reasoning_chunk API additions for zh and ja. Also corrects pre-existing broken hyphenated api-reference cross-links in the zh workflow spec. |
||
|
RiskeyL
|
e5e1d4da67 |
docs: adopt upstream main PRs into audience-products structure
Bring in changes merged to main since the branch point: API reference and plugin development updates, the plugin sidebar reorganization with a new choose-plugin-type page, backport tooling, workflow node content updates, and refreshed skill, glossary, and translation config files. Content updates are applied to both Cloud and Self-Host copies and to zh and ja. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> |
||
|
RiskeyL
|
40737579af | chore: restore docs.json navigation | ||
|
RiskeyL
|
cf8ae4cde6 |
feat: restructure docs into cloud and self-hosted products
Phase 1 of the audience-products restructure. Establishes two-product navigation using Mintlify's products primitive, with content moved into per-product paths so each product has its own URL space.
IA composition: languages > products > tabs > {groups | dropdowns | menu | pages}
Cloud product (3 tabs):
- Use Dify
- Developers (menu: API Reference, CLI)
- Plugin
Self-Hosted product (4 tabs):
- Use Dify (dropdowns: User Guide, Admin Guide [EE placeholder])
- Deploy (dropdowns: Community, Enterprise [EE placeholder])
- Developers (menu: API Reference with User API / Admin API dropdowns, CLI)
- Plugin
Filesystem reorganization (en/zh/ja parallel):
- use-dify, develop-plugin, api-reference moved into cloud/, copied into self-hosted/
- self-host moved into self-hosted/deploy/ce
- 9 misfit pages deleted per audit (subscription-management and knowledge-request-rate-limit removed from Self-Hosted; web-app-access removed from Cloud)
- Placeholder MDX for Admin Guide, EE Deploy, Admin API, CLI
Configuration:
- Theme: maple to luma
- Logo href: https://dify.ai
- Navbar: Blog link + Get Started primary button
References:
- Audit: audit/page-audience-classification.md
- Design: ~/Documents/Work/Drafts/2026-04-30-dify-docs-audience-products-design.md
- Progress: ~/Documents/Work/Drafts/2026-05-14-dify-docs-audience-products-progress.md
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
||
|
Riskey
|
66523cf52b |
docs: 1.14 release follow-up fixes (#766)
* docs: 1.14 fixes for HITL events and Creator Center env vars (#764) * docs: reorganize chatflow API tags and surface workflow_run_id * refactor: update internal tooling for dify-graphon repo split * fix: surface workflow_run_id in HITL stream events * chore: tighten env-vars skill source-of-truth rule * docs: document Creator Center env vars * fix: use language-prefixed paths for non-api-reference links * fix: drop redundant workflow_run_id from workflow HITL events * fix: drop format uuid from chatflow HITL workflow_run_id * docs: small fixes for self-host, workspace, and CJK disclaimers (#765) * docs: shorten docker-compose section headings * docs: update Team plan limit and remove Dataset Operator role * fix: correct Japanese translation errors in workspace docs * style: align AI translation disclaimers with CJK spacing rules * style: add missing space between disclaimer link and particle in ja docs * fix: point zh general-specifications disclaimer to en source * fix: drop format uuid from chatflow workflow paused event |
||
|
Riskey
|
dd89e17178 |
docs: 1.14 release documentation (#763)
* docs: sync App Toolkit with dify#35442 follow-up settings (#757) * docs: sync App Toolkit page with follow-up settings PR and UI labels * fix: correct CJK format linter false positives * chore: broaden post-writing audit scope to whole documents * docs: address Copilot review on PR #754 Restore the Tab titles rule in formatting-zh.md, which had been trimmed to a stub. Drop the First-Mention Rule entry from the terminology-check skill's Output Format so the report sections match the Checks to Perform sections (the corresponding check was removed earlier). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs: document workflow collaboration feature (#758) * docs: add workflow collaboration user guide * docs: tighten style and formatting guides * docs: avoid "please" in zh refer-to phrases * fix: add CJK-Latin spacing in translation notice templates * docs: add env var coordination to dify-docs-guides skill * docs: document collaboration environment variables * style: trim collaboration env var descriptions for consistency * docs: add zoom menu tip for hiding comments and cursors * docs: sync collaboration UI labels after upstream localization * docs: rewrite orchestration logic for cross-workflow node copy-paste (#759) * docs: rewrite orchestration logic and extend workflow-chatflow overview * translate: update zh and ja for orchestration logic and overview * docs: refine orchestration logic node reuse section * docs: clarify MAX_TREE_DEPTH env var description * fix: align zh title and body references with the glossary UI label * fix: align EN node reuse text with zh/ja translations (User Input exception) Agent-Logs-Url: https://github.com/langgenius/dify-docs/sessions/00e54676-8a43-4b6f-99f8-fef2495b054f Co-authored-by: RiskeyL <36894937+RiskeyL@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> * docs: note HTTPS requirement for cross-workflow node paste (#761) * docs: HITL Service API polish and 1.14 release follow-ups (#760) * feat: add env var ignore-list consumed by the verifier * docs: add 1.14 env vars and correct drifted defaults * fix: correct knowledge pipeline datasource-plugins response in api references * chore: record 1.14 env var traces in deep-dive * docs: update HITL Service API documentation * docs: clarify /api-reference/ link convention in formatting guide * docs: update marketplace publish flow * fix: drop duplicate workflow_run_id from HITL event data schemas The three HITL event schemas (StreamEventHumanInputRequired, StreamEventHumanInputFormFilled, StreamEventHumanInputFormTimeout) declared `workflow_run_id` inside `data.properties`, but `HumanInputRequiredResponse` in `api/core/app/entities/task_entities.py` defines `workflow_run_id` only as a top-level field on the response (alongside `event` and `task_id`); its inner `Data` class doesn't carry one. The OpenAPI spec already provides top-level `workflow_run_id` via the `$ref: StreamEventBase` in the `allOf` composition, so the inline duplicate was a phantom field that doesn't exist in the actual payload. Remove the inline `workflow_run_id` from `data.properties` in all three HITL event schemas across all six spec files. This relies on `StreamEventBase` to provide `workflow_run_id` at the top level via composition, matching how every other event schema in this spec handles it (e.g., `StreamEventWorkflowStarted`). Reported by Copilot on PR #756. * fix: address Copilot's review comments * feat: skip api-reference paths in internal link checker The /api-reference/... URL convention (no language prefix, derived from OpenAPI tag/summary) generates pages that Mintlify auto-builds rather than from filesystem MDX files, so the existing filesystem resolution logic flags every such link as broken. Skip both filesystem-existence and anchor validation for any URL containing /api-reference/, mirroring the existing anchor_check_skipped behaviour. The convention is documented in writing-guides/formatting-guide.md. Caveat: typos in tag or summary slugs will now pass silently. A follow-up could parse the OpenAPI specs to validate against the real tag/summary kebab pairs if hand-written api-reference links become common enough to warrant it. * fix: correct CORS anchor in ja environments page Inline link [CORS設定](#cors 設定) used a literal space, but the heading "CORS 設定" slugifies to "cors-設定" (whitespace replaced with hyphen). Update the anchor to #cors-設定. * fix: align datasource-plugins is_published and 200 description with node framing * fix: clarify chatflow stream workflow events task_id origin * docs: address HITL Service API reader-test feedback --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> |
||
|
Riskey
|
83fc9593fa |
docs: document datasource_info_list schemas and improve Run Pipeline API (#741)
* docs: document datasource_info_list per-type schemas for Run Pipeline API * docs: improve Run Pipeline parameter descriptions and SSE event documentation * translate: sync zh/ja pipeline API specs with English schema updates * fix: address Copilot's PR review feedback on pipeline API docs * style: add punctuation spacing and API cross-link rules to translation guides |
||
|
Riskey
|
5c1c3a4cc9 |
docs: sync documentation for Dify v1.13.0–v1.13.3 changes (#722)
* feat: optimize the docs-release-sync skill * docs: add doc_form validation to knowledge API spec * docs: update AI Credits/Default Model Settings terminology |
||
|
Riskey
|
21122c4282 |
Batch update apis (#715)
* Batch update service apis * final check and add zh/ja docs * add temporary redirects for changed api links embedded in the product * Restore original operationIds to preserve SDK compatibility Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * complete the missing descriptions * correct the human input terminology --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> |
||
|
盐粒 Yanli
|
b7f1aab7b4 |
docs(api): add end-user lookup (#684)
* docs(api): add end-user lookup * update zh and ja docs --------- Co-authored-by: RiskeyL <7a8y@163.com> |
||
|
FFXN
|
df83a9a07c |
feat: summary index for knowledge. (#670)
* feat: summary index for knowledge. * feat: summary index for knowledge. * align terminology * add zh and ja translation --------- Co-authored-by: Riskey <riskey47@dify.ai> |
||
|
Jyong
|
fecc1138d5 |
fix(api): fix en/api-reference/openapi_knowledge.json (#657)
* fix(api): change reranking_mode to reranking_model in openapi_knowledge.json * add reranking mode field * update reranking mode description; standardize rerank model terminology --------- Co-authored-by: Zhiqiang Yang <58433399+yangzq50@users.noreply.github.com> Co-authored-by: Riskey <riskey47@dify.ai> |
||
|
quicksand
|
9e278d65bf | Update partial_member_list schema to require user_id objects across OpenAPI docs (#623) | ||
|
Riskey
|
f258cdffcb |
correct the method type for the api that queries tags bound to a dataset (#614)
Co-authored-by: Riskey <riskey47@dify.ai> |
||
|
非法操作
|
57e04ab0b1 |
rm variable name of variable api (#595)
* rm variable name of variable api * update zh and jp docs --------- Co-authored-by: Riskey <riskey47@dify.ai> |
||
|
Chenhe Gu
|
767397a9de |
changed language codes: cn -> zh, jp -> ja. with other supporting structural changes (#565)
* fix redirect language code prefixes * rename: cn -> zh, jp -> ja * remove hardcoded ja / zh references * remove hardcoded 'english' references * renamed variable names and dict keys to language agnostic names * fix: add missing language helper methods to PRAnalyzer - Add get_language_directory() method - Initialize source_language and target_languages from config - Fixes AttributeError when generating mixed PR errors 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * test: kitchen sink workflow validation v2 This PR validates the translation workflow after config-driven refactoring: Changes: - Add new test file: test-workflow-validation.mdx - Modify existing file: introduction.mdx - Update docs.json navigation Tests: - New file translation (add workflow) - Existing file translation (update workflow) - Navigation sync across languages - Config-driven language codes (zh/ja instead of cn/jp) - Source language abstraction (no hardcoded "English") Expected workflow behavior: 1. Detect changes in en/ directory 2. Translate new file to zh and ja 3. Update modified file translations 4. Sync docs.json for all language sections 5. Commit translated files automatically 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * fix: update workflow paths to use zh/ja instead of cn/jp Aligns workflow trigger paths with the zh/ja language directory rename. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Revert "fix: update workflow paths to use zh/ja instead of cn/jp" This reverts commit |