feat: replace swagger-cli with redocly for OpenAPI validation

# Issue Redocly CLI is the recommended replacement for the deprecated swagger-cli package # Fix See https://redocly.com/docs/cli/guides/migrate-from-swagger-cli
cloudfoundry · Jan 30, 2025 · 4af0c81 · 4af0c81
1 parent 80a7bcd
commit 4af0c81
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 55 deletions.
diff --git a/.github/workflows/openapi-specs-check.yaml b/.github/workflows/openapi-specs-check.yaml
@@ -4,15 +4,21 @@ on:
 jobs:
   validate:
     runs-on: ubuntu-latest
-    container:
-      image: ghcr.io/cloudfoundry/app-autoscaler-release-tools:main@sha256:a850ee87a32ae11003e1343714b8af06d2be377744510472601f3ff4b153968e
     steps:
     - name: Get Repository content
       uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+    - name: Install devbox
+      uses: jetify-com/devbox-install-action@975fb35b9a6472bed4edf51e5db534d5efec2817 # v0.12.0
+      with:
+        enable-cache: 'true'
+    - name: Make devbox shellenv available
+      run: |
+        eval "$(devbox shellenv)"
+        printenv >> "$GITHUB_ENV"
     - name: Validating OpenAPI Specifications
       shell: bash
       run: |
         #! /usr/bin/env bash
 
         set -eu -o pipefail
-        make validate-openapi-specs
+        make validate-openapi-specs
diff --git a/Makefile b/Makefile
@@ -447,7 +447,7 @@ docker-image: docker-login
 	docker push ghcr.io/cloudfoundry/app-autoscaler-release-tools:latest
 validate-openapi-specs: $(wildcard ./api/*.openapi.yaml)
 	for file in $^ ; do \
-		swagger-cli validate "$${file}" ; \
+		redocly lint --extends=minimal --format=$(if $(GITHUB_ACTIONS),github-actions,codeframe) "$${file}" ; \
 	done
 
 .PHONY: go-get-u

diff --git a/devbox.json b/devbox.json
@@ -24,7 +24,6 @@
     "rubocop":                              "latest",
     "rubyPackages.solargraph":              "latest",
     "shellcheck":                           "0.10.0",
-    "swagger-cli":                          "latest",
     "which":                                "latest",
     "credhub-cli":                          "2.9.29",
     "markdownlint-cli2":                    "latest",
@@ -39,7 +38,8 @@
     "ruby":                                 "3.3.6",
     "cloudfoundry-cli":                     "8.8.1",
     "go":                                   "1.23.0",
-    "temurin-bin-21":                       "latest"
+    "temurin-bin-21":                       "latest",
+    "redocly":                              "latest"
   },
   "shell": {
     "init_hook": [

diff --git a/devbox.lock b/devbox.lock
@@ -1487,6 +1487,54 @@
         }
       }
     },
+    "redocly@latest": {
+      "last_modified": "2025-01-25T23:17:58Z",
+      "resolved": "github:NixOS/nixpkgs/b582bb5b0d7af253b05d58314b85ab8ec46b8d19#redocly",
+      "source": "devbox-search",
+      "version": "1.26.0",
+      "systems": {
+        "aarch64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/km1z31a88xqf6yzd10g2g20r68lmnpaz-redocly-1.26.0",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/km1z31a88xqf6yzd10g2g20r68lmnpaz-redocly-1.26.0"
+        },
+        "aarch64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/81vbqb3nxr8ca7zycsxcri872hgap27q-redocly-1.26.0",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/81vbqb3nxr8ca7zycsxcri872hgap27q-redocly-1.26.0"
+        },
+        "x86_64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/mzq47b40sbvajy9v17h691j3r3ib3l6f-redocly-1.26.0",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/mzq47b40sbvajy9v17h691j3r3ib3l6f-redocly-1.26.0"
+        },
+        "x86_64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/znsd0yp7rfjhf49am3y5n6v4swlzr8wx-redocly-1.26.0",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/znsd0yp7rfjhf49am3y5n6v4swlzr8wx-redocly-1.26.0"
+        }
+      }
+    },
     "rubocop@latest": {
       "last_modified": "2024-08-31T19:22:30Z",
       "resolved": "github:NixOS/nixpkgs/282e35e0762d64800d78e33ff225704baf9e5216#rubocop",
@@ -1752,54 +1800,6 @@
         }
       }
     },
-    "swagger-cli@latest": {
-      "last_modified": "2024-08-31T10:12:23Z",
-      "resolved": "github:NixOS/nixpkgs/5629520edecb69630a3f4d17d3d33fc96c13f6fe#swagger-cli",
-      "source": "devbox-search",
-      "version": "4.0.4",
-      "systems": {
-        "aarch64-darwin": {
-          "outputs": [
-            {
-              "name": "out",
-              "path": "/nix/store/l97bajrw465kq0ylnkhwkf22myx5wqi2-swagger-cli-4.0.4",
-              "default": true
-            }
-          ],
-          "store_path": "/nix/store/l97bajrw465kq0ylnkhwkf22myx5wqi2-swagger-cli-4.0.4"
-        },
-        "aarch64-linux": {
-          "outputs": [
-            {
-              "name": "out",
-              "path": "/nix/store/4m3kq0l9xfj8qxh8qfwijf5a95jx0jgw-swagger-cli-4.0.4",
-              "default": true
-            }
-          ],
-          "store_path": "/nix/store/4m3kq0l9xfj8qxh8qfwijf5a95jx0jgw-swagger-cli-4.0.4"
-        },
-        "x86_64-darwin": {
-          "outputs": [
-            {
-              "name": "out",
-              "path": "/nix/store/ff5wx2b7dswhhsqqkza6xv5npzh927x4-swagger-cli-4.0.4",
-              "default": true
-            }
-          ],
-          "store_path": "/nix/store/ff5wx2b7dswhhsqqkza6xv5npzh927x4-swagger-cli-4.0.4"
-        },
-        "x86_64-linux": {
-          "outputs": [
-            {
-              "name": "out",
-              "path": "/nix/store/db6z4kinn17pj73gybhxjq25lm7mhmsy-swagger-cli-4.0.4",
-              "default": true
-            }
-          ],
-          "store_path": "/nix/store/db6z4kinn17pj73gybhxjq25lm7mhmsy-swagger-cli-4.0.4"
-        }
-      }
-    },
     "temurin-bin-21@latest": {
       "last_modified": "2024-10-13T23:44:06Z",
       "resolved": "github:NixOS/nixpkgs/d4f247e89f6e10120f911e2e2d2254a050d0f732#temurin-bin-21",

diff --git a/flake.nix b/flake.nix
@@ -84,7 +84,7 @@
               #
               # jdwpkgs.rubyPackages.cf-uaac
               shellcheck
-              swagger-cli
+              redocly
               temurin-bin
               uutils-coreutils-noprefix
               yq-go