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

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: [],
+  },
 ]);

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: [],
+  },
 ]);

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: [],
+  },
 ]);

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: [],
+  },
 ]);

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: [],
+  },
 ]);

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: [],
+  },
 ]);

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

@@ -115,3 +115,5 @@ rules:
       function: 'IPA104ValidOperationID'
       functionOptions:
         methodName: 'get'
+        ignoreList:
+          - 'Fts'

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

@@ -95,3 +95,5 @@ rules:
       function: 'IPA105ValidOperationID'
       functionOptions:
         methodName: 'list'
+        ignoreList:
+          - 'Fts'

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

@@ -129,3 +129,5 @@ rules:
       function: 'IPA106ValidOperationID'
       functionOptions:
         methodName: 'create'
+        ignoreList:
+          - 'Fts'

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

@@ -130,3 +130,5 @@ rules:
       function: 'IPA107ValidOperationID'
       functionOptions:
         methodName: 'update'
+        ignoreList:
+          - 'Fts'

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

@@ -71,6 +71,8 @@ rules:
       function: 'IPA108ValidOperationID'
       functionOptions:
         methodName: 'delete'
+        ignoreList:
+          - 'Fts'
 
 functions:
   - IPA108DeleteMethodResponseShouldNotHaveSchema

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

@@ -75,3 +75,6 @@ rules:
     given: '$.paths[*][*]'
     then:
       function: 'IPA109ValidOperationID'
+      functionOptions:
+        ignoreList:
+          - 'Fts'

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, ignoreList }, { 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, ignoreList);
 
     return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, input, path);
   } catch (e) {

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, ignoreList }, { 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, ignoreList);
     return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, input, path);
   } catch (e) {
     return handleInternalError(RULE_NAME, path, e);

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, ignoreList }, { 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, ignoreList);
     return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, input, path);
   } catch (e) {
     return handleInternalError(RULE_NAME, path, e);

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, ignoreList }, { 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, ignoreList);
     return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, input, path);
   } catch (e) {
     return handleInternalError(RULE_NAME, path, e);

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, ignoreList }, { 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, ignoreList);
     return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, input, path);
   } catch (e) {
     return handleInternalError(RULE_NAME, path, e);

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, { ignoreList }, { 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, ignoreList);
     return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, input, path);
   } catch (e) {
     return handleInternalError(RULE_NAME, path, e);

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) {
+export function generateOperationID(method, path, ignoreList = []) {
   if (!path) {
     return method;
   }
@@ -40,7 +40,7 @@ export function generateOperationID(method, path) {
 
   let opID = verb;
   for (let i = 0; i < nouns.length - 1; i++) {
-    opID += inflection.singularize(nouns[i]);
+    opID += singularize(nouns[i], ignoreList);
   }
 
   // singularize final noun, dependent on resource identifier - leave custom nouns alone
@@ -49,7 +49,7 @@ export function generateOperationID(method, path) {
       !camelCaseCustomMethod) ||
     verb === 'create'
   ) {
-    nouns[nouns.length - 1] = inflection.singularize(nouns[nouns.length - 1]);
+    nouns[nouns.length - 1] = singularize(nouns[nouns.length - 1], ignoreList);
   }
 
   opID += nouns.pop();
@@ -92,3 +92,10 @@ function deriveActionVerb(method) {
 function capitalize(val) {
   return String(val).charAt(0).toUpperCase() + String(val).slice(1);
 }
+
+function singularize(noun, ignoreList = []) {
+  if (!ignoreList.includes(noun)) {
+    return inflection.singularize(noun);
+  }
+  return noun;
+}

tools/spectral/ipa/rulesets/functions/utils/validations/validateOperationIdAndReturnErrors.js

@@ -18,9 +18,9 @@ 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) {
+export function validateOperationIdAndReturnErrors(methodName, resourcePath, operationObject, path, ignoreList) {
   const operationId = operationObject.operationId;
-  const expectedOperationId = generateOperationID(methodName, resourcePath);
+  const expectedOperationId = generateOperationID(methodName, resourcePath, ignoreList);
 
   const operationIdPath = path.concat(['operationId']);