openapi_context: "in"="body" regression in 2.6.2

[lazka]

Upgrade from 2.6.1 to 2.6.2 leads to this error:

I have the following annotations:

 *             "openapi_context"={
 *                 "parameters"={
 *                    {"name"="body", "in"="body", "description"="Token", "type"="string", "example"={"token"="foo", "typeId"="bar"}, "required"=true}
 *                 }
 *             },

It seems that "in"="body" no longer works.

It leads to

Symfony\Component\PropertyAccess\Exception\AccessException:
The method "ApiPlatform\Core\OpenApi\Model\Parameter::getStyle()" returned "null", but expected type "string". Did you forget to initialize a property or to make the return type nullable using "?string"?

  at vendor/symfony/property-access/PropertyAccessor.php:403
  at Symfony\Component\PropertyAccess\PropertyAccessor->readProperty(array(object(Parameter)), 'style', false)
     (vendor/symfony/property-access/PropertyAccessor.php:93)
  at Symfony\Component\PropertyAccess\PropertyAccessor->getValue(object(Parameter), 'style')
     (vendor/symfony/serializer/Normalizer/ObjectNormalizer.php:148)

[lazka]

(also "required"="true" also throws an error now, but I fixed that locally to remove the quotes. Should I file a bug?)

[cacahouwete]

I think my PR solve your problem about getStyle

#4033

[cavasinf]

Same case here, even when following the DOC.

And I don't think the DOC is either up to date.

@lazka How did you manage your "body" without schema ?
Downgrading to 2.6.1 broke my body part..

[cavasinf]

@cacahouwete Doesn't seems to be the solution,
In the constructor of Parameter, style is defined there.
Parameter Constructor Line

But I don't see the case for body, the "nearest" type is query ? 🤔

[cavasinf]

@lazka & @cacahouwete
Looking through change logs from 2.6.0, This PR is looking sus #4001.

So I've checked the Test file for this PR

And, as I can see in : "body" is not a thing anymore.
We need to go through requestBody inside of openapi_context.

Here my case (with my Entity too) in YAML:

App\Entity\construction_site\ConstructionSite:

    [...]

    itemOperations:
        ## GET ##
        get:
            method: 'GET'
        ## PUT ##
        put:
            method: 'PUT'

        ## SetCosu ##
        constructionSite_setCosu:
            method: "PUT"
            path: "construction_sites/{id}/setCosu"
            controller: App\Controller\API\SetConstructionSiteCosu
            security: "is_granted('ROLE_ADMIN')"
            openapi_context:
                summary: "Set cosu on Construction Site"
                description: "Set the cosu of a ConstructionSite"
                parameters:
                    -
                        in: "path"
                        name: "id"
                        description: "Id of ConstructionSite"
                        required: true
                        type: "integer"

                requestBody:
                    description: "Go to 'Schema' to see the description of the body fields"
                    content:
                        application/json:
                            schema:
                                type: "object"
                                required: "cosu"
                                properties:
                                    cosu:
                                        type: "boolean"
                                        description: "True : Disabled | False : Enabled"
                                        example: true
        #######################################

The Result:

Note : I think input_formats & required are gone too:

constructionSite_setCosu:
            method: "PUT"

            [...]

            input_formats:
                json: "application/json"

            [...]

            openapi_context:
                requestBody:
                    content:
                        application/json:
                            schema:
                                required: "cosu"

[cacahouwete]

@cavasinf
If the conditions about setting "style" are not true , then style can be null, there are no default value about style.
Having a correct type hint is important.
Or we have to change conditions to set style to have a default value like "simple" or ...

[soyuka]

Hello, finally got time to check this. body is not a valid parameter for the in, see the specification:

REQUIRED. The location of the parameter. Possible values are "query", "header", "path" or "cookie".

The corresponding style:

Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.

You should use Swagger (configure the v2 instead of the v3) if you want the old behavior.