@Groups and @ApiProperty annotations not inherited from parent classes and/or traits

[lopezio]

API Platform version(s) affected: 2.5.0

Description
Inheritance of Serializer @groups or @ApiProperty items seems not to be honoured when extending classes or adding Traits to a class.

How to reproduce
Example class:

/**
 * @ORM\MappedSuperclass()
 * @ORM\HasLifecycleCallbacks()
 */
abstract class BaseEntity
{
    /**
     * @ApiProperty()
     * @ORM\Column(type="datetime")
     * @Groups({"base:internal"})
     */
    private $created;

    /**
     * @ApiProperty()
     * @ORM\Column(type="datetime")
     * @Groups({"base:internal"})
     */
    private $modified;

    /**
     * @ORM\ManyToOne(targetEntity="App\Entity\User")
     * @Groups({"base:internal"})
     */
    private $creator;
    ...
}

Classes extending this one have correct fields in Doctrine, but the ApiPlatform Groups and other annotations in ApiProperty are not honored.
The same happens if I add properties and getters/setters via a a corresponding Trait, e.g.

/**
 * Trait TimeStampedEntityTrait
 * @package App\Entity
 */
trait TimeStampedEntityTrait
{
    /**
     * @ORM\Column(type="datetime")
     * @Groups({"base:internal"})
     */
    private $created;

    /**
     * @ApiProperty()
     * @ORM\Column(type="datetime")
     * @Groups({"base:internal"})
     */
    private $modified;
    ...
}

I would expect the annotations to be carried on into all children.

[lopezio]

Addition: Even adding @ApiProperty() annotation on top (which isn't correct conceptually, since the BaseEntity deosn't actually represent a Resource), the serialization Groups are still not honoured in the children.

[soyuka]

We're using Traits and their properties are taken into consideration when used in an @ApiResource. We also have test cases that are using abstract classes:
https://github.com/api-platform/core/blob/bf867e02964271ce36e4355e7bde104f1e57d2da/tests/Fixtures/TestBundle/Entity/AbstractDummy.php
https://github.com/api-platform/core/blob/2f941fc3c0dc9dd257da3b34a6bb3f5c21c4230c/tests/Fixtures/TestBundle/Entity/ConcreteDummy.php

An ApiProperty can not be used outside an ApiResource (for example it'll work with the trait when used in an ApiResource)

[lopezio]

OK, I must correct this. Traits seem to be working fine. And ApiProperty() annotation, so far, seem to be too. I can't reproduce the original problem leading to this pr right now. In one case, it helped to remove the ApiProperty annotation in a child, reloading the documentation, and then pasting it back in, and there it was (caching..)?

However:

• Abstract classes should (imo) not be listed in swagger nor available as endpoints;
• @ApiFilter annotations are not inherited..

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.