rest_framework.schemas.coreapi

module documentation
(source)

Undocumented

Class AutoSchema Default inspector for APIView
Class LinkNode Undocumented
Class ManualSchema Allows providing a list of coreapi.Fields, plus an optional description.
Class SchemaGenerator Original CoreAPI version.
Function common_path Undocumented
Function distribute_links Undocumented
Function field_to_schema Undocumented
Function insert_into Nested dictionary insertion.
Function is_custom_action Undocumented
Function is_enabled Is CoreAPI Mode enabled?
Constant INSERT_INTO_COLLISION_FMT Undocumented
def common_path(paths): (source)

Undocumented

def distribute_links(obj): (source)

Undocumented

def field_to_schema(field): (source)

Undocumented

def insert_into(target, keys, value): (source)

Nested dictionary insertion. >>> example = {} >>> insert_into(example, ['a', 'b', 'c'], 123) >>> example LinkNode({'a': LinkNode({'b': LinkNode({'c': LinkNode(links=[123])}}})))

def is_custom_action(action): (source)

Undocumented

def is_enabled(): (source)

Is CoreAPI Mode enabled?

INSERT_INTO_COLLISION_FMT: str = (source)

Undocumented

Value
'''
Schema Naming Collision.

coreapi.Link for URL path {value_url} cannot be inserted into schema.
Position conflicts with coreapi.Link for URL path {target_url}.

Attempted to insert link with keys: {keys}.
...