fix: correct the audio-to-text spec and the api reference term (#903) (backport to release/1.16.0-rc1) - #907
Merged
Conversation
* fix: correct the audio-to-text errors and SSE example separators Drop app_unavailable, provider_quota_exceeded and model_currently_not_support from the /audio-to-text 400 list: no raise site reaches them on the path the endpoint takes. provider_not_support_speech_to_text stays, since audio_service raises it when the tenant has no default speech-to-text model. The endpoint uses the workspace default model, not the app's configured one, so correct that claim too. Separate the events in the 10 space-joined SSE examples with blank lines, matching the wire format the response descriptions already document. Also render triggered_from's plugin source as Integration Trigger. * docs: standardize the web app term in the api reference Same rule as the rest of the docs: web app / Web 应用 / Web アプリ in prose, capitalized where a sentence starts. The operation title Get App WebApp Settings is left alone, because Mintlify derives the published slug /api-reference/applications/get-app-webapp-settings from it and 18 files link there, as are the getChatWebAppSettings operationId and the WebAppSettingsResponse schema. * fix: title-case the web app heading in the end-user identity guide The heading is Title Case, so the term takes Web App there rather than the body-text lowercase. The anchor is unchanged, since both forms slug to api-users-and-web-app-users-stay-separate. (cherry picked from commit 791f002) # Conflicts: # en/api-reference/openapi_service.json # ja/api-reference/openapi_service.json # zh/api-reference/openapi_service.json
dosubot
Bot
added
size:M
Contributor
There was a problem hiding this comment.
🟡 Not ready to approve
Several ZH/JA guide link labels were changed to “Web 应用 / Web アプリ” while the destination endpoint titles remain “WebApp” in the OpenAPI metadata, creating a navigation/recognition mismatch that should be resolved for clarity.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.
Pull request overview
Backports documentation/spec fixes from #903 to release/1.16.0-rc1, correcting the /audio-to-text API description/error list, fixing SSE wire-format examples, and standardizing “web app / Web 应用 / Web アプリ” terminology across the Service API reference and guides.
Changes:
- Update SSE streaming examples to separate events with blank lines (
\n\n) in all three OpenAPI specs. - Correct
/audio-to-textto reflect workspace-default speech-to-text model usage and remove unreachable 400 error codes. - Standardize “web app” terminology across specs and guides (EN/ZH/JA).
File summaries
| File | Description |
|---|---|
| zh/api-reference/openapi_service.json | Updates SSE examples, /audio-to-text description + 400 errors, and “Web 应用” terminology in the ZH OpenAPI spec. |
| zh/api-reference/guides/workflow.mdx | Replaces “WebApp” wording with “Web 应用” in the ZH workflow guide. |
| zh/api-reference/guides/human-input-flow.mdx | Updates Human Input delivery-method wording to “Web 应用” (ZH). |
| zh/api-reference/guides/end-user-identity.mdx | Updates API vs hosted web app identity wording to “Web 应用” (ZH). |
| zh/api-reference/guides/completion.mdx | Updates “WebApp” terminology to “Web 应用” in the ZH completion guide. |
| zh/api-reference/guides/chatflow.mdx | Updates “WebApp” terminology to “Web 应用” in the ZH chatflow guide. |
| zh/api-reference/guides/chat.mdx | Updates “WebApp” terminology to “Web 应用” in the ZH chat guide. |
| zh/api-reference/guides/agent.mdx | Updates “WebApp” terminology to “Web 应用” in the ZH agent guide. |
| ja/api-reference/openapi_service.json | Updates SSE examples, /audio-to-text description + 400 errors, and “Web アプリ” terminology in the JA OpenAPI spec. |
| ja/api-reference/guides/workflow.mdx | Replaces “WebApp” wording with “Web アプリ” in the JA workflow guide. |
| ja/api-reference/guides/human-input-flow.mdx | Updates Human Input delivery-method wording to “Web アプリ” (JA). |
| ja/api-reference/guides/end-user-identity.mdx | Updates API vs hosted web app identity wording to “Web アプリ” (JA). |
| ja/api-reference/guides/completion.mdx | Updates “WebApp” terminology to “Web アプリ” in the JA completion guide. |
| ja/api-reference/guides/chatflow.mdx | Updates “WebApp” terminology to “Web アプリ” in the JA chatflow guide. |
| ja/api-reference/guides/chat.mdx | Updates “WebApp” terminology to “Web アプリ” in the JA chat guide. |
| ja/api-reference/guides/agent.mdx | Updates “WebApp” terminology to “Web アプリ” in the JA agent guide. |
| en/api-reference/openapi_service.json | Updates SSE examples, /audio-to-text description + 400 errors, and standardizes “web app” wording in the EN OpenAPI spec. |
| en/api-reference/guides/workflow.mdx | Updates Human Input delivery-method wording and guide phrasing to “web app” (EN). |
| en/api-reference/guides/human-input-flow.mdx | Updates Human Input delivery-method wording to “web app” (EN). |
| en/api-reference/guides/end-user-identity.mdx | Updates API vs hosted web app identity wording and headings (EN). |
| en/api-reference/guides/completion.mdx | Updates guide phrasing to “web app” (EN). |
| en/api-reference/guides/chatflow.mdx | Updates Human Input delivery-method wording and guide phrasing to “web app” (EN). |
| en/api-reference/guides/chat.mdx | Updates guide phrasing to “web app” (EN). |
| en/api-reference/guides/agent.mdx | Updates guide phrasing to “web app” (EN). |
Review details
- Files reviewed: 24/24 changed files
- Comments generated: 10
- Review effort level: Low
We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.
| - **[获取应用参数](/zh/api-reference/applications/get-app-parameters)**：返回调用需在 `inputs` 中传入的字段（名称、类型、默认值），以及应用的功能开关，可据此构建请求或客户端界面。 | ||
| - **[获取应用元数据](/zh/api-reference/applications/get-app-meta)**：返回工具图标等配置元数据。 | ||
| - **[获取应用 WebApp 设置](/zh/api-reference/applications/get-app-webapp-settings)**：返回 WebApp 的站点配置、主题和自定义选项。 | ||
| - **[获取应用 Web 应用设置](/zh/api-reference/applications/get-app-webapp-settings)**：返回 Web 应用的站点配置、主题和自定义选项。 |
| - **[获取应用参数](/zh/api-reference/applications/get-app-parameters)**：返回调用需在 `inputs` 中传入的字段（名称、类型、默认值），以及应用的功能开关，可据此构建请求或客户端界面。 | ||
| - **[获取应用元数据](/zh/api-reference/applications/get-app-meta)**：返回工具图标等配置元数据。 | ||
| - **[获取应用 WebApp 设置](/zh/api-reference/applications/get-app-webapp-settings)**：返回 WebApp 的站点配置、主题和自定义选项。 | ||
| - **[获取应用 Web 应用设置](/zh/api-reference/applications/get-app-webapp-settings)**：返回 Web 应用的站点配置、主题和自定义选项。 |
| - **[获取应用参数](/zh/api-reference/applications/get-app-parameters)**：返回调用需在 `inputs` 中传入的字段（名称、类型、默认值），以及应用的功能开关，可据此构建请求或客户端界面。 | ||
| - **[获取应用元数据](/zh/api-reference/applications/get-app-meta)**：返回工具图标等配置元数据。 | ||
| - **[获取应用 WebApp 设置](/zh/api-reference/applications/get-app-webapp-settings)**：返回 WebApp 的站点配置、主题和自定义选项。 | ||
| - **[获取应用 Web 应用设置](/zh/api-reference/applications/get-app-webapp-settings)**：返回 Web 应用的站点配置、主题和自定义选项。 |
| - **[获取应用参数](/zh/api-reference/applications/get-app-parameters)**：返回调用需在 `inputs` 中传入的字段（名称、类型、默认值），以及应用的功能开关，可据此构建请求或客户端界面。 | ||
| - **[获取应用元数据](/zh/api-reference/applications/get-app-meta)**：返回工具图标等配置元数据。 | ||
| - **[获取应用 WebApp 设置](/zh/api-reference/applications/get-app-webapp-settings)**：返回 WebApp 的站点配置、主题和自定义选项。 | ||
| - **[获取应用 Web 应用设置](/zh/api-reference/applications/get-app-webapp-settings)**：返回 Web 应用的站点配置、主题和自定义选项。 |
| - **[获取应用参数](/zh/api-reference/applications/get-app-parameters)**：返回调用需在 `inputs` 中传入的字段（名称、类型、默认值），以及应用的功能开关，可据此构建请求或客户端界面。 | ||
| - **[获取应用元数据](/zh/api-reference/applications/get-app-meta)**：返回应用的配置元数据；对新 Agent 应用，`tool_icons` 为空。 | ||
| - **[获取应用 WebApp 设置](/zh/api-reference/applications/get-app-webapp-settings)**：返回 WebApp 的站点配置、主题和自定义选项。 | ||
| - **[获取应用 Web 应用设置](/zh/api-reference/applications/get-app-webapp-settings)**：返回 Web 应用的站点配置、主题和自定义选项。 |
| - **[アプリケーションのパラメータ情報を取得](/ja/api-reference/applications/get-app-parameters)**：呼び出し時に `inputs` で送るフィールド（名前、型、デフォルト値）と、アプリの機能スイッチを返します。リクエストやクライアント UI を構築する際の基礎になります。 | ||
| - **[アプリケーションのメタ情報を取得](/ja/api-reference/applications/get-app-meta)**：ツールアイコンなどの設定メタデータを返します。 | ||
| - **[アプリの WebApp 設定を取得](/ja/api-reference/applications/get-app-webapp-settings)**：WebApp のサイト設定、テーマ、カスタマイズ項目を返します。 | ||
| - **[アプリの Web アプリ設定を取得](/ja/api-reference/applications/get-app-webapp-settings)**：Web アプリのサイト設定、テーマ、カスタマイズ項目を返します。 |
| - **[アプリケーションのパラメータ情報を取得](/ja/api-reference/applications/get-app-parameters)**：呼び出し時に `inputs` で送るフィールド（名前、型、デフォルト値）と、アプリの機能スイッチを返します。リクエストやクライアント UI を構築する際の基礎になります。 | ||
| - **[アプリケーションのメタ情報を取得](/ja/api-reference/applications/get-app-meta)**：ツールアイコンなどの設定メタデータを返します。 | ||
| - **[アプリの WebApp 設定を取得](/ja/api-reference/applications/get-app-webapp-settings)**：WebApp のサイト設定、テーマ、カスタマイズ項目を返します。 | ||
| - **[アプリの Web アプリ設定を取得](/ja/api-reference/applications/get-app-webapp-settings)**：Web アプリのサイト設定、テーマ、カスタマイズ項目を返します。 |
| - **[アプリケーションのパラメータ情報を取得](/ja/api-reference/applications/get-app-parameters)**：呼び出し時に `inputs` で送るフィールド（名前、型、デフォルト値）と、アプリの機能スイッチを返します。リクエストやクライアント UI を構築する際の基礎になります。 | ||
| - **[アプリケーションのメタ情報を取得](/ja/api-reference/applications/get-app-meta)**：ツールアイコンなどの設定メタデータを返します。 | ||
| - **[アプリの WebApp 設定を取得](/ja/api-reference/applications/get-app-webapp-settings)**：WebApp のサイト設定、テーマ、カスタマイズ項目を返します。 | ||
| - **[アプリの Web アプリ設定を取得](/ja/api-reference/applications/get-app-webapp-settings)**：Web アプリのサイト設定、テーマ、カスタマイズ項目を返します。 |
| - **[アプリケーションのパラメータ情報を取得](/ja/api-reference/applications/get-app-parameters)**：呼び出し時に `inputs` で送るフィールド（名前、型、デフォルト値）と、アプリの機能スイッチを返します。リクエストやクライアント UI を構築する際の基礎になります。 | ||
| - **[アプリケーションのメタ情報を取得](/ja/api-reference/applications/get-app-meta)**：ツールアイコンなどの設定メタデータを返します。 | ||
| - **[アプリの WebApp 設定を取得](/ja/api-reference/applications/get-app-webapp-settings)**：WebApp のサイト設定、テーマ、カスタマイズ項目を返します。 | ||
| - **[アプリの Web アプリ設定を取得](/ja/api-reference/applications/get-app-webapp-settings)**：Web アプリのサイト設定、テーマ、カスタマイズ項目を返します。 |
| - **[アプリケーションのパラメータ情報を取得](/ja/api-reference/applications/get-app-parameters)**：呼び出し時に `inputs` で送るフィールド（名前、型、デフォルト値）と、アプリの機能スイッチを返します。リクエストやクライアント UI を構築する際の基礎になります。 | ||
| - **[アプリケーションのメタ情報を取得](/ja/api-reference/applications/get-app-meta)**：アプリの設定メタデータを返します。新しい Agent アプリでは `tool_icons` は空です。 | ||
| - **[アプリの WebApp 設定を取得](/ja/api-reference/applications/get-app-webapp-settings)**：WebApp のサイト設定、テーマ、カスタマイズ項目を返します。 | ||
| - **[アプリの Web アプリ設定を取得](/ja/api-reference/applications/get-app-webapp-settings)**：Web アプリのサイト設定、テーマ、カスタマイズ項目を返します。 |
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.
Backport
This will backport the following commits from
maintorelease/1.16.0-rc1: