latest.ipv8.REST.schema

Module Contents

Classes

DefaultResponseSchema

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

Address

The schema for address information.

AddressWithPK

The schema for addresses that have a public key.

OverlayStatisticsSchema

The schema for overlay statistics.

OverlayStrategySchema

The schema describing discovery strategies for overlays.

OverlaySchema

The schema to describe overlays.

DHTValueSchema

The schema to describe values in the DHT.

Functions

schema(→ marshmallow.Schema)

Create a schema. Mostly useful for creating single-use schemas on-the-fly.
class latest.ipv8.REST.schema.DefaultResponseSchema(*, only: marshmallow.types.StrSequenceOrSet | None = None, exclude: marshmallow.types.StrSequenceOrSet = (), many: bool = False, 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: marshmallow.Schema

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

success
error
class latest.ipv8.REST.schema.Address(*, only: marshmallow.types.StrSequenceOrSet | None = None, exclude: marshmallow.types.StrSequenceOrSet = (), many: bool = False, 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: marshmallow.Schema

The schema for address information.

ip
port
class latest.ipv8.REST.schema.AddressWithPK(*, only: marshmallow.types.StrSequenceOrSet | None = None, exclude: marshmallow.types.StrSequenceOrSet = (), many: bool = False, 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: Address

The schema for addresses that have a public key.

public_key
class latest.ipv8.REST.schema.OverlayStatisticsSchema(*, only: marshmallow.types.StrSequenceOrSet | None = None, exclude: marshmallow.types.StrSequenceOrSet = (), many: bool = False, 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: marshmallow.Schema

The schema for overlay statistics.

num_up
num_down
bytes_up
bytes_down
diff_time
class latest.ipv8.REST.schema.OverlayStrategySchema(*, only: marshmallow.types.StrSequenceOrSet | None = None, exclude: marshmallow.types.StrSequenceOrSet = (), many: bool = False, 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: marshmallow.Schema

The schema describing discovery strategies for overlays.

name
target_peers
class latest.ipv8.REST.schema.OverlaySchema(*, only: marshmallow.types.StrSequenceOrSet | None = None, exclude: marshmallow.types.StrSequenceOrSet = (), many: bool = False, 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: marshmallow.Schema

The schema to describe overlays.

id
my_peer
global_time
peers
overlay_name
max_peers
is_isolated
my_estimated_wan
my_estimated_lan
strategies
statistics
class latest.ipv8.REST.schema.DHTValueSchema(*, only: marshmallow.types.StrSequenceOrSet | None = None, exclude: marshmallow.types.StrSequenceOrSet = (), many: bool = False, 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: marshmallow.Schema

The schema to describe values in the DHT.

public_key
key
value
latest.ipv8.REST.schema.schema(**kwargs) → marshmallow.Schema

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