fix(ipa): Add ignore list for nouns in OperationID Validation (#901)

sphterry · web-flow · commit fe4c9bae330e · 2025-08-19T17:52:07.000+01:00
diff --git a/tools/spectral/ipa/__tests__/IPA104ValidOperationID.test.js b/tools/spectral/ipa/__tests__/IPA104ValidOperationID.test.js
@@ -145,4 +145,18 @@ testRule('xgen-IPA-104-valid-operation-id', [
     },
     errors: [],
   },
+  {
+    name: 'valid method that needs ignoreList',
+    document: {
+      paths: {
+        '/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId} ': {
+          get: {
+            operationId: 'getGroupClusterFtsIndex',
+            'x-xgen-operation-id-override': 'getClusterFtsIndex',
+          },
+        },
+      },
+    },
+    errors: [],
+  },
 ]);
diff --git a/tools/spectral/ipa/__tests__/IPA105ValidOperationID.test.js b/tools/spectral/ipa/__tests__/IPA105ValidOperationID.test.js
@@ -136,4 +136,18 @@ testRule('xgen-IPA-105-valid-operation-id', [
     },
     errors: [],
   },
+  {
+    name: 'valid method that needs ignoreList',
+    document: {
+      paths: {
+        '/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics': {
+          get: {
+            operationId: 'listGroupHostFtsMetrics',
+            'x-xgen-operation-id-override': 'listHostFtsMetrics',
+          },
+        },
+      },
+    },
+    errors: [],
+  },
 ]);
diff --git a/tools/spectral/ipa/__tests__/IPA106ValidOperationID.test.js b/tools/spectral/ipa/__tests__/IPA106ValidOperationID.test.js
@@ -168,4 +168,18 @@ testRule('xgen-IPA-106-valid-operation-id', [
     },
     errors: [],
   },
+  {
+    name: 'valid method that needs ignoreList',
+    document: {
+      paths: {
+        '/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes': {
+          post: {
+            operationId: 'createGroupClusterFtsIndex',
+            'x-xgen-operation-id-override': 'createClusterFtsIndex',
+          },
+        },
+      },
+    },
+    errors: [],
+  },
 ]);
diff --git a/tools/spectral/ipa/__tests__/IPA107ValidOperationID.test.js b/tools/spectral/ipa/__tests__/IPA107ValidOperationID.test.js
@@ -162,4 +162,18 @@ testRule('xgen-IPA-107-valid-operation-id', [
     },
     errors: [],
   },
+  {
+    name: 'valid method that needs ignoreList',
+    document: {
+      paths: {
+        '/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}': {
+          put: {
+            operationId: 'updateGroupClusterFtsIndex',
+            'x-xgen-operation-id-override': 'updateClusterFtsIndex',
+          },
+        },
+      },
+    },
+    errors: [],
+  },
 ]);
diff --git a/tools/spectral/ipa/__tests__/IPA108ValidOperationID.test.js b/tools/spectral/ipa/__tests__/IPA108ValidOperationID.test.js
@@ -167,4 +167,18 @@ testRule('xgen-IPA-108-valid-operation-id', [
     },
     errors: [],
   },
+  {
+    name: 'valid method that needs ignoreList',
+    document: {
+      paths: {
+        '/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}': {
+          delete: {
+            operationId: 'deleteGroupClusterFtsIndex',
+            'x-xgen-operation-id-override': 'deleteClusterFtsIndex',
+          },
+        },
+      },
+    },
+    errors: [],
+  },
 ]);
diff --git a/tools/spectral/ipa/__tests__/IPA109ValidOperationID.test.js b/tools/spectral/ipa/__tests__/IPA109ValidOperationID.test.js
@@ -137,4 +137,18 @@ testRule('xgen-IPA-109-valid-operation-id', [
     },
     errors: [],
   },
+  {
+    name: 'valid method that needs ignoreList',
+    document: {
+      paths: {
+        '/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}:test': {
+          delete: {
+            operationId: 'testGroupClusterFtsIndex',
+            'x-xgen-operation-id-override': 'testClusterFtsIndex',
+          },
+        },
+      },
+    },
+    errors: [],
+  },
 ]);
diff --git a/tools/spectral/ipa/rulesets/IPA-104.yaml b/tools/spectral/ipa/rulesets/IPA-104.yaml
@@ -108,10 +108,17 @@ rules:
       Rule checks for the following conditions:
         - Applies only to GET methods on single resources or singleton resources
         - Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
+
+      ##### Configuration
+      This rule includes two configuration options:
+        - `methodName`: The verb to be used in the OperationIds
+        - `ignorePluralizationList`: Words that are allowed to maintain their assumed plurality (e.g., "Fts")
     message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-104-valid-operation-id'
     severity: warn
     given: '#GetOperationObject'
     then:
       function: 'IPA104ValidOperationID'
       functionOptions:
         methodName: 'get'
+        ignorePluralizationList:
+          - 'Fts'
diff --git a/tools/spectral/ipa/rulesets/IPA-105.yaml b/tools/spectral/ipa/rulesets/IPA-105.yaml
@@ -88,10 +88,17 @@ rules:
         - Applies only to GET methods on resource collection paths
         - Ignores singleton resources
         - Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
+
+      ##### Configuration
+      This rule includes two configuration options:
+        - `methodName`: The verb to be used in the OperationIds
+        - `ignorePluralizationList`: Words that are allowed to maintain their assumed plurality (e.g., "Fts")
     message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-105-valid-operation-id'
     severity: warn
     given: '#GetOperationObject'
     then:
       function: 'IPA105ValidOperationID'
       functionOptions:
         methodName: 'list'
+        ignorePluralizationList:
+          - 'Fts'
diff --git a/tools/spectral/ipa/rulesets/IPA-106.yaml b/tools/spectral/ipa/rulesets/IPA-106.yaml
@@ -122,10 +122,17 @@ rules:
       Rule checks for the following conditions:
         - Applies only to POST methods that are not [custom methods](https://mongodb.github.io/ipa/109)
         - Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
+
+      ##### Configuration
+      This rule includes two configuration options:
+        - `methodName`: The verb to be used in the OperationIds
+        - `ignorePluralizationList`: Words that are allowed to maintain their assumed plurality (e.g., "Fts")
     message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-106-valid-operation-id'
     severity: warn
     given: '#CreateOperationObject'
     then:
       function: 'IPA106ValidOperationID'
       functionOptions:
         methodName: 'create'
+        ignorePluralizationList:
+          - 'Fts'
diff --git a/tools/spectral/ipa/rulesets/IPA-107.yaml b/tools/spectral/ipa/rulesets/IPA-107.yaml
@@ -123,10 +123,17 @@ rules:
       Rule checks for the following conditions:
         - Applies only to PUT/PATCH methods that are not [custom methods](https://mongodb.github.io/ipa/109)
         - Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
+
+      ##### Configuration
+      This rule includes two configuration options:
+        - `methodName`: The verb to be used in the OperationIds
+        - `ignorePluralizationList`: Words that are allowed to maintain their assumed plurality (e.g., "Fts")
     message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-107-valid-operation-id'
     severity: warn
     given: '#UpdateOperationObject'
     then:
       function: 'IPA107ValidOperationID'
       functionOptions:
         methodName: 'update'
+        ignorePluralizationList:
+          - 'Fts'
diff --git a/tools/spectral/ipa/rulesets/IPA-108.yaml b/tools/spectral/ipa/rulesets/IPA-108.yaml
@@ -64,13 +64,19 @@ rules:
       Rule checks for the following conditions:
         - Applies only to DELETE methods that are not [custom methods](https://mongodb.github.io/ipa/109)
         - Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
+      ##### Configuration
+      This rule includes two configuration options:
+        - `methodName`: The verb to be used in the OperationIds
+        - `ignorePluralizationList`: Words that are allowed to maintain their assumed plurality (e.g., "Fts")
     message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-108-valid-operation-id'
     severity: warn
     given: '#DeleteOperationObject'
     then:
       function: 'IPA108ValidOperationID'
       functionOptions:
         methodName: 'delete'
+        ignorePluralizationList:
+          - 'Fts'
 
 functions:
   - IPA108DeleteMethodResponseShouldNotHaveSchema
diff --git a/tools/spectral/ipa/rulesets/IPA-109.yaml b/tools/spectral/ipa/rulesets/IPA-109.yaml
@@ -70,8 +70,15 @@ rules:
       Rule checks for the following conditions:
         - Applies only to paths containing custom method identifiers (with colon format)
         - Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
+
+      ##### Configuration
+      This rule includes one configuration options:
+        - `ignorePluralizationList`: Words that are allowed to maintain their assumed plurality (e.g., "Fts")
     message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-109-valid-operation-id'
     severity: warn
     given: '$.paths[*][*]'
     then:
       function: 'IPA109ValidOperationID'
+      functionOptions:
+        ignorePluralizationList:
+          - 'Fts'
diff --git a/tools/spectral/ipa/rulesets/README.md b/tools/spectral/ipa/rulesets/README.md
@@ -154,6 +154,11 @@ Rule checks for the following conditions:
   - Applies only to GET methods on single resources or singleton resources
   - Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
 
+##### Configuration
+This rule includes two configuration options:
+  - `methodName`: The verb to be used in the OperationIds
+  - `ignorePluralizationList`: Words that are allowed to maintain their assumed plurality (e.g., "Fts")
+
 
 
 ### IPA-105
@@ -220,6 +225,11 @@ Rule checks for the following conditions:
   - Ignores singleton resources
   - Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
 
+##### Configuration
+This rule includes two configuration options:
+  - `methodName`: The verb to be used in the OperationIds
+  - `ignorePluralizationList`: Words that are allowed to maintain their assumed plurality (e.g., "Fts")
+
 
 
 ### IPA-106
@@ -311,6 +321,11 @@ Rule checks for the following conditions:
   - Applies only to POST methods that are not [custom methods](https://mongodb.github.io/ipa/109)
   - Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
 
+##### Configuration
+This rule includes two configuration options:
+  - `methodName`: The verb to be used in the OperationIds
+  - `ignorePluralizationList`: Words that are allowed to maintain their assumed plurality (e.g., "Fts")
+
 
 
 ### IPA-107
@@ -394,6 +409,11 @@ Rule checks for the following conditions:
   - Applies only to PUT/PATCH methods that are not [custom methods](https://mongodb.github.io/ipa/109)
   - Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
 
+##### Configuration
+This rule includes two configuration options:
+  - `methodName`: The verb to be used in the OperationIds
+  - `ignorePluralizationList`: Words that are allowed to maintain their assumed plurality (e.g., "Fts")
+
 
 
 ### IPA-108
@@ -448,6 +468,10 @@ The noun(s) in the Operation ID should be the collection identifiers from the re
 Rule checks for the following conditions:
   - Applies only to DELETE methods that are not [custom methods](https://mongodb.github.io/ipa/109)
   - Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
+##### Configuration
+This rule includes two configuration options:
+  - `methodName`: The verb to be used in the OperationIds
+  - `ignorePluralizationList`: Words that are allowed to maintain their assumed plurality (e.g., "Fts")
 
 
 
@@ -509,6 +533,10 @@ Rule checks for the following conditions:
   - Applies only to paths containing custom method identifiers (with colon format)
   - Confirms that the existing OperationId is compliant with generated IPA Compliant OperationId
 
+##### Configuration
+This rule includes one configuration options:
+  - `ignorePluralizationList`: Words that are allowed to maintain their assumed plurality (e.g., "Fts")
+
 
 
 ### IPA-110
diff --git a/tools/spectral/ipa/rulesets/functions/IPA104ValidOperationID.js b/tools/spectral/ipa/rulesets/functions/IPA104ValidOperationID.js
@@ -6,7 +6,7 @@ import { validateOperationIdAndReturnErrors } from './utils/validations/validate
 
 const RULE_NAME = 'xgen-IPA-104-valid-operation-id';
 
-export default (input, { methodName }, { path, documentInventory }) => {
+export default (input, { methodName, ignorePluralizationList }, { path, documentInventory }) => {
   const resourcePath = path[1];
   const oas = documentInventory.resolved;
   const resourcePaths = getResourcePathItems(resourcePath, oas.paths);
@@ -23,7 +23,7 @@ export default (input, { methodName }, { path, documentInventory }) => {
     if (hasMethodVerbOverride(input, methodName)) {
       methodName = input[VERB_OVERRIDE_EXTENSION].verb;
     }
-    const errors = validateOperationIdAndReturnErrors(methodName, resourcePath, input, path);
+    const errors = validateOperationIdAndReturnErrors(methodName, resourcePath, input, path, ignorePluralizationList);
 
     return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, input, path);
   } catch (e) {
diff --git a/tools/spectral/ipa/rulesets/functions/IPA105ValidOperationID.js b/tools/spectral/ipa/rulesets/functions/IPA105ValidOperationID.js
@@ -6,7 +6,7 @@ import { validateOperationIdAndReturnErrors } from './utils/validations/validate
 
 const RULE_NAME = 'xgen-IPA-105-valid-operation-id';
 
-export default (input, { methodName }, { path, documentInventory }) => {
+export default (input, { methodName, ignorePluralizationList }, { path, documentInventory }) => {
   const resourcePath = path[1];
   const oas = documentInventory.resolved;
   const resourcePaths = getResourcePathItems(resourcePath, oas.paths);
@@ -24,7 +24,7 @@ export default (input, { methodName }, { path, documentInventory }) => {
   }
 
   try {
-    const errors = validateOperationIdAndReturnErrors(methodName, resourcePath, input, path);
+    const errors = validateOperationIdAndReturnErrors(methodName, resourcePath, input, path, ignorePluralizationList);
     return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, input, path);
   } catch (e) {
     return handleInternalError(RULE_NAME, path, e);
diff --git a/tools/spectral/ipa/rulesets/functions/IPA106ValidOperationID.js b/tools/spectral/ipa/rulesets/functions/IPA106ValidOperationID.js
@@ -5,7 +5,7 @@ import { validateOperationIdAndReturnErrors } from './utils/validations/validate
 
 const RULE_NAME = 'xgen-IPA-106-valid-operation-id';
 
-export default (input, { methodName }, { path }) => {
+export default (input, { methodName, ignorePluralizationList }, { path }) => {
   const resourcePath = path[1];
 
   if (hasCustomMethodOverride(input) || isCustomMethodIdentifier(resourcePath)) {
@@ -17,7 +17,7 @@ export default (input, { methodName }, { path }) => {
   }
 
   try {
-    const errors = validateOperationIdAndReturnErrors(methodName, resourcePath, input, path);
+    const errors = validateOperationIdAndReturnErrors(methodName, resourcePath, input, path, ignorePluralizationList);
     return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, input, path);
   } catch (e) {
     return handleInternalError(RULE_NAME, path, e);
diff --git a/tools/spectral/ipa/rulesets/functions/IPA107ValidOperationID.js b/tools/spectral/ipa/rulesets/functions/IPA107ValidOperationID.js
@@ -5,7 +5,7 @@ import { validateOperationIdAndReturnErrors } from './utils/validations/validate
 
 const RULE_NAME = 'xgen-IPA-107-valid-operation-id';
 
-export default (input, { methodName }, { path }) => {
+export default (input, { methodName, ignorePluralizationList }, { path }) => {
   const resourcePath = path[1];
 
   if (isCustomMethodIdentifier(resourcePath) || hasCustomMethodOverride(input)) {
@@ -17,7 +17,7 @@ export default (input, { methodName }, { path }) => {
   }
 
   try {
-    const errors = validateOperationIdAndReturnErrors(methodName, resourcePath, input, path);
+    const errors = validateOperationIdAndReturnErrors(methodName, resourcePath, input, path, ignorePluralizationList);
     return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, input, path);
   } catch (e) {
     return handleInternalError(RULE_NAME, path, e);
diff --git a/tools/spectral/ipa/rulesets/functions/IPA108ValidOperationID.js b/tools/spectral/ipa/rulesets/functions/IPA108ValidOperationID.js
@@ -5,7 +5,7 @@ import { validateOperationIdAndReturnErrors } from './utils/validations/validate
 
 const RULE_NAME = 'xgen-IPA-108-valid-operation-id';
 
-export default (input, { methodName }, { path }) => {
+export default (input, { methodName, ignorePluralizationList }, { path }) => {
   const resourcePath = path[1];
 
   if (isCustomMethodIdentifier(resourcePath) || hasCustomMethodOverride(input)) {
@@ -17,7 +17,7 @@ export default (input, { methodName }, { path }) => {
   }
 
   try {
-    const errors = validateOperationIdAndReturnErrors(methodName, resourcePath, input, path);
+    const errors = validateOperationIdAndReturnErrors(methodName, resourcePath, input, path, ignorePluralizationList);
     return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, input, path);
   } catch (e) {
     return handleInternalError(RULE_NAME, path, e);
diff --git a/tools/spectral/ipa/rulesets/functions/IPA109ValidOperationID.js b/tools/spectral/ipa/rulesets/functions/IPA109ValidOperationID.js
@@ -5,7 +5,7 @@ import { validateOperationIdAndReturnErrors } from './utils/validations/validate
 
 const RULE_NAME = 'xgen-IPA-109-valid-operation-id';
 
-export default (input, _, { path }) => {
+export default (input, { ignorePluralizationList }, { path }) => {
   const resourcePath = path[1];
 
   if (!isCustomMethodIdentifier(resourcePath) && !hasCustomMethodOverride(input)) {
@@ -28,7 +28,7 @@ export default (input, _, { path }) => {
       return;
     }
 
-    const errors = validateOperationIdAndReturnErrors(methodName, endpointUrl, input, path);
+    const errors = validateOperationIdAndReturnErrors(methodName, endpointUrl, input, path, ignorePluralizationList);
     return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, input, path);
   } catch (e) {
     return handleInternalError(RULE_NAME, path, e);
diff --git a/tools/spectral/ipa/rulesets/functions/utils/operationIdGeneration.js b/tools/spectral/ipa/rulesets/functions/utils/operationIdGeneration.js
diff --git a/tools/spectral/ipa/rulesets/functions/utils/validations/validateOperationIdAndReturnErrors.js b/tools/spectral/ipa/rulesets/functions/utils/validations/validateOperationIdAndReturnErrors.js
