OpenApi platform docs Response missing

[aarsla]

OpenApi docs for LexikJWTAuthenticationBundle's "Login Check" response schema is missing "refresh_token" attribute.

How can I (decorate OpenApiFactory?) include it in docs response/example value and match the actual response body?

[mbabker]

Decorate the lexik_jwt_authentication.api_platform.openapi.factory service provided by the LexikJWTAuthenticationBundle to add it, or disable that bundle's API Platform integration and add the info you need with a service in your own app.

I don't actually use API Platform so no idea what is the best solution, but there is no hook point in the Lexik bundle's factory class to extend the login endpoint's response schema. It also seems like you'd need something in your app documenting the refresh endpoint since this bundle doesn't provide an integration for that, either.

[galliroberto]

how to decorate it?

I set in service.yaml:

services:
    App\Documentation\LexikJWTAuthenticationSwagger:
        decorates: 'lexik_jwt_authentication.api_platform.openapi.factory'

And create the file:

final class LexikJWTAuthenticationSwagger implements OpenApiFactoryInterface
{
    public function __construct(private OpenApiFactory $openApiFactory)
    {
    }

    
    public function __invoke(array $context = []): OpenApi
    {
        $openApi = ($this->openApiFactory)();


        $openApi
            ->getPaths()
            ->getPath('/auth/token/request')->withPost(
                (new Operation())
                    ->withOperationId('login_check_post')
                    ->withTags(['Login Check'])
                    ->withResponses([
                        Response::HTTP_OK => [
                            'description' => 'User token created',
                            'content' => [
                                'application/json' => [
                                    'schema' => [
                                        'type' => 'object',
                                        'properties' => [
                                            'token' => [
                                                'readOnly' => true,
                                                'type' => 'string',
                                                'nullable' => false,
                                            ],
                                            'refresh_token' => [
                                                'readOnly' => true,
                                                'type' => 'string',
                                                'nullable' => false,
                                            ],
                                        ],
                                        'required' => ['token'],
                                    ],
                                ],
                            ],
                        ],
                    ])
                    ->withSummary('Creates a user token.')
                    ->withDescription('Creates a user token.')

            );

        return $openApi;
    }
}

I also tried:
$openApi = $this->openApiFactory->__invoke($context);

It doesn't work

[UrbiJr]

+1

[mateusfmello]

+1