Skip to content

website

konigle.filters.website

AuthorFilters

Bases: BaseFilters

Filters for author resources.

handle = Field(default=None) class-attribute instance-attribute

Filter by author handle

ordering = Field(default=None) class-attribute instance-attribute

Ordering options for author results

q = Field(default=None) class-attribute instance-attribute

Search query that matches name and handle fields

BackupFilters

Bases: BaseFilters

Filters for backup resources.

backup_type = Field(default=None) class-attribute instance-attribute

Filter by backup type

kind = Field(default=None) class-attribute instance-attribute

Filter by backup kind

ordering = Field(default=None) class-attribute instance-attribute

Ordering options for backup results

status = Field(default=None) class-attribute instance-attribute

Filter by backup status

target_id = Field(default=None) class-attribute instance-attribute

Filter by target ID

BlogFilters

Bases: BaseFilters

Filters for blog post resources.

folder = Field(default=None) class-attribute instance-attribute

Filter by folder ID

handle = Field(default=None) class-attribute instance-attribute

Filter by blog post handle

ordering = Field(default=None) class-attribute instance-attribute

Ordering options for blog results

published = Field(default=None) class-attribute instance-attribute

Filter by publication status

q = Field(default=None) class-attribute instance-attribute

Search query that matches title and name fields

ComponentFilters

Bases: BaseFilters

Filters for component resources.

ordering = Field(default=None) class-attribute instance-attribute

Ordering options for component results

q = Field(default=None) class-attribute instance-attribute

Search query that matches name and description fields

type = Field(default=None) class-attribute instance-attribute

Filter by component type. use comma to separate multiple types

FolderFilters

Bases: BaseFilters

Filters for folder resources.

folder_type = Field(default=None) class-attribute instance-attribute

Filter by folder type

is_original_version = Field(default=None) class-attribute instance-attribute

Filter by original version status

ordering = Field(default=None) class-attribute instance-attribute

Ordering options for folder results

parent = Field(default=None) class-attribute instance-attribute

Filter by parent folder ID

q = Field(default=None) class-attribute instance-attribute

Search query that matches name and handle fields

GlossaryTermFilters

Bases: BaseFilters

Filters for glossary term resources.

ordering = Field(default=None) class-attribute instance-attribute

Ordering options for glossary term results

published = Field(default=None) class-attribute instance-attribute

Filter by publication status

q = Field(default=None) class-attribute instance-attribute

Search query that matches title and name fields

PageFilters

Bases: BaseFilters

Filters for page resources.

folder = Field(default=None) class-attribute instance-attribute

Filter by folder ID

handle = Field(default=None) class-attribute instance-attribute

Filter by page handle

ordering = Field(default=None) class-attribute instance-attribute

Ordering options for page results

page_type = Field(default=None) class-attribute instance-attribute

Filter by page type

published = Field(default=None) class-attribute instance-attribute

Filter by publication status

q = Field(default=None) class-attribute instance-attribute

Search query that matches title and name fields

RedirectFilters

Bases: BaseFilters

Filters for redirect resources.

ordering = Field(default=None) class-attribute instance-attribute

Ordering options for redirect results

path = Field(default=None) class-attribute instance-attribute

Filter by redirect path

q = Field(default=None) class-attribute instance-attribute

Search query that matches path and target fields

target = Field(default=None) class-attribute instance-attribute

Filter by redirect target

TemplateFilters

Bases: BaseFilters

Filters for template resources.

base = Field(default=None) class-attribute instance-attribute

Filter by base template ID

handle = Field(default=None) class-attribute instance-attribute

Filter by template handle

is_base = Field(default=None) class-attribute instance-attribute

Filter by base template status

ordering = Field(default=None) class-attribute instance-attribute

Ordering options for site template results

q = Field(default=None) class-attribute instance-attribute

Search query that matches name and handle fields