mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-11-11 04:07:39 +03:00
7b1582e00e
* Add tests for schema exclusions * Move exclusion check to should_include_endpoint * Update docs * Switch to using `schema = None` * Test PendingDeprecationWarnings * Add note to release notes. * s/deprecated/pending deprecation/ * Add PR link to release notes * Correct typo in test class name * Test 'exclude_from_schema' deprecation warning message (#1) * Correct deprecation warning message
35 lines
1.2 KiB
Python
35 lines
1.2 KiB
Python
"""
|
|
views.py # Houses `SchemaView`, `APIView` subclass.
|
|
|
|
See schemas.__init__.py for package overview.
|
|
"""
|
|
from rest_framework import exceptions, renderers
|
|
from rest_framework.response import Response
|
|
from rest_framework.settings import api_settings
|
|
from rest_framework.views import APIView
|
|
|
|
|
|
class SchemaView(APIView):
|
|
_ignore_model_permissions = True
|
|
schema = None # exclude from schema
|
|
renderer_classes = None
|
|
schema_generator = None
|
|
public = False
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
super(SchemaView, self).__init__(*args, **kwargs)
|
|
if self.renderer_classes is None:
|
|
if renderers.BrowsableAPIRenderer in api_settings.DEFAULT_RENDERER_CLASSES:
|
|
self.renderer_classes = [
|
|
renderers.CoreJSONRenderer,
|
|
renderers.BrowsableAPIRenderer,
|
|
]
|
|
else:
|
|
self.renderer_classes = [renderers.CoreJSONRenderer]
|
|
|
|
def get(self, request, *args, **kwargs):
|
|
schema = self.schema_generator.get_schema(request, self.public)
|
|
if schema is None:
|
|
raise exceptions.PermissionDenied()
|
|
return Response(schema)
|