Add support for distinguishing equivalent paths by parameter format in overloaded parameters (#661)

* Add support for distinguishing equivalent paths by parameter format in overloaded parameters

* Fix typos in PathsDiff.java

* Add test case for complex path parameter with dot while handling overloaded parameters

---------

Co-authored-by: Aliaksandr Pinchuk <[email protected]>

Author: DrSatyr

core/src/main/java/org/openapitools/openapidiff/core/compare/PathsDiff.java

@@ -125,6 +125,8 @@ private static boolean methodsAndParametersIntersect(PathItem a, PathItem b) {
   }
 
   /**
+   * Checks if provided parameter pairs are equal by type and format
+   *
    * @param left parameters from the first compared method
    * @param right parameters from the second compared method
    * @return <code>true</code> in case each parameter pair is of the same type; <code>false</code>
@@ -134,9 +136,21 @@ private static boolean parametersIntersect(List<Parameter> left, List<Parameter>
     int parametersSize = left.size();
     long intersectedParameters =
         IntStream.range(0, left.size())
-            .filter(
-                i -> left.get(i).getSchema().getType().equals(right.get(i).getSchema().getType()))
+            .filter(i -> parametersTypeEquals(left.get(i), right.get(i)))
             .count();
     return parametersSize == intersectedParameters;
   }
+
+  /**
+   * Checks if provided parameter pair is equal by type and format
+   *
+   * @param left parameter from the first compared method
+   * @param right parameter from the second compared method
+   * @return <code>true</code> in case parameter pair is of the same type; <code>false</code>
+   *     otherwise
+   */
+  private static boolean parametersTypeEquals(Parameter left, Parameter right) {
+    return Objects.equals(left.getSchema().getType(), right.getSchema().getType())
+        && Objects.equals(left.getSchema().getFormat(), right.getSchema().getFormat());
+  }
 }

core/src/test/resources/parameters_overloading.yaml

@@ -3,6 +3,21 @@ info:
   title: Projects API
   version: 1.0.0
 paths:
+  /projects/{key}:
+    get:
+      parameters:
+        - in: path
+          name: key
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: 'Success'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SampleResponse'
   /projects/{id}:
     get:
       parameters:
@@ -35,6 +50,26 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/SampleResponse'
+  /projects/{id}.{idPostfix}:
+    get:
+      parameters:
+        - in: path
+          name: id
+          required: true
+          schema:
+            type: string
+        - in: path
+          name: idPostfix
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: 'Success'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SampleResponse'
 components:
   schemas:
     SampleResponse: