Add an XML / YML example for "Serialization Groups and Relations"

[dkarlovi]

Docs says "The Symfony Serializer component allows to specify the definition of serialization using XML, YAML, or annotations. "

But there's no sample how to setup for example this:

/**
 * @ApiResource(
 *     attributes={"normalization_context"={"groups"={"get"}}},
 *     itemOperations={
 *          "get"={"method"="GET"},
 *          "put"={"method"="PUT", "normalization_context"={"groups"={"put"}}}
 *     }
 * )
 */

in XML or YAML. AFAIK there's also no XML Schema provided (as Symfony does) so it's ever harder to discover the functionality.

It would be great to provide a sample XML / YAML config, even just in a Git repo somewhere. I've looked in core's tests, there isn't one there either.

[soyuka]

You can find examples here: https://github.com/api-platform/core/tree/master/tests/Fixtures/FileConfigurations

We should have added those to the documentation, for example with custom operations we added yaml and xml configuration examples.

Is this what you were looking for? We have a schema for XML metadata here.

[dkarlovi]

That was exactly what I was looking for, but I looked for those in tests/Fixtures/TestBundle/Resources/config. :( So it's just a matter of discoverability. That's the same reason I've assumed you don't ship XML schema: there's none in the docs.

Having those in the docs would surely help, yes.

Thank you very much @soyuka, closing this.

[soyuka]

@dkarlovi I'll leave this open until someone has the time to update the docs regarding this issue! Thanks for the report.

[Simperfit]

It is now documented

[egorzot]

Here is the example in docs

[dunglas]

It's a goal for the project to document available configuration options in all formats.
But it's tedious and it takes time.
Help on this topic would be very welcome.

It can be contributing the missing configs, or improving the website to display a format selector like on the Symfony website.