Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

OpenApiFactory doesn't document DELETE with content

Aperta
#8,418 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
66/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
php
Ambito
api

Direzione di ricerca

Inizia in src/OpenApi/Factory/OpenApiFactory.php, in corrispondenza del controllo indicato vicino alla riga 473, e riproduci il DELETE personalizzato usando BulkInput, BulkOutput e BulkProcessor dell'issue. Traccia come vengono generati i corpi delle richieste per le altre operazioni, quindi verifica che il documento OpenAPI generato includa il campo uuids per questa operazione DELETE.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

API Platform version(s) affected: 4.3.17

Description
Hi @soyuka

Because the OpenApiFactory does an explicit check on PATCH / PUT / POST,
https://github.com/api-platform/core/blob/dd00d0fa2862d06736fe9db66ac16fa382360e0f/src/OpenApi/Factory/OpenApiFactory.php#L473
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.

Lingua principale
PHP
Stelle
2.6k
Fork
982
Merge medio
1g 16h
PR unite (30g)
59

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di api-platform/core

Tutte le issue di api-platform/core

Issue simili

Altre issue su PHP

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.