address the comments

Author: yelizhenden-mdb

.prettierignore

@@ -4,3 +4,4 @@
 *.yaml
 *.yml
 *.html
+!/tools/spectral/ipa/**/*.yaml

tools/spectral/ipa/__tests__/eachPathAlternatesBetweenResourceNameAndPathParam.test.js

@@ -6,33 +6,13 @@ testRule('xgen-IPA-102-path-alternate-resource-name-path-param', [
     name: 'valid paths - api/atlas/v2',
     document: {
       paths: {
-        '/api/atlas/v2/resourceName': {
-          post: {},
-          get: {},
-        },
-        '/api/atlas/v2/resourceName/{pathParam}': {
-          get: {},
-          patch: {},
-          delete: {},
-        },
-        '/api/atlas/v2/resourceName1/{pathParam}/resourceName2': {
-          post: {},
-          get: {},
-        },
-        '/api/atlas/v2/resourceName1/{pathParam1p}/resourceName2/{pathParam2}': {
-          get: {},
-          patch: {},
-          delete: {},
-        },
-        '/api/atlas/v2/resourceName/{pathParam}:method': {
-          post: {},
-        },
-        '/api/atlas/v2/custom:method': {
-          post: {},
-        },
-        '/api/atlas/v2': {
-          post: {},
-        },
+        '/api/atlas/v2/resourceName': {},
+        '/api/atlas/v2/resourceName/{pathParam}': {},
+        '/api/atlas/v2/resourceName1/{pathParam}/resourceName2': {},
+        '/api/atlas/v2/resourceName1/{pathParam1p}/resourceName2/{pathParam2}': {},
+        '/api/atlas/v2/resourceName/{pathParam}:method': {},
+        '/api/atlas/v2/custom:method': {},
+        '/api/atlas/v2': {},
       },
     },
     errors: [],
@@ -41,33 +21,13 @@ testRule('xgen-IPA-102-path-alternate-resource-name-path-param', [
     name: 'valid paths - api/atlas/v2/unauth',
     document: {
       paths: {
-        '/api/atlas/v2/unauth/resourceName': {
-          post: {},
-          get: {},
-        },
-        '/api/atlas/v2/unauth/resourceName/{pathParam}': {
-          get: {},
-          patch: {},
-          delete: {},
-        },
-        '/api/atlas/v2/unauth/resourceName1/{pathParam}/resourceName2': {
-          post: {},
-          get: {},
-        },
-        '/api/atlas/v2/unauth/resourceName1/{pathParam1p}/resourceName2/{pathParam2}': {
-          get: {},
-          patch: {},
-          delete: {},
-        },
-        '/api/atlas/v2/unauth/resourceName/{pathParam}:method': {
-          post: {},
-        },
-        '/api/atlas/v2/unauth/custom:method': {
-          post: {},
-        },
-        '/api/atlas/v2/unauth': {
-          post: {},
-        },
+        '/api/atlas/v2/unauth/resourceName': {},
+        '/api/atlas/v2/unauth/resourceName/{pathParam}': {},
+        '/api/atlas/v2/unauth/resourceName1/{pathParam}/resourceName2': {},
+        '/api/atlas/v2/unauth/resourceName1/{pathParam1p}/resourceName2/{pathParam2}': {},
+        '/api/atlas/v2/unauth/resourceName/{pathParam}:method': {},
+        '/api/atlas/v2/unauth/custom:method': {},
+        '/api/atlas/v2/unauth': {},
       },
     },
     errors: [],
@@ -76,30 +36,12 @@ testRule('xgen-IPA-102-path-alternate-resource-name-path-param', [
     name: 'invalid paths - api/atlas/v2',
     document: {
       paths: {
-        '/api/atlas/v2/resourceName1/resourceName2': {
-          post: {},
-          get: {},
-        },
-        '/api/atlas/v2/resourceName/{pathParam1}/{pathParam2}': {
-          patch: {},
-          delete: {},
-        },
-        '/api/atlas/v2/resourceName1/{pathParam1}/resourceName2/resourceName3': {
-          patch: {},
-          delete: {},
-        },
-        '/api/atlas/v2/resourceName1/{pathParam1}/resourceName2/{pathParam2}/{pathParam3}': {
-          patch: {},
-          delete: {},
-        },
-        '/api/atlas/v2/{pathParam}': {
-          post: {},
-          get: {},
-        },
-        '/api/atlas/v2/{pathParam1}/{pathParam2}': {
-          post: {},
-          get: {},
-        },
+        '/api/atlas/v2/resourceName1/resourceName2': {},
+        '/api/atlas/v2/resourceName/{pathParam1}/{pathParam2}': {},
+        '/api/atlas/v2/resourceName1/{pathParam1}/resourceName2/resourceName3': {},
+        '/api/atlas/v2/resourceName1/{pathParam1}/resourceName2/{pathParam2}/{pathParam3}': {},
+        '/api/atlas/v2/{pathParam}': {},
+        '/api/atlas/v2/{pathParam1}/{pathParam2}': {},
       },
     },
     errors: [
@@ -145,30 +87,12 @@ testRule('xgen-IPA-102-path-alternate-resource-name-path-param', [
     name: 'invalid paths - api/atlas/v2/unauth',
     document: {
       paths: {
-        '/api/atlas/v2/unauth/resourceName1/resourceName2': {
-          post: {},
-          get: {},
-        },
-        '/api/atlas/v2/unauth/resourceName/{pathParam1}/{pathParam2}': {
-          patch: {},
-          delete: {},
-        },
-        '/api/atlas/v2/unauth/resourceName1/{pathParam1}/resourceName2/resourceName3': {
-          patch: {},
-          delete: {},
-        },
-        '/api/atlas/v2/unauth/resourceName1/{pathParam1}/resourceName2/{pathParam2}/{pathParam3}': {
-          patch: {},
-          delete: {},
-        },
-        '/api/atlas/v2/unauth/{pathParam}': {
-          post: {},
-          get: {},
-        },
-        '/api/atlas/v2/unauth/{pathParam1}/{pathParam2}': {
-          post: {},
-          get: {},
-        },
+        '/api/atlas/v2/unauth/resourceName1/resourceName2': {},
+        '/api/atlas/v2/unauth/resourceName/{pathParam1}/{pathParam2}': {},
+        '/api/atlas/v2/unauth/resourceName1/{pathParam1}/resourceName2/resourceName3': {},
+        '/api/atlas/v2/unauth/resourceName1/{pathParam1}/resourceName2/{pathParam2}/{pathParam3}': {},
+        '/api/atlas/v2/unauth/{pathParam}': {},
+        '/api/atlas/v2/unauth/{pathParam1}/{pathParam2}': {},
       },
     },
     errors: [

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

@@ -20,14 +20,16 @@ const validatePathStructure = (elements) => {
 
 export default (input) => {
   const prefix = getPrefix(input);
-  if (!prefix) return [];
+  if (!prefix) return;
 
   let suffixWithLeadingSlash = input.slice(prefix.length);
   if (suffixWithLeadingSlash.length === 0) {
-    return [];
+    return;
   }
 
   let suffix = suffixWithLeadingSlash.slice(1);
   let elements = suffix.split('/');
-  return validatePathStructure(elements) ? [] : ERROR_RESULT;
+  if (!validatePathStructure(elements)) {
+    return ERROR_RESULT;
+  }
 };

tools/spectral/ipa/rulesets/functions/utils/pathUtils.js

@@ -1,3 +1,12 @@
+/**
+ * Checks if a string belongs to a path parameter or a path parameter with a custom method.
+ *
+ * A path parameter has the format: `{paramName}`
+ * A path parameter with a custom method has the format: `{paramName}:customMethod`
+ *
+ * @param {string} str - A string extracted from a path split by slashes.
+ * @returns {boolean} True if the string matches the expected formats, false otherwise.
+ */
 export function isPathParam(str) {
   const pathParamRegEx = new RegExp(`^{[a-z][a-zA-Z0-9]*}$`);
   const pathParamWithCustomMethodRegEx = new RegExp(`^{[a-z][a-zA-Z0-9]*}:[a-z][a-zA-Z0-9]*$`);