[Devops] Feature/221 add openapi linting

.github/workflows/azure-dev-build-only.yml

@@ -13,7 +13,7 @@ on:
 
 permissions:
   id-token: write
-  contents: read
+  contents: write
   issues: write
   pull-requests: write
 
@@ -43,6 +43,11 @@ jobs:
         dotnet workload update
         dotnet workload install aspire
 
+    - name: Install Spectral Cli
+      shell: bash
+      run: |
+        curl -L https://raw.github.com/stoplightio/spectral/master/scripts/install.sh | sh
+
     - name: Restore NuGet packages
       shell: bash
       run: |
@@ -53,6 +58,30 @@ jobs:
       run: |
         dotnet build
 
+    - name: Create openapi.json
+      shell: pwsh
+      run: |
+        $fileContent = Get-Content './src/AzureOpenAIProxy.ApiApp/Constants.cs'
+        $API_VERSION = [regex]::Match($fileContent, 'public const string Version = "([^"]+)"').Groups[1].Value
+
+        $PROCESS = Start-Process -FilePath "dotnet" -ArgumentList "run --project src/AzureOpenAIProxy.AppHost" -PassThru
+
+        Start-Sleep -Seconds 30
+
+        Invoke-WebRequest -Uri "https://localhost:7001/swagger/$API_VERSION/swagger.json" -OutFile "openapi.json"
+
+        $PROCESS.Kill()
+
+    - name: Lint OpenAPI doc
+      shell: pwsh
+      run: |
+        $LINT_RESULT = spectral lint -f json -F warn -D openapi.json
+
+        if( $LINT_RESULT.Count -ge 1) {
+          $LINT_RESULT
+          exit 1
+        }
+
     - name: Install playwright
       shell: pwsh
       run: |

.github/workflows/azure-dev.yml

@@ -10,7 +10,7 @@ on:
 
 permissions:
   id-token: write
-  contents: read
+  contents: write
 
 jobs:
   build-test-deploy:
@@ -56,6 +56,11 @@ jobs:
         $appsettings.Azure.KeyVault.VaultUri = "${{ env.AZURE_KEYVAULT_URI }}"
         $appsettings.Azure.KeyVault.SecretName = "${{ env.AZURE_KEYVAULT_SECRET_NAME }}"
         $appsettings | ConvertTo-Json -Depth 100 | Set-Content -Path "./src/AzureOpenAIProxy.ApiApp/appsettings.json" -Encoding UTF8 -Force
+
+    - name: Install Spectral Cli
+      shell: bash
+      run: |
+        curl -L https://raw.github.com/stoplightio/spectral/master/scripts/install.sh | sh
 
     - name: Restore NuGet packages
       shell: bash
@@ -67,6 +72,34 @@ jobs:
       run: |
         dotnet build -c Release
 
+    - name: Create openapi.json
+      shell: pwsh
+      run: |
+        $fileContent = Get-Content './src/AzureOpenAIProxy.ApiApp/Constants.cs'
+        $API_VERSION = [regex]::Match($fileContent, 'public const string Version = "([^"]+)"').Groups[1].Value
+
+        $PROCESS = Start-Process -FilePath "dotnet" -ArgumentList "run --project src/AzureOpenAIProxy.AppHost" -PassThru
+
+        Start-Sleep -Seconds 30
+
+        Remove-Item -Path "openapi.json" -Force
+
+        Invoke-WebRequest -Uri "https://localhost:7001/swagger/$API_VERSION/swagger.json" -OutFile "openapi.json"
+
+        $PROCESS.Kill()
+
+    - name: Lint OpenAPI doc
+      shell: pwsh
+      run: |
+        $LINT_RESULT = spectral lint -f json -F warn -D openapi.json
+
+        if( $LINT_RESULT.Count -ge 1) {
+          $LINT_RESULT
+          exit 1
+        }
+
+    - name: Test solution
+
     - name: Install playwright
       shell: pwsh
       run: |