rest_framework.schemas.generators.BaseSchemaGenerator

class documentation

class BaseSchemaGenerator: (source)

Known subclasses: rest_framework.schemas.coreapi.SchemaGenerator, rest_framework.schemas.openapi.SchemaGenerator

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method coerce_path Coerce {pk} path arguments into the name of the model field, where possible. This is cleaner for an external representation. (Ie. "this is an identifier", not "this is a database primary key")
Method create_view Given a callback, return an actual view instance.
Method get_schema Undocumented
Method has_view_permissions Return `True` if the incoming request has the correct view permissions.
Instance Variable coerce_path_pk Undocumented
Instance Variable description Undocumented
Instance Variable endpoints Undocumented
Instance Variable patterns Undocumented
Instance Variable title Undocumented
Instance Variable url Undocumented
Instance Variable urlconf Undocumented
Instance Variable version Undocumented
Method _get_paths_and_endpoints Generate (path, method, view) given (path, method, callback) for paths.
Method _initialise_endpoints Undocumented
def __init__(self, title=None, url=None, description=None, patterns=None, urlconf=None, version=None): (source)
overridden in rest_framework.schemas.coreapi.SchemaGenerator

Undocumented

def coerce_path(self, path, method, view): (source)

Coerce {pk} path arguments into the name of the model field, where possible. This is cleaner for an external representation. (Ie. "this is an identifier", not "this is a database primary key")

def create_view(self, callback, method, request=None): (source)

Given a callback, return an actual view instance.

def get_schema(self, request=None, public=False): (source)
overridden in rest_framework.schemas.coreapi.SchemaGenerator, rest_framework.schemas.openapi.SchemaGenerator

Undocumented

def has_view_permissions(self, path, method, view): (source)

Return `True` if the incoming request has the correct view permissions.

coerce_path_pk = (source)

Undocumented

description = (source)

Undocumented

endpoints = (source)

Undocumented

patterns = (source)

Undocumented

title = (source)

Undocumented

url = (source)

Undocumented

urlconf = (source)

Undocumented

version = (source)

Undocumented

def _get_paths_and_endpoints(self, request): (source)

Generate (path, method, view) given (path, method, callback) for paths.

def _initialise_endpoints(self): (source)

Undocumented