feat: automate API specs workflow and documentation - #6786
Merged
Conversation
SATYAsasini
requested review from
pawan-59,
pawan-mehta-dt,
prakarsh-dt,
tayalrishabh96,
vikramdevtron and
vivek-devtron
as code owners
August 14, 2025 10:03
|
Bito Automatic Review Skipped - Large PR |
|
Bito Automatic Review Skipped - Large PR |
prkhrkat
previously approved these changes
Aug 17, 2025
Contributor
|
/review |
vikramdevtron
previously approved these changes
Aug 18, 2025
prakarsh-dt
reviewed
Aug 18, 2025
prakarsh-dt
reviewed
Aug 18, 2025
prakarsh-dt
reviewed
Aug 18, 2025
|
Bito Automatic Review Skipped - Large PR |
|
prakarsh-dt
approved these changes
Aug 20, 2025
|
Bito Automatic Review Skipped - Large PR |
prkhrkat
added a commit
that referenced
this pull request
Aug 25, 2025
) * corrected api specs * specs enhance * Merge pull request #6771 from devtron-labs/fix-cron-job-suspend fix: cron job suspend * fix: update default sequence for bulk edit config table and correct README link * corrected specs * corrected specs * Improve CI status fetching logic in `CiHandlerImpl` to handle linked pipelines, add duplicate removal utility, and enhance logging and fallback mechanisms. * Refactor `CiHandlerImpl` to modularize and streamline CI pipeline status fetching, extracting common logic into reusable functions and improving linked pipeline handling. * Remove redundant comments in `CiHandler.go` to enhance code clarity and maintain consistency with refactored CI status handling logic. * Clean up redundant comments in `preparePipelineStatusLookup` to enhance readability and align with refactored CI pipeline handling logic. * Remove unused `mapWorkflowsToLinkedPipelines` function from `CiHandler.go` to enhance code clarity and eliminate dead code. * Extract `RemoveDuplicateInts` utility to `CiCdUtil.go` for reusability and replace the inlined method in `CiHandler.go`. * vendor for spec-validator * spec-fixes as per cursor when ran on results file * spec-fixes manually for /orchestrator path * script fix to run against server * naming changed from devtron-lab duplicated removed ap spec correction * removed extra code * wip: adding cluster status * fix cluster status * Enhance CI status fetching in `CiHandlerImpl` to handle linked pipelines. Add linked pipeline mapping and workflow statuses, refactor status population logic, and introduce reusable adapter methods for linked CI workflows. * framework.go update * api-spec fix api-spec fix api-spec fix api-spec fix API Error wrapper API Error wrapper specs fixes * spec fix * script fix * Update workflow status table scripts to latest version. * Update `authenticator` and `common-lib` dependencies to latest versions. * added sql ent files (#6780) * devops specs included * script fix * script fix * migration number chnage (#6783) * feat: add resource recommendation APIs and update openapi.yaml * feat: add Resource Recommendation to openapi.yaml * specs fix * redocly script to generate html * refact * refact * refact * doc: api spec merger * chore: test commit * misc: script name rectified in action file * misc: testing change in /spec * misc: test commit * misc: test commit * refact * refact * refact * refact * feat: action fix and resource recommender specs * fix: action fixes * chore: test trigger commit * chore: test run commit * chore: test commit * chore: test commit * feat: git push job in action file * feat: git push job in action file * chore: test commit * chore: test commit * chore: test commit * chore: test commit * fix panic * chore: test commit * chore: test commit * chore: test commit * fix: script misc chore fixes and trigger commit * fix: script fixes * fix: script fixes * fix: script fixes * fix: script fixes * fix: script fixes * fix: script fixes * fix: script fixes * create API token validation * misc: added support for cronjob annotations and probes (#6787) * added support for cronjob annotations and probes * support for older charts * reconfiguring semverCompare * removed restartPolicy from cronjob-config * added support for external-secrets.io/v1 * added default values for eso * older compatibility * rectify the semverCompare * added support for jobLabels and jobAnnotations * refact * refact * security policy specs fixed * refact * refact * refact * refact * refact * refact * ent separation * ent separation * feat: automate API specs workflow and documentation (#6786) * feat: api spec hosting mechanism * fix: trigger condition update on wf file * fix: remove old wf * refact in specs * generate-api-docs.sh fix --------- Co-authored-by: prakhar katiyar <39842461+prkhrkat@users.noreply.github.com> Co-authored-by: prakhar katiyar <prkhrkat@gmail.com> * driftSpec.yaml added * fix: API token generation api responses refactoring (#6788) * fix: API token generation api responses refactoring * fix: register custom validation against tag for api token name validations * fix: register custom validation against tag for api token name validations * Revert "fix: register custom validation against tag for api token name validations" This reverts commit 7593c27. * fix: remove `required` validation from Description and expiryAtInMs * fix: adding resource conflict api response in WriteJsonResp utility * fix: path params int validation updated to whole numbers only * fix: handled resource not found response for update and delete api, token * path corrected * cmscs added * corrected specs * fix: api responses (#6789) * fix: API token generation api responses refactoring * fix: register custom validation against tag for api token name validations * fix: register custom validation against tag for api token name validations * Revert "fix: register custom validation against tag for api token name validations" This reverts commit 7593c27. * fix: remove `required` validation from Description and expiryAtInMs * fix: adding resource conflict api response in WriteJsonResp utility * fix: path params int validation updated to whole numbers only * fix: handled resource not found response for update and delete api, token * fix: validation for SSO config name field * fix: enhanced query param validation for commit metadata for pipeline material * fix: disable updating clsutername and api name in update clsuter api * fix: enhanced api response in query param validation failure reeors in ge default deployment template * fix: disable modifying cluster nae and env name in update env api * fix: resolving review comments * fix: resolving review comments --------- Co-authored-by: iamayushm <32041961+iamayushm@users.noreply.github.com> Co-authored-by: Ash-exp <asutosh2000ad@gmail.com> Co-authored-by: Prakash Kumar <prakash.kumar@devtron.ai> Co-authored-by: ayushmaheshwari <ayush@devtron.ai> Co-authored-by: Vikram <73224103+vikramdevtron@users.noreply.github.com> Co-authored-by: Shivam Nagar <124123645+Shivam-nagar23@users.noreply.github.com> Co-authored-by: SATYAsasini <satya.prakash@devtron.ai> Co-authored-by: Badal Kumar <130441461+badal773@users.noreply.github.com> Co-authored-by: satya_prakash <155617493+SATYAsasini@users.noreply.github.com>
prkhrkat
added a commit
that referenced
this pull request
Aug 26, 2025
* Merge pull request #6771 from devtron-labs/fix-cron-job-suspend fix: cron job suspend * fix: update default sequence for bulk edit config table and correct README link * Improve CI status fetching logic in `CiHandlerImpl` to handle linked pipelines, add duplicate removal utility, and enhance logging and fallback mechanisms. * Refactor `CiHandlerImpl` to modularize and streamline CI pipeline status fetching, extracting common logic into reusable functions and improving linked pipeline handling. * Remove redundant comments in `CiHandler.go` to enhance code clarity and maintain consistency with refactored CI status handling logic. * Clean up redundant comments in `preparePipelineStatusLookup` to enhance readability and align with refactored CI pipeline handling logic. * Remove unused `mapWorkflowsToLinkedPipelines` function from `CiHandler.go` to enhance code clarity and eliminate dead code. * Extract `RemoveDuplicateInts` utility to `CiCdUtil.go` for reusability and replace the inlined method in `CiHandler.go`. * wip: adding cluster status * fix cluster status * Enhance CI status fetching in `CiHandlerImpl` to handle linked pipelines. Add linked pipeline mapping and workflow statuses, refactor status population logic, and introduce reusable adapter methods for linked CI workflows. * Update workflow status table scripts to latest version. * Update `authenticator` and `common-lib` dependencies to latest versions. * added sql ent files (#6780) * migration number chnage (#6783) * feat: add resource recommendation APIs and update openapi.yaml * feat: add Resource Recommendation to openapi.yaml * fix panic * misc: added support for cronjob annotations and probes (#6787) * added support for cronjob annotations and probes * support for older charts * reconfiguring semverCompare * removed restartPolicy from cronjob-config * added support for external-secrets.io/v1 * added default values for eso * older compatibility * rectify the semverCompare * added support for jobLabels and jobAnnotations * feat: automate API specs workflow and documentation (#6786) * feat: api spec hosting mechanism * fix: trigger condition update on wf file * fix: remove old wf * refact in specs * generate-api-docs.sh fix --------- Co-authored-by: prakhar katiyar <39842461+prkhrkat@users.noreply.github.com> Co-authored-by: prakhar katiyar <prkhrkat@gmail.com> --------- Co-authored-by: iamayushm <32041961+iamayushm@users.noreply.github.com> Co-authored-by: Ash-exp <asutosh2000ad@gmail.com> Co-authored-by: Prakash Kumar <prakash.kumar@devtron.ai> Co-authored-by: ayushmaheshwari <ayush@devtron.ai> Co-authored-by: Vikram <73224103+vikramdevtron@users.noreply.github.com> Co-authored-by: Shivam Nagar <124123645+Shivam-nagar23@users.noreply.github.com> Co-authored-by: Badal Kumar <130441461+badal773@users.noreply.github.com> Co-authored-by: satya_prakash <155617493+SATYAsasini@users.noreply.github.com>
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
4 participants
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.
Description
Fixes https://github.com/devtron-labs/sprint-tasks/issues/2519
Checklist:
Does this PR introduce a user-facing change?
Summary by Bito
This pull request introduces extensive updates to the API specifications, enhancing documentation clarity and usability across various endpoints. Key changes include the addition of new functionalities for user management, API token management, and SSO configurations, while removing outdated definitions to streamline the API workflow.