encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-22 17:47:04 +03:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
Allow setting custom authentication and permissions on docs view.
This commit is contained in:
Carlton Gibson 2017-09-25 16:50:16 +02:00 committed by GitHub
commit 8812e6c47a
3 changed files with 34 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/api-guide/schemas.md
View File

@ -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

21
rest_framework/documentation.py
View File

@ -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(
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(
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(
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(
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'),

8
rest_framework/schemas/__init__.py
View File

@ -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(
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,
) )