Skip to content

misc: changes in description of api spec - #6767

Merged
pawan-59 merged 6 commits into
mainfrom
api-fixes
Jul 28, 2025
Merged

misc: changes in description of api spec#6767
pawan-59 merged 6 commits into
mainfrom
api-fixes

Conversation

@kamal-devtron

@kamal-devtron kamal-devtron commented Jul 28, 2025 •
edited by bito-code-review Bot
Loading

Copy link
Copy Markdown
Contributor

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 pull request standardizes security definitions across the OpenAPI specification by replacing outdated authentication schemes with a consistent token-based model. It enhances documentation clarity by adding detailed descriptions for various schema properties and endpoints, particularly for GitOps-related fields and Azure properties. These changes modernize the API spec, improve developer understanding, and ensure uniformity in security documentation.

@bito-code-review

bito-code-review Bot commented Jul 28, 2025 •
edited
Loading

Copy link
Copy Markdown

Code Review Agent Run #10fd48

Actionable Suggestions - 0
Review Details
  • Files reviewed - 1 · Commit Range: 9d492f7..9d492f7
    • 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 shivam@devtron.ai.

Documentation & Help

AI Code Review powered by Bito Logo

@bito-code-review

bito-code-review Bot commented Jul 28, 2025 •
edited
Loading

Copy link
Copy Markdown

Changelist by Bito

This pull request implements the following key changes.

Key Change Files Impacted
Documentation - Standardized API Security Definitions

- openapi.yaml - Updated security definitions across endpoints by replacing deprecated authentication schemes with a uniform token-based model and enhancing parameter descriptions.

@bito-code-review

bito-code-review Bot commented Jul 28, 2025

Copy link
Copy Markdown

Bito Banner

Bito's AI Code Review trial is almost over
Your free trial of Bito's AI Code Reviews was setup by shivam@devtron.ai and is nearly over. Let them know if you'd like to continue getting complete reviews.

Sign in to upgrade

About Bito
Merge PRs 89% faster, with 34% fewer regressions, and 87% of relevant PR feedback provided by Bito's AI Code Reviews. Trusted by 100,000+ developers and 1,000+ engineering teams.

@bito-code-review

bito-code-review Bot commented Jul 28, 2025 •
edited
Loading

Copy link
Copy Markdown

Code Review Agent Run #3c0f19

Actionable Suggestions - 0
Review Details
  • Files reviewed - 1 · Commit Range: 9d492f7..f818c09
    • 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 shivam@devtron.ai.

Documentation & Help

AI Code Review powered by Bito Logo

@sonarqubecloud

sonarqubecloud Bot commented Jul 28, 2025

Copy link
Copy Markdown

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

bito-code-review Bot commented Jul 28, 2025 •
edited
Loading

Copy link
Copy Markdown

Code Review Agent Run #b60c7b

Actionable Suggestions - 0
Review Details
  • Files reviewed - 1 · Commit Range: f818c09..48f983e
    • 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 shivam@devtron.ai.

Documentation & Help

AI Code Review powered by Bito Logo

@pawan-59
pawan-59 merged commit dbbcbe0 into main Jul 28, 2025
@pawan-59
pawan-59 deleted the api-fixes branch July 28, 2025 13:32
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 <prkhrkat@gmail.com>
Co-authored-by: prakhar katiyar <39842461+prkhrkat@users.noreply.github.com>
Co-authored-by: ayushmaheshwari <ayush@devtron.ai>
Co-authored-by: iamayushm <32041961+iamayushm@users.noreply.github.com>
Co-authored-by: Vikram <73224103+vikramdevtron@users.noreply.github.com>
Co-authored-by: Vikram Singh <vikram@devtron.ai>
Co-authored-by: akshatsinha007 <156403098+akshatsinha007@users.noreply.github.com>
Co-authored-by: kamal-devtron <128121299+kamal-devtron@users.noreply.github.com>
Co-authored-by: Badal Kumar <130441461+badal773@users.noreply.github.com>
Co-authored-by: Pawan Kumar <85476803+pawan-59@users.noreply.github.com>
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

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.

2 participants

@kamal-devtron @pawan-59
Sponsor
SponsoredKunjungi sekarang
Promo