CLOUDP-304929: exceptions on the each path

Author: wtrocki

tools/spectral/ipa/__tests__/IPA102CollectionIdentifierCamelCase.test.js

@@ -124,14 +124,67 @@ testRule('xgen-IPA-102-collection-identifier-camelCase', [
     document: {
       paths: {
         '/resource_groups': {
-          'x-xgen-IPA-exception': {
-            'xgen-IPA-102-collection-identifier-camelCase': 'Legacy API path that cannot be changed',
+          get: {
+            'x-xgen-IPA-exception': {
+              'xgen-IPA-102-collection-identifier-camelCase': 'Legacy API path that cannot be changed',
+            },
+          },
+          delete: {
+            'x-xgen-IPA-exception': {
+              'xgen-IPA-102-collection-identifier-camelCase': 'Legacy API path that cannot be changed',
+            },
+          },
+        },
+      },
+    },
+    errors: [],
+  },
+  {
+    name: 'valid with all methods having exceptions (every method needs exception)',
+    document: {
+      paths: {
+        '/resource_groups': {
+          get: {
+            'x-xgen-IPA-exception': {
+              'xgen-IPA-102-collection-identifier-camelCase': 'Legacy API path that cannot be changed',
+            },
+          },
+          delete: {
+            'x-xgen-IPA-exception': {
+              'xgen-IPA-102-collection-identifier-camelCase': 'Legacy API path that cannot be changed',
+            },
           },
         },
       },
     },
     errors: [],
   },
+  {
+    name: 'invalid when not all methods have exceptions',
+    document: {
+      paths: {
+        '/resource_groups': {
+          get: {
+            'x-xgen-IPA-exception': {
+              'xgen-IPA-102-collection-identifier-camelCase': 'Legacy API path that cannot be changed',
+            },
+          },
+          post: {
+            description: 'This method has no exception',
+          },
+        },
+      },
+    },
+    errors: [
+      {
+        code: 'xgen-IPA-102-collection-identifier-camelCase',
+        message:
+          "Collection identifiers must be in camelCase. Path segment 'resource_groups' in path '/resource_groups' is not in camelCase.",
+        path: ['paths', '/resource_groups'],
+        severity: DiagnosticSeverity.Warning,
+      },
+    ],
+  },
   {
     name: 'reports violations for paths with double slashes',
     document: {

tools/spectral/ipa/rulesets/IPA-102.yaml

@@ -14,7 +14,7 @@ rules:
          - Path parameters should also follow camelCase naming
          - Certain values can be exempted via the ignoredValues configuration that can be supplied as `ignoredValues` 
          argument to the rule
-         - Paths with `x-xgen-IPA-exception` for this rule are excluded from validation
+         - Each operation within path with `x-xgen-IPA-exception` are excluded from validation
          - Double slashes (//) are not allowed in paths
 
     message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-102-collection-identifier-camelCase'

tools/spectral/ipa/rulesets/functions/IPA102CollectionIdentifierCamelCase.js

@@ -4,7 +4,7 @@ import {
   collectException,
   handleInternalError,
 } from './utils/collectionUtils.js';
-import { hasException } from './utils/exceptions.js';
+import { hasExceptionInEveryHttpMethod } from './utils/exceptions.js';
 import { isPathParam } from './utils/componentUtils.js';
 import { casing } from '@stoplight/spectral-functions';
 
@@ -22,10 +22,12 @@ export default (input, options, { path, documentInventory }) => {
   const oas = documentInventory.resolved;
   const pathKey = input;
 
-  // Check for exception at the path level
-  if (hasException(oas.paths[input], RULE_NAME)) {
-    collectException(oas.paths[input], RULE_NAME, path);
-    return;
+  if (oas.paths[input]) {
+    const pathItem = oas.paths[input];
+    if (hasExceptionInEveryHttpMethod(pathItem, RULE_NAME)) {
+      collectException(pathItem, RULE_NAME, path);
+      return;
+    }
   }
 
   // Extract ignored values from options

tools/spectral/ipa/rulesets/functions/utils/exceptions.js

@@ -13,3 +13,23 @@ export function hasException(object, ruleName) {
   }
   return false;
 }
+
+/**
+ * Checks if every HTTP method in the path item has an exception for the specified rule
+ * Only considers methods that actually exist in the path item
+ *
+ * @param {object} pathItem - The path item object containing HTTP methods
+ * @param {string} ruleName - The name of the rule to check for exceptions
+ * @returns {boolean} true if every HTTP method has an exception for the rule, otherwise false
+ */
+export function hasExceptionInEveryHttpMethod(pathItem, ruleName) {
+  if (!pathItem) return false;
+  const httpMethods = ['get', 'post', 'put', 'delete', 'patch', 'options', 'head'];
+  const existingMethods = httpMethods.filter((method) => pathItem[method]);
+
+  // If no HTTP methods exist, return false
+  if (existingMethods.length === 0) return false;
+
+  // Check if every existing HTTP method has the exception
+  return existingMethods.every((method) => hasException(pathItem[method], ruleName));
+}