Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

OpenApiFactory doesn't document DELETE with content

オープン
#8,418 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
66/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
静か
技術スタック
php
領域
api

調査の方向性

src/OpenApi/Factory/OpenApiFactory.php の 473 行目付近にあるリンクされたチェックから始め、issue にある BulkInput、BulkOutput、BulkProcessor を使ってカスタム DELETE を再現します。他の操作でリクエストボディがどのように生成されるかを追跡し、その後、生成された OpenAPI ドキュメントにこの DELETE 操作の uuids フィールドが含まれていることを確認します。

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
PHP
スター
2.6k
フォーク
982
平均マージ
1日 16時間
マージ済み PR（30日）
59

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

api-platform/core のほかの issue

api-platform/core の issue をすべて見る

似ている issue

PHP の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。