encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-04-25 19:43:47 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fix typo (#5687)

Browse Source 
Fixed `include_docs_url` to be `include_docs_urls`
This commit is contained in:
Jimmy Merrild Krag 2017-12-19 15:03:47 +01:00 committed by Carlton Gibson
parent 4bcbf691cf
commit ea0b3b32ad
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/topics/documenting-your-api.md
View File

@ -93,11 +93,11 @@ When using viewsets, you should use the relevant action names as delimiters.
### `documentation` API Reference ### `documentation` API Reference
The `rest_framework.documentation` module provides three helper functions to help configure the interactive API documentation, `include_docs_url` (usage shown above), `get_docs_view` and `get_schemajs_view`. The `rest_framework.documentation` module provides three helper functions to help configure the interactive API documentation, `include_docs_urls` (usage shown above), `get_docs_view` and `get_schemajs_view`.
`include_docs_url` employs `get_docs_view` and `get_schemajs_view` to generate the url patterns for the documentation page and JavaScript resource that exposes the API schema respectively. They expose the following options for customisation. (`get_docs_view` and `get_schemajs_view` ultimately call `rest_frameworks.schemas.get_schema_view()`, see the Schemas docs for more options there.) `include_docs_urls` employs `get_docs_view` and `get_schemajs_view` to generate the url patterns for the documentation page and JavaScript resource that exposes the API schema respectively. They expose the following options for customisation. (`get_docs_view` and `get_schemajs_view` ultimately call `rest_frameworks.schemas.get_schema_view()`, see the Schemas docs for more options there.)
#### `include_docs_url` #### `include_docs_urls`
* `title`: Default `None`. May be used to provide a descriptive title for the schema definition. * `title`: Default `None`. May be used to provide a descriptive title for the schema definition.
* `description`: Default `None`. May be used to provide a description for the schema definition. * `description`: Default `None`. May be used to provide a description for the schema definition.