Briq
/
drf-yasg
6
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Correct values in swagger-ui docs (#108)

openapi3
Tobias Krönke 2018-04-25 16:53:22 +02:00 committed by Cristi Vîjdea
parent 322971f3e7
commit 5e684549a1
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/settings.rst
View File

@ -190,8 +190,8 @@ OPERATIONS_SORTER
Sorting order for the operation list of each tag. Sorting order for the operation list of each tag.
* :python:`None`: show in the order returned by the server * :python:`None`: show in the order returned by the server
* :python:`alpha`: sort alphabetically by path * :python:`'alpha'`: sort alphabetically by path
* :python:`method`: sort by HTTP method * :python:`'method'`: sort by HTTP method
**Default**: :python:`None` |br| **Default**: :python:`None` |br|
*Maps to parameter*: ``operationsSorter`` *Maps to parameter*: ``operationsSorter``
@ -202,7 +202,7 @@ TAGS_SORTER
Sorting order for tagged operation groups. Sorting order for tagged operation groups.
* :python:`None`: Swagger UI default ordering * :python:`None`: Swagger UI default ordering
* :python:`alpha`: sort alphabetically * :python:`'alpha'`: sort alphabetically
**Default**: :python:`None` |br| **Default**: :python:`None` |br|
*Maps to parameter*: ``tagsSorter`` *Maps to parameter*: ``tagsSorter``
@ -212,9 +212,9 @@ DOC_EXPANSION
Controls the default expansion setting for the operations and tags. Controls the default expansion setting for the operations and tags.
* :python:`None`: everything is collapsed * :python:`'none'`: everything is collapsed
* :python:`list`: only tags are expanded * :python:`'list'`: only tags are expanded
* :python:`full`: all operations are expanded * :python:`'full'`: all operations are expanded
**Default**: :python:`'list'` |br| **Default**: :python:`'list'` |br|
*Maps to parameter*: ``docExpansion`` *Maps to parameter*: ``docExpansion``
@ -240,8 +240,8 @@ DEFAULT_MODEL_RENDERING
Controls whether operations show the model structure or the example value by default. Controls whether operations show the model structure or the example value by default.
* :python:`model`: show the model fields by default * :python:`'model'`: show the model fields by default
* :python:`example`: show the example value by default * :python:`'example'`: show the example value by default
**Default**: :python:`'model'` |br| **Default**: :python:`'model'` |br|
*Maps to parameter*: ``defaultModelRendering`` *Maps to parameter*: ``defaultModelRendering``