feat(openapi): allow optional request body content

[monitaurus]

Q	A
Branch?	main
Tickets	Closes #2680
License	MIT
Doc PR	already existing (see doc)

Allow to generate a default request content or description if not defined in the extension of OpenApi using Model\RequestBody.

For example, on a POST /greetings/test operation on a Greeting entity with a id and a name, the following:

#[ApiResource(
    mercure: true,
    operations: [
        new Post(
            uriTemplate: '/greetings/test',
            openapi: new Operation(
                requestBody: new RequestBody(
                    description: 'Extended description',
                ),
            ),
        ),
    ],
)]

Will generate the following OpenApi, with the default generated content:

[soyuka]

to understand this correctly the main change is that true is now the default value when there's a request body ?

I think that early on we used false as a default value to comply with: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#request-body-object I agree that this is better thanks!

[monitaurus]

to understand this correctly the main change is that true is now the default value when there's a request body ?

In the current code, the constructor set Model\RequestBody's required to false by default. But the OpenFactory force the required to be true if there were no RequestBody and if this was a write operation.

Here the PR allow the developer to fine-tune the values as he/she wants.
So it's even possible now to set a required to false even in a write operation.

[soyuka]

funny enough content is Required in the spec: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#request-body-object

[monitaurus]

The PR's originated where I wanted to edit the description of an endpoint, but by doing so, I needed to rewrite the whole content.

The PR code make the Model\RequestBody itself differs from OpenAPI own specification.
But the whole OpenApiFactory will bring back the compliance while the specification by overwriting the content if it's set to null.

[soyuka]

see my previous comment this was correct but the constructor is not