Edit to logic to handle outliers

Author: Sophia Marie Terry

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

@@ -1,24 +1,16 @@
 import { hasException } from './utils/exceptions.js';
 import { collectAdoption, collectException, collectAndReturnViolation } from './utils/collectionUtils.js';
-import {
-  isCustomMethodIdentifier,
-  isResourceCollectionIdentifier,
-  isSingletonResource,
-  getResourcePathItems,
-} from './utils/resourceEvaluation.js';
+import { isCustomMethodIdentifier } from './utils/resourceEvaluation.js';
 import { generateOperationID } from './utils/operationIdGeneration.js';
 import { isLegacyCustomMethod } from './utils/extensions.js';
 
 const RULE_NAME = 'xgen-IPA-106-valid-operation-id';
 const ERROR_MESSAGE = 'Invalid OperationID.';
 
-export default (input, { methodName }, { path, documentInventory }) => {
+export default (input, { methodName }, { path }) => {
   const resourcePath = path[1];
-  const oas = documentInventory.resolved;
-  const resourcePaths = getResourcePathItems(resourcePath, oas.paths);
 
-  const isResourceCollection = isResourceCollectionIdentifier(resourcePath) && !isSingletonResource(resourcePaths);
-  if (isLegacyCustomMethod(input) || isCustomMethodIdentifier(resourcePath) || !isResourceCollection) {
+  if (isLegacyCustomMethod(input) || isCustomMethodIdentifier(resourcePath)) {
     return;
   }
 

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

@@ -1,29 +1,16 @@
 import { hasException } from './utils/exceptions.js';
 import { collectAdoption, collectException, collectAndReturnViolation } from './utils/collectionUtils.js';
-import {
-  isSingleResourceIdentifier,
-  isResourceCollectionIdentifier,
-  isSingletonResource,
-  getResourcePathItems,
-  isCustomMethodIdentifier,
-} from './utils/resourceEvaluation.js';
+import { isCustomMethodIdentifier } from './utils/resourceEvaluation.js';
 import { generateOperationID } from './utils/operationIdGeneration.js';
 import { isLegacyCustomMethod } from './utils/extensions.js';
 
 const RULE_NAME = 'xgen-IPA-107-valid-operation-id';
 const ERROR_MESSAGE = 'Invalid OperationID.';
 
-export default (input, { methodName }, { path, documentInventory }) => {
+export default (input, { methodName }, { path }) => {
   const resourcePath = path[1];
-  const oas = documentInventory.resolved;
-  const resourcePaths = getResourcePathItems(resourcePath, oas.paths);
 
-  if (
-    isCustomMethodIdentifier(resourcePath) ||
-    isLegacyCustomMethod(input) ||
-    (!isSingleResourceIdentifier(resourcePath) &&
-      !(isResourceCollectionIdentifier(resourcePath) && isSingletonResource(resourcePaths)))
-  ) {
+  if (isCustomMethodIdentifier(resourcePath) || isLegacyCustomMethod(input)) {
     return;
   }
 

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

@@ -10,11 +10,7 @@ const ERROR_MESSAGE = 'Invalid OperationID.';
 export default (input, { methodName }, { path }) => {
   const resourcePath = path[1];
 
-  if (
-    isCustomMethodIdentifier(resourcePath) ||
-    !isSingleResourceIdentifier(resourcePath) ||
-    isLegacyCustomMethod(input)
-  ) {
+  if (isCustomMethodIdentifier(resourcePath) || isLegacyCustomMethod(input)) {
     return;
   }
 

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

@@ -34,15 +34,28 @@ export default (input, _, { path }) => {
     }
 
     const operationId = obj.operationId;
-    errors.push(checkViolationAndReturnError(operationId, expectedOperationID, path));
+    if (operationId !== expectedOperationID) {
+      const errors = [
+        {
+          path,
+          message: `${ERROR_MESSAGE} Found ${operationId}, expected ${expectedOperationID}.`,
+        },
+      ];
+      return collectAndReturnViolation(path, RULE_NAME, errors);
+    }
   } else if (hasMethodWithVerbOverride(input)) {
     const methods = Object.keys(input);
     for (let i = 0; i < methods.length; i++) {
       let obj = input[methods[i]];
       const operationId = obj.operationId;
       if (isLegacyCustomMethod(obj)) {
         expectedOperationID = generateOperationID(obj['x-xgen-method-verb-override'].verb, resourcePath);
-        errors.push(checkViolationAndReturnError(operationId, expectedOperationID, path));
+        if (operationId !== expectedOperationID) {
+          errors.push({
+            path,
+            message: `${ERROR_MESSAGE} Found ${operationId}, expected ${expectedOperationID}.`,
+          });
+        }
       }
     }
   } else {
@@ -55,13 +68,3 @@ export default (input, _, { path }) => {
 
   collectAdoption(path, RULE_NAME);
 };
-
-function checkViolationAndReturnError(oldOperationID, newOperationID, path) {
-  if (oldOperationID !== newOperationID) {
-    return {
-      path,
-      message: `${ERROR_MESSAGE} Found ${oldOperationID}, expected ${newOperationID}.`,
-    };
-  }
-  return;
-}