Add reference normalize to path parameters on top level

marcelthole · Jul 24, 2024 · 71b0773 · 71b0773
1 parent dadf6b6
commit 71b0773
Show file tree

Hide file tree

Showing 5 changed files with 79 additions and 14 deletions.
diff --git a/src/Merge/ReferenceNormalizer.php b/src/Merge/ReferenceNormalizer.php
@@ -30,27 +30,26 @@ public function normalizeInlineReferences(
     ): ReferenceResolverResult {
         $refFileCollection = [];
         foreach ($openApiDefinition->paths as $path) {
+            foreach ($path->parameters as $parameterIndex => $parameter) {
+                $allParameters = $path->parameters;
+                if ($parameter instanceof Reference) {
+                    $allParameters[$parameterIndex] = $this->normalizeReference($parameter, $refFileCollection);
+                } else {
+                    $allParameters[$parameterIndex] = $this->normalizeParameters($parameter, $refFileCollection);
+                }
+
+                $path->parameters = $allParameters;
+            }
+
             foreach ($path->getOperations() as $operation) {
                 foreach (($operation->parameters ?? []) as $parameterIndex => $parameter) {
                     if (! $parameter instanceof Parameter) {
                         continue;
                     }
 
                     /** @var array<int, Parameter> $allParameters */
-                    $allParameters = $operation->parameters;
-                    if ($parameter->schema instanceof Reference) {
-                        $allParameters[$parameterIndex]->schema = $this->normalizeReference(
-                            $parameter->schema,
-                            $refFileCollection,
-                        );
-                    }
-
-                    if ($parameter->schema instanceof Schema) {
-                        $allParameters[$parameterIndex]->schema = $this->normalizeProperties(
-                            $parameter->schema,
-                            $refFileCollection,
-                        );
-                    }
+                    $allParameters                  = $operation->parameters;
+                    $allParameters[$parameterIndex] = $this->normalizeParameters($parameter, $refFileCollection);
 
                     $operation->parameters = $allParameters;
                 }
@@ -265,4 +264,24 @@ public function normalizeProperty(Reference|Schema $property, array &$refFileCol
 
         return $property;
     }
+
+    /** @param array<string, string> $refFileCollection */
+    public function normalizeParameters(Parameter $parameter, array &$refFileCollection): Parameter
+    {
+        if ($parameter->schema instanceof Reference) {
+            $parameter->schema = $this->normalizeReference(
+                $parameter->schema,
+                $refFileCollection,
+            );
+        }
+
+        if ($parameter->schema instanceof Schema) {
+            $parameter->schema = $this->normalizeProperties(
+                $parameter->schema,
+                $refFileCollection,
+            );
+        }
+
+        return $parameter;
+    }
 }
diff --git a/tests/Merge/Fixtures/expected/openapi-normalized.json b/tests/Merge/Fixtures/expected/openapi-normalized.json
@@ -3,6 +3,28 @@
     "info": {},
     "paths": {
         "\/dummy": {},
+        "\/path\/{id}\/{id2}": {
+            "get": {
+                "responses": {
+                    "200": {
+                        "description": "OK"
+                    }
+                }
+            },
+            "parameters": [
+                {
+                    "name": "id",
+                    "in": "path",
+                    "required": true,
+                    "schema": {
+                        "type": "integer"
+                    }
+                },
+                {
+                    "$ref": "#\/components\/schemas\/pathOutsideOperation"
+                }
+            ]
+        },
         "\/reference": {
             "get": {
                 "parameters": [

diff --git a/tests/Merge/Fixtures/openapi-with-reference.json b/tests/Merge/Fixtures/openapi-with-reference.json
@@ -3,6 +3,28 @@
     "info": {},
     "paths": {
         "/dummy": {},
+        "/path/{id}/{id2}": {
+            "parameters": [
+                {
+                    "name": "id",
+                    "in": "path",
+                    "required": true,
+                    "schema": {
+                        "type": "integer"
+                    }
+                },
+                {
+                    "$ref": "pathOutsideOperation.json#/components/schemas/pathOutsideOperation"
+                }
+            ],
+            "get": {
+                "responses": {
+                    "200": {
+                        "description": "OK"
+                    }
+                }
+            }
+        },
         "/reference": {
             "get": {
                 "parameters": [

diff --git a/tests/Merge/Fixtures/pathOutsideOperation.json b/tests/Merge/Fixtures/pathOutsideOperation.json
@@ -0,0 +1 @@
+{}
diff --git a/tests/Merge/ReferenceNormalizerTest.php b/tests/Merge/ReferenceNormalizerTest.php
@@ -48,6 +48,7 @@ public function testReadFileWithResolvedReference(): void
 
         $foundRefFiles    = $specificationResult->getFoundReferenceFiles();
         $expectedRefFiles = [
+            __DIR__ . '/Fixtures/pathOutsideOperation.json',
             __DIR__ . '/Fixtures/requestParam.json',
             __DIR__ . '/Fixtures/requestParamNullable.json',
             __DIR__ . '/Fixtures/responseModel.json',