feat(sage-monorepo): externalize the config and ruleset used by the O…

…penAPI validator for OpenChallenges (#2818)
Sage-Bionetworks · Sep 17, 2024 · a93fedd · a93fedd
1 parent 1287259
commit a93fedd
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 7 deletions.
diff --git a/libs/openchallenges/api-description/openapi-lint-config.yaml b/libs/openchallenges/api-description/openapi-lint-config.yaml
diff --git a/libs/openchallenges/api-description/project.json b/libs/openchallenges/api-description/project.json
@@ -29,8 +29,12 @@
     "lint": {
       "executor": "nx:run-commands",
       "options": {
-        "command": "lint-openapi --config openapi-lint-config.yaml --ruleset spectral.yaml build/openapi.yaml build/challenge.openapi.yaml build/organization.openapi.yaml build/image.openapi.yaml",
-        "cwd": "{projectRoot}"
+        "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"
+        ]
       },
       "dependsOn": ["build"]
     },

diff --git a/tools/ibm-openapi-validator/config.yaml b/tools/ibm-openapi-validator/config.yaml
@@ -0,0 +1,7 @@
+errorsOnly: true
+summaryOnly: false
+limits:
+  warnings: 25
+# This path to the spectral config file assumes that the validator's current working directory is
+# set to the workspace root folder.
+ruleset: tools/ibm-openapi-validator/spectral.yaml
diff --git a/...nchallenges/api-description/spectral.yaml → tools/ibm-openapi-validator/spectral.yaml b/...nchallenges/api-description/spectral.yaml → tools/ibm-openapi-validator/spectral.yaml