Merge branch 'main' into CLOUDP-304053/fix

Author: yelizhenden-mdb

.github/scripts/split_spec.sh

@@ -6,9 +6,16 @@ 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
+mkdir -p ./openapi/.raw
+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 +24,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

.husky/pre-commit

@@ -1,4 +1,6 @@
 {
   "**/*.{js,jsx,ts,tsx,json,md}": ["prettier --write"],
-  "**/*.js": ["jest --findRelatedTests --passWithNoTests"]
+  "**/*.js": ["jest --findRelatedTests --passWithNoTests"],
+  "tools/spectral/ipa/**/*.yaml": ["node tools/spectral/ipa/scripts/generateRulesetReadme.js"],
+  "**/*.go": ["./tools/cli/precommit.sh"]
 }

.lintstagedrc.json

@@ -7,6 +7,7 @@
 - Node.js v20 or later
 - npm v8 or later
 - Git
+- Go 1.21 or later (for CLI development)
 
 ### Installation
 
@@ -21,11 +22,17 @@
    npm install
    ```
 
-3. Set up Git hooks (optional):
+3. Set up Git hooks (recommended):
    ```bash
    npm run precommit
    ```
 
+4. If working on the Go CLI, set up the Go environment:
+   ```bash
+   cd tools/cli
+   make setup
+   ```
+
 This will install Husky, which manages Git hooks for the project. The hooks ensure code quality by automatically running various checks before commits.
 
 ## Development Workflow
@@ -34,16 +41,28 @@ This will install Husky, which manages Git hooks for the project. The hooks ensu
 
 This project uses the following Git hooks:
 
-- **pre-commit**: Automatically formats your code using Prettier and runs tests for staged JavaScript files to ensure code quality before each commit.
+- **pre-commit**: 
+  - Automatically formats your code using Prettier and runs tests for staged JavaScript files 
+  - If you get the message `hint: The '.husky/pre-commit' hook was ignored because it's not set as executable.` during the commit, you can run `chmod ug+x .husky/*` to make it executable.
+  - For Go files, runs formatting, linting, and tests using the project's Makefile
 
 ### Available Scripts
 
+#### JavaScript/Node.js
 - `npm run format` - Format all files with Prettier
 - `npm run format-check` - Check formatting without modifying files
 - `npm run lint-js` - Lint JavaScript files
 - `npm run test` - Run all tests
 
 #### IPA specific targets
-
 - `npm run gen-ipa-docs` - Generate IPA ruleset documentation (see `./tools` folder for more information)
 - `npm run ipa-validation` - Run OpenAPI validation with Spectral
+
+#### Go OpenAPI CLI (internal) 
+When working in the `tools/cli` directory:
+- `make fmt` - Format Go code
+- `make lint` - Run golangci-lint
+- `make unit-test` - Run Go unit tests
+- `make e2e-test` - Run end-to-end tests
+- `make build` - Build the CLI binary
+- `make gen-docs` - Generate CLI documentation

CONTRIBUTING.md

@@ -1,7 +1,7 @@
 {
   "runDate": "2025-03-11",
-  "specRevision": "039e6ac71118273c1be2ea529b26035b1b884a00",
-  "specRevisionShort": "039e6ac7111",
+  "specRevision": "9c739cc8a51f69b2bf5ffc8178fd1d28b63bae65",
+  "specRevisionShort": "9c739cc8a51",
   "versions": [
     "2023-01-01",
     "2023-02-01",

changelog/internal/metadata.json

@@ -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)