Understanding why requestBody.required is expected as true in OpenApiFactoryTest

[monitaurus]

Hi there.

I'm working on a PR related to this discussion api-platform/api-platform#2680, to make optional parameters in the OpenAPI RequestBody model.

My question doesn't evolve around my code, but I'm trying to understand a test case on the dummy postDummyCollection within OpenApiFactoryTest (see here).

In the assertion part, it's expected for postDummyCollection RequestBody's required to be true (see here).

But the dummy is built straight with the $baseOperation (line 83) which doesn't state anything about the RequestBody. In that case, I was thinking required should be false, as it's the default value in the constructor (see constructor).

Does someone know what's the logical path involve for the core to generate a required true in this test case?

[soyuka]

On API Platform the body is required on every "write" operations.

[monitaurus]

It's totally make sens, thanks.
I changed my code to comply with this.

But while looking at the rest of the test cases, I stumble upon this dummy postDummyCollectionWithRequestBody, which define a POST operation, without the required parameter:

'postDummyCollectionWithRequestBody' => (new Post())->withUriTemplate('/dummiesRequestBody')->withOperation($baseOperation)->withOpenapi(new OpenApiOperation(
    requestBody: new RequestBody(
        description: 'List of Ids',
        content: new \ArrayObject([
            'application/json' => [ ... ],
        ]),
    ),
)),

Based on current Model\RequestBody parameters (see here), the default of required is false.
So the assert ends up testing required to be false (see here).

This assert seems logic to me given the actual code, but based on the rule you mentioned @soyuka "the body is required on every "write" operations", this dummy seems to show a way to create an operation that contradicts it.

Is there another thingI didn't catch that explain this?

[soyuka]

open api allows this. it's probable that there's a bug in how API Platform describes the OpenAPI documentation in that regard.

[monitaurus]

Thanks for the clarification.
I'll make the PR comply with the current implementation of API Platform.