Merge remote-tracking branch 'origin/main' into CLOUDP-277336

andreaangiolillo · andreaangiolillo · commit 236d9af4dcc3 · 2024-12-12T11:49:54.000Z
diff --git a/.github/workflows/release-postman.yml b/.github/workflows/release-postman.yml
@@ -3,7 +3,7 @@ on:
   workflow_call:
     inputs:
       atlas_prod_base_url:
-        description: 'Base URL of Atlas.'
+        description: Base URL of Atlas
         required: true
         type: string
     secrets: # all secrets are passed explicitly in this workflow
diff --git a/changelog/internal/metadata.json b/changelog/internal/metadata.json
@@ -1,7 +1,7 @@
 {
-  "runDate": "2024-12-09",
-  "specRevision": "250de29f4a410f2895ff9ae84ba6ae026a644059",
-  "specRevisionShort": "250de29f4a4",
+  "runDate": "2024-12-11",
+  "specRevision": "d717f1a63591e6b4b9407f543c2091f515ae38d1",
+  "specRevisionShort": "d717f1a6359",
   "versions": [
     "2023-01-01",
     "2023-02-01",
diff --git a/openapi/v2.json b/openapi/v2.json
@@ -252,7 +252,7 @@
     "termsOfService": "https://www.mongodb.com/mongodb-management-service-terms-and-conditions",
     "title": "MongoDB Atlas Administration API",
     "version": "2.0",
-    "x-xgen-sha": "250de29f4a410f2895ff9ae84ba6ae026a644059"
+    "x-xgen-sha": "d717f1a63591e6b4b9407f543c2091f515ae38d1"
   },
   "paths": {
     "/api/atlas/v2": {
diff --git a/openapi/v2.yaml b/openapi/v2.yaml
@@ -34186,7 +34186,7 @@ info:
     termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
     title: MongoDB Atlas Administration API
     version: "2.0"
-    x-xgen-sha: 250de29f4a410f2895ff9ae84ba6ae026a644059
+    x-xgen-sha: d717f1a63591e6b4b9407f543c2091f515ae38d1
 openapi: 3.0.1
 paths:
     /api/atlas/v2:
diff --git a/openapi/v2/openapi-2023-01-01.json b/openapi/v2/openapi-2023-01-01.json
@@ -208,7 +208,7 @@
     "termsOfService": "https://www.mongodb.com/mongodb-management-service-terms-and-conditions",
     "title": "MongoDB Atlas Administration API",
     "version": "2.0",
-    "x-xgen-sha": "250de29f4a410f2895ff9ae84ba6ae026a644059"
+    "x-xgen-sha": "d717f1a63591e6b4b9407f543c2091f515ae38d1"
   },
   "paths": {
     "/api/atlas/v2": {
diff --git a/openapi/v2/openapi-2023-01-01.yaml b/openapi/v2/openapi-2023-01-01.yaml
@@ -34186,7 +34186,7 @@ info:
     termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
     title: MongoDB Atlas Administration API
     version: "2.0"
-    x-xgen-sha: 250de29f4a410f2895ff9ae84ba6ae026a644059
+    x-xgen-sha: d717f1a63591e6b4b9407f543c2091f515ae38d1
 openapi: 3.0.1
 paths:
     /api/atlas/v2:
diff --git a/openapi/v2/openapi-2023-02-01.json b/openapi/v2/openapi-2023-02-01.json
@@ -212,7 +212,7 @@
     "termsOfService": "https://www.mongodb.com/mongodb-management-service-terms-and-conditions",
     "title": "MongoDB Atlas Administration API",
     "version": "2.0",
-    "x-xgen-sha": "250de29f4a410f2895ff9ae84ba6ae026a644059"
+    "x-xgen-sha": "d717f1a63591e6b4b9407f543c2091f515ae38d1"
   },
   "paths": {
     "/api/atlas/v2": {
diff --git a/openapi/v2/openapi-2023-02-01.yaml b/openapi/v2/openapi-2023-02-01.yaml
@@ -34186,7 +34186,7 @@ info:
     termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
     title: MongoDB Atlas Administration API
     version: "2.0"
-    x-xgen-sha: 250de29f4a410f2895ff9ae84ba6ae026a644059
+    x-xgen-sha: d717f1a63591e6b4b9407f543c2091f515ae38d1
 openapi: 3.0.1
 paths:
     /api/atlas/v2:
diff --git a/openapi/v2/openapi-2023-10-01.json b/openapi/v2/openapi-2023-10-01.json
@@ -212,7 +212,7 @@
     "termsOfService": "https://www.mongodb.com/mongodb-management-service-terms-and-conditions",
     "title": "MongoDB Atlas Administration API",
     "version": "2.0",
-    "x-xgen-sha": "250de29f4a410f2895ff9ae84ba6ae026a644059"
+    "x-xgen-sha": "d717f1a63591e6b4b9407f543c2091f515ae38d1"
   },
   "paths": {
     "/api/atlas/v2": {
diff --git a/openapi/v2/openapi-2023-10-01.yaml b/openapi/v2/openapi-2023-10-01.yaml
@@ -34186,7 +34186,7 @@ info:
     termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
     title: MongoDB Atlas Administration API
     version: "2.0"
-    x-xgen-sha: 250de29f4a410f2895ff9ae84ba6ae026a644059
+    x-xgen-sha: d717f1a63591e6b4b9407f543c2091f515ae38d1
 openapi: 3.0.1
 paths:
     /api/atlas/v2:
diff --git a/openapi/v2/openapi-2023-11-15.json b/openapi/v2/openapi-2023-11-15.json
@@ -216,7 +216,7 @@
     "termsOfService": "https://www.mongodb.com/mongodb-management-service-terms-and-conditions",
     "title": "MongoDB Atlas Administration API",
     "version": "2.0",
-    "x-xgen-sha": "250de29f4a410f2895ff9ae84ba6ae026a644059"
+    "x-xgen-sha": "d717f1a63591e6b4b9407f543c2091f515ae38d1"
   },
   "paths": {
     "/api/atlas/v2": {
diff --git a/openapi/v2/openapi-2023-11-15.yaml b/openapi/v2/openapi-2023-11-15.yaml
@@ -34186,7 +34186,7 @@ info:
     termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
     title: MongoDB Atlas Administration API
     version: "2.0"
-    x-xgen-sha: 250de29f4a410f2895ff9ae84ba6ae026a644059
+    x-xgen-sha: d717f1a63591e6b4b9407f543c2091f515ae38d1
 openapi: 3.0.1
 paths:
     /api/atlas/v2:
diff --git a/openapi/v2/openapi-2024-05-30.json b/openapi/v2/openapi-2024-05-30.json
@@ -216,7 +216,7 @@
     "termsOfService": "https://www.mongodb.com/mongodb-management-service-terms-and-conditions",
     "title": "MongoDB Atlas Administration API",
     "version": "2.0",
-    "x-xgen-sha": "250de29f4a410f2895ff9ae84ba6ae026a644059"
+    "x-xgen-sha": "d717f1a63591e6b4b9407f543c2091f515ae38d1"
   },
   "paths": {
     "/api/atlas/v2": {
diff --git a/openapi/v2/openapi-2024-05-30.yaml b/openapi/v2/openapi-2024-05-30.yaml
@@ -34186,7 +34186,7 @@ info:
     termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
     title: MongoDB Atlas Administration API
     version: "2.0"
-    x-xgen-sha: 250de29f4a410f2895ff9ae84ba6ae026a644059
+    x-xgen-sha: d717f1a63591e6b4b9407f543c2091f515ae38d1
 openapi: 3.0.1
 paths:
     /api/atlas/v2:
diff --git a/openapi/v2/openapi-2024-08-05.json b/openapi/v2/openapi-2024-08-05.json
@@ -228,7 +228,7 @@
     "termsOfService": "https://www.mongodb.com/mongodb-management-service-terms-and-conditions",
     "title": "MongoDB Atlas Administration API",
     "version": "2.0",
-    "x-xgen-sha": "250de29f4a410f2895ff9ae84ba6ae026a644059"
+    "x-xgen-sha": "d717f1a63591e6b4b9407f543c2091f515ae38d1"
   },
   "paths": {
     "/api/atlas/v2": {
diff --git a/openapi/v2/openapi-2024-08-05.yaml b/openapi/v2/openapi-2024-08-05.yaml
@@ -34186,7 +34186,7 @@ info:
     termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
     title: MongoDB Atlas Administration API
     version: "2.0"
-    x-xgen-sha: 250de29f4a410f2895ff9ae84ba6ae026a644059
+    x-xgen-sha: d717f1a63591e6b4b9407f543c2091f515ae38d1
 openapi: 3.0.1
 paths:
     /api/atlas/v2:
diff --git a/openapi/v2/openapi-2024-10-23.json b/openapi/v2/openapi-2024-10-23.json
@@ -228,7 +228,7 @@
     "termsOfService": "https://www.mongodb.com/mongodb-management-service-terms-and-conditions",
     "title": "MongoDB Atlas Administration API",
     "version": "2.0",
-    "x-xgen-sha": "250de29f4a410f2895ff9ae84ba6ae026a644059"
+    "x-xgen-sha": "d717f1a63591e6b4b9407f543c2091f515ae38d1"
   },
   "paths": {
     "/api/atlas/v2": {
diff --git a/openapi/v2/openapi-2024-10-23.yaml b/openapi/v2/openapi-2024-10-23.yaml
@@ -34186,7 +34186,7 @@ info:
     termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
     title: MongoDB Atlas Administration API
     version: "2.0"
-    x-xgen-sha: 250de29f4a410f2895ff9ae84ba6ae026a644059
+    x-xgen-sha: d717f1a63591e6b4b9407f543c2091f515ae38d1
 openapi: 3.0.1
 paths:
     /api/atlas/v2:
diff --git a/openapi/v2/openapi-2024-11-13.json b/openapi/v2/openapi-2024-11-13.json
@@ -240,7 +240,7 @@
     "termsOfService": "https://www.mongodb.com/mongodb-management-service-terms-and-conditions",
     "title": "MongoDB Atlas Administration API",
     "version": "2.0",
-    "x-xgen-sha": "250de29f4a410f2895ff9ae84ba6ae026a644059"
+    "x-xgen-sha": "d717f1a63591e6b4b9407f543c2091f515ae38d1"
   },
   "paths": {
     "/api/atlas/v2": {
diff --git a/openapi/v2/openapi-2024-11-13.yaml b/openapi/v2/openapi-2024-11-13.yaml
@@ -34186,7 +34186,7 @@ info:
     termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
     title: MongoDB Atlas Administration API
     version: "2.0"
-    x-xgen-sha: 250de29f4a410f2895ff9ae84ba6ae026a644059
+    x-xgen-sha: d717f1a63591e6b4b9407f543c2091f515ae38d1
 openapi: 3.0.1
 paths:
     /api/atlas/v2:
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -13,6 +13,6 @@
         "@eslint/js": "^9.16.0",
         "eslint": "^9.16.0",
         "globals": "^15.13.0",
-        "prettier": "3.4.1"
+        "prettier": "3.4.2"
     }
 }
diff --git a/tools/postman/README.md b/tools/postman/README.md
@@ -1,25 +1,21 @@
 # Postman Collections from OpenAPI
 
-This folder contains the code required to generate the MongoDB Atlas Postman collections from the MongoDB OpenAPI Specification. All scripts can be run locally if the environment variables for POSTMAN_API_KEY, WORKSPACE_ID, BASE_URL, and SLACK_WEBHOOK_URL are set
+Folder contains the code required to generate the [MongoDB Atlas Postman collections](https://www.postman.com/mongodb-devrel?tab=collections).
+Collections are generated from from the MongoDB OpenAPI Specification. 
 
 ## Purpose of the project
 
 Scripts allow for the generation of Postman collections from OpenAPI specifications. This allows
-the [DevRel Postman workspace](https://www.postman.com/mongodb-devrel) to stay up to date with the latest version of the
+the [DevRel Postman workspace](https://www.postman.com/mongodb-devrel?tab=collections) to stay up to date with the latest version of the
 API.
 
+Process of updating involves:
+
 1. Fetching OpenAPI file
 2. Converting OpenAPI file to Postman Collection
 3. Updating information about the Collection
 4. Uploading the Collection to Postman
 
-## Postman folder structure
-
-- `openapi` - Where the OpenAPI Spec, version information, and fork files are stored
-- `tmp` - Where the Postman Collection is generated and the temporary working files are stored
-- `scripts` - Where the Bash scripts are stored
-- `validation` - Where the files for spectral validation of the generated collection is stored
-
 ## Postman Collection Generation Workflow
 
 ```mermaid
@@ -48,6 +44,20 @@ flowchart TD
 
 5. **Upload Collection to Postman**: Use the Postman API to upload the Collection to Postman.
 
+## Limitations
+
+Our Postman collection generation has several limitations, meaning some manual user actions may be necessary during setup:
+
+-  Only a single content-type header is supported generation, meaning users may have to manually update this header if the API supports more than one; see docs links on endpoint level
+- Only a single auth scheme is supported during generation, meaning users may have to update their auth on the collection level or endpoint level if not selecting the default
+
+## Postman folder structure
+
+- `openapi` - Where the OpenAPI Spec, version information, and fork files are stored
+- `tmp` - Where the Postman Collection is generated and the temporary working files are stored
+- `scripts` - Where the Bash scripts are stored
+- `validation` - Where the files for spectral validation of the generated collection is stored
+
 ## Local setup and validation
 
 ### Prerequisites
@@ -64,6 +74,7 @@ To test the scripts locally, you should set up the required environment variable
 BASE_URL=""
 WORKSPACE_ID=""
 POSTMAN_API_KEY=""
+SLACK_WEBHOOK_URL=""
 ```
 
 Run `make load-env` to set your required and overriding env vars.
@@ -78,10 +89,6 @@ Once env vars are configured, the setup scripts can be run locally using the Mak
 - `make transform_collection`
 - `make upload_collection`
 
+## Automatic updates
 
-### Limitations
-
-Our Postman collection generation has several limitations, meaning some manual user actions may be necessary during setup:
-
--  Only a single content-type header is supported generation, meaning users may have to manually update this header if the API supports more than one; see docs links on endpoint level
-- Only a single auth scheme is supported during generation, meaning users may have to update their auth on the collection level or endpoint level if not selecting the default
+Postman collection is regenerated automatically by github action [`release-spec.yml`](../../.github/workflows/release-spec.yml).
diff --git a/tools/postman/scripts/transform-for-api.sh b/tools/postman/scripts/transform-for-api.sh
@@ -59,10 +59,15 @@ jq --arg desc "$description" \
   '.collection.info.description.content = $desc' \
   intermediateCollectionWithName.json >  intermediateCollectionWithDescription.json
 
-echo "Adding baseUrl env $BASE_URL"
+echo "Removing all variables. We use environment for variables instead"
+jq \
+  '.collection.variable = []' \
+  intermediateCollectionWithDescription.json > intermediateCollectionWithNoVar.json
+
+echo "Adding baseUrl property $BASE_URL"
 jq --arg base_url "$BASE_URL" \
-  '.collection.variable[0].value = $base_url' \
-  intermediateCollectionWithDescription.json > intermediateCollectionWithBaseURL.json
+  '.collection.variable += [{ key: "baseUrl", value: $base_url }]' \
+  intermediateCollectionWithNoVar.json > intermediateCollectionWithBaseURL.json
 
 if [ "$TOGGLE_ADD_DOCS_LINKS" = "true" ]; then
   echo "Adding links to docs for each request"
@@ -130,6 +135,7 @@ rm intermediateCollectionWrapped.json \
    intermediateCollectionWithDescription.json \
    intermediateCollectionWithBaseURL.json \
    intermediateCollectionWithLinks.json \
-   intermediateCollectionPostBody.json 
+   intermediateCollectionPostBody.json \
+   intermediateCollectionWithNoVar.json
 
 popd -0
