Commit 8812e6c4 by Carlton Gibson Committed by GitHub

Merge pull request #5448 from carltongibson/pr/5309-docs-view-custom-auth

Allow setting custom authentication and permissions on docs view. 
parents 107e8b3d 1bcee8c6
...@@ -334,6 +334,15 @@ to be exposed in the schema: ...@@ -334,6 +334,15 @@ to be exposed in the schema:
May be used to specify a `SchemaGenerator` subclass to be passed to the May be used to specify a `SchemaGenerator` subclass to be passed to the
`SchemaView`. `SchemaView`.
#### `authentication_classes`
May be used to specify the list of authentication classes that will apply to the schema endpoint.
Defaults to `settings.DEFAULT_AUTHENTICATION_CLASSES`
#### `permission_classes`
May be used to specify the list of permission classes that will apply to the schema endpoint.
Defaults to `settings.DEFAULT_PERMISSION_CLASSES`
## Using an explicit schema view ## Using an explicit schema view
......
...@@ -4,11 +4,14 @@ from rest_framework.renderers import ( ...@@ -4,11 +4,14 @@ from rest_framework.renderers import (
CoreJSONRenderer, DocumentationRenderer, SchemaJSRenderer CoreJSONRenderer, DocumentationRenderer, SchemaJSRenderer
) )
from rest_framework.schemas import SchemaGenerator, get_schema_view from rest_framework.schemas import SchemaGenerator, get_schema_view
from rest_framework.settings import api_settings
def get_docs_view( def get_docs_view(
title=None, description=None, schema_url=None, public=True, title=None, description=None, schema_url=None, public=True,
patterns=None, generator_class=SchemaGenerator): patterns=None, generator_class=SchemaGenerator,
authentication_classes=api_settings.DEFAULT_AUTHENTICATION_CLASSES,
permission_classes=api_settings.DEFAULT_PERMISSION_CLASSES):
renderer_classes = [DocumentationRenderer, CoreJSONRenderer] renderer_classes = [DocumentationRenderer, CoreJSONRenderer]
return get_schema_view( return get_schema_view(
...@@ -19,12 +22,16 @@ def get_docs_view( ...@@ -19,12 +22,16 @@ def get_docs_view(
public=public, public=public,
patterns=patterns, patterns=patterns,
generator_class=generator_class, generator_class=generator_class,
authentication_classes=authentication_classes,
permission_classes=permission_classes,
) )
def get_schemajs_view( def get_schemajs_view(
title=None, description=None, schema_url=None, public=True, title=None, description=None, schema_url=None, public=True,
patterns=None, generator_class=SchemaGenerator): patterns=None, generator_class=SchemaGenerator,
authentication_classes=api_settings.DEFAULT_AUTHENTICATION_CLASSES,
permission_classes=api_settings.DEFAULT_PERMISSION_CLASSES):
renderer_classes = [SchemaJSRenderer] renderer_classes = [SchemaJSRenderer]
return get_schema_view( return get_schema_view(
...@@ -35,12 +42,16 @@ def get_schemajs_view( ...@@ -35,12 +42,16 @@ def get_schemajs_view(
public=public, public=public,
patterns=patterns, patterns=patterns,
generator_class=generator_class, generator_class=generator_class,
authentication_classes=authentication_classes,
permission_classes=permission_classes,
) )
def include_docs_urls( def include_docs_urls(
title=None, description=None, schema_url=None, public=True, title=None, description=None, schema_url=None, public=True,
patterns=None, generator_class=SchemaGenerator): patterns=None, generator_class=SchemaGenerator,
authentication_classes=api_settings.DEFAULT_AUTHENTICATION_CLASSES,
permission_classes=api_settings.DEFAULT_PERMISSION_CLASSES):
docs_view = get_docs_view( docs_view = get_docs_view(
title=title, title=title,
description=description, description=description,
...@@ -48,6 +59,8 @@ def include_docs_urls( ...@@ -48,6 +59,8 @@ def include_docs_urls(
public=public, public=public,
patterns=patterns, patterns=patterns,
generator_class=generator_class, generator_class=generator_class,
authentication_classes=authentication_classes,
permission_classes=permission_classes,
) )
schema_js_view = get_schemajs_view( schema_js_view = get_schemajs_view(
title=title, title=title,
...@@ -56,6 +69,8 @@ def include_docs_urls( ...@@ -56,6 +69,8 @@ def include_docs_urls(
public=public, public=public,
patterns=patterns, patterns=patterns,
generator_class=generator_class, generator_class=generator_class,
authentication_classes=authentication_classes,
permission_classes=permission_classes,
) )
urls = [ urls = [
url(r'^$', docs_view, name='docs-index'), url(r'^$', docs_view, name='docs-index'),
......
...@@ -20,13 +20,17 @@ basic use-cases: ...@@ -20,13 +20,17 @@ basic use-cases:
Other access should target the submodules directly Other access should target the submodules directly
""" """
from rest_framework.settings import api_settings
from .generators import SchemaGenerator from .generators import SchemaGenerator
from .inspectors import AutoSchema, ManualSchema # noqa from .inspectors import AutoSchema, ManualSchema # noqa
def get_schema_view( def get_schema_view(
title=None, url=None, description=None, urlconf=None, renderer_classes=None, title=None, url=None, description=None, urlconf=None, renderer_classes=None,
public=False, patterns=None, generator_class=SchemaGenerator): public=False, patterns=None, generator_class=SchemaGenerator,
authentication_classes=api_settings.DEFAULT_AUTHENTICATION_CLASSES,
permission_classes=api_settings.DEFAULT_PERMISSION_CLASSES):
""" """
Return a schema view. Return a schema view.
""" """
...@@ -40,4 +44,6 @@ def get_schema_view( ...@@ -40,4 +44,6 @@ def get_schema_view(
renderer_classes=renderer_classes, renderer_classes=renderer_classes,
schema_generator=generator, schema_generator=generator,
public=public, public=public,
authentication_classes=authentication_classes,
permission_classes=permission_classes,
) )
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment