Skip to content

Batch update apis#715

Merged
RiskeyL merged 6 commits intomainfrom
batch-update-apis
Mar 23, 2026
Merged

Batch update apis#715
RiskeyL merged 6 commits intomainfrom
batch-update-apis

Conversation

@RiskeyL
Copy link
Copy Markdown
Contributor

@RiskeyL RiskeyL commented Mar 19, 2026

Fix #712
Close #713

Copilot AI review requested due to automatic review settings March 19, 2026 14:30
@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Mar 19, 2026
@dosubot dosubot bot added the documentation Improvements or additions to documentation label Mar 19, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the Completion App OpenAPI specs (EN/JA) to reflect a newer, more comprehensive API surface and example set, and fixes a Chinese docs navigation label.

Changes:

  • Expanded openapi_completion.json (EN/JA) with updated schemas, richer examples, and additional endpoints (file preview, STT/TTS, app meta, etc.).
  • Refined response documentation and standardized reusable components (e.g., SuccessResult).
  • Localized a docs navigation group label in docs.json for the zh API docs section.

Reviewed changes

Copilot reviewed 1 out of 16 changed files in this pull request and generated 1 comment.

File Description
ja/api-reference/openapi_completion.json Major restructure/expansion of the JA Completion OpenAPI spec (endpoints, schemas, examples, responses).
en/api-reference/openapi_completion.json Major restructure/expansion of the EN Completion OpenAPI spec (endpoints, schemas, examples, responses).
docs.json Updates the zh API docs group label from “Chatflow” to “对话流”.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Completion App OpenAPI references (English + Japanese) to reflect newer API surface and documentation structure, plus a small navigation label fix in docs.json.

Changes:

  • Refresh Completion OpenAPI specs with expanded endpoints/schemas (files preview, audio-to-text/text-to-audio, app meta, richer examples, standardized response components).
  • Align Japanese Completion spec naming/structure with the rest of the repository (e.g., Ja suffixes, shared schema names).
  • Fix a zh API Reference navigation group label in docs.json.

Reviewed changes

Copilot reviewed 1 out of 16 changed files in this pull request and generated 3 comments.

File Description
en/api-reference/openapi_completion.json Large update of Completion OpenAPI paths/schemas/examples and response components.
ja/api-reference/openapi_completion.json Mirrors the Completion OpenAPI refresh for Japanese and normalizes naming conventions.
docs.json Changes zh API Reference group label for Chatflow to Chinese.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

@RiskeyL RiskeyL force-pushed the batch-update-apis branch from 73704e7 to 5f28a4c Compare March 20, 2026 04:17
Copilot AI review requested due to automatic review settings March 20, 2026 04:42
@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. and removed size:XS This PR changes 0-9 lines, ignoring generated files. labels Mar 20, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the Completion App OpenAPI specifications (English and Japanese) to a newer, richer schema/endpoint set and adjusts docs navigation/redirect behavior in docs.json.

Changes:

  • Refresh Completion OpenAPI specs (EN/JA): updated tags/operationIds, expanded schemas, and added/rewritten endpoints (e.g., file preview/download, audio-to-text, app meta).
  • Improve API examples and error response documentation for Completion endpoints (blocking/streaming examples, SSE parsing guide, standardized error examples).
  • Update Chinese API docs grouping label and add API reference redirects in docs.json.

Reviewed changes

Copilot reviewed 1 out of 16 changed files in this pull request and generated 2 comments.

File Description
en/api-reference/openapi_completion.json Major refresh of Completion OpenAPI: tags rename, endpoint additions, updated schemas/examples, standardized responses.
ja/api-reference/openapi_completion.json Japanese counterpart of the Completion OpenAPI refresh with localized descriptions and updated operationIds.
docs.json Fixes a zh API docs group label and adds redirects for renamed API reference routes.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 16 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 16 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 16 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 16 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@RiskeyL RiskeyL force-pushed the batch-update-apis branch from 27dedbf to 3839109 Compare March 23, 2026 08:29
@RiskeyL RiskeyL merged commit 21122c4 into main Mar 23, 2026
1 of 2 checks passed
@RiskeyL RiskeyL deleted the batch-update-apis branch March 23, 2026 08:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS]: Add new Service API endpoints for KB document download

2 participants