misc: Update openapi spec #6758
Conversation
|
Changelist by BitoThis pull request implements the following key changes.
|
![bito-code-review[bot]](https://avatars.githubusercontent.com/in/1061978?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review Agent Run #145c57
Actionable Suggestions - 1
-
specs/swagger/openapi.yaml - 1
- Incorrect operationId for GET endpoint · Line 3790-3790
Review Details
-
Files reviewed - 1 · Commit Range:
5e8d155..8dac532- specs/swagger/openapi.yaml
-
Files skipped - 0
-
Tools
- Whispers (Secret Scanner) - ✔︎ Successful
- Detect-secrets (Secret Scanner) - ✔︎ Successful
Bito Usage Guide
Commands
Type the following command in the pull request comment and save the comment.
-
/review- Manually triggers a full AI review. -
/pause- Pauses automatic reviews on this pull request. -
/resume- Resumes automatic reviews. -
/resolve- Marks all Bito-posted review comments as resolved. -
/abort- Cancels all in-progress reviews.
Refer to the documentation for additional commands.
Configuration
This repository uses Default Agent You can customize the agent settings here or contact your Bito workspace admin at [email protected].
Documentation & Help
AI Code Review powered by
| summary: used to fetch providers(recipients) | ||
| description: recipients fetch by string search, it will return slacks providers | ||
| and email ids | ||
| operationId: deleteGroupPolicy |
There was a problem hiding this comment.
The operationId: deleteGroupPolicy is semantically incorrect for a GET operation that fetches notification recipients. This will cause confusion in code generation tools and API clients. Please change to findNotificationRecipients or similar.
Code suggestion
Check the AI-generated fix before applying
| operationId: deleteGroupPolicy | |
| operationId: findNotificationRecipients |
Code Review Run #145c57
Should Bito avoid suggestions like this for future reviews? (Manage Rules)
- Yes, avoid them
* ephemeral error fix * ephemeral error fix (#6737) * panic fix * NotificationRule removed * vendor update * misc: Added Github Actions for linting and building api specs (#6720) * Added action to check for linting errors in openapi.yaml * Create build-docs.yaml * added read-only permission in api-linter * updated action to add permission * misc: open api spec addition (#6750) * added version yml * changes in openapi.yaml * Updated build-docs.yaml (#6752) switch the approach from rebasing to creating a temp folder and copying the file * misc: fixing swagger openapi.yaml (#6751) * resolved application.yaml * resolved application.yaml * resolved applisting.yaml * resolved charts.yaml helm-apps list * resolved jobs.yaml jobs list * removed unrequired server * renamed the x-displayName * resolved app-labels.yaml * resolved merge-conflict * resolved merge-conflict - 02 * added Get Deployment History (ENT) spec * misc: adding codeowner for swagger api spec (#6754) * adding codeowner for swagger api spec * adding codeowner for swagger api spec * gitops validation spec added (#6755) * misc: Update openapi spec (#6758) * Updated openapi-spec with notificats api * updated openapi-spec to add historical-get-api-change * updated the title of openapi specs (#6759) * removed timeout notification (#6760) * misc: Timeout main notification (#6761) * removed timeout notification * removed timeout notification * misc: changes in description of api spec (#6767) * changes in description of api spec * refactor: rename bulk edit config SQL files for consistency * chore: update dependencies to origin/main --------- Co-authored-by: prakhar katiyar <[email protected]> Co-authored-by: prakhar katiyar <[email protected]> Co-authored-by: ayushmaheshwari <[email protected]> Co-authored-by: iamayushm <[email protected]> Co-authored-by: Vikram <[email protected]> Co-authored-by: Vikram Singh <[email protected]> Co-authored-by: akshatsinha007 <[email protected]> Co-authored-by: kamal-devtron <[email protected]> Co-authored-by: Badal Kumar <[email protected]> Co-authored-by: Pawan Kumar <[email protected]>
Description
Fixes #
Checklist:
Does this PR introduce a user-facing change?
Summary by Bito
This pull request introduces extensive updates to the OpenAPI specification, including refinements to endpoint descriptions, security schemes, and schema definitions. New endpoints for notifications and deployment history have been added, while existing documentation has been improved for clarity and consistency. The changes enhance the overall usability and accuracy of the API documentation.