flexmeasures.api.common.schemas.generic_schemas

Classes

class flexmeasures.api.common.schemas.generic_schemas.BeliefTimeFilterSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: Literal['exclude', 'include', 'raise'] | None = None)

Shared belief-time fields for endpoints returning event-indexed time series or annotations.

beliefs_after is deliberately left out of the generated API docs (both Sphinx and the OpenAPI/Swagger spec): unlike prior (its upper-bound counterpart), it has no established canonical name elsewhere in the API, and no known caller needs it – but it remains a working field for backward/internal use.

class flexmeasures.api.common.schemas.generic_schemas.EventWindowSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: Literal['exclude', 'include', 'raise'] | None = None)

Shared event-window fields for endpoints returning event-indexed time series or annotations.

Accepts start`+`end, start`+`duration, or end`+`duration. When duration is combined with only one of start/end, the other bound is derived.

class flexmeasures.api.common.schemas.generic_schemas.PaginationSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: Literal['exclude', 'include', 'raise'] | None = None)