Add feature to update swagger context for properties

[mab05k]

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets
License	MIT
Doc PR	api-platform/docs#315

[mab05k]

@dunglas Pull request for documentation is at api-platform/docs#315

[dunglas]

Is this new method necessary?

[mab05k]

My thought here was to have that method there to add additional functionality in the future. In case you wanted to do more with the "attributes" on properties.

[dunglas]

This should be enough to get rid of all other lines:

$attributes = $propertyMetadata->getAttributes();

return new \ArrayObject((array) $propertySchema + $valueSchema + $attributes['swagger_context'] ?? []);

[mab05k]

@dunglas Updated per your comments.

[meyerbaptiste]

$attributeSchema is useless. ($propertyMetadata->getAttributes()['swagger_context'] ?? []) should do the trick.

[mab05k]

@meyerbaptiste Updated.

[meyerbaptiste]

Thanks @mab05k!

[greg0ire]

Maybe I just don't understand the feature, but I can't get it to work because of this guard clause:

core/src/Swagger/Serializer/DocumentationNormalizer.php

Lines 524 to 526 in c7e2cda

	if (null === $type = $propertyMetadata->getType()) {
	return $propertySchema;
	}

Because of it, the code in the PR is never reached, and I can't get the type to be anything else than null.

Here is what my resource definition looks like:

resources:

    EMA\MD\Interfaces\Work\Dto:
        shortName: Work
        description: Work DTO
        attributes:
            filters:
                - App\Infrastructure\ApiPlatform\DataProvider\WorkCollectionDataProvider
        properties:
            contentId:
                identifier: true
                type: string
                attributes:
                    swagger_context:
                        type: string
                        enum: ['one', 'two']
                        example: 'one'
        itemOperations:
            get:
                method: 'GET'
                path: /works/{id}
        collectionOperations:
            search:
                method: 'GET'
                path: /works

[mab05k]

My guess is there must be something with the entity class you are using that is causing the $propertyMetadata to resolve to a type of "null". I would need to see the rest of what you're working with to give you a better answer.

[greg0ire]

It's a DTO, maybe this could explain a lot of things?

namespace EMA\MD\Interfaces\Work;

final class Dto
{
    public $identifier;
    public $contentId;
    public $runLength;
    public $releaseYear;
    public $releaseDate;
    public $workType;
    public $originalTitle;
    public $countryOfOrigin;
    public $title;
}

[greg0ire]

I wrote #1466 to fix this.

[mab05k]

I actually have used a DTO for this. Try adding annotations of the types. And make sure you type hint your setter.

/*
 * @var string|null
 */
private $contentId;

[greg0ire]

Thanks, using the comment works!