Merge branch 'main' into CLOUDP-304938

lovisaberggren · lovisaberggren · commit ade7f67fe8c5 · 2025-03-14T12:27:27.000Z
diff --git a/changelog/internal/metadata.json b/changelog/internal/metadata.json
@@ -1,7 +1,7 @@
 {
-  "runDate": "2025-03-13",
-  "specRevision": "ea31b246dee192e28f29a05b89b2138479429cfa",
-  "specRevisionShort": "ea31b246dee",
+  "runDate": "2025-03-14",
+  "specRevision": "6e79a1caa25bee7ead84d18635ddab957449060d",
+  "specRevisionShort": "6e79a1caa25",
   "versions": [
     "2023-01-01",
     "2023-02-01",
diff --git a/openapi/.raw/v2.json b/openapi/.raw/v2.json
@@ -256,7 +256,7 @@
     "termsOfService": "https://www.mongodb.com/mongodb-management-service-terms-and-conditions",
     "title": "MongoDB Atlas Administration API",
     "version": "2.0",
-    "x-xgen-sha": "ea31b246dee192e28f29a05b89b2138479429cfa"
+    "x-xgen-sha": "6e79a1caa25bee7ead84d18635ddab957449060d"
   },
   "paths": {
     "/api/atlas/v2": {
diff --git a/openapi/.raw/v2.yaml b/openapi/.raw/v2.yaml
@@ -34932,7 +34932,7 @@ info:
     termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
     title: MongoDB Atlas Administration API
     version: "2.0"
-    x-xgen-sha: ea31b246dee192e28f29a05b89b2138479429cfa
+    x-xgen-sha: 6e79a1caa25bee7ead84d18635ddab957449060d
 openapi: 3.0.1
 paths:
     /api/atlas/v2:
diff --git a/openapi/v2.json b/openapi/v2.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": "ea31b246dee192e28f29a05b89b2138479429cfa"
+    "x-xgen-sha": "6e79a1caa25bee7ead84d18635ddab957449060d"
   },
   "paths": {
     "/api/atlas/v2": {
diff --git a/openapi/v2.yaml b/openapi/v2.yaml
@@ -34728,7 +34728,7 @@ info:
     termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
     title: MongoDB Atlas Administration API
     version: "2.0"
-    x-xgen-sha: ea31b246dee192e28f29a05b89b2138479429cfa
+    x-xgen-sha: 6e79a1caa25bee7ead84d18635ddab957449060d
 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": "ea31b246dee192e28f29a05b89b2138479429cfa"
+    "x-xgen-sha": "6e79a1caa25bee7ead84d18635ddab957449060d"
   },
   "paths": {
     "/api/atlas/v2": {
diff --git a/openapi/v2/openapi-2023-01-01.yaml b/openapi/v2/openapi-2023-01-01.yaml
@@ -34728,7 +34728,7 @@ info:
     termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
     title: MongoDB Atlas Administration API
     version: "2.0"
-    x-xgen-sha: ea31b246dee192e28f29a05b89b2138479429cfa
+    x-xgen-sha: 6e79a1caa25bee7ead84d18635ddab957449060d
 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": "ea31b246dee192e28f29a05b89b2138479429cfa"
+    "x-xgen-sha": "6e79a1caa25bee7ead84d18635ddab957449060d"
   },
   "paths": {
     "/api/atlas/v2": {
diff --git a/openapi/v2/openapi-2023-02-01.yaml b/openapi/v2/openapi-2023-02-01.yaml
@@ -34728,7 +34728,7 @@ info:
     termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
     title: MongoDB Atlas Administration API
     version: "2.0"
-    x-xgen-sha: ea31b246dee192e28f29a05b89b2138479429cfa
+    x-xgen-sha: 6e79a1caa25bee7ead84d18635ddab957449060d
 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": "ea31b246dee192e28f29a05b89b2138479429cfa"
+    "x-xgen-sha": "6e79a1caa25bee7ead84d18635ddab957449060d"
   },
   "paths": {
     "/api/atlas/v2": {
diff --git a/openapi/v2/openapi-2023-10-01.yaml b/openapi/v2/openapi-2023-10-01.yaml
@@ -34728,7 +34728,7 @@ info:
     termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
     title: MongoDB Atlas Administration API
     version: "2.0"
-    x-xgen-sha: ea31b246dee192e28f29a05b89b2138479429cfa
+    x-xgen-sha: 6e79a1caa25bee7ead84d18635ddab957449060d
 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": "ea31b246dee192e28f29a05b89b2138479429cfa"
+    "x-xgen-sha": "6e79a1caa25bee7ead84d18635ddab957449060d"
   },
   "paths": {
     "/api/atlas/v2": {
diff --git a/openapi/v2/openapi-2023-11-15.yaml b/openapi/v2/openapi-2023-11-15.yaml
@@ -34728,7 +34728,7 @@ info:
     termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
     title: MongoDB Atlas Administration API
     version: "2.0"
-    x-xgen-sha: ea31b246dee192e28f29a05b89b2138479429cfa
+    x-xgen-sha: 6e79a1caa25bee7ead84d18635ddab957449060d
 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": "ea31b246dee192e28f29a05b89b2138479429cfa"
+    "x-xgen-sha": "6e79a1caa25bee7ead84d18635ddab957449060d"
   },
   "paths": {
     "/api/atlas/v2": {
diff --git a/openapi/v2/openapi-2024-05-30.yaml b/openapi/v2/openapi-2024-05-30.yaml
@@ -34728,7 +34728,7 @@ info:
     termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
     title: MongoDB Atlas Administration API
     version: "2.0"
-    x-xgen-sha: ea31b246dee192e28f29a05b89b2138479429cfa
+    x-xgen-sha: 6e79a1caa25bee7ead84d18635ddab957449060d
 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": "ea31b246dee192e28f29a05b89b2138479429cfa"
+    "x-xgen-sha": "6e79a1caa25bee7ead84d18635ddab957449060d"
   },
   "paths": {
     "/api/atlas/v2": {
diff --git a/openapi/v2/openapi-2024-08-05.yaml b/openapi/v2/openapi-2024-08-05.yaml
@@ -34728,7 +34728,7 @@ info:
     termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
     title: MongoDB Atlas Administration API
     version: "2.0"
-    x-xgen-sha: ea31b246dee192e28f29a05b89b2138479429cfa
+    x-xgen-sha: 6e79a1caa25bee7ead84d18635ddab957449060d
 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": "ea31b246dee192e28f29a05b89b2138479429cfa"
+    "x-xgen-sha": "6e79a1caa25bee7ead84d18635ddab957449060d"
   },
   "paths": {
     "/api/atlas/v2": {
diff --git a/openapi/v2/openapi-2024-10-23.yaml b/openapi/v2/openapi-2024-10-23.yaml
@@ -34728,7 +34728,7 @@ info:
     termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
     title: MongoDB Atlas Administration API
     version: "2.0"
-    x-xgen-sha: ea31b246dee192e28f29a05b89b2138479429cfa
+    x-xgen-sha: 6e79a1caa25bee7ead84d18635ddab957449060d
 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": "ea31b246dee192e28f29a05b89b2138479429cfa"
+    "x-xgen-sha": "6e79a1caa25bee7ead84d18635ddab957449060d"
   },
   "paths": {
     "/api/atlas/v2": {
diff --git a/openapi/v2/openapi-2024-11-13.yaml b/openapi/v2/openapi-2024-11-13.yaml
@@ -34728,7 +34728,7 @@ info:
     termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
     title: MongoDB Atlas Administration API
     version: "2.0"
-    x-xgen-sha: ea31b246dee192e28f29a05b89b2138479429cfa
+    x-xgen-sha: 6e79a1caa25bee7ead84d18635ddab957449060d
 openapi: 3.0.1
 paths:
     /api/atlas/v2:
diff --git a/openapi/v2/openapi-2025-02-19.json b/openapi/v2/openapi-2025-02-19.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": "ea31b246dee192e28f29a05b89b2138479429cfa"
+    "x-xgen-sha": "6e79a1caa25bee7ead84d18635ddab957449060d"
   },
   "paths": {
     "/api/atlas/v2": {
diff --git a/openapi/v2/openapi-2025-02-19.yaml b/openapi/v2/openapi-2025-02-19.yaml
@@ -34728,7 +34728,7 @@ info:
     termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
     title: MongoDB Atlas Administration API
     version: "2.0"
-    x-xgen-sha: ea31b246dee192e28f29a05b89b2138479429cfa
+    x-xgen-sha: 6e79a1caa25bee7ead84d18635ddab957449060d
 openapi: 3.0.1
 paths:
     /api/atlas/v2:
diff --git a/openapi/v2/openapi-2025-03-12.json b/openapi/v2/openapi-2025-03-12.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": "ea31b246dee192e28f29a05b89b2138479429cfa"
+    "x-xgen-sha": "6e79a1caa25bee7ead84d18635ddab957449060d"
   },
   "paths": {
     "/api/atlas/v2": {
diff --git a/openapi/v2/openapi-2025-03-12.yaml b/openapi/v2/openapi-2025-03-12.yaml
@@ -34728,7 +34728,7 @@ info:
     termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
     title: MongoDB Atlas Administration API
     version: "2.0"
-    x-xgen-sha: ea31b246dee192e28f29a05b89b2138479429cfa
+    x-xgen-sha: 6e79a1caa25bee7ead84d18635ddab957449060d
 openapi: 3.0.1
 paths:
     /api/atlas/v2:
diff --git a/package.json b/package.json
@@ -7,7 +7,8 @@
         "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/.raw/v2.yaml --ruleset=./tools/spectral/ipa/ipa-spectral.yaml",
+        "ipa-validation": "spectral lint  ./openapi/.raw/v2.yaml --ruleset=./tools/spectral/ipa/ipa-spectral.yaml",
+        "ipa-filter-violations": "node tools/spectral/ipa/scripts/filter-ipa-violations.js",
         "spectral-validation": "spectral lint ./openapi/.raw/v2.yaml --ruleset=./tools/spectral/.spectral.yaml",
         "test": "jest",
         "precommit": "husky install"
diff --git a/tools/spectral/ipa/__tests__/utils/resourceEvaluation.test.js b/tools/spectral/ipa/__tests__/utils/resourceEvaluation.test.js
@@ -227,6 +227,11 @@ describe('tools/spectral/ipa/rulesets/functions/utils/resourceEvaluation.js', ()
         path: '/resourceOne/{id}/{id}',
         isSingleResourceIdentifier: false,
       },
+      {
+        description: 'invalid single identifier',
+        path: '/resource/resource/{id}',
+        isSingleResourceIdentifier: false,
+      },
       {
         description: 'single identifier',
         path: '/resource/{id}',
diff --git a/tools/spectral/ipa/rulesets/functions/utils/resourceEvaluation.js b/tools/spectral/ipa/rulesets/functions/utils/resourceEvaluation.js
@@ -20,15 +20,33 @@ export function isResourceCollectionIdentifier(path) {
 /**
  * Checks if a path represents a single resource. For example:
  * '/resource/{id}' returns true
+ * '/resource/{resourceId}/child/{childId}' returns true
  * '/resource/{id}/child' returns false
- * '/resource/{id}/{id}' returns false
+ * '/resource' returns false
+ * '/resource/child/{id}' returns false
  *
  * @param {string} path the path to evaluate
  * @returns {boolean} true if the path represents a single resource, false otherwise
  */
 export function isSingleResourceIdentifier(path) {
-  const pattern = new RegExp(`^.*/[a-zA-Z]+/{[a-zA-Z]+}$`);
-  return pattern.test(path);
+  const p = removePrefix(path);
+
+  // Check if the path ends with /{paramName} pattern
+  const endsWithParamPattern = /\/\{[a-zA-Z][a-zA-Z0-9]*}$/;
+
+  if (!endsWithParamPattern.test(p)) {
+    return false;
+  }
+
+  // Extract the part before the final parameter
+  const lastSlashBeforeParam = p.lastIndexOf('/');
+  if (lastSlashBeforeParam === -1) {
+    return false;
+  }
+
+  // Check if the preceding part is a valid resource collection identifier
+  const collectionPath = p.substring(0, lastSlashBeforeParam);
+  return isResourceCollectionIdentifier(collectionPath);
 }
 
 export function isCustomMethodIdentifier(path) {
diff --git a/tools/spectral/ipa/scripts/filter-ipa-violations.js b/tools/spectral/ipa/scripts/filter-ipa-violations.js
@@ -0,0 +1,85 @@
+import fs from 'node:fs/promises';
+import { execSync } from 'child_process';
+import path from 'path';
+
+async function filterIpaViolations() {
+  try {
+    // Check if rule ID is provided
+    const ruleId = process.argv[2];
+    if (!ruleId) {
+      console.error('Usage: node filter-ipa-violations.js <rule-id>');
+      console.error('Example: node filter-ipa-violations.js xgen-IPA-102-collection-identifier-camelCase');
+      process.exit(1);
+    }
+
+    const outputFile = path.join(process.cwd(), `${ruleId}-violations.md`);
+
+    console.log(`Filtering violations for rule ID: ${ruleId}`);
+    console.log('Running IPA validation...');
+
+    let validationOutput;
+    try {
+      // Run IPA validation and get output as JSON
+      execSync(
+        'spectral lint --format=json -o results.json ./openapi/.raw/v2.yaml --ruleset=./tools/spectral/ipa/ipa-spectral.yaml',
+        {
+          encoding: 'utf-8',
+          timeout: 4000,
+          maxBuffer: 10 * 1024 * 1024,
+        }
+      );
+    } catch (error) {
+      console.error('Error (expected):', error.message);
+    }
+
+    // Read the JSON output
+    validationOutput = await fs.readFile('results.json', 'utf-8');
+    console.log('Filtering results...');
+
+    // Parse the JSON output
+    const validationResults = JSON.parse(validationOutput);
+
+    // Filter results for the exact specified rule ID
+    const filteredResults = validationResults.filter((violation) => violation.code === ruleId);
+
+    // Group by source file
+    const groupedBySource = filteredResults.reduce((acc, violation) => {
+      const source = violation.source;
+      if (!acc[source]) {
+        acc[source] = [];
+      }
+      acc[source].push({
+        path: violation.path,
+        message: violation.message,
+        source: violation.source,
+      });
+      return acc;
+    }, {});
+
+    // Generate markdown content
+    let markdownContent = `# ${ruleId} Violations Checklist\n\n`;
+    markdownContent += `Generated on: ${new Date().toLocaleString()}\n\n`;
+
+    Object.keys(groupedBySource).forEach((source) => {
+      const violations = groupedBySource[source];
+
+      violations.forEach((violation) => {
+        markdownContent += `## ${violation.source}\n\n`;
+        markdownContent += `Path: \`${violation.path.join('/')}\`\n\n`;
+        markdownContent += `- [ ] Fixed\n\n`;
+      });
+    });
+
+    // Write the markdown file
+    await fs.writeFile(outputFile, markdownContent, 'utf-8');
+
+    const violationCount = filteredResults.length;
+    console.log(`Results saved to ${outputFile}`);
+    console.log(`Found ${violationCount} violations to fix`);
+  } catch (error) {
+    console.error('Error:', error.message);
+    process.exit(1);
+  }
+}
+
+filterIpaViolations();
