misc: Validation on payload and Error handling, API Specs revised (#6790)

* 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 <[email protected]>
Co-authored-by: prakhar katiyar <[email protected]>

* 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 <[email protected]>
Co-authored-by: Ash-exp <[email protected]>
Co-authored-by: Prakash Kumar <[email protected]>
Co-authored-by: ayushmaheshwari <[email protected]>
Co-authored-by: Vikram <[email protected]>
Co-authored-by: Shivam Nagar <[email protected]>
Co-authored-by: SATYAsasini <[email protected]>
Co-authored-by: Badal Kumar <[email protected]>
Co-authored-by: satya_prakash <[email protected]>

Author: 8 people

.github/workflows/api-linter.yaml

@@ -0,0 +1,57 @@
+name: API Specs Merger
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'specs/**'
+permissions:
+  contents: write
+
+jobs:
+  lint-bundle-host:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+
+      - name: Set up Redocly CLI
+        run: npm install -g @redocly/cli
+
+      - name: Run specs bundling script
+        working-directory: ${{ github.workspace }}
+        run: |
+          chmod +x scripts/generate-api-docs.sh
+          ./scripts/generate-api-docs.sh
+
+      - name: Commit and push documentation
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_SYSTEMSDT_TOKEN }}
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action"
+
+          # Fetch the gh-pages branch
+          git fetch origin gh-pages
+
+          # Create a separate worktree for the branch
+          git worktree add /tmp/gh-pages gh-pages
+
+          # Copy generated docs into the worktree
+          mkdir -p /tmp/gh-pages/docs/api-docs
+          cp -r docs/api-docs/* /tmp/gh-pages/docs/api-docs/ || true
+
+          cd /tmp/gh-pages
+
+          git add .
+          if git diff --staged --quiet; then
+            echo "✅ No changes to commit"
+          else
+            git commit -m "📄 Update API documentation"
+            git push origin gh-pages
+            echo "🚀 Documentation pushed to gh-pages branch!"
+          fi
+      

.github/workflows/api-spec-merger.yaml

@@ -4,5 +4,6 @@
 .env
 /cmd/external-app/devtron-ea
 devtron
-
+/tests/api-spec-validation/bin
+/tests/api-spec-validation/reports
 .qodo

.github/workflows/build-docs.yaml

@@ -18,9 +18,6 @@ package apiToken
 
 import (
 	"encoding/json"
-	"net/http"
-	"strconv"
-
 	openapi "github.com/devtron-labs/devtron/api/openapi/openapiClient"
 	"github.com/devtron-labs/devtron/api/restHandler/common"
 	"github.com/devtron-labs/devtron/pkg/apiToken"
@@ -30,6 +27,8 @@ import (
 	"github.com/juju/errors"
 	"go.uber.org/zap"
 	"gopkg.in/go-playground/validator.v9"
+	"net/http"
+	"strconv"
 )
 
 type ApiTokenRestHandler interface {
@@ -62,7 +61,7 @@ func NewApiTokenRestHandlerImpl(logger *zap.SugaredLogger, apiTokenService apiTo
 func (impl ApiTokenRestHandlerImpl) GetAllApiTokens(w http.ResponseWriter, r *http.Request) {
 	userId, err := impl.userService.GetLoggedInUser(r)
 	if userId == 0 || err != nil {
-		common.WriteJsonResp(w, err, "Unauthorized User", http.StatusUnauthorized)
+		common.HandleUnauthorized(w, r)
 		return
 	}
 
@@ -86,7 +85,7 @@ func (impl ApiTokenRestHandlerImpl) GetAllApiTokens(w http.ResponseWriter, r *ht
 func (impl ApiTokenRestHandlerImpl) CreateApiToken(w http.ResponseWriter, r *http.Request) {
 	userId, err := impl.userService.GetLoggedInUser(r)
 	if userId == 0 || err != nil {
-		common.WriteJsonResp(w, err, "Unauthorized User", http.StatusUnauthorized)
+		common.HandleUnauthorized(w, r)
 		return
 	}
 
@@ -103,19 +102,15 @@ func (impl ApiTokenRestHandlerImpl) CreateApiToken(w http.ResponseWriter, r *htt
 	err = decoder.Decode(&request)
 	if err != nil {
 		impl.logger.Errorw("err in decoding request in CreateApiToken", "err", err)
-		common.WriteJsonResp(w, err, nil, http.StatusBadRequest)
+		common.WriteJsonResp(w, errors.New("invalid JSON payload "+err.Error()), nil, http.StatusBadRequest)
 		return
 	}
 
-	// validate request
+	// validate request structure
 	err = impl.validator.Struct(request)
 	if err != nil {
-		impl.logger.Errorw("validation err in CreateApiToken", "err", err, "request", request)
-		common.WriteJsonResp(w, err, nil, http.StatusBadRequest)
-		return
-	}
-	if len(*request.Name) == 0 {
-		common.WriteJsonResp(w, errors.New("name cannot be blank in the request"), nil, http.StatusBadRequest)
+		impl.logger.Errorw("validation err in CreateApiToken ", "err", err, "request", request)
+		common.HandleValidationErrors(w, r, err)
 		return
 	}
 
@@ -132,7 +127,7 @@ func (impl ApiTokenRestHandlerImpl) CreateApiToken(w http.ResponseWriter, r *htt
 func (impl ApiTokenRestHandlerImpl) UpdateApiToken(w http.ResponseWriter, r *http.Request) {
 	userId, err := impl.userService.GetLoggedInUser(r)
 	if userId == 0 || err != nil {
-		common.WriteJsonResp(w, err, "Unauthorized User", http.StatusUnauthorized)
+		common.HandleUnauthorized(w, r)
 		return
 	}
 
@@ -182,7 +177,7 @@ func (impl ApiTokenRestHandlerImpl) UpdateApiToken(w http.ResponseWriter, r *htt
 func (impl ApiTokenRestHandlerImpl) DeleteApiToken(w http.ResponseWriter, r *http.Request) {
 	userId, err := impl.userService.GetLoggedInUser(r)
 	if userId == 0 || err != nil {
-		common.WriteJsonResp(w, err, "Unauthorized User", http.StatusUnauthorized)
+		common.HandleUnauthorized(w, r)
 		return
 	}
 
@@ -221,7 +216,7 @@ func (handler ApiTokenRestHandlerImpl) checkManagerAuth(resource, token, object
 func (impl ApiTokenRestHandlerImpl) GetAllApiTokensForWebhook(w http.ResponseWriter, r *http.Request) {
 	userId, err := impl.userService.GetLoggedInUser(r)
 	if userId == 0 || err != nil {
-		common.WriteJsonResp(w, err, "Unauthorized User", http.StatusUnauthorized)
+		common.HandleUnauthorized(w, r)
 		return
 	}
 

.gitignore

@@ -177,7 +177,7 @@ func (handler *InstalledAppRestHandlerImpl) FetchAppOverview(w http.ResponseWrit
 func (handler InstalledAppRestHandlerImpl) GetAllInstalledApp(w http.ResponseWriter, r *http.Request) {
 	userId, err := handler.userAuthService.GetLoggedInUser(r)
 	if userId == 0 || err != nil {
-		common.WriteJsonResp(w, err, "Unauthorized User", http.StatusUnauthorized)
+		common.HandleUnauthorized(w, r)
 		return
 	}
 	v := r.URL.Query()
@@ -343,7 +343,7 @@ func (handler InstalledAppRestHandlerImpl) GetAllInstalledApp(w http.ResponseWri
 func (handler *InstalledAppRestHandlerImpl) DeployBulk(w http.ResponseWriter, r *http.Request) {
 	userId, err := handler.userAuthService.GetLoggedInUser(r)
 	if userId == 0 || err != nil {
-		common.WriteJsonResp(w, err, "Unauthorized User", http.StatusUnauthorized)
+		common.HandleUnauthorized(w, r)
 		return
 	}
 	decoder := json.NewDecoder(r.Body)
@@ -512,7 +512,7 @@ func (handler *InstalledAppRestHandlerImpl) getChartGroupInstallMetadata(req *ch
 func (handler *InstalledAppRestHandlerImpl) CheckAppExists(w http.ResponseWriter, r *http.Request) {
 	userId, err := handler.userAuthService.GetLoggedInUser(r)
 	if userId == 0 || err != nil {
-		common.WriteJsonResp(w, err, "Unauthorized User", http.StatusUnauthorized)
+		common.HandleUnauthorized(w, r)
 		return
 	}
 	decoder := json.NewDecoder(r.Body)
@@ -538,7 +538,7 @@ func (impl *InstalledAppRestHandlerImpl) DefaultComponentInstallation(w http.Res
 	userId, err := impl.userAuthService.GetLoggedInUser(r)
 	if userId == 0 || err != nil {
 		impl.Logger.Errorw("service err, DefaultComponentInstallation", "error", err, "userId", userId)
-		common.WriteJsonResp(w, err, "Unauthorized User", http.StatusUnauthorized)
+		common.HandleUnauthorized(w, r)
 		return
 	}
 	vars := mux.Vars(r)
@@ -885,7 +885,7 @@ func (handler *InstalledAppRestHandlerImpl) fetchResourceTreeWithHibernateForACD
 func (handler *InstalledAppRestHandlerImpl) MigrateDeploymentTypeForChartStore(w http.ResponseWriter, r *http.Request) {
 	userId, err := handler.userAuthService.GetLoggedInUser(r)
 	if userId == 0 || err != nil {
-		common.WriteJsonResp(w, err, "Unauthorized User", http.StatusUnauthorized)
+		common.HandleUnauthorized(w, r)
 		return
 	}
 
@@ -929,7 +929,7 @@ func (handler *InstalledAppRestHandlerImpl) MigrateDeploymentTypeForChartStore(w
 func (handler *InstalledAppRestHandlerImpl) TriggerChartStoreAppAfterMigration(w http.ResponseWriter, r *http.Request) {
 	userId, err := handler.userAuthService.GetLoggedInUser(r)
 	if userId == 0 || err != nil {
-		common.WriteJsonResp(w, err, "Unauthorized User", http.StatusUnauthorized)
+		common.HandleUnauthorized(w, r)
 		return
 	}