fix: correct the audio-to-text spec and the api reference term (#903) (backport to release/1.16.0) - #908
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
the
size:M
Contributor
There was a problem hiding this comment.
Pull request overview
Backports documentation fixes from #903 onto release/1.16.0, updating the Service API OpenAPI specs and related API-reference guides to better match actual endpoint behavior and improve consistency.
Changes:
- Corrected
/audio-to-textdescription and pruned unreachable 400 error codes/examples in the OpenAPI specs (en/zh/ja). - Fixed SSE multi-event example formatting by separating events with blank lines (
\n\n) to match the wire format. - Standardized “WebApp” wording toward “web app / Web 应用 / Web アプリ” across specs and guides (while keeping the
/get-app-webapp-settingsslug stable).
Reviewed changes
Copilot reviewed 24 out of 24 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| en/api-reference/openapi_service.json | Updates SSE examples, audio-to-text 400 errors, and “web app” terminology in the English Service API spec. |
| zh/api-reference/openapi_service.json | Mirrors the same spec corrections and terminology updates in Chinese. |
| ja/api-reference/openapi_service.json | Mirrors the same spec corrections and terminology updates in Japanese. |
| en/api-reference/guides/workflow.mdx | Updates Human Input pause wording and WebApp-related phrasing in the workflow guide. |
| en/api-reference/guides/human-input-flow.mdx | Updates the delivery-method wording to “web app method”. |
| en/api-reference/guides/end-user-identity.mdx | Updates headings/body text to “Web App / web app” terminology. |
| en/api-reference/guides/completion.mdx | Updates WebApp phrasing in the completion guide. |
| en/api-reference/guides/chatflow.mdx | Updates Human Input pause wording and WebApp phrasing in the chatflow guide. |
| en/api-reference/guides/chat.mdx | Updates WebApp phrasing in the chat guide. |
| en/api-reference/guides/agent.mdx | Updates WebApp phrasing in the agent guide. |
| zh/api-reference/guides/workflow.mdx | Updates WebApp phrasing in the Chinese workflow guide. |
| zh/api-reference/guides/human-input-flow.mdx | Updates WebApp phrasing in the Chinese Human Input flow guide. |
| zh/api-reference/guides/end-user-identity.mdx | Updates WebApp phrasing in the Chinese end-user identity guide. |
| zh/api-reference/guides/completion.mdx | Updates WebApp phrasing in the Chinese completion guide. |
| zh/api-reference/guides/chatflow.mdx | Updates WebApp phrasing in the Chinese chatflow guide. |
| zh/api-reference/guides/chat.mdx | Updates WebApp phrasing in the Chinese chat guide. |
| zh/api-reference/guides/agent.mdx | Updates WebApp phrasing in the Chinese agent guide. |
| ja/api-reference/guides/workflow.mdx | Updates WebApp phrasing in the Japanese workflow guide. |
| ja/api-reference/guides/human-input-flow.mdx | Updates WebApp phrasing in the Japanese Human Input flow guide. |
| ja/api-reference/guides/end-user-identity.mdx | Updates WebApp phrasing in the Japanese end-user identity guide. |
| ja/api-reference/guides/completion.mdx | Updates WebApp phrasing in the Japanese completion guide. |
| ja/api-reference/guides/chatflow.mdx | Updates WebApp phrasing in the Japanese chatflow guide. |
| ja/api-reference/guides/chat.mdx | Updates WebApp phrasing in the Japanese chat guide. |
| ja/api-reference/guides/agent.mdx | Updates WebApp phrasing in the Japanese agent guide. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
2406
to
+2414
| "summary": "Get App WebApp Settings", | ||
| "description": "**Available for**: Chatflow, Workflow, New Agent, Chatbot, Agent, Text Generator apps.\n\nReturns the branding and display settings for the app's hosted WebApp, such as its title, icon, theme colors, and default language.", | ||
| "description": "**Available for**: Chatflow, Workflow, New Agent, Chatbot, Agent, Text Generator apps.\n\nReturns the branding and display settings for the app's hosted web app, such as its title, icon, theme colors, and default language.", | ||
| "operationId": "getChatWebAppSettings", | ||
| "tags": [ | ||
| "Applications" | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "WebApp settings of the application.", | ||
| "description": "Web app settings of the application.", |
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: