OWL Schemas

The MCAM’s settings files are defined by owl.schemas models. The same models back the settings written to disk and the request bodies the WebMCAM API accepts. The core settings schemas are:

• owl.schemas.mcam.MCAMState — the MCAM imaging state.

• owl.schemas.assay_acquire_and_save.Parameters — the acquire and save assay.

• owl.schemas.assay_z_stack.Parameters — the z-stack assay.

Inspecting a schema from Python

Every schema can print its own definition — the full list of fields, along with each field’s type, default, and description. Import the model and call model_json_schema():

from owl.schemas.mcam import MCAMState

MCAMState.model_json_schema()

This is always in sync with the owl version installed on your system, so it is the authoritative reference for what a given release accepts.

Viewing the Web API schemas

The schemas used by the WebMCAM API are also published in the openapi.yaml specification, which you can download here. Upload that file to any OpenAPI viewer — for example Swagger Editor or Redocly — to browse every endpoint and schema, including MCAMState and the assay parameter models, as an interactive reference. See WebMCAM for how to retrieve the specification directly from a running MCAM.