fix: IPA-102

Author: wtrocki

tools/spectral/ipa/__tests__/collectionIdentifierCamelCase.test.js renamed to tools/spectral/ipa/__tests__/IPA102CollectionIdentifierCamelCase.test.js

@@ -22,30 +22,50 @@ rules:
     given: $.paths
     then:
       field: '@key'
-      function: collectionIdentifierCamelCase
+      function: IPA102CollectionIdentifierCamelCase
       functionOptions:
         # Contains list of ignored path params
         ignoredValues: ['v2', 'v1']
 
   xgen-IPA-102-path-alternate-resource-name-path-param:
-    description: 'Paths should alternate between resource names and path params.'
+    description: |
+      Paths should alternate between resource names and path params.
+      
+      ##### Implementation details
+      Rule checks for the following conditions:
+      
+        - Paths must follow a pattern where resource names and path parameters strictly alternate
+        - Even-indexed path segments should be resource names (not path parameters)
+        - Odd-indexed path segments should be path parameters
+        - Paths with `x-xgen-IPA-exception` for this rule are excluded from validation
     message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-102-path-alternate-resource-name-path-param'
     severity: error
     given: '$.paths'
     then:
       field: '@key'
-      function: 'eachPathAlternatesBetweenResourceNameAndPathParam'
+      function: IPA102EachPathAlternatesBetweenResourceNameAndPathParam
 
   xgen-IPA-102-collection-identifier-pattern:
-    description: Collection identifiers must begin with a lowercase letter and contain only ASCII letters and numbers.
+    description: |
+      Collection identifiers must begin with a lowercase letter and contain only ASCII letters and numbers.
+      
+      ##### Implementation details
+      Rule checks for the following conditions:
+      
+        - All path segments that are not path parameters must match pattern `/^[a-z][a-zA-Z0-9]*$/`
+        - Path parameters (inside curly braces) are excluded from validation
+        - Custom methods (segments containing colons) are excluded from validation
+        - Paths with `x-xgen-IPA-exception` for this rule are excluded from validation
+        - Each non-parameter path segment must start with a lowercase letter followed by any combination of ASCII letters and numbers
+
     message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-102-collection-identifier-pattern'
     severity: warn
     given: $.paths
     then:
       field: '@key'
-      function: collectionIdentifierPattern
+      function: IPA102CollectionIdentifierPattern
 
 functions:
-  - collectionIdentifierPattern
-  - eachPathAlternatesBetweenResourceNameAndPathParam
-  - collectionIdentifierCamelCase
+  - IPA102CollectionIdentifierPattern
+  - IPA102EachPathAlternatesBetweenResourceNameAndPathParam
+  - IPA102CollectionIdentifierCamelCase

tools/spectral/ipa/__tests__/collectionIdentifierPattern.test.js renamed to tools/spectral/ipa/__tests__/IPA102CollectionIdentifierPattern.test.js

@@ -33,6 +33,15 @@ Rule is based on [http://go/ipa/IPA-102](http://go/ipa/IPA-102).
 
  ![error](https://img.shields.io/badge/error-red) 
 Paths should alternate between resource names and path params.
+
+##### Implementation details
+Rule checks for the following conditions:
+
+  - Paths must follow a pattern where resource names and path parameters strictly alternate
+  - Even-indexed path segments should be resource names (not path parameters)
+  - Odd-indexed path segments should be path parameters
+  - Paths with `x-xgen-IPA-exception` for this rule are excluded from validation
+
 #### xgen-IPA-102-collection-identifier-camelCase
 
  ![warn](https://img.shields.io/badge/warning-yellow) 
@@ -54,6 +63,16 @@ Collection identifiers must be in camelCase.
  ![warn](https://img.shields.io/badge/warning-yellow) 
 Collection identifiers must begin with a lowercase letter and contain only ASCII letters and numbers.
 
+##### Implementation details
+Rule checks for the following conditions:
+
+  - All path segments that are not path parameters must match pattern `/^[a-z][a-zA-Z0-9]*$/`
+  - Path parameters (inside curly braces) are excluded from validation
+  - Custom methods (segments containing colons) are excluded from validation
+  - Paths with `x-xgen-IPA-exception` for this rule are excluded from validation
+  - Each non-parameter path segment must start with a lowercase letter followed by any combination of ASCII letters and numbers
+
+
 
 ### IPA-104
 

tools/spectral/ipa/__tests__/eachPathAlternatesBetweenResourceNameAndPathParam.test.js renamed to tools/spectral/ipa/__tests__/IPA102EachPathAlternatesBetweenResourceNameAndPathParam.test.js

@@ -159,6 +159,7 @@ function resourceBelongsToSingleParent(resourcePath) {
   return isPathParam(parentResourceSection);
 }
 
+// TODO move prefixes to be rule arguments
 function removePrefix(path) {
   if (path.startsWith(AUTH_PREFIX)) {
     return path.slice(AUTH_PREFIX.length);