CLOUDP-302671: Update v2 to filtered OAS (#497)

Author: blva

.github/scripts/split_spec.sh

@@ -6,9 +6,15 @@ foascli versions -s openapi-foas.json -o ./openapi/v2/versions.json --env "${tar
 
 echo "Running FOAS CLI split command with the following --env=${target_env:?} and -o=./openapi/v2/openapi.json"
 
+# Generate one OAS per version based on the versioning extensions
 foascli split -s openapi-foas.json --env "${target_env:?}" -o ./openapi/v2/openapi.json --format all
-mv -f "openapi-foas.json" "./openapi/v2.json"
-mv -f "openapi-foas.yaml" "./openapi/v2.yaml"
+
+# Filters out the current foas, removing all extensions that are not related with versioning
+foascli filter -s openapi-foas.json --env "${target_env:?}" -o ./openapi/v2.json --format all
+
+# Moves the unfiltered OAS to the raw folder
+mv -f "openapi-foas.json" "./openapi/.raw/v2.json"
+mv -f "openapi-foas.yaml" "./openapi/.raw/v2.yaml"
 
 # Create folder if it does not exist
 mkdir -p ./openapi/v2/private
@@ -17,4 +23,4 @@ echo "Moving preview files to preview and private-preview folder"
 find ./openapi/v2 -type f -name "*private-preview*" -exec mv -f {} ./openapi/v2/private/ \;
 
 echo "Generate the versions.json file for private preview APIs"
-foascli versions --spec ./openapi/v2.json --stability-level PRIVATE-PREVIEW -o ./openapi/v2/private/versions.json --env "${target_env:?}"
+foascli versions --spec ./openapi/.raw/v2.json --stability-level PRIVATE-PREVIEW -o ./openapi/v2/private/versions.json --env "${target_env:?}"

.github/workflows/generate-openapi.yml

@@ -79,4 +79,4 @@ jobs:
           name: openapi-foas-${{ inputs.env }}
           path: |
             openapi-foas.*
-            foas-metadata.json
+            foas-metadata.json

.github/workflows/release-IPA-metrics.yml

@@ -33,7 +33,7 @@ jobs:
         run: npm install
 
       - name: Fetch OAS file from Dev Branch
-        run: curl -O "https://raw.githubusercontent.com/mongodb/openapi/refs/heads/dev/openapi/v2.json"
+        run: curl -O "https://raw.githubusercontent.com/mongodb/openapi/refs/heads/dev/openapi/.raw/v2.json"
         working-directory: ${{ github.workspace }}
 
       - name: Run Metric Collection Job

.github/workflows/spectral-lint.yml

@@ -39,11 +39,11 @@ jobs:
       - name: Spectral action
         uses: stoplightio/spectral-action@2ad0b9302e32a77c1caccf474a9b2191a8060d83
         with:
-          # Path to the OpenAPI spec files and openapi/v2.yaml
-          file_glob: openapi/v2.yaml
+          # Path to the OpenAPI spec files and openapi/.raw/v2.yaml
+          file_glob: openapi/.raw/v2.yaml
           spectral_ruleset: tools/spectral/.spectral.yaml #If updated, need to update in MMS too.
       - name: IPA validation action
         uses: stoplightio/spectral-action@2ad0b9302e32a77c1caccf474a9b2191a8060d83
         with:
-          file_glob: openapi/v2.yaml
+          file_glob: openapi/.raw/v2.yaml
           spectral_ruleset: tools/spectral/ipa/ipa-spectral.yaml

openapi/.raw/README.md

@@ -0,0 +1,3 @@
+## Raw / Unfiltered OAS
+
+The OAS stored in this folder is only useable for linting and tools that require `x-xgen` type of extensions. To leverage the already applied filters, use [v2.yaml](https://github.com/mongodb/openapi/blob/main/openapi/v2.yaml) or [v2.json](https://github.com/mongodb/openapi/blob/main/openapi/v2.json)

openapi/.raw/v2.json

@@ -7,7 +7,7 @@
         "format-check": "npx prettier . --check",
         "lint-js": "npx eslint **/*.js",
         "gen-ipa-docs": "node tools/spectral/ipa/scripts/generateRulesetReadme.js",
-        "ipa-validation": "spectral lint ./openapi/v2.yaml --ruleset=./tools/spectral/ipa/ipa-spectral.yaml",
+        "ipa-validation": "spectral lint ./openapi/.raw/v2.yaml --ruleset=./tools/spectral/ipa/ipa-spectral.yaml",
         "test": "jest",
         "precommit": "husky install"
     },

openapi/.raw/v2.yaml

@@ -19,12 +19,12 @@ setup: deps devtools ## Set up dev env
 .PHONY: linterr
 linterr: ## Run spectral linter on foas
 	@echo "==> Running spectral linter"
-	npx -- @stoplight/spectral-cli@"${SPECTRAL_VERSION}" lint ../../openapi/v2.yaml --ruleset=.spectral.yaml
+	npx -- @stoplight/spectral-cli@"${SPECTRAL_VERSION}" lint ../../openapi/.raw/v2.yaml --ruleset=.spectral.yaml
 
 .PHONY: lintwarn
 lintwarn: ## Run spectral linter on foas
 	@echo "==> Running spectral linter"
-	npx -- @stoplight/spectral-cli@"${SPECTRAL_VERSION}" lint ../../openapi/v2.yaml --ruleset=.spectral.yaml --fail-severity=warn
+	npx -- @stoplight/spectral-cli@"${SPECTRAL_VERSION}" lint ../../openapi/.raw/v2.yaml --ruleset=.spectral.yaml --fail-severity=warn
 
 .PHONY: help
 .DEFAULT_GOAL := help

package.json

@@ -19,7 +19,7 @@ To run the IPA validation locally, install necessary dependencies with `npm inst
 npm run ipa-validation
 ```
 
-This command will run Spectral CLI for the ruleset [ipa-spectral.yaml](https://github.com/mongodb/openapi/blob/main/tools/spectral/ipa/ipa-spectral.yaml) on the [v2.yaml](https://github.com/mongodb/openapi/blob/main/openapi/v2.json) OpenAPI spec.
+This command will run Spectral CLI for the ruleset [ipa-spectral.yaml](https://github.com/mongodb/openapi/blob/main/tools/spectral/ipa/ipa-spectral.yaml) on the raw [v2.yaml](https://github.com/mongodb/openapi/blob/main/openapi/.raw/v2.yaml) OpenAPI spec.
 
 The Spectral CLI can also be used to run the validation on any valid OpenAPI file (`json` or `yaml`).
 

tools/spectral/Makefile

@@ -5,7 +5,7 @@ const dirname = path.dirname(fileURLToPath(import.meta.url));
 const rootDir = path.resolve(dirname, '../../../../');
 
 const config = {
-  defaultOasFilePath: path.join(rootDir, 'openapi', 'v2.json'),
+  defaultOasFilePath: path.join(rootDir, 'openapi', '.raw', 'v2.json'),
   defaultRulesetFilePath: path.join(dirname, '..', 'ipa-spectral.yaml'),
   defaultCollectorResultsFilePath: path.join(dirname, 'scripts', 'ipa-collector-results-combined.log'),
   defaultOutputsDir: path.join(dirname, 'outputs'),