Schemas¶

Pydantic request and response schemas for AcqStore Server API v2.

Internal service models intentionally use Python snake_case names and do not contain HTTP URLs. This module alone defines the JSON-facing API contract.

ApiModel ¶

Bases: BaseModel

Base model for strict camelCase API v2 payloads.

OpenRequest ¶

Bases: _ChannelSelectionRequest

Request body for opening a server-accessible acquisition path.

PickAndOpenRequest ¶

Bases: _ChannelSelectionRequest

Request body for native file selection followed by opening.

ApiLinkResponse ¶

Bases: ApiModel

One discoverable API v2 resource link.

ApiIndexResponse ¶

Bases: ApiModel

Discoverable entry point for AcqStore Server API v2.

BinaryEncodingResponse ¶

Bases: ApiModel

Binary transport representation used for served planes.

CapabilitiesResponse ¶

Bases: ApiModel

Runtime AcqStore loader and transport capabilities.

AxisResponse ¶

Bases: ApiModel

Description of one array dimension in a served plane.

SourceResponse ¶

Bases: ApiModel

Source acquisition metadata.

HeaderResponse ¶

Bases: ApiModel

AcqStore image header normalized for JSON clients.

PlaneResponse ¶

Bases: ApiModel

Encoding and geometry shared by a collection of channel planes.

ChannelResponse ¶

Bases: ApiModel

One generic source channel binary resource.

ScanPathResponse ¶

Bases: ApiModel

Reference-image scan path coordinates in AcqStore convention.

ReferenceChannelResponse ¶

Bases: ApiModel

One generic reference-image channel binary resource.

ReferenceResponse ¶

Bases: ApiModel

Reference image metadata and channel resources.

OpenResponse ¶

Bases: ApiModel

Successful API v2 open response.

SessionResponse ¶

Bases: ApiModel

Metadata for one live binary session.

DeleteSessionResponse ¶

Bases: ApiModel

Confirmation that a live session was explicitly deleted.

ErrorDetailResponse ¶

Bases: ApiModel

One machine-readable request-validation issue.

ErrorResponse ¶

Bases: ApiModel

Stable API v2 error envelope.