mirror of
https://github.com/retailcrm/NelmioApiDocBundle.git
synced 2025-03-11 18:16:13 +03:00
Updates documentation to show a side effect of design decision.
When using serializer context groups in JMS serializer, even if just using the Default group in one place explicitly and leaving it blank in another, they will be treated as different component schemas, even though to the serializer outcome they are the same. Documenting behavior of decision with side effect.
This commit is contained in:
parent
7f3926cc89
commit
730feba2d9
@ -256,6 +256,28 @@ General PHP objects
|
||||
**If you're using the JMS Serializer**, the metadata of the JMS serializer are used by default to describe your
|
||||
models. Additional information is extracted from the PHP doc block comment,
|
||||
but the property types must be specified in the JMS annotations.
|
||||
|
||||
NOTE: If you are using serialization contexts (e.g. Groups) each permutation will be treated as a separate Path. For example if you have the following two variations defined in different places in your code:
|
||||
|
||||
.. code-block:: php
|
||||
/**
|
||||
* A nested serializer property with no context group
|
||||
*
|
||||
* @JMS\VirtualProperty
|
||||
* @JMS\Type("ArrayCollection<App\Response\ItemResponse>")
|
||||
* @JMS\Since("1.0")
|
||||
*
|
||||
* @return Collection|ItemResponse[]
|
||||
*/
|
||||
public function getItems(): Collection|array
|
||||
{
|
||||
return $this->items;
|
||||
}
|
||||
|
||||
.. code-block
|
||||
@OA\Schema(ref=@Model(type="App\Response\ItemResponse", groups=["Default"])),
|
||||
|
||||
It will generate two different component schemas (ItemResponse, ItemResponse2), even though Default and blank are the same. This is by design.
|
||||
|
||||
In case you prefer using the `Symfony PropertyInfo component`_ (you
|
||||
won't be able to use JMS serialization groups), you can disable JMS serializer
|
||||
|
Loading…
x
Reference in New Issue
Block a user