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

Fix doc: Default => default (views)

Browse Source
This commit is contained in:
William Durand 2015-05-16 12:22:11 +02:00
parent e46bd73a32
commit e04981356b
No known key found for this signature in database
GPG Key ID: A509BCF1C1274F3B
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Resources/doc/index.md
View File

@ -235,7 +235,7 @@ define strict _method requirements etc.
With the `views` tag in the `@ApiDoc` annotation, it is possible to create With the `views` tag in the `@ApiDoc` annotation, it is possible to create
different views of your API documentation. Without the tag, all methods are different views of your API documentation. Without the tag, all methods are
located in the `Default` view, and can be found under the normal API located in the `default` view, and can be found under the normal API
documentation url. documentation url.
You can specify one or more _view_ names under which the method will be You can specify one or more _view_ names under which the method will be
@ -249,7 +249,7 @@ An example:
* @ApiDoc( * @ApiDoc(
* resource=true, * resource=true,
* description="This is a description of your API method", * description="This is a description of your API method",
* views = { "Default", "premium" } * views = { "default", "premium" }
* ) * )
*/ */
public function getAction() public function getAction()
@ -275,7 +275,7 @@ while both methods will be available under the `premium` view.
#### Accessing Specific API Views #### Accessing Specific API Views
The `Default` view can be found at the normal location. Other views can be The `default` view can be found at the normal location. Other views can be
found at `http://your.documentation/<view name>`. found at `http://your.documentation/<view name>`.
For instance, if your documentation is located at: For instance, if your documentation is located at: