fix(ipa): Update override logic to be more lenient (#857)

sphterry · web-flow · commit 9e8cb9ff5c57 · 2025-08-01T11:14:15.000+01:00
diff --git a/tools/spectral/ipa/__tests__/utils/validations/validateOperationIdAndReturnErrors.test.js b/tools/spectral/ipa/__tests__/utils/validations/validateOperationIdAndReturnErrors.test.js
@@ -202,6 +202,19 @@ describe('tools/spectral/ipa/rulesets/functions/utils/validations/validateOperat
         ['paths', '/some/{id}/resource/{resourceId}/long/{id}/childResource/{id}', 'get']
       )
     ).toHaveLength(0);
+
+    // valid override on short opID
+    expect(
+      validateOperationIdAndReturnErrors(
+        'get',
+        '/some/{id}/resource/{resourceId}',
+        {
+          operationId: 'getSomeResource',
+          'x-xgen-operation-id-override': 'getResource',
+        },
+        ['paths', '/some/{id}/resource/{resourceId}', 'get']
+      )
+    ).toHaveLength(0);
   });
 
   it('should return errors for invalid operation ID', () => {
@@ -258,26 +271,6 @@ describe('tools/spectral/ipa/rulesets/functions/utils/validations/validateOperat
     ]);
   });
 
-  it('should return errors for valid operation ID with unnecessary override', () => {
-    expect(
-      validateOperationIdAndReturnErrors(
-        'get',
-        '/some/{id}/resource/{resourceId}',
-        {
-          operationId: 'getSomeResource',
-          'x-xgen-operation-id-override': 'getResource',
-        },
-        ['paths', '/some/{id}/resource/{resourceId}', 'get']
-      )
-    ).toEqual([
-      {
-        path: ['paths', '/some/{id}/resource/{resourceId}', 'get', 'x-xgen-operation-id-override'],
-        message:
-          "Please remove the 'x-xgen-operation-id-override' extension from the operation. The Operation ID already has a valid length (<=4 words).",
-      },
-    ]);
-  });
-
   it('should return errors for operation ID override with wrong verb', () => {
     expect(
       validateOperationIdAndReturnErrors(
diff --git a/tools/spectral/ipa/rulesets/functions/IPA104ValidOperationID.js b/tools/spectral/ipa/rulesets/functions/IPA104ValidOperationID.js
@@ -6,7 +6,7 @@ import {
 } from './utils/collectionUtils.js';
 import { hasException } from './utils/exceptions.js';
 import { getResourcePathItems, isCustomMethodIdentifier } from './utils/resourceEvaluation.js';
-import { hasCustomMethodOverride, hasMethodVerbOverride } from './utils/extensions.js';
+import { hasCustomMethodOverride, hasMethodVerbOverride, VERB_OVERRIDE_EXTENSION } from './utils/extensions.js';
 import { isInvalidGetMethod } from './utils/methodLogic.js';
 import { validateOperationIdAndReturnErrors } from './utils/validations/validateOperationIdAndReturnErrors.js';
 
@@ -32,6 +32,9 @@ export default (input, { methodName }, { path, documentInventory }) => {
   }
 
   try {
+    if (hasMethodVerbOverride(input, methodName)) {
+      methodName = input[VERB_OVERRIDE_EXTENSION].verb;
+    }
     const errors = validateOperationIdAndReturnErrors(methodName, resourcePath, input, path);
 
     if (errors.length > 0) {
diff --git a/tools/spectral/ipa/rulesets/functions/IPA105ValidOperationID.js b/tools/spectral/ipa/rulesets/functions/IPA105ValidOperationID.js
@@ -7,7 +7,7 @@ import {
 } from './utils/collectionUtils.js';
 import { getResourcePathItems, isCustomMethodIdentifier } from './utils/resourceEvaluation.js';
 import { isInvalidListMethod } from './utils/methodLogic.js';
-import { hasCustomMethodOverride, hasMethodVerbOverride } from './utils/extensions.js';
+import { hasCustomMethodOverride, hasMethodVerbOverride, VERB_OVERRIDE_EXTENSION } from './utils/extensions.js';
 import { validateOperationIdAndReturnErrors } from './utils/validations/validateOperationIdAndReturnErrors.js';
 
 const RULE_NAME = 'xgen-IPA-105-valid-operation-id';
@@ -31,6 +31,10 @@ export default (input, { methodName }, { path, documentInventory }) => {
     return;
   }
 
+  if (hasMethodVerbOverride(input, methodName)) {
+    methodName = input[VERB_OVERRIDE_EXTENSION].verb;
+  }
+
   try {
     const errors = validateOperationIdAndReturnErrors(methodName, resourcePath, input, path);
 
diff --git a/tools/spectral/ipa/rulesets/functions/IPA106ValidOperationID.js b/tools/spectral/ipa/rulesets/functions/IPA106ValidOperationID.js
@@ -6,7 +6,7 @@ import {
   handleInternalError,
 } from './utils/collectionUtils.js';
 import { isCustomMethodIdentifier } from './utils/resourceEvaluation.js';
-import { hasCustomMethodOverride } from './utils/extensions.js';
+import { hasCustomMethodOverride, hasMethodVerbOverride, VERB_OVERRIDE_EXTENSION } from './utils/extensions.js';
 import { validateOperationIdAndReturnErrors } from './utils/validations/validateOperationIdAndReturnErrors.js';
 
 const RULE_NAME = 'xgen-IPA-106-valid-operation-id';
@@ -23,6 +23,10 @@ export default (input, { methodName }, { path }) => {
     return;
   }
 
+  if (hasMethodVerbOverride(input, methodName)) {
+    methodName = input[VERB_OVERRIDE_EXTENSION].verb;
+  }
+
   try {
     const errors = validateOperationIdAndReturnErrors(methodName, resourcePath, input, path);
 
diff --git a/tools/spectral/ipa/rulesets/functions/IPA107ValidOperationID.js b/tools/spectral/ipa/rulesets/functions/IPA107ValidOperationID.js
@@ -6,7 +6,7 @@ import {
   handleInternalError,
 } from './utils/collectionUtils.js';
 import { isCustomMethodIdentifier } from './utils/resourceEvaluation.js';
-import { hasCustomMethodOverride } from './utils/extensions.js';
+import { hasCustomMethodOverride, hasMethodVerbOverride, VERB_OVERRIDE_EXTENSION } from './utils/extensions.js';
 import { validateOperationIdAndReturnErrors } from './utils/validations/validateOperationIdAndReturnErrors.js';
 
 const RULE_NAME = 'xgen-IPA-107-valid-operation-id';
@@ -23,6 +23,10 @@ export default (input, { methodName }, { path }) => {
     return;
   }
 
+  if (hasMethodVerbOverride(input, methodName)) {
+    methodName = input[VERB_OVERRIDE_EXTENSION].verb;
+  }
+
   try {
     const errors = validateOperationIdAndReturnErrors(methodName, resourcePath, input, path);
 
diff --git a/tools/spectral/ipa/rulesets/functions/IPA108ValidOperationID.js b/tools/spectral/ipa/rulesets/functions/IPA108ValidOperationID.js
@@ -6,7 +6,7 @@ import {
   handleInternalError,
 } from './utils/collectionUtils.js';
 import { isCustomMethodIdentifier } from './utils/resourceEvaluation.js';
-import { hasCustomMethodOverride } from './utils/extensions.js';
+import { hasCustomMethodOverride, hasMethodVerbOverride, VERB_OVERRIDE_EXTENSION } from './utils/extensions.js';
 import { validateOperationIdAndReturnErrors } from './utils/validations/validateOperationIdAndReturnErrors.js';
 
 const RULE_NAME = 'xgen-IPA-108-valid-operation-id';
@@ -23,6 +23,10 @@ export default (input, { methodName }, { path }) => {
     return;
   }
 
+  if (hasMethodVerbOverride(input, methodName)) {
+    methodName = input[VERB_OVERRIDE_EXTENSION].verb;
+  }
+
   try {
     const errors = validateOperationIdAndReturnErrors(methodName, resourcePath, input, path);
 
diff --git a/tools/spectral/ipa/rulesets/functions/utils/extensions.js b/tools/spectral/ipa/rulesets/functions/utils/extensions.js
@@ -19,7 +19,7 @@ export function hasCustomMethodOverride(object) {
  * @returns {boolean} true if the object has the extension with the given verb, otherwise false
  */
 export function hasMethodVerbOverride(object, verb) {
-  return hasVerbOverride(object) && object[VERB_OVERRIDE_EXTENSION].verb === verb;
+  return hasVerbOverride(object) && object[VERB_OVERRIDE_EXTENSION].verb.startsWith(verb);
 }
 
 /**
diff --git a/tools/spectral/ipa/rulesets/functions/utils/validations/validateOperationIdAndReturnErrors.js b/tools/spectral/ipa/rulesets/functions/utils/validations/validateOperationIdAndReturnErrors.js
@@ -8,10 +8,6 @@ const TOO_LONG_OP_ID_ERROR_MESSAGE =
   "The Operation ID is longer than 4 words. Please add an '" +
   OPERATION_ID_OVERRIDE_EXTENSION +
   "' extension to the operation with a shorter operation ID.";
-const REMOVE_OP_ID_OVERRIDE_ERROR_MESSAGE =
-  "Please remove the '" +
-  OPERATION_ID_OVERRIDE_EXTENSION +
-  "' extension from the operation. The Operation ID already has a valid length (<=4 words).";
 
 /**
  * Validates the operationId of an operation object and returns errors if it does not match the expected format. Also validates that the operationId override, if present, follows the expected rules.
@@ -37,26 +33,23 @@ export function validateOperationIdAndReturnErrors(methodName, resourcePath, ope
   }
 
   const operationIdOverridePath = path.concat([OPERATION_ID_OVERRIDE_EXTENSION]);
-  if (numberOfWords(operationId) > 4) {
-    if (!hasOperationIdOverride(operationObject)) {
-      errors.push({
-        path: operationIdPath,
-        message: TOO_LONG_OP_ID_ERROR_MESSAGE + " For example: '" + shortenOperationId(expectedOperationId) + "'.",
-      });
-      return errors;
-    }
+  if (numberOfWords(operationId) > 4 && !hasOperationIdOverride(operationObject)) {
+    errors.push({
+      path: operationIdPath,
+      message: TOO_LONG_OP_ID_ERROR_MESSAGE + " For example: '" + shortenOperationId(expectedOperationId) + "'.",
+    });
+    return errors;
+  }
+
+  if (hasOperationIdOverride(operationObject)) {
     const overrideErrors = validateOperationIdOverride(
       operationIdOverridePath,
       getOperationIdOverride(operationObject),
       expectedOperationId
     );
     errors.push(...overrideErrors);
-  } else if (hasOperationIdOverride(operationObject)) {
-    errors.push({
-      path: operationIdOverridePath,
-      message: REMOVE_OP_ID_OVERRIDE_ERROR_MESSAGE,
-    });
   }
+
   return errors;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ export function hasCustomMethodOverride(object) {`
`19`	`19`	`* @returns {boolean} true if the object has the extension with the given verb, otherwise false`
`20`	`20`	`*/`
`21`	`21`	`export function hasMethodVerbOverride(object, verb) {`
`22`		`- return hasVerbOverride(object) && object[VERB_OVERRIDE_EXTENSION].verb === verb;`
	`22`	`+ return hasVerbOverride(object) && object[VERB_OVERRIDE_EXTENSION].verb.startsWith(verb);`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`/**`