Fix duplicated security section for api doc#2196
Merged
cb-github-robot merged 1 commit intocloud-barista:mainfrom Nov 3, 2025
Merged
Fix duplicated security section for api doc#2196cb-github-robot merged 1 commit intocloud-barista:mainfrom
cb-github-robot merged 1 commit intocloud-barista:mainfrom
Conversation
Signed-off-by: Seokho Son <shsongist@gmail.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request removes redundant and unnecessary OpenAPI specification fields from the Swagger documentation. The changes streamline the API documentation by removing default parameter styling attributes (style, explode) that are automatically inferred by OpenAPI 3.0, removing required: false declarations (which is the default), and removing global security declarations that were previously appended via a script.
Key Changes:
- Removed redundant
styleandexplodeparameter attributes throughout the API endpoints - Removed explicit
required: falsedeclarations from optional parameters - Removed global security declarations from both the YAML file and the conversion script
Reviewed Changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/interface/rest/docs/swagger.yaml | Removed redundant OpenAPI parameter attributes (style, explode, required: false) and global security declarations from the API specification |
| scripts/misc/convert-swagger-version.sh | Removed script logic that was appending security declarations to the swagger.yaml file |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Member
Author
|
/approve |
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.
No description provided.