tribler.core.database.restapi.schema
====================================

.. py:module:: tribler.core.database.restapi.schema


Classes
-------

.. autoapisummary::

   tribler.core.database.restapi.schema.MetadataParameters
   tribler.core.database.restapi.schema.SearchMetadataParameters
   tribler.core.database.restapi.schema.MetadataSchema
   tribler.core.database.restapi.schema.CollectionSchema
   tribler.core.database.restapi.schema.TorrentSchema
   tribler.core.database.restapi.schema.ChannelSchema


Module Contents
---------------

.. py:class:: 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: :py:obj:`marshmallow.Schema`


   The REST API schema for metadata parameters.


   .. py:attribute:: first


   .. py:attribute:: last


   .. py:attribute:: sort_by


   .. py:attribute:: sort_desc


   .. py:attribute:: fts_text


   .. py:attribute:: hide_xxx


   .. py:attribute:: category


   .. py:attribute:: tags


   .. py:attribute:: exclude_deleted


   .. py:attribute:: metadata_type


.. py:class:: 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: :py:obj:`MetadataParameters`


   The REST API schema for search parameters.


   .. py:attribute:: include_total


   .. py:attribute:: max_rowid


.. py:class:: 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: :py:obj:`marshmallow.Schema`


   The REST API schema for metadata itself.


   .. py:attribute:: type


   .. py:attribute:: id


   .. py:attribute:: origin_id


   .. py:attribute:: public_key


   .. py:attribute:: name


   .. py:attribute:: category


   .. py:attribute:: progress


.. py:class:: 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: :py:obj:`MetadataSchema`


   The REST API schema for collected torrents.


   .. py:attribute:: torrents


   .. py:attribute:: state


   .. py:attribute:: description_flag


   .. py:attribute:: thumbnail_flag


.. py:class:: 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: :py:obj:`MetadataSchema`


   The REST API schema for a torrent.


   .. py:attribute:: status


   .. py:attribute:: infohash


   .. py:attribute:: size


   .. py:attribute:: num_seeders


   .. py:attribute:: num_leechers


   .. py:attribute:: last_tracker_check


   .. py:attribute:: updated


.. py:class:: 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: :py:obj:`TorrentSchema`, :py:obj:`CollectionSchema`


   The REST API schema for a channel.


   .. py:attribute:: dirty


   .. py:attribute:: subscribed


   .. py:attribute:: votes