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

Author: akshatsinha007

.github/workflows/api-linter.yaml

@@ -0,0 +1,26 @@
+name: Lint API Specs
+on:
+ pull_request:
+   paths:
+     - 'specs/swagger/**'
+permissions:
+  contents: read
+jobs:
+ lint:
+   runs-on: ubuntu-latest
+   steps:
+     - name: Checkout repository
+       uses: actions/checkout@v4
+       with:
+         fetch-depth: 0 
+     - name: Setup Node.js
+       uses: actions/setup-node@v4
+     - name: Install Redocly CLI
+       run: npm install -g @redocly/cli
+     - name: Lint OpenAPI specification
+       run: |
+         cd specs/swagger
+         echo "Linting OpenAPI specification..."
+         redocly lint openapi.yaml
+       env:
+         GITHUB_TOKEN: ${{ secrets.GH_SYSTEMSDT_TOKEN }}

.github/workflows/build-docs.yaml

@@ -0,0 +1,55 @@
+name: OpenAPI Build Documentation
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'specs/swagger/**'
+permissions:
+  contents: write
+jobs:
+  lint-and-build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+
+      - name: Install Redocly CLI
+        run: npm install -g @redocly/cli
+
+      - name: Switch to gh-pages branch
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action"
+          echo "Switching to gh-pages branch..."
+          git checkout -b gh-pages
+          git fetch origin gh-pages
+          git pull --rebase origin gh-pages
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_SYSTEMSDT_TOKEN }}
+      - name: Build OpenAPI documentation
+        run: |
+          cd specs/swagger
+          echo "Building OpenAPI documentation..."
+          redocly build-docs openapi.yaml --output=openapi.html
+          echo "Documentation built successfully!"
+      
+      - name: Commit and push documentation
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action"
+          echo "Committing and pushing documentation..."
+          git add specs/swagger/openapi.html
+          if git diff --staged --quiet; then
+            echo "No changes to commit"
+          else
+            git commit -m "Update OpenAPI documentation from main branch"
+            git push --force origin gh-pages
+            echo "Documentation pushed to gh-pages branch!"
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_SYSTEMSDT_TOKEN }}