Schemas package

Backend package for schemas definition. This module is based on the group of python framework marshmallow, an ORM/ODM/framework-agnostic library for converting complex datatypes, such as objects, to and from native Python datatypes.

Combined with the flask extension flask_smorest, it allows to generate the OpenAPI specification schemas based on python class objects.

This objects come into 2 types:

• Schemas: JSON structures used to operate model instances

• Arguments: Query arguments to control route method parameters

class BaseSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Base schema to control common schema features.

class Meta

Bases: object

marshmallow options object for BaseSchema.

ordered = True

Enforce Order in OpenAPI Specification File

class Pagination(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

Pagination schema to limit the amount of results provided by a method

has_next

(Bool, required, dump_only): True if a next page exists.

has_prev

(Bool, required, dump_only): True if a previous page exists.

next_num

(Int, required, dump_only): Number of the next page.

prev_num

(Int, required, dump_only): Number of the previous page.

pages

(Int, required, dump_only): The total number of pages

per_page

(Int, required, dump_only): The number of items to be displayed on a page.

page

(Int, required, dump_only): The return page number (1 indexed).

total

(Int, required, dump_only): The total number of items matching the query.

class Id(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

id

(UUID, required, dump_only): Primary key with an Unique Identifier for the model instance

class Status(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

status

(Str): Resource current state (approved, on_review, etc.)

class Search(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

terms

([Text]): Group of strings to use as general search on model instances

sort_by

(Str): Order to return the results separated by coma

class UploadDatetime(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

upload_datetime

(ISO8601): Upload datetime of the model instance

class UploadFilter(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: marshmallow.schema.Schema

upload_before

(ISO8601, attribute=”upload_datetime”): Upload datetime of the instance before a specific date

upload_after

(ISO8601, attribute=”upload_datetime”): Upload datetime of the instance after a specific date

Benchmark schemas

class Benchmark(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.Id, backend.schemas.UploadDatetime, backend.schemas.schemas.CreateBenchmark

class Benchmarks(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.Pagination, backend.schemas.BaseSchema

items

([Benchmark], required): List of benchmark items for the pagination object

class CreateBenchmark(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.BaseSchema

docker_image

(Text, required): Docker image referenced by the benchmark

docker_tag

(Text, required): Docker image version/tag referenced by the benchmark

url

(Text, required): URL to the benchmark container documentation

json_schema

(JSON, required): Schema used to validate benchmark results before upload

description

(Text): Short text describing the main benchmark features

Benchmark arguments

class BenchmarkFilter(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.args.Pagination, backend.schemas.UploadFilter, backend.schemas.Status, backend.schemas.BaseSchema

docker_image

(Text, required): Docker image referenced by the benchmark

docker_tag

(Text, required): Docker image version/tag referenced by the benchmark

sort_by

(Str): Order to return the results separated by coma

class BenchmarkSearch(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.args.Pagination, backend.schemas.UploadFilter, backend.schemas.Status, backend.schemas.Search, backend.schemas.BaseSchema

Flavor schemas

class Flavor(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.Id, backend.schemas.UploadDatetime, backend.schemas.schemas.CreateFlavor

class Flavors(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.Pagination, backend.schemas.BaseSchema

items

([Flavor], required): List of flavor items for the pagination object

class CreateFlavor(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.BaseSchema

name

(Text, required): Text with virtual hardware template identification

description

(Text, required): Text with useful information for users

Flavor arguments

class FlavorFilter(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.args.Pagination, backend.schemas.UploadFilter, backend.schemas.Status, backend.schemas.BaseSchema

name

(Text): Text with virtual hardware template identification

sort_by

(Str): Order to return the results separated by coma

class FlavorSearch(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.args.Pagination, backend.schemas.UploadFilter, backend.schemas.Status, backend.schemas.Search, backend.schemas.BaseSchema

Report schemas

class Submit(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.UploadDatetime, backend.schemas.BaseSchema

resource_type

(String, required): Resource discriminator

resource_id

(UUID, required): Resource unique identification

uploader

(User, required): Resource uploader/creator

class Submits(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.Pagination, backend.schemas.BaseSchema

items

([Submit], required): List of submit items for the pagination object

class CreateClaim(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.BaseSchema

message

(String, required): Claim text describing the resource issue

class Claim(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.Id, backend.schemas.UploadDatetime, backend.schemas.schemas.CreateClaim

resource_type

(UUID, required): Resource unique identification

resource_id

(UUID, required): Resource unique identification

uploader

(User, required): Claim uploader/creator

class Claims(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.Pagination, backend.schemas.BaseSchema

items

([Claim], required): List of claim items for the pagination object

Report arguments

class SubmitFilter(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.args.Pagination, backend.schemas.UploadFilter, backend.schemas.BaseSchema

resource_type

(String): Resource discriminator

sort_by

(Str): Order to return the results separated by coma

class ClaimFilter(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.args.Pagination, backend.schemas.UploadFilter, backend.schemas.Status, backend.schemas.BaseSchema

sort_by

(Str): Order to return the results separated by coma

Result schemas

class Result(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.Id, backend.schemas.UploadDatetime, backend.schemas.BaseSchema

execution_datetime

(ISO8601, required) : Benchmark execution START

benchmark

(Benchmark, required): Benchmark used to provide the results

site

(Site, required): Site where the benchmark was executed

flavor

(Flavor, required): Flavor used to executed the benchmark

tags

([Tag], required): List of associated tags to the model

json

(JSON, required): Benchmark execution results

class Results(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.Pagination, backend.schemas.BaseSchema

items

([Result], required): List of results items for the pagination object

class Json(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.BaseSchema

Special schema to allow free JSON property

class Meta

Bases: object

marshmallow options object for JSON properties

unknown = 'include'

Accept and include the unknown fields

Result arguments

class ResultFilter(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.args.Pagination, backend.schemas.UploadFilter, backend.schemas.BaseSchema

execution_before

(ISO8601): Execution datetime of the instance before a specific date

execution_after

(ISO8601): Execution datetime of the instance after a specific date

benchmark_id

(Benchmark.id): Unique Identifier for result associated benchmark

site_id

(Site.id): Unique Identifier for result associated site

flavor_id

(Flavor.id): Unique Identifier for result associated flavor

tags_ids

([Tag.id], required): Unique Identifiers for result associated tags

filters

(String; <json.path> <operation> <value>) Expression to condition the returned results on JSON field

sort_by

(Str): Order to return the results separated by coma

class ResultContext(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.BaseSchema

execution_datetime

(ISO8601, required) : Benchmark execution START

benchmark_id

(Benchmark.id, required): Unique Identifier for result associated benchmark

flavor_id

(Flavor.id, required): Unique Identifier for result associated flavor

tags_ids

([Tag.id], default=[]): Unique Identifiers for result associated tags

class ResultSearch(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.args.Pagination, backend.schemas.UploadFilter, backend.schemas.Search, backend.schemas.BaseSchema

Site schemas

class Site(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.Id, backend.schemas.UploadDatetime, backend.schemas.schemas.CreateSite

class Sites(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.Pagination, backend.schemas.BaseSchema

items

([Site], required): List of site items for the pagination object

class CreateSite(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.BaseSchema

name

(Text, required): Human readable institution identification

address

(Text, required): Place where a site is physically located

description

(Text, required): Useful site information to help users

Site arguments

class SiteFilter(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.args.Pagination, backend.schemas.UploadFilter, backend.schemas.Status, backend.schemas.BaseSchema

name

(Text): Human readable institution identification

address

(Text): Place where a site is physically located

sort_by

(Str): Order to return the results separated by coma

class SiteSearch(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.args.Pagination, backend.schemas.UploadFilter, backend.schemas.Status, backend.schemas.Search, backend.schemas.BaseSchema

Tag schemas

class Tag(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.Id, backend.schemas.schemas.CreateTag

class Tags(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.Pagination, backend.schemas.BaseSchema

items

([Tag], required): List of tag items for the pagination object

class TagsIds(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.BaseSchema

tags_ids

([UUID]): List of tag ids

class CreateTag(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.BaseSchema

name

(Text, required): Human readable feature identification

description

(Text): Useful information to help users to understand the label context

Tag arguments

class TagFilter(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.args.Pagination, backend.schemas.BaseSchema

name

(Text): Human readable feature identification

sort_by

(Str): Order to return the results separated by coma

class TagSearch(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.args.Pagination, backend.schemas.Search, backend.schemas.BaseSchema

User schemas

class User(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.BaseSchema

sub

(Text, required, dump_only): Primary key containing the OIDC subject the model instance

iss

(Text, required, dump_only): Primary key containing the OIDC issuer of the model instance

email

(Email, required): Electronic mail collected from OIDC access token

registration_datetime

(Email) Electronic mail collected from OIDC access token

class Users(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.Pagination, backend.schemas.BaseSchema

items

([User], required): List of site items for the pagination object

User arguments

class UserFilter(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.args.Pagination, backend.schemas.BaseSchema

sub

(Text, required, dump_only): Primary key containing the OIDC subject the model instance

iss

(Text, required, dump_only): Primary key containing the OIDC issuer of the model instance

email

(Email, required): Electronic mail collected from OIDC access token

class UserDelete(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.args.UserFilter

class UserSearch(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

Bases: backend.schemas.args.Pagination, backend.schemas.Search, backend.schemas.BaseSchema