fix(openapi): Improve response override (#7428)

Author: VincentLanglet

src/OpenApi/Factory/OpenApiFactory.php

@@ -504,12 +504,15 @@ private function buildOpenApiResponse(array $existingResponses, int|string $stat
         $noOutput = \is_array($operation?->getOutput()) && null === $operation->getOutput()['class'];
 
         $response = $existingResponses[$status] ?? new Response($description);
+        if (null === $response->getDescription()) {
+            $response = $response->withDescription($description);
+        }
 
-        if (!$response->getContent() && $responseMimeTypes && $operationOutputSchemas && !$noOutput) {
+        if (null === $response->getContent() && $responseMimeTypes && $operationOutputSchemas && !$noOutput) {
             $response = $response->withContent($this->buildContent($responseMimeTypes, $operationOutputSchemas));
         }
 
-        if (!$response->getLinks() && $resourceMetadataCollection && $operation) {
+        if (null === $response->getLinks() && $resourceMetadataCollection && $operation) {
             $response = $response->withLinks($this->getLinks($resourceMetadataCollection, $operation));
         }
 

src/OpenApi/Model/Response.php

@@ -17,11 +17,11 @@ final class Response
 {
     use ExtensionTrait;
 
-    public function __construct(private string $description = '', private ?\ArrayObject $content = null, private ?\ArrayObject $headers = null, private ?\ArrayObject $links = null)
+    public function __construct(private ?string $description = null, private ?\ArrayObject $content = null, private ?\ArrayObject $headers = null, private ?\ArrayObject $links = null)
     {
     }
 
-    public function getDescription(): string
+    public function getDescription(): ?string
     {
         return $this->description;
     }

src/OpenApi/Tests/Factory/OpenApiFactoryTest.php

@@ -262,6 +262,18 @@ public function testInvoke(): void
                         ),
                     ],
                 )),
+                'postDummyItemWithEmptyResponse' => (new Post())->withUriTemplate('/dummyitems/noresponse')->withOperation($baseOperation)->withOpenapi(new OpenApiOperation(
+                    responses: [
+                        '201' => new OpenApiResponse(
+                            description: '',
+                            content: new \ArrayObject(),
+                            headers: new \ArrayObject(),
+                            links: new \ArrayObject(),
+                        ),
+                        '400' => new OpenApiResponse(),
+                    ],
+                    requestBody: new RequestBody(''),
+                )),
                 'postDummyItemWithoutInput' => (new Post())->withUriTemplate('/dummyitem/noinput')->withOperation($baseOperation)->withInput(false),
                 'getDummyCollectionWithErrors' => (new GetCollection())->withUriTemplate('erroredDummies')->withErrors([DummyErrorResource::class])->withOperation($baseOperation),
             ])
@@ -1209,6 +1221,40 @@ public function testInvoke(): void
             ]
         ), $dummyItemPath->getGet());
 
+        $emptyReponsePath = $paths->getPath('/dummyitems/noresponse');
+        $this->assertEquals(new Operation(
+            'postDummyItemWithEmptyResponse',
+            ['Dummy'],
+            [
+                '201' => new Response(
+                    '',
+                    new \ArrayObject(),
+                    new \ArrayObject(),
+                    new \ArrayObject()
+                ),
+                '400' => new Response(
+                    'Invalid input',
+                    content: new \ArrayObject(['application/problem+json' => new MediaType(schema: new \ArrayObject(['$ref' => '#/components/schemas/Error']))]),
+                    links: new \ArrayObject(['getDummyItem' => new Model\Link('getDummyItem', new \ArrayObject(['id' => '$response.body#/id']), null, 'This is a dummy')])
+                ),
+                '422' => new Response(
+                    'Unprocessable entity',
+                    content: new \ArrayObject(['application/problem+json' => new MediaType(schema: new \ArrayObject(['$ref' => '#/components/schemas/Error']))]),
+                    links: new \ArrayObject(['getDummyItem' => new Model\Link('getDummyItem', new \ArrayObject(['id' => '$response.body#/id']), null, 'This is a dummy')])
+                ),
+            ],
+            'Creates a Dummy resource.',
+            'Creates a Dummy resource.',
+            null,
+            [],
+            new RequestBody(
+                '',
+                content: new \ArrayObject([
+                    'application/ld+json' => new MediaType(new \ArrayObject(['$ref' => '#/components/schemas/Dummy.jsonld'])),
+                ]),
+            ),
+        ), $emptyReponsePath->getPost());
+
         $emptyRequestBodyPath = $paths->getPath('/dummyitem/noinput');
         $this->assertEquals(new Operation(
             'postDummyItemWithoutInput',