Code reference#

Subpackages#

Submodules#

catalog.custom_auto_schema module#

class catalog.custom_auto_schema.CustomAutoSchema(view, path, method, components, request, overrides, operation_keys=None)#

Bases: SwaggerAutoSchema

get_operation(operation_keys=None)#

Get an Operation for the given API endpoint (path, method). This includes query, body parameters and response schemas.

Parameters:

operation_keys (tuple[str]) – an array of keys describing the hierarchical layout of this view in the API; e.g. ('snippets', 'list'), ('snippets', 'retrieve'), etc.

Return type:

openapi.Operation

get_pagination_parameters()#

Set pagination params to an empty list.

Since the pagination params are a part of the MediaSearchRequestSerializer, they need not be added again as pagination params.

catalog.example_responses module#