fix: add support for normalization/denormalization with attributes

[Maxcastel]

Q	A
Branch?	4.2
Tickets	Closes #7536
License	MIT

ApiResource examples:

#[ApiResource(
    operations: [
        new Get(
            normalizationContext: [
                'attributes' => ['title', 'name', 'author' => ['name']],
            ],
        ),
        new Post(
            denormalizationContext: [
                'attributes' => ['title', 'name', 'author' => ['name']], 
            ],
            normalizationContext: [
                'attributes' => ['id', 'title', 'author' => ['id', 'name']],
            ],
        )
    ]
)]
class Book
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column(type: 'integer')]
    private ?int $id = null;

    #[Groups(['book:read'])]
    #[ORM\Column(type: 'string', length: 255)]
    public string $title = 'The book title';

    #[ORM\Column(type: 'string', length: 255)]
    private ?string $name = null;

    #[ORM\ManyToOne(targetEntity: Author::class)]
    #[ORM\JoinColumn(nullable: false)]
    private Author $author;
    
    #[ORM\Column(type: 'string', length: 20)]
    public string $isbn = '978-3-16-148410-0';

    // getters and setters
}

#[ApiResource]
class Author
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column(type: 'integer')]
    private ?int $id = null;

    #[Groups(['user:read', 'user:write'])]
    #[ORM\Column(type: 'string', length: 255)]
    private string $name;

    // getters and setters
}

Before

API response

/api/books/id GET:

API Docs

JSON Schema

bin/console api:openapi:export --output=swagger_docs.json

"application/json": {
    "schema": {
        "$ref": "#/components/schemas/Book"
    }
}

"Book": {
    "type": "object",
    "properties": {
        "id": {
            "readOnly": true,
            "type": "integer"
        },
        "title": {
            "default": "The book title",
            "type": "string"
        },
        "name": {
            "type": "string"
        },
        "author": {
            "type": "string",
            "format": "iri-reference",
            "example": "https://example.com/"
        },
        "isbn": {
            "default": "978-3-16-148410-0",
            "type": "string"
        }
    }
}

Now

API response

/api/books/id GET:

API Docs

JSON Schema

"application/json": {
    "schema": {
        "$ref": "#/components/schemas/Book-title_name_author.name"
    }
}

"Book-title_name_author.name": {
    "type": "object",
    "properties": {
        "title": {
            "default": "The book title",
            "type": "string"
        },
        "name": {
            "type": "string"
        },
        "author": {
            "$ref": "#/components/schemas/Author-name"
        }
    }
}

"Author-name": {
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        }
    }
}

[soyuka]

This looks nice, can you add a test on the JsonSchema generation (tests/Functional/JsonSchema/JsonSchemaTest.php) as I'm not sure that we'd gather the correct properties.

[Maxcastel]

I rebased onto 4.2 to retrieve the code that fixes the 8 failing tests.

[Maxcastel]

This looks nice, can you add a test on the JsonSchema generation (tests/Functional/JsonSchema/JsonSchemaTest.php) as I'm not sure that we'd gather the correct properties.

Done in c2b0997 @soyuka