rest_framework.schemas.openapi.AutoSchema

class documentation

class AutoSchema(ViewInspector): (source)

View In Hierarchy

Undocumented

Method __init__ :param operation_id_base: user-defined name in operationId. If empty, it will be deducted from the Model/Serializer/View name. :param component_name: user-defined component's name. If empty, it will be deducted from the Serializer's class name.
Method allows_filters Determine whether to include filter Fields in schema.
Method get_component_name Compute the component's name from the serializer. Raise an exception if the serializer's class name is "Serializer" (case-insensitive).
Method get_components Return components with their properties from the serializer.
Method get_filter_parameters Undocumented
Method get_operation Undocumented
Method get_operation_id Compute an operation ID from the view type and get_operation_id_base method.
Method get_operation_id_base Compute the base part for operation ID from the model, serializer or view name.
Method get_pagination_parameters Undocumented
Method get_paginator Undocumented
Method get_path_parameters Return a list of parameters from templated path variables.
Method get_reference Undocumented
Method get_request_body Undocumented
Method get_request_serializer Override this method if your view uses a different serializer for handling request body.
Method get_response_serializer Override this method if your view uses a different serializer for populating response data.
Method get_responses Undocumented
Method get_serializer Undocumented
Method get_tags Undocumented
Method map_choicefield Undocumented
Method map_field Undocumented
Method map_field_validators map field validators
Method map_parsers Undocumented
Method map_renderers Undocumented
Method map_serializer Undocumented
Class Variable method_mapping Undocumented
Instance Variable component_name Undocumented
Instance Variable operation_id_base Undocumented
Instance Variable request_media_types Undocumented
Instance Variable response_media_types Undocumented
Method _get_reference Undocumented
Method _map_min_max Undocumented
Method _to_camel_case Undocumented
Instance Variable _tags Undocumented

Inherited from ViewInspector:

Method __get__ Enables `ViewInspector` as a Python _Descriptor_.
Method __set__ Undocumented
Method get_description Determine a path description.
Method view.deleter Undocumented
Method view.setter Undocumented
Class Variable header_regex Undocumented
Instance Variable instance_schemas Undocumented
Property view View property.
Method _get_description_section Undocumented
Instance Variable _view Undocumented
def __init__(self, tags=None, operation_id_base=None, component_name=None): (source)
overrides rest_framework.schemas.inspectors.ViewInspector.__init__

:param operation_id_base: user-defined name in operationId. If empty, it will be deducted from the Model/Serializer/View name. :param component_name: user-defined component's name. If empty, it will be deducted from the Serializer's class name.

def allows_filters(self, path, method): (source)

Determine whether to include filter Fields in schema. Default implementation looks for ModelViewSet or GenericAPIView actions/methods that cause filtering on the default implementation.

def get_component_name(self, serializer): (source)

Compute the component's name from the serializer. Raise an exception if the serializer's class name is "Serializer" (case-insensitive).

def get_components(self, path, method): (source)

Return components with their properties from the serializer.

def get_filter_parameters(self, path, method): (source)

Undocumented

def get_operation(self, path, method): (source)

Undocumented

def get_operation_id(self, path, method): (source)

Compute an operation ID from the view type and get_operation_id_base method.

def get_operation_id_base(self, path, method, action): (source)

Compute the base part for operation ID from the model, serializer or view name.

def get_pagination_parameters(self, path, method): (source)

Undocumented

def get_paginator(self): (source)

Undocumented

def get_path_parameters(self, path, method): (source)

Return a list of parameters from templated path variables.

def get_reference(self, serializer): (source)

Undocumented

def get_request_body(self, path, method): (source)

Undocumented

def get_request_serializer(self, path, method): (source)

Override this method if your view uses a different serializer for handling request body.

def get_response_serializer(self, path, method): (source)

Override this method if your view uses a different serializer for populating response data.

def get_responses(self, path, method): (source)

Undocumented

def get_serializer(self, path, method): (source)

Undocumented

def get_tags(self, path, method): (source)

Undocumented

def map_choicefield(self, field): (source)

Undocumented

def map_field(self, field): (source)

Undocumented

def map_field_validators(self, field, schema): (source)

map field validators

def map_parsers(self, path, method): (source)

Undocumented

def map_renderers(self, path, method): (source)

Undocumented

def map_serializer(self, serializer): (source)

Undocumented

method_mapping: dict[str, str] = (source)

Undocumented

component_name = (source)

Undocumented

operation_id_base = (source)

Undocumented

request_media_types = (source)

Undocumented

response_media_types = (source)

Undocumented

def _get_reference(self, serializer): (source)

Undocumented

def _map_min_max(self, field, content): (source)

Undocumented

def _to_camel_case(self, snake_str): (source)

Undocumented

_tags = (source)

Undocumented