Skip to content

Commit f9fb2fd

Browse files
committed
#31:- add description of the request fields to readme
1 parent 56d09e7 commit f9fb2fd

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

readme.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ to display the generated documentation for a config.
9393
public function rules()
9494
{
9595
return [
96+
'some_field',
9697
'all_cities_available' => 'boolean',
9798
'free_comparison' => 'boolean'
9899
];
@@ -104,6 +105,7 @@ to display the generated documentation for a config.
104105
- **@summary** - short description of request
105106
- **@description** - Implementation Notes
106107
- **@_204** - Custom description of code of response. You can specify any code as you want.
108+
- **@some_field** - Description of this field from the rules method
107109

108110
If you do not create a class Request, the summary, Implementation Notes and parameters will be empty.
109111
Plugin will collect codes and examples of responses only.

0 commit comments

Comments
 (0)