RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-10 11:39:25 +03:00
Code Issues Projects Releases Wiki Activity

Document the support of OA annotations on methods

Browse Source
This commit is contained in:
Guilhem Niot 2020-07-12 15:21:14 +02:00
parent ad4e5551f5
commit fa3158ce67
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Resources/doc/index.rst
View File

@ -17,12 +17,12 @@ This bundle supports *Symfony* route requirements, PHP annotations, `Swagger-Php
For models, it supports the `Symfony serializer`_ , the `JMS serializer`_ and the `willdurand/Hateoas`_ library. For models, it supports the `Symfony serializer`_ , the `JMS serializer`_ and the `willdurand/Hateoas`_ library.
It does also support `Symfony form`_ types. It does also support `Symfony form`_ types.
Migrate from 2.x to 3.0 Migrate from 3.x to 4.0
----------------------- -----------------------
`To migrate from 2.x to 3.0, just follow our guide.`__ `To migrate from 3.x to 4.0, follow our guide.`__
__ https://github.com/nelmio/NelmioApiDocBundle/blob/master/UPGRADE-3.0.md __ https://github.com/nelmio/NelmioApiDocBundle/blob/master/UPGRADE-4.0.md
Installation Installation
------------ ------------
@ -241,7 +241,7 @@ You can customize the documentation of a form field using the ``documentation``
], ],
]); ]);
See the `OpenAPI 3.0 specification`__ to see all the available fields of the ``documentation`` option. See the `OpenAPI 3.0 specification`__ to see all the available fields of the ``documentation`` option (it accepts the same fields as the OpenApi ``Property`` object).
__ https://swagger.io/specification/ __ https://swagger.io/specification/
@ -293,6 +293,13 @@ If you want to customize the documentation of an object's property, you can use
* @OA\Property(ref=@Model(type=User::class)) * @OA\Property(ref=@Model(type=User::class))
*/ */
public $friend; public $friend;
/**
* @OA\Property(description="This is my coworker!")
*/
public setCoworker(User $coworker) {
// ...
}
} }
See the `OpenAPI 3.0 specification`__ to see all the available fields of ``@OA\Property``. See the `OpenAPI 3.0 specification`__ to see all the available fields of ``@OA\Property``.