[Devops] Feature/221 add openapi linting (#243)

Author: sikutisa

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

@@ -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: |
@@ -71,13 +76,32 @@ jobs:
       run: |
         dotnet run --project ./src/AzureOpenAIProxy.AppHost &
 
-        DOTNET_PID=$!
-
         sleep 30
 
         dotnet test ./test/AzureOpenAIProxy.PlaygroundApp.Tests --no-build --logger "trx" --collect:"XPlat Code Coverage"
 
-        kill $DOTNET_PID
+    - 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
+
+        Invoke-WebRequest -Uri "https://localhost:7001/swagger/$API_VERSION/swagger.json" -OutFile "openapi.json"
+
+    - name: Lint OpenAPI doc
+      shell: pwsh
+      run: |
+        $LINT_RESULT = spectral lint -f json -F warn -D -q openapi.json | ConvertFrom-Json
+
+        if( $LINT_RESULT.Count -gt 0) {
+          $LINT_RESULT | ForEach-Object {
+            Write-Host ("code: " + $_.code)
+            Write-Host ("message: " + $_.message)
+            Write-Host ("path: " + $($_.path -join "."))
+            Write-Host "`n"
+          }
+          exit 1
+        }
 
     - name: Publish test results
       if: ${{ !cancelled() }}

.github/workflows/azure-dev.yml

@@ -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
@@ -85,13 +90,32 @@ jobs:
       run: |
         dotnet run --project ./src/AzureOpenAIProxy.AppHost &
 
-        DOTNET_PID=$!
-
         sleep 30
 
         dotnet test ./test/AzureOpenAIProxy.PlaygroundApp.Tests -c Release --no-build --logger "trx" --collect:"XPlat Code Coverage"
 
-        kill $DOTNET_PID
+    - 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
+
+        Invoke-WebRequest -Uri "https://localhost:7001/swagger/$API_VERSION/swagger.json" -OutFile "openapi.json"
+
+    - name: Lint OpenAPI doc
+      shell: pwsh
+      run: |
+        $LINT_RESULT = spectral lint -f json -F warn -D -q openapi.json | ConvertFrom-Json
+
+        if( $LINT_RESULT.Count -gt 0) {
+          $LINT_RESULT | ForEach-Object {
+            Write-Host ("code: " + $_.code)
+            Write-Host ("message: " + $_.message)
+            Write-Host ("path: " + $($_.path -join "."))
+            Write-Host "`n"
+          }
+          exit 1
+        }
 
     - name: Publish test results
       uses: bibipkins/dotnet-test-reporter@main