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

Provide example for action summary and description

Browse Source
This commit is contained in:
David Buchmann 2018-01-09 10:31:38 +01:00 committed by GitHub
parent 393a6c061e
commit c30fb4c984
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Resources/doc/index.rst
View File

@ -123,6 +123,10 @@ To document your routes, you can use the SwaggerPHP annotations and the
class UserController class UserController
{ {
/* /*
* List the rewards of the specified user.
*
* This call takes into account all confirmed awards, but not pending or refused awards.
*
* @Route("/api/{user}/rewards", methods={"GET"}) * @Route("/api/{user}/rewards", methods={"GET"})
* @SWG\Response( * @SWG\Response(
* response=200, * response=200,
@ -146,6 +150,8 @@ To document your routes, you can use the SwaggerPHP annotations and the
} }
} }
The normal PHP docblock for the controller method is used for the summary and description.
Use models Use models
---------- ----------