Skip to content

Commit b558c9e

Browse files
committed
Allow the documentation and schema shortcut functions to get a list of urls to introspect.
1 parent 3b466fa commit b558c9e

File tree

2 files changed

+15
-9
lines changed

2 files changed

+15
-9
lines changed

rest_framework/documentation.py

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,42 +6,46 @@
66
from rest_framework.schemas import get_schema_view
77

88

9-
def get_docs_view(title=None, description=None, schema_url=None, public=True):
9+
def get_docs_view(title=None, description=None, schema_url=None, public=True, patterns=None):
1010
renderer_classes = [DocumentationRenderer, CoreJSONRenderer]
1111

1212
return get_schema_view(
1313
title=title,
1414
url=schema_url,
1515
description=description,
1616
renderer_classes=renderer_classes,
17-
public=public
17+
public=public,
18+
patterns=patterns,
1819
)
1920

2021

21-
def get_schemajs_view(title=None, description=None, schema_url=None, public=True):
22+
def get_schemajs_view(title=None, description=None, schema_url=None, public=True, patterns=None):
2223
renderer_classes = [SchemaJSRenderer]
2324

2425
return get_schema_view(
2526
title=title,
2627
url=schema_url,
2728
description=description,
2829
renderer_classes=renderer_classes,
29-
public=public
30+
public=public,
31+
patterns=patterns,
3032
)
3133

3234

33-
def include_docs_urls(title=None, description=None, schema_url=None, public=True):
35+
def include_docs_urls(title=None, description=None, schema_url=None, public=True, patterns=None):
3436
docs_view = get_docs_view(
3537
title=title,
3638
description=description,
3739
schema_url=schema_url,
38-
public=public
40+
public=public,
41+
patterns=patterns,
3942
)
4043
schema_js_view = get_schemajs_view(
4144
title=title,
4245
description=description,
4346
schema_url=schema_url,
44-
public=public
47+
public=public,
48+
patterns=patterns,
4549
)
4650
urls = [
4751
url(r'^$', docs_view, name='docs-index'),

rest_framework/schemas.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -690,11 +690,13 @@ def get(self, request, *args, **kwargs):
690690
return Response(schema)
691691

692692

693-
def get_schema_view(title=None, url=None, description=None, urlconf=None, renderer_classes=None, public=False):
693+
def get_schema_view(
694+
title=None, url=None, description=None, urlconf=None,
695+
renderer_classes=None, public=False, patterns=None):
694696
"""
695697
Return a schema view.
696698
"""
697-
generator = SchemaGenerator(title=title, url=url, description=description, urlconf=urlconf)
699+
generator = SchemaGenerator(title=title, url=url, description=description, urlconf=urlconf, patterns=patterns)
698700
return SchemaView.as_view(
699701
renderer_classes=renderer_classes,
700702
schema_generator=generator,

0 commit comments

Comments
 (0)