diff --git a/Formatter/MarkdownFormatter.php b/Formatter/MarkdownFormatter.php index 3126909..46a030c 100644 --- a/Formatter/MarkdownFormatter.php +++ b/Formatter/MarkdownFormatter.php @@ -76,6 +76,7 @@ class MarkdownFormatter extends AbstractFormatter $markdown .= sprintf("%s:\n\n", $name); $markdown .= sprintf(" * type: %s\n", $parameter['dataType']); $markdown .= sprintf(" * required: %s\n", $parameter['required'] ? 'true' : 'false'); + $markdown .= sprintf(" * readonly: %s\n", $parameter['readonly'] ? 'true' : 'false'); if (isset($parameter['description']) && !empty($parameter['description'])) { $markdown .= sprintf(" * description: %s\n", $parameter['description']); @@ -92,6 +93,7 @@ class MarkdownFormatter extends AbstractFormatter $markdown .= sprintf("%s:\n\n", $name); $markdown .= sprintf(" * type: %s\n", $parameter['dataType']); $markdown .= sprintf(" * required: %s\n", $parameter['required'] ? 'true' : 'false'); + $markdown .= sprintf(" * readonly: %s\n", $parameter['readonly'] ? 'true' : 'false'); if (isset($parameter['description']) && !empty($parameter['description'])) { $markdown .= sprintf(" * description: %s\n", $parameter['description']); diff --git a/README.md b/README.md index f669443..f7f044f 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,7 @@ class YourController extends Controller * @ApiDoc( * description="Create a new Object", * input="Your\Namespace\Form\Type\YourType" + * return='Your\Namespace\Class' * ) */ public function postAction() @@ -101,6 +102,8 @@ The following properties are available: * `input`: the input type associated to the method, currently this supports Form Types, and classes with JMS Serializer metadata, useful for POST|PUT methods, either as FQCN or as form type (if it is registered in the form factory in the container) + +* `return`: the return type associated with the response. Specified and parsed the same way as `input`. Each _filter_ has to define a `name` parameter, but other parameters are free. Filters are often optional parameters, and you can document them as you want, but keep in mind to be consistent for the whole documentation. diff --git a/Resources/views/method.html.twig b/Resources/views/method.html.twig index f7a1182..aab13ad 100644 --- a/Resources/views/method.html.twig +++ b/Resources/views/method.html.twig @@ -91,6 +91,7 @@
Parameter | +Type | +Required? | +Read Only? | +Description | +
---|---|---|---|---|
{{ name }} | +{{ infos.dataType }} | +{{ infos.required ? 'true' : 'false' }} | +{{ infos.readonly }} ? 'true' : 'false' | {{ infos.description }} |