tribler.core.database.restapi.schema

Classes

MetadataParameters

The REST API schema for metadata parameters.

SearchMetadataParameters

The REST API schema for search parameters.

MetadataSchema

The REST API schema for metadata itself.

CollectionSchema

The REST API schema for collected torrents.

TorrentSchema

The REST API schema for a torrent.

ChannelSchema

The REST API schema for a channel.

Module Contents

class tribler.core.database.restapi.schema.MetadataParameters(*, only: marshmallow.types.StrSequenceOrSet | None = None, exclude: marshmallow.types.StrSequenceOrSet = (), many: bool | None = None, load_only: marshmallow.types.StrSequenceOrSet = (), dump_only: marshmallow.types.StrSequenceOrSet = (), partial: bool | marshmallow.types.StrSequenceOrSet | None = None, unknown: marshmallow.types.UnknownOption | None = None)

Bases: marshmallow.Schema

The REST API schema for metadata parameters.

first
last
sort_by
sort_desc
fts_text
hide_xxx
category
tags
exclude_deleted
metadata_type
class tribler.core.database.restapi.schema.SearchMetadataParameters(*, only: marshmallow.types.StrSequenceOrSet | None = None, exclude: marshmallow.types.StrSequenceOrSet = (), many: bool | None = None, load_only: marshmallow.types.StrSequenceOrSet = (), dump_only: marshmallow.types.StrSequenceOrSet = (), partial: bool | marshmallow.types.StrSequenceOrSet | None = None, unknown: marshmallow.types.UnknownOption | None = None)

Bases: MetadataParameters

The REST API schema for search parameters.

include_total
max_rowid
class tribler.core.database.restapi.schema.MetadataSchema(*, only: marshmallow.types.StrSequenceOrSet | None = None, exclude: marshmallow.types.StrSequenceOrSet = (), many: bool | None = None, load_only: marshmallow.types.StrSequenceOrSet = (), dump_only: marshmallow.types.StrSequenceOrSet = (), partial: bool | marshmallow.types.StrSequenceOrSet | None = None, unknown: marshmallow.types.UnknownOption | None = None)

Bases: marshmallow.Schema

The REST API schema for metadata itself.

type
id
origin_id
public_key
name
category
progress
class tribler.core.database.restapi.schema.CollectionSchema(*, only: marshmallow.types.StrSequenceOrSet | None = None, exclude: marshmallow.types.StrSequenceOrSet = (), many: bool | None = None, load_only: marshmallow.types.StrSequenceOrSet = (), dump_only: marshmallow.types.StrSequenceOrSet = (), partial: bool | marshmallow.types.StrSequenceOrSet | None = None, unknown: marshmallow.types.UnknownOption | None = None)

Bases: MetadataSchema

The REST API schema for collected torrents.

torrents
state
description_flag
thumbnail_flag
class tribler.core.database.restapi.schema.TorrentSchema(*, only: marshmallow.types.StrSequenceOrSet | None = None, exclude: marshmallow.types.StrSequenceOrSet = (), many: bool | None = None, load_only: marshmallow.types.StrSequenceOrSet = (), dump_only: marshmallow.types.StrSequenceOrSet = (), partial: bool | marshmallow.types.StrSequenceOrSet | None = None, unknown: marshmallow.types.UnknownOption | None = None)

Bases: MetadataSchema

The REST API schema for a torrent.

status
infohash
size
num_seeders
num_leechers
last_tracker_check
updated
class tribler.core.database.restapi.schema.ChannelSchema(*, only: marshmallow.types.StrSequenceOrSet | None = None, exclude: marshmallow.types.StrSequenceOrSet = (), many: bool | None = None, load_only: marshmallow.types.StrSequenceOrSet = (), dump_only: marshmallow.types.StrSequenceOrSet = (), partial: bool | marshmallow.types.StrSequenceOrSet | None = None, unknown: marshmallow.types.UnknownOption | None = None)

Bases: TorrentSchema, CollectionSchema

The REST API schema for a channel.

dirty
subscribed
votes