Skip to content

OpenApiFactory doesn't document DELETE with content #8418

Description

@VincentLanglet

API Platform version(s) affected: 4.3.17

Description
Hi @soyuka

Because the OpenApiFactory does an explicit check on PATCH / PUT / POST,

\in_array($method, ['PATCH', 'PUT', 'POST'], true)

an operation which does DELETE never have a request body generated.

This is often ok since DELETE does not require a request body. But for custom DELETE which are using Inputs, documentation would be nice.
I wonder if this was done on purpose or if this should be fixed ?

How to reproduce

new Delete(
            uriTemplate: '/foo/bulk-delete',
            status: 200,
            openapi: new Operation(
                responses: [
                    200 => new Response(description: 'Foo deleted successfully'),
                ],
            ),
            input: BulkInput::class,
            output: BulkOutput::class,
            read: false,
            deserialize: true,
            processor: BulkProcessor::class,
        ),

with

class BulkInput
{
    /**
     * @var Uuid[]
     */
    public array $uuids = [];

    //...
}

The uuids field is not documented.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions