Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
D
django-rest-framework
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
edx
django-rest-framework
Commits
5333565f
Commit
5333565f
authored
Sep 25, 2017
by
Katharyn Garcia
Committed by
Carlton Gibson
Sep 25, 2017
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
allow custom authentication and permission classes for docs view
parent
107e8b3d
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
25 additions
and
4 deletions
+25
-4
rest_framework/documentation.py
+18
-3
rest_framework/schemas/__init__.py
+7
-1
No files found.
rest_framework/documentation.py
View file @
5333565f
...
...
@@ -4,11 +4,14 @@ from rest_framework.renderers import (
CoreJSONRenderer
,
DocumentationRenderer
,
SchemaJSRenderer
)
from
rest_framework.schemas
import
SchemaGenerator
,
get_schema_view
from
rest_framework.settings
import
api_settings
def
get_docs_view
(
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
]
return
get_schema_view
(
...
...
@@ -19,12 +22,16 @@ def get_docs_view(
public
=
public
,
patterns
=
patterns
,
generator_class
=
generator_class
,
authentication_classes
=
authentication_classes
,
permission_classes
=
permission_classes
,
)
def
get_schemajs_view
(
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
]
return
get_schema_view
(
...
...
@@ -35,12 +42,16 @@ def get_schemajs_view(
public
=
public
,
patterns
=
patterns
,
generator_class
=
generator_class
,
authentication_classes
=
authentication_classes
,
permission_classes
=
permission_classes
,
)
def
include_docs_urls
(
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
(
title
=
title
,
description
=
description
,
...
...
@@ -48,6 +59,8 @@ def include_docs_urls(
public
=
public
,
patterns
=
patterns
,
generator_class
=
generator_class
,
authentication_classes
=
authentication_classes
,
permission_classes
=
permission_classes
,
)
schema_js_view
=
get_schemajs_view
(
title
=
title
,
...
...
@@ -56,6 +69,8 @@ def include_docs_urls(
public
=
public
,
patterns
=
patterns
,
generator_class
=
generator_class
,
authentication_classes
=
authentication_classes
,
permission_classes
=
permission_classes
,
)
urls
=
[
url
(
r'^$'
,
docs_view
,
name
=
'docs-index'
),
...
...
rest_framework/schemas/__init__.py
View file @
5333565f
...
...
@@ -20,13 +20,17 @@ basic use-cases:
Other access should target the submodules directly
"""
from
rest_framework.settings
import
api_settings
from
.generators
import
SchemaGenerator
from
.inspectors
import
AutoSchema
,
ManualSchema
# noqa
def
get_schema_view
(
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.
"""
...
...
@@ -40,4 +44,6 @@ def get_schema_view(
renderer_classes
=
renderer_classes
,
schema_generator
=
generator
,
public
=
public
,
authentication_classes
=
authentication_classes
,
permission_classes
=
permission_classes
,
)
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment