feat(sage-monorepo): lint OpenAPI descriptions with Redocly (#2839)

Author: tschaffter

libs/agora/api-description/project.json

@@ -14,23 +14,11 @@
     "lint": {
       "executor": "nx:run-commands",
       "options": {
-        "command": "lint-openapi --config tools/ibm-openapi-validator/config.yaml {projectRoot}/build/openapi.yaml"
+        "command": "redocly lint --config tools/redocly/config.yaml {projectName}"
       },
       "dependsOn": ["build"]
-    },
-    "format": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "prettier --write {projectRoot}"
-      }
-    },
-    "format-check": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "prettier --check {projectRoot}"
-      }
     }
   },
-  "tags": [],
+  "tags": ["language:openapi"],
   "implicitDependencies": []
 }

libs/model-ad/api-description/project.json

@@ -14,23 +14,11 @@
     "lint": {
       "executor": "nx:run-commands",
       "options": {
-        "command": "lint-openapi --config tools/ibm-openapi-validator/config.yaml {projectRoot}/build/openapi.yaml"
+        "command": "redocly lint --config tools/redocly/config.yaml {projectName}"
       },
       "dependsOn": ["build"]
-    },
-    "format": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "prettier --write {projectRoot}"
-      }
-    },
-    "format-check": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "prettier --check {projectRoot}"
-      }
     }
   },
-  "tags": [],
+  "tags": ["language:openapi"],
   "implicitDependencies": []
 }

libs/openchallenges/api-description/project.json

@@ -29,28 +29,11 @@
     "lint": {
       "executor": "nx:run-commands",
       "options": {
-        "commands": [
-          "lint-openapi --config tools/ibm-openapi-validator/config.yaml {projectRoot}/build/openapi.yaml",
-          "lint-openapi --config tools/ibm-openapi-validator/config.yaml {projectRoot}/build/challenge.openapi.yaml",
-          "lint-openapi --config tools/ibm-openapi-validator/config.yaml {projectRoot}/build/organization.openapi.yaml",
-          "lint-openapi --config tools/ibm-openapi-validator/config.yaml {projectRoot}/build/image.openapi.yaml"
-        ]
+        "command": "redocly lint --config tools/redocly/config.yaml {projectName}"
       },
       "dependsOn": ["build"]
-    },
-    "format": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "prettier --write {projectRoot}"
-      }
-    },
-    "format-check": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "prettier --check {projectRoot}"
-      }
     }
   },
-  "tags": [],
+  "tags": ["language:openapi"],
   "implicitDependencies": []
 }

libs/schematic/api-description/openapi-lint-config.yaml

@@ -7,32 +7,18 @@
     "build": {
       "executor": "nx:run-commands",
       "options": {
-        "commands": ["redocly bundle --output build/openapi.yaml src/openapi.yaml"],
-        "parallel": true,
+        "command": "redocly bundle --output build/openapi.yaml src/openapi.yaml",
         "cwd": "{projectRoot}"
       }
     },
     "lint": {
       "executor": "nx:run-commands",
       "options": {
-        "command": "lint-openapi --config openapi-lint-config.yaml --ruleset spectral.yaml build/openapi.yaml",
-        "cwd": "{projectRoot}"
+        "command": "redocly lint --config tools/redocly/config.yaml {projectName}"
       },
       "dependsOn": ["build"]
-    },
-    "format": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "prettier --write {projectRoot}"
-      }
-    },
-    "format-check": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "prettier --check {projectRoot}"
-      }
     }
   },
-  "tags": [],
+  "tags": ["language:openapi"],
   "implicitDependencies": []
 }

libs/schematic/api-description/project.json

@@ -4,35 +4,28 @@
   "sourceRoot": "libs/synapse/api-description/src",
   "projectType": "library",
   "targets": {
-    "build": {
+    "get": {
       "executor": "nx:run-commands",
       "options": {
-        "commands": ["redocly bundle --output build/openapi.yaml src/openapi.yaml"],
-        "parallel": true,
+        "command": "curl -fsSL https://rest-docs.synapse.org/rest/openapi/openapispecification.json -o build/openapi.json",
         "cwd": "{projectRoot}"
       }
     },
-    "lint": {
+    "build": {
       "executor": "nx:run-commands",
       "options": {
-        "command": "lint-openapi --config openapi-lint-config.yaml --ruleset spectral.yaml build/openapi.yaml",
+        "command": "redocly bundle --output build/openapi.yaml src/openapi.yaml",
         "cwd": "{projectRoot}"
-      },
-      "dependsOn": ["build"]
-    },
-    "format": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "prettier --write {projectRoot}"
       }
     },
-    "format-check": {
+    "lint": {
       "executor": "nx:run-commands",
       "options": {
-        "command": "prettier --check {projectRoot}"
-      }
+        "command": "redocly lint --config tools/redocly/config.yaml {projectName}"
+      },
+      "dependsOn": ["build"]
     }
   },
-  "tags": [],
+  "tags": ["language:openapi"],
   "implicitDependencies": []
 }

libs/schematic/api-description/spectral.yaml

@@ -99,7 +99,7 @@
     "@openapitools/openapi-generator-cli": "2.5.2",
     "@playwright/test": "^1.36.0",
     "@prettier/plugin-xml": "2.2.0",
-    "@redocly/cli": "1.25.2",
+    "@redocly/cli": "1.25.3",
     "@schematics/angular": "18.2.5",
     "@storybook/addon-essentials": "8.3.2",
     "@storybook/angular": "8.3.2",
@@ -148,7 +148,6 @@
     "eslint-plugin-react-hooks": "4.6.0",
     "hint": "7.1.3",
     "husky": "9.1.5",
-    "ibm-openapi-validator": "1.22.1",
     "jest": "29.7.0",
     "jest-environment-jsdom": "29.7.0",
     "jest-preset-angular": "14.1.1",