Merge pull request #122 from RonasIT/incorrect-handling-with-type-field

Error when handling response with the field name "type"
RonasIT · Apr 22, 2024 · 37ed94f · 37ed94f
2 parents aa1c7b1 + bea15ed
commit 37ed94f
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 9 deletions.
diff --git a/src/Services/SwaggerService.php b/src/Services/SwaggerService.php
@@ -317,7 +317,7 @@ protected function saveObjectResponseDefinitions(array $content, array &$schemaP
         $properties = Arr::get($this->data['definitions'], $definition, []);
 
         foreach ($content as $name => $value) {
-            $property = Arr::get($properties, $name, []);
+            $property = Arr::get($properties, "properties.{$name}", []);
 
             if (is_null($value)) {
                 $property['nullable'] = true;

diff --git a/tests/SwaggerServiceTest.php b/tests/SwaggerServiceTest.php
@@ -535,6 +535,27 @@ public function testAddDataWithPathParameters()
         $service->addData($request, $response);
     }
 
+    public function testAddDataWithTypeNameInResponse()
+    {
+        $this->mockDriverGetTpmData($this->getJsonFixture('tmp_data_get_user_request'));
+
+        $service = app(SwaggerService::class);
+
+        $request = $this->generateRequest('get', 'users/{id}/assign-role/{role-id}', [
+            'with' => ['role'],
+            'with_likes_count' => true
+        ], [
+            'id' => 1,
+            'role-id' => 5
+        ]);
+
+        $response = $this->generateResponse('example_success_user_response.json', 200, [
+            'Content-type' => 'application/json'
+        ]);
+
+        $service->addData($request, $response);
+    }
+
     public function testAddDataClosureRequest()
     {
         config(['auto-doc.security' => 'jwt']);

diff --git a/tests/fixtures/SwaggerServiceTest/example_success_user_response.json b/tests/fixtures/SwaggerServiceTest/example_success_user_response.json
@@ -5,5 +5,6 @@
     "role": {
         "id": 2,
         "name": "client"
-    }
+    },
+    "type": "reader"
 }
diff --git a/tests/fixtures/SwaggerServiceTest/tmp_data_get_user_request.json b/tests/fixtures/SwaggerServiceTest/tmp_data_get_user_request.json
@@ -59,7 +59,8 @@
                                 "role": {
                                     "id": 2,
                                     "name": "client"
-                                }
+                                },
+                                "type": "reader"
                             },
                             "$ref": "#/definitions/getUsers{id}assignRole{roleId}200ResponseObject"
                         }
@@ -87,6 +88,9 @@
                 },
                 "role": {
                     "type": "array"
+                },
+                "type": {
+                    "type": "string"
                 }
             }
         }

diff --git a/tests/support/Traits/SwaggerServiceMockTrait.php b/tests/support/Traits/SwaggerServiceMockTrait.php
@@ -12,7 +12,7 @@ protected function mockDriverGetEmptyAndSaveTpmData(
         $tmpData,
         $savedTmpData = null,
         $driverClass = LocalDriver::class
-    ) {
+    ): void {
         $driver = $this->mockClass($driverClass, ['getTmpData', 'saveTmpData']);
 
         $driver
@@ -32,8 +32,11 @@ protected function mockDriverGetEmptyAndSaveTpmData(
         $this->app->instance($driverClass, $driver);
     }
 
-    protected function mockDriverGetPreparedAndSaveTpmData($getTmpData, $saveTmpData, $driverClass = LocalDriver::class)
-    {
+    protected function mockDriverGetPreparedAndSaveTpmData(
+        $getTmpData,
+        $saveTmpData,
+        $driverClass = LocalDriver::class
+    ): void {
         $driver = $this->mockClass($driverClass, ['getTmpData', 'saveTmpData']);
 
         $driver
@@ -49,7 +52,7 @@ protected function mockDriverGetPreparedAndSaveTpmData($getTmpData, $saveTmpData
         $this->app->instance($driverClass, $driver);
     }
 
-    protected function mockDriverGetTpmData($tmpData, $driverClass = LocalDriver::class)
+    protected function mockDriverGetTpmData($tmpData, $driverClass = LocalDriver::class): void
     {
         $driver = $this->mockClass($driverClass, ['getTmpData']);
 
@@ -61,7 +64,7 @@ protected function mockDriverGetTpmData($tmpData, $driverClass = LocalDriver::cl
         $this->app->instance($driverClass, $driver);
     }
 
-    protected function mockDriverGetDocumentation($data, $driverClass = LocalDriver::class)
+    protected function mockDriverGetDocumentation($data, $driverClass = LocalDriver::class): void
     {
         $driver = $this->mockClass($driverClass, ['getDocumentation']);
 
@@ -73,7 +76,7 @@ protected function mockDriverGetDocumentation($data, $driverClass = LocalDriver:
         $this->app->instance($driverClass, $driver);
     }
 
-    protected function mockDriverSaveData($driverClass = LocalDriver::class)
+    protected function mockDriverSaveData($driverClass = LocalDriver::class): void
     {
         $driver = $this->mockClass($driverClass, ['saveData']);