Commit Graph

16 Commits

Author SHA1 Message Date
-LAN- 9b82c3e7f2 docs: require user for file upload API (#794)
* docs(api-reference): require user for file upload

Mark the user form field as required for the shared files/upload Service API endpoint in chat, chatflow, completion, and workflow specs.

Update the field description to clarify that Service API conversations are separate from WebApp conversations.

* docs(api-reference): clarify file upload user field and sync zh/ja

---------

Co-authored-by: RiskeyL <7a8y@163.com>
2026-05-27 22:57:01 +08:00
Riskey dbd94cd64b docs: sync release/1.14.1 into main (#777)
* docs: add Hidden & Pre-Filled section to User Input page (#773)

* docs: add Hidden & Pre-Filled section to User Input page

* translate: add Hidden & Pre-Filled section in user-input (zh, ja)

* docs: add macro translation principles to zh formatting guide

* fix: correct Variables anchor in zh/ja translations

* docs: update docker compose environment docs (#774)

* docs: update docker compose environment docs

* chore: retrigger documentation analysis

* docs: refine env-split deployment docs and translate zh/ja

* docs: update aws premium env guidance

* docs: refine aws premium env guidance and translate zh/ja

---------

Co-authored-by: RiskeyL <7a8y@163.com>

* Docs/1.14.1 check (#775)

* docs: sync knowledge api spec for 1.14.1

* chore: tighten release-sync and api-reference skills

* docs: update education discount steps

* docs: relax over-applied zh translation rules

* docs: sync env vars for 1.14.1

* chore: env-vars verifier supports multi-file layout

* docs: cover editable class labels in question classifier; sync question classifier zh/ja docs

* chore: sync termbase_i18n with current glossary

* docs: update collaboration docs for websocket service split; sync zh/ja translation

* docs: human input updates for 1.14.1; sync zh/ja

* docs: add end user term to glossary

* chore: align ja api spec human input terminology with glossary

* fix: enforce at-least-one tag in unbinding request schema

* Revert "fix: enforce at-least-one tag in unbinding request schema"

This reverts commit b392b148.

Mintlify renders schema-level `anyOf` as unlabeled "Option 1" / "Option 2"
tabs in the request body section, which is more confusing than the
loose-schema-with-prose-rule it replaced. The SDK-generator benefit isn't
worth the rendered-docs regression for a deprecated compat path. Keep the
contract in the parameter descriptions only.

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: add "Agent app" glossary entry to disambiguate from Agent node

---------

Co-authored-by: -LAN- <laipz8200@outlook.com>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-12 16:20:12 +08:00
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
2026-04-29 21:47:53 +08:00
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>
2026-04-29 11:57:59 +08:00
Riskey 7cea249f73 docs: rewrite external knowledge base documentation (#737)
* docs: rewrite external knowledge base overview page

* docs: rewrite external knowledge API specification

* style: add adjustable parameter guidance pattern

* fix: standardize "similarity score" terminology across docs and glossary

* fix: address Copilot's PR review feedback on external knowledge base docs

* translate: sync zh/ja external knowledge base pages with English rewrite

* style: add standard phrase translation convention for zh docs

* fix: address Copilot's PR review feedback on external knowledge base docs

* docs: strengthen codebase verification rule for rewrites

* docs: elevate cross-reference anchor rule in translation guides

* style: add vague cross-references pattern to style guide

* fix: remove filler content from external knowledge base pages

* fix: correct anchor examples in translation formatting guides

* fix: translate code block examples and remove invalid operators in zh/ja API spec

* docs: add translation quality rules for EN→ZH/JA

* docs: move LlamaCloud setup to tip and remove Connection Example section

* translate: sync zh/ja with LlamaCloud restructure and apply new quality rules
2026-04-15 10:26:52 +08:00
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
2026-04-10 15:49:43 +08:00
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
2026-03-30 22:16:46 +08:00
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>
2026-03-23 16:38:10 +08:00
Riskey a1985649f3 differentiate operationId for end-user api across app types (#692) 2026-03-01 22:08:36 +08:00
盐粒 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>
2026-03-01 19:53:17 +08:00
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>
2026-02-03 22:02:28 +08:00
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>
2026-01-08 14:09:50 +08:00
quicksand 9e278d65bf Update partial_member_list schema to require user_id objects across OpenAPI docs (#623) 2025-12-19 10:43:22 +08:00
Riskey f258cdffcb correct the method type for the api that queries tags bound to a dataset (#614)
Co-authored-by: Riskey <riskey47@dify.ai>
2025-12-12 17:42:34 +08:00
非法操作 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>
2025-12-12 14:53:38 +08:00
Chenhe Gu 08e9e11c90 Replace main with revamp (#547) 2025-11-26 04:46:31 -08:00