Alter name to 'ignorePluralizationList' and add documentation

Sophia Marie Terry · Sophia Marie Terry · commit 506eec045b89 · 2025-08-19T17:35:11.000+01:00
diff --git a/tools/spectral/ipa/rulesets/IPA-104.yaml b/tools/spectral/ipa/rulesets/IPA-104.yaml
@@ -108,12 +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'
-        ignoreList:
+        ignorePluralizationList:
           - 'Fts'
diff --git a/tools/spectral/ipa/rulesets/IPA-105.yaml b/tools/spectral/ipa/rulesets/IPA-105.yaml
@@ -88,12 +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'
-        ignoreList:
+        ignorePluralizationList:
           - 'Fts'
diff --git a/tools/spectral/ipa/rulesets/IPA-106.yaml b/tools/spectral/ipa/rulesets/IPA-106.yaml
@@ -122,12 +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'
-        ignoreList:
+        ignorePluralizationList:
           - 'Fts'
diff --git a/tools/spectral/ipa/rulesets/IPA-107.yaml b/tools/spectral/ipa/rulesets/IPA-107.yaml
@@ -123,12 +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'
-        ignoreList:
+        ignorePluralizationList:
           - 'Fts'
diff --git a/tools/spectral/ipa/rulesets/IPA-108.yaml b/tools/spectral/ipa/rulesets/IPA-108.yaml
@@ -64,14 +64,18 @@ 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'
-        ignoreList:
+        ignorePluralizationList:
           - 'Fts'
 
 functions:
diff --git a/tools/spectral/ipa/rulesets/IPA-109.yaml b/tools/spectral/ipa/rulesets/IPA-109.yaml
@@ -70,11 +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:
-        ignoreList:
+        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, ignoreList }, { 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, ignoreList }, { path, documentInventory })
     if (hasMethodVerbOverride(input, methodName)) {
       methodName = input[VERB_OVERRIDE_EXTENSION].verb;
     }
-    const errors = validateOperationIdAndReturnErrors(methodName, resourcePath, input, path, ignoreList);
+    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, ignoreList }, { 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, ignoreList }, { path, documentInventory })
   }
 
   try {
-    const errors = validateOperationIdAndReturnErrors(methodName, resourcePath, input, path, ignoreList);
+    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, ignoreList }, { path }) => {
+export default (input, { methodName, ignorePluralizationList }, { path }) => {
   const resourcePath = path[1];
 
   if (hasCustomMethodOverride(input) || isCustomMethodIdentifier(resourcePath)) {
@@ -17,7 +17,7 @@ export default (input, { methodName, ignoreList }, { path }) => {
   }
 
   try {
-    const errors = validateOperationIdAndReturnErrors(methodName, resourcePath, input, path, ignoreList);
+    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, ignoreList }, { path }) => {
+export default (input, { methodName, ignorePluralizationList }, { path }) => {
   const resourcePath = path[1];
 
   if (isCustomMethodIdentifier(resourcePath) || hasCustomMethodOverride(input)) {
@@ -17,7 +17,7 @@ export default (input, { methodName, ignoreList }, { path }) => {
   }
 
   try {
-    const errors = validateOperationIdAndReturnErrors(methodName, resourcePath, input, path, ignoreList);
+    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, ignoreList }, { path }) => {
+export default (input, { methodName, ignorePluralizationList }, { path }) => {
   const resourcePath = path[1];
 
   if (isCustomMethodIdentifier(resourcePath) || hasCustomMethodOverride(input)) {
@@ -17,7 +17,7 @@ export default (input, { methodName, ignoreList }, { path }) => {
   }
 
   try {
-    const errors = validateOperationIdAndReturnErrors(methodName, resourcePath, input, path, ignoreList);
+    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, { ignoreList }, { path }) => {
+export default (input, { ignorePluralizationList }, { path }) => {
   const resourcePath = path[1];
 
   if (!isCustomMethodIdentifier(resourcePath) && !hasCustomMethodOverride(input)) {
@@ -28,7 +28,7 @@ export default (input, { ignoreList }, { path }) => {
       return;
     }
 
-    const errors = validateOperationIdAndReturnErrors(methodName, endpointUrl, input, path, ignoreList);
+    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
@@ -10,7 +10,7 @@ const CAMEL_CASE_WITH_ABBREVIATIONS = /[A-Z]+(?![a-z])|[A-Z]*[a-z]+/g;
  * @param method the standard method name (create, update, get etc.), custom method name, or empty string (only for legacy custom methods)
  * @param path the path for the endpoint
  */
-export function generateOperationID(method, path, ignoreList = []) {
+export function generateOperationID(method, path, ignorePluralizationList = []) {
   if (!path) {
     return method;
   }
@@ -40,7 +40,7 @@ export function generateOperationID(method, path, ignoreList = []) {
 
   let opID = verb;
   for (let i = 0; i < nouns.length - 1; i++) {
-    opID += singularize(nouns[i], ignoreList);
+    opID += singularize(nouns[i], ignorePluralizationList);
   }
 
   // singularize final noun, dependent on resource identifier - leave custom nouns alone
@@ -49,7 +49,7 @@ export function generateOperationID(method, path, ignoreList = []) {
       !camelCaseCustomMethod) ||
     verb === 'create'
   ) {
-    nouns[nouns.length - 1] = singularize(nouns[nouns.length - 1], ignoreList);
+    nouns[nouns.length - 1] = singularize(nouns[nouns.length - 1], ignorePluralizationList);
   }
 
   opID += nouns.pop();
@@ -93,8 +93,8 @@ function capitalize(val) {
   return String(val).charAt(0).toUpperCase() + String(val).slice(1);
 }
 
-function singularize(noun, ignoreList = []) {
-  if (!ignoreList.includes(noun)) {
+function singularize(noun, ignorePluralizationList = []) {
+  if (!ignorePluralizationList.includes(noun)) {
     return inflection.singularize(noun);
   }
   return noun;
diff --git a/tools/spectral/ipa/rulesets/functions/utils/validations/validateOperationIdAndReturnErrors.js b/tools/spectral/ipa/rulesets/functions/utils/validations/validateOperationIdAndReturnErrors.js
@@ -18,9 +18,15 @@ const TOO_LONG_OP_ID_ERROR_MESSAGE =
  * @param path the path to the operation object being evaluated, used for error reporting with Spectral.
  * @returns {[{path: string[], message: string}]} an array of error objects, each containing a path and a message, or an empty array if no errors are found.
  */
-export function validateOperationIdAndReturnErrors(methodName, resourcePath, operationObject, path, ignoreList) {
+export function validateOperationIdAndReturnErrors(
+  methodName,
+  resourcePath,
+  operationObject,
+  path,
+  ignorePluralizationList
+) {
   const operationId = operationObject.operationId;
-  const expectedOperationId = generateOperationID(methodName, resourcePath, ignoreList);
+  const expectedOperationId = generateOperationID(methodName, resourcePath, ignorePluralizationList);
 
   const operationIdPath = path.concat(['operationId']);
 
