You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/topics/documenting-your-api.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -93,11 +93,11 @@ When using viewsets, you should use the relevant action names as delimiters.
93
93
94
94
###`documentation` API Reference
95
95
96
-
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`.
96
+
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`.
97
97
98
-
`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.)
98
+
`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.)
99
99
100
-
####`include_docs_url`
100
+
####`include_docs_urls`
101
101
102
102
*`title`: Default`None`. May be used to provide a descriptive title for the schema definition.
103
103
*`description`: Default`None`. May be used to provide a description for the schema definition.