Skip to content

misc: swagger api spec fixes #6755

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jul 23, 2025
Merged

misc: swagger api spec fixes #6755

merged 1 commit into from
Jul 23, 2025

Conversation

@kamal-devtron
Copy link
Contributor

@kamal-devtron kamal-devtron commented Jul 23, 2025 •
edited by bito-code-review bot
Loading

Description

Fixes #

Checklist:

  • The title of the PR states what changed and the related issues number (used for the release note).
  • Does this PR requires documentation updates?
  • I've updated documentation as required by this PR.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have tested it for all user roles.
  • I have added all the required unit/api test cases.

Does this PR introduce a user-facing change?

Summary by Bito

This PR refines API specification files by upgrading to secure URLs, adding clear endpoint summaries, and implementing security schemes in the GitOps validation file. The Swagger documentation receives improved formatting, reorganized tags, and expanded schema definitions to enhance clarity and consistency across API specifications.

@bito-code-review
Copy link

bito-code-review bot commented Jul 23, 2025 •
edited
Loading

Code Review Agent Run #d42fe1

Actionable Suggestions - 0
Filtered by Review Rules

Bito filtered these suggestions based on rules created automatically for your feedback. Manage rules.

  • specs/gitops-validation.yaml - 1
    • Invalid placeholder server URL · Line 6-6
Review Details
  • Files reviewed - 2 · Commit Range: b7f49aa..b7f49aa
    • specs/gitops-validation.yaml
    • 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 Bito Logo

@sonarqubecloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@bito-code-review
Copy link

Changelist by Bito

This pull request implements the following key changes.

Key Change Files Impacted
Bug Fix - Fix GitOps Validation API

- gitops-validation.yaml - Replaced insecure local URL with a secure one, added summary fields, and introduced security definitions for API endpoints.
Documentation - Swagger API Specification Improvements

- openapi.yaml - Enhanced endpoint descriptions and formatting, added a GitOps Validation tag, and incorporated new schema definitions for better API documentation.

@kamal-devtron kamal-devtron requested a review from badal773 July 23, 2025 13:06
@kamal-devtron kamal-devtron merged commit f3038cf into main Jul 23, 2025
13 checks passed
@kamal-devtron kamal-devtron deleted the swagger-api-fix branch July 23, 2025 13:21
Ash-exp added a commit that referenced this pull request Jul 31, 2025
@Ash-exp @prkhrkat
@iamayushm @vikramdevtron @akshatsinha007 @kamal-devtron @badal773 @pawan-59
chore: Merged origin/main branch into develop (#6770)
839e287 
* 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pawan-59 pawan-59 pawan-59 approved these changes

@prakarsh-dt prakarsh-dt Awaiting requested review from prakarsh-dt prakarsh-dt is a code owner

@pawan-mehta-dt pawan-mehta-dt Awaiting requested review from pawan-mehta-dt pawan-mehta-dt is a code owner

@badal773 badal773 Awaiting requested review from badal773

Assignees

No one assigned

Labels

PR:Ready-to-Review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@kamal-devtron @pawan-59