Call to a member function getContent() on array when generating openapi schema

[fcharrier]

API Platform version(s) affected: 4.2.1

Description
When I update my app with api-platform 4.2.1 (was 4.1.24 before), I can't generate openapi schema anymore (with bin/console api:openapi:export)

Possible Solution
The bug occurs in api-platform/openapi/Factory/OpenApiFactory.php line 508:

/**
 * @param array<Response> $existingResponses
 */
private function buildOpenApiResponse(array $existingResponses, int|string $status, string $description, Operation $openapiOperation, ?HttpOperation $operation = null, ?array $responseMimeTypes = null, ?array $operationOutputSchemas = null, ?ResourceMetadataCollection $resourceMetadataCollection = null): Operation
{
    $noOutput = \is_array($operation?->getOutput()) && null === $operation->getOutput()['class'];

    $response = $existingResponses[$status] ?? new Response($description);

    if (!$response->getContent() && $responseMimeTypes && $operationOutputSchemas && !$noOutput) {
        $response = $response->withContent($this->buildContent($responseMimeTypes, $operationOutputSchemas));
    }

=> With api-platform/openapi 4.2.1, $response is an array on my app. So $response->getContent() crashes

With api-platform/openapi 4.1.24, the code was different:

private function buildOpenApiResponse(array $existingResponses, int|string $status, string $description, ?Operation $openapiOperation = null, ?HttpOperation $operation = null, ?array $responseMimeTypes = null, ?array $operationOutputSchemas = null, ?ResourceMetadataCollection $resourceMetadataCollection = null): Operation
    {
        if (isset($existingResponses[$status])) {
            return $openapiOperation;
        }

in this case, if existingResponses is an array, it works properly.

Additional Context

bin/console api:openapi:export --output=var/openapi.json
18:54:35 CRITICAL  [console] Error thrown while running command "api:openapi:export --output='var/openapi.json'". Message: "Call to a member function getContent() on array" ["exception" => Error { …},"command" => "api:openapi:export --output='var/openapi.json'","message" => "Call to a member function getContent() on array"]

In OpenApiFactory.php line 508:
                                                   
  Call to a member function getContent() on array  
                                                   

api:openapi:export [-y|--yaml] [-o|--output OUTPUT] [--spec-version SPEC-VERSION] [--api-gateway] [--filter-tags FILTER-TAGS]

[fcharrier]

I don't understand why I get this code:

/**
 * @param array<Response> $existingResponses
 */
private function buildOpenApiResponse(array $existingResponses, int|string $status, string $description, Operation $openapiOperation, ?HttpOperation $operation = null, ?array $responseMimeTypes = null, ?array $operationOutputSchemas = null, ?ResourceMetadataCollection $resourceMetadataCollection = null): Operation
{
    $noOutput = \is_array($operation?->getOutput()) && null === $operation->getOutput()['class'];

    $response = $existingResponses[$status] ?? new Response($description);

    if (!$response->getContent() && $responseMimeTypes && $operationOutputSchemas && !$noOutput) {
        $response = $response->withContent($this->buildContent($responseMimeTypes, $operationOutputSchemas));
    }

when I update to 4.2.1: it's not the same found here:
https://github.com/api-platform/core/blob/main/src/OpenApi/Factory/OpenApiFactory.php#L499

I suppose I make something wrong, but can't understand what.

EDIT: ok, I understand, 4.2.1 version of this code is not the same as main:
https://github.com/api-platform/core/blob/v4.2.1/src/OpenApi/Factory/OpenApiFactory.php

[fcharrier]

Is it possible that this commit is wrong?
https://github.com/api-platform/core/pull/7412/files

[fcharrier]

@VincentLanglet and @soyuka if you have any idea, I'm a little bit lost :(

[fcharrier]

If it helps: If I change buildOpenApiResponse method with the main version, it works again

[VincentLanglet]

Rather than identifying the code which break on api platform side, you should give your Operation config/declaration which might be wrong.

=> With api-platform/openapi 4.2.1, $response is an array on my app. So $response->getContent() crashes

Why would response be an array on your app ?

We have

 $existingResponses = $openapiOperation->getResponses() ?: [];

and

$response = $existingResponses[$status] ?? new Response($description)

And if you look at Operation::withResponse,

core/src/OpenApi/Model/Operation.php

Line 28 in 510fa55

public function addResponse(Response $response, $status = 'default'): self

, the existing responses is supposed to be an array array<string, Response>, and not array<string, array<Response>>.

So $response is a Response, unless you're configuring your Operation with something like

responses: [
     '400' => [new Response(...)],
],

which seems wrong to me.

[yunicot]

I had the same problem. Before it was allowed to write in operation like:

openapi: new Model\Operation(
    responses: [
        '202' => [
            'description' => 'Some description for response with 202',
        ],
    ],
)

But after update it should be like:

openapi: new Model\Operation(
    responses: [
        202 => new Model\Response(
            description: 'Some description for response with 202',
        ),
    ],
)

It looks like small BC break in v4.2.1

[fcharrier]

Thank you both for your reactivity! :)

I was configuring Operation as you guess @VincentLanglet:

new Post(
    uriTemplate: 'myendpointurl',
    status: Response::HTTP_ACCEPTED,
    openapi: new Operation(
        responses: [
            Response::HTTP_ACCEPTED => [
                'description' => 'operation is in progress...',
            ],
            Response::HTTP_CONFLICT => [
                'description' => 'operation refused: same operation is already in progress',
            ],
        ],

And yes, if I fix it with the correct way, it works again! :)

I don't know if it's a breaking change as you say yunicot, I'm upgrading from 4.1.24 to 4.2.1 due to another bug in 4.2.0.

[VincentLanglet]

I dunno if it was supposed to be supported. I let @soyuka answer to this.

But if it's supported I will write a fix, it seems easy

[fcharrier]

No problem. Maybe we made a mistake, it worked by chance, but was not supposed to. Anyway I fixed in my app. And this bug will help others devs to find a solution if needed

I think it can be closed.