acassan
commented
3 years ago As workaround, I rewrite decorator
<?php
declare(strict_types=1);
namespace App\OpenApi;
use ApiPlatform\Core\OpenApi\Factory\OpenApiFactoryInterface;
use ApiPlatform\Core\OpenApi\OpenApi;
use ApiPlatform\Core\OpenApi\Model;
final class ForgotPasswordDecorator implements OpenApiFactoryInterface
{
public function __construct(
private OpenApiFactoryInterface $decorated
) {}
public function __invoke(array $context = []): OpenApi
{
$openApi = ($this->decorated)($context);
$schemas = $openApi->getComponents()->getSchemas();
$schemas['ForgotPassword:reset'] = new \ArrayObject([
'type' => 'object',
'required' => ['password'],
'properties' => [
'password' => [
'type' => 'string',
],
],
]);
$schemas['ForgotPassword:validate'] = new \ArrayObject([
'type' => 'object',
]);
$schemas['ForgotPassword:request'] = new \ArrayObject([
'type' => 'object',
'required' => ['email'],
'properties' => [
'email' => [
'type' => 'string',
],
],
]);
$pathItem = new Model\PathItem(
ref: 'ForgotPassword',
post: new Model\Operation(
operationId: 'postForgotPassword',
tags: ['Forgot password'],
responses: [
204 => [
'description' => 'Valid email address, no matter if user exists or not',
],
400 => [
'description' => 'Missing email parameter or invalid format',
],
],
summary: 'Generates a token and send email',
requestBody: new Model\RequestBody(
description: 'Request a new password',
content: new \ArrayObject([
'application/json' => [
'schema' => [
'$ref' => '#/components/schemas/ForgotPassword:request',
],
],
]),
),
),
);
$openApi->getPaths()->addPath('/forgot-password/', $pathItem);
$pathItem = new Model\PathItem(
ref: 'ForgotPassword',
get: new Model\Operation(
operationId: 'getForgotPassword',
tags: ['Forgot password'],
responses: [
200 => [
'description' => 'Authenticated user',
'content' => [
'application/json' => [
'schema' => [
'$ref' => '#/components/schemas/ForgotPassword:validate',
],
],
],
],
404 => [
'description' => 'Token not found or expired',
],
],
summary: 'Validates token',
parameters: [
[
'name' => 'token',
'in' => 'path',
'required' => true,
'schema' => [
'type' => 'string',
],
],
]
),
post: new Model\Operation(
operationId: 'postForgotPasswordToken',
tags: ['Forgot password'],
responses: [
204 => [
'description' => 'Email address format valid, no matter if user exists or not',
],
400 => [
'description' => 'Missing password parameter',
],
404 => [
'description' => 'Token not found',
],
],
summary: 'Resets user password from token',
parameters: [
[
'name' => 'token',
'in' => 'path',
'required' => true,
'schema' => [
'type' => 'string',
],
],
],
requestBody: new Model\RequestBody(
description: 'Reset password',
content: new \ArrayObject([
'application/json' => [
'schema' => [
'$ref' => '#/components/schemas/ForgotPassword:reset',
],
],
]),
),
),
);
$openApi->getPaths()->addPath('/forgot-password/{token}', $pathItem);
return $openApi;
}
}
`
Documentation is well generated
vincentchalamon
Describe the bug Got "Call to a member function withPost() on null" in vendor/tilleuls/forgot-password-bundle/Bridge/ApiPlatform/OpenApi/OpenApiFactory.php (line 46)
Unable to generate documentation
To Reproduce Install bundle on api-platform 2.6
Expected behavior Endpoints displayed on documentation
Dont know where is problem, in var $paths, bundle routes are not set, maybe "DocumentationNormalizer" not registered ? I can PR if problem found