rest_framework.filters.OrderingFilter

class documentation

class OrderingFilter(BaseFilterBackend): (source)

Undocumented

Method	`filter_queryset`	Return a filtered queryset.
Method	`get_default_ordering`	Undocumented
Method	`get_default_valid_fields`	Undocumented
Method	`get_ordering`	Ordering is set by a comma delimited ?ordering=... query parameter.
Method	`get_schema_fields`	Undocumented
Method	`get_schema_operation_parameters`	Undocumented
Method	`get_template_context`	Undocumented
Method	`get_valid_fields`	Undocumented
Method	`remove_invalid_fields`	Undocumented
Method	`to_html`	Undocumented
Class Variable	`ordering_description`	Undocumented
Class Variable	`ordering_fields`	Undocumented
Class Variable	`ordering_title`	Undocumented
Class Variable	`template`	Undocumented

def filter_queryset(self, request, queryset, view): (source) ¶

overrides rest_framework.filters.BaseFilterBackend.filter_queryset

Return a filtered queryset.

def get_default_ordering(self, view): (source) ¶

Undocumented

def get_default_valid_fields(self, queryset, view, context={}): (source) ¶

Undocumented

def get_ordering(self, request, queryset, view): (source) ¶

Ordering is set by a comma delimited ?ordering=... query parameter. The `ordering` query parameter can be overridden by setting the `ordering_param` value on the OrderingFilter or by specifying an `ORDERING_PARAM` value in the API settings.

def get_schema_fields(self, view): (source) ¶

overrides rest_framework.filters.BaseFilterBackend.get_schema_fields

Undocumented

def get_schema_operation_parameters(self, view): (source) ¶

overrides rest_framework.filters.BaseFilterBackend.get_schema_operation_parameters

Undocumented

def get_template_context(self, request, queryset, view): (source) ¶

Undocumented

def get_valid_fields(self, queryset, view, context={}): (source) ¶

Undocumented

def remove_invalid_fields(self, queryset, fields, view, request): (source) ¶

Undocumented