3.0.ipv8.REST.schema
====================

.. py:module:: 3.0.ipv8.REST.schema


Classes
-------

.. autoapisummary::

   3.0.ipv8.REST.schema.DefaultResponseSchema
   3.0.ipv8.REST.schema.Address
   3.0.ipv8.REST.schema.AddressWithPK
   3.0.ipv8.REST.schema.OverlayStatisticsSchema
   3.0.ipv8.REST.schema.OverlayStrategySchema
   3.0.ipv8.REST.schema.OverlaySchema
   3.0.ipv8.REST.schema.DHTValueSchema


Functions
---------

.. autoapisummary::

   3.0.ipv8.REST.schema.schema


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

.. py:class:: DefaultResponseSchema(*, only: marshmallow.types.StrSequenceOrSet | None = None, exclude: marshmallow.types.StrSequenceOrSet = (), many: bool | None = None, context: dict | None = None, load_only: marshmallow.types.StrSequenceOrSet = (), dump_only: marshmallow.types.StrSequenceOrSet = (), partial: bool | marshmallow.types.StrSequenceOrSet | None = None, unknown: str | None = None)

   Bases: :py:obj:`marshmallow.Schema`


   Every response contains its sucess status and optionally the error that occurred.


   .. py:attribute:: success


   .. py:attribute:: error


.. py:class:: Address(*, only: marshmallow.types.StrSequenceOrSet | None = None, exclude: marshmallow.types.StrSequenceOrSet = (), many: bool | None = None, context: dict | None = None, load_only: marshmallow.types.StrSequenceOrSet = (), dump_only: marshmallow.types.StrSequenceOrSet = (), partial: bool | marshmallow.types.StrSequenceOrSet | None = None, unknown: str | None = None)

   Bases: :py:obj:`marshmallow.Schema`


   The schema for address information.


   .. py:attribute:: ip


   .. py:attribute:: port


.. py:class:: AddressWithPK(*, only: marshmallow.types.StrSequenceOrSet | None = None, exclude: marshmallow.types.StrSequenceOrSet = (), many: bool | None = None, context: dict | None = None, load_only: marshmallow.types.StrSequenceOrSet = (), dump_only: marshmallow.types.StrSequenceOrSet = (), partial: bool | marshmallow.types.StrSequenceOrSet | None = None, unknown: str | None = None)

   Bases: :py:obj:`Address`


   The schema for addresses that have a public key.


   .. py:attribute:: public_key


.. py:class:: OverlayStatisticsSchema(*, only: marshmallow.types.StrSequenceOrSet | None = None, exclude: marshmallow.types.StrSequenceOrSet = (), many: bool | None = None, context: dict | None = None, load_only: marshmallow.types.StrSequenceOrSet = (), dump_only: marshmallow.types.StrSequenceOrSet = (), partial: bool | marshmallow.types.StrSequenceOrSet | None = None, unknown: str | None = None)

   Bases: :py:obj:`marshmallow.Schema`


   The schema for overlay statistics.


   .. py:attribute:: num_up


   .. py:attribute:: num_down


   .. py:attribute:: bytes_up


   .. py:attribute:: bytes_down


   .. py:attribute:: diff_time


.. py:class:: OverlayStrategySchema(*, only: marshmallow.types.StrSequenceOrSet | None = None, exclude: marshmallow.types.StrSequenceOrSet = (), many: bool | None = None, context: dict | None = None, load_only: marshmallow.types.StrSequenceOrSet = (), dump_only: marshmallow.types.StrSequenceOrSet = (), partial: bool | marshmallow.types.StrSequenceOrSet | None = None, unknown: str | None = None)

   Bases: :py:obj:`marshmallow.Schema`


   The schema describing discovery strategies for overlays.


   .. py:attribute:: name


   .. py:attribute:: target_peers


.. py:class:: OverlaySchema(*, only: marshmallow.types.StrSequenceOrSet | None = None, exclude: marshmallow.types.StrSequenceOrSet = (), many: bool | None = None, context: dict | None = None, load_only: marshmallow.types.StrSequenceOrSet = (), dump_only: marshmallow.types.StrSequenceOrSet = (), partial: bool | marshmallow.types.StrSequenceOrSet | None = None, unknown: str | None = None)

   Bases: :py:obj:`marshmallow.Schema`


   The schema to describe overlays.


   .. py:attribute:: id


   .. py:attribute:: my_peer


   .. py:attribute:: global_time


   .. py:attribute:: peers


   .. py:attribute:: overlay_name


   .. py:attribute:: max_peers


   .. py:attribute:: is_isolated


   .. py:attribute:: my_estimated_wan


   .. py:attribute:: my_estimated_lan


   .. py:attribute:: strategies


   .. py:attribute:: statistics


.. py:class:: DHTValueSchema(*, only: marshmallow.types.StrSequenceOrSet | None = None, exclude: marshmallow.types.StrSequenceOrSet = (), many: bool | None = None, context: dict | None = None, load_only: marshmallow.types.StrSequenceOrSet = (), dump_only: marshmallow.types.StrSequenceOrSet = (), partial: bool | marshmallow.types.StrSequenceOrSet | None = None, unknown: str | None = None)

   Bases: :py:obj:`marshmallow.Schema`


   The schema to describe values in the DHT.


   .. py:attribute:: public_key


   .. py:attribute:: key


   .. py:attribute:: value


.. py:function:: schema(**kwargs) -> marshmallow.Schema

   Create a schema. Mostly useful for creating single-use schemas on-the-fly.