fix: correct the audio-to-text spec and the api reference term (#903) (backport to release/1.16.1) - #905
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)
dosubot
Bot
added
size:M
Contributor
There was a problem hiding this comment.
Pull request overview
Backports #903 onto release/1.16.1, aligning the Service API OpenAPI spec and guide text with actual runtime behavior for /audio-to-text, correcting SSE (Server-Sent Events) example formatting, and standardizing “web app” terminology across the API reference (EN/ZH/JA).
Changes:
- Correct
/audio-to-textdocumentation to reflect that it uses the workspace default speech-to-text model, and remove unreachable 400 error codes/examples from the spec. - Fix SSE example payload formatting by separating events with blank lines (
\n\n) to match the documented wire format. - Standardize “web app” terminology in spec descriptions and guide wording (while preserving the
Get App WebApp Settingsoperation title/slug stability).
Reviewed changes
Copilot reviewed 24 out of 24 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| en/api-reference/openapi_service.json | Updates SSE examples, /audio-to-text spec details, and “web app” wording in API descriptions/schemas. |
| zh/api-reference/openapi_service.json | Mirrors EN spec fixes in Chinese: SSE examples, /audio-to-text corrections, and term updates. |
| ja/api-reference/openapi_service.json | Mirrors EN spec fixes in Japanese: SSE examples, /audio-to-text corrections, and term updates. |
| en/api-reference/guides/workflow.mdx | Updates Human Input delivery terminology (“web app”) and related reference text. |
| en/api-reference/guides/human-input-flow.mdx | Updates Human Input delivery terminology (“web app”). |
| en/api-reference/guides/end-user-identity.mdx | Updates WebApp/user-identity terminology to “Web App”/“web app”. |
| en/api-reference/guides/completion.mdx | Updates “web app” terminology in referenced settings bullet. |
| en/api-reference/guides/chatflow.mdx | Updates Human Input delivery terminology (“web app”) and referenced settings bullet. |
| en/api-reference/guides/chat.mdx | Updates “web app” terminology in conversation isolation + referenced settings bullet. |
| en/api-reference/guides/agent.mdx | Updates “web app” terminology in referenced settings bullet. |
| zh/api-reference/guides/workflow.mdx | Updates Human Input delivery terminology (“Web 应用”) and referenced settings bullet. |
| zh/api-reference/guides/human-input-flow.mdx | Updates Human Input delivery terminology (“Web 应用”). |
| zh/api-reference/guides/end-user-identity.mdx | Updates WebApp/user-identity terminology (“Web 应用”). |
| zh/api-reference/guides/completion.mdx | Updates “Web 应用” terminology in referenced settings bullet. |
| zh/api-reference/guides/chatflow.mdx | Updates Human Input delivery terminology (“Web 应用”) and referenced settings bullet. |
| zh/api-reference/guides/chat.mdx | Updates “Web 应用” terminology in conversation isolation + referenced settings bullet. |
| zh/api-reference/guides/agent.mdx | Updates “Web 应用” terminology in referenced settings bullet. |
| ja/api-reference/guides/workflow.mdx | Updates Human Input delivery terminology (“Web アプリ”) and referenced settings bullet. |
| ja/api-reference/guides/human-input-flow.mdx | Updates Human Input delivery terminology (“Web アプリ”). |
| ja/api-reference/guides/end-user-identity.mdx | Updates WebApp/user-identity terminology (“Web アプリ”). |
| ja/api-reference/guides/completion.mdx | Updates “Web アプリ” terminology in referenced settings bullet. |
| ja/api-reference/guides/chatflow.mdx | Updates Human Input delivery terminology (“Web アプリ”) and referenced settings bullet. |
| ja/api-reference/guides/chat.mdx | Updates “Web アプリ” terminology in conversation isolation + referenced settings bullet. |
| ja/api-reference/guides/agent.mdx | Updates “Web アプリ” terminology in referenced settings bullet. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.1: