Skip to content

Cross-service contracts

The models in biomero_schema.zarr, biomero_schema.imports, and biomero_schema.shallower are wire contracts between BIOMERO-owned services. They provide shared validation while leaving storage, OMERO access, event persistence, locking, and Zarr I/O to the consumer that owns those operations.

The stable serialized form uses camelCase field aliases and is produced with to_dict(). Each contract family carries its own integer schema; this is independent of the workflow descriptor version.

Boundaries

These contracts:

  • can identify managed canonical Zarr data and its pixels;
  • can snapshot the ordered canonical inputs to a workflow;
  • can describe omitted image arrays in a shallow result;
  • can request optional importer lifecycle operations;
  • can record normalization outcomes and bind a remotely normalized result to its report, helper image, tool version, and execution task.

They do not:

  • redefine OME-NGFF or RFC-8;
  • prescribe a database or storage-root implementation;
  • make an embedded ISCC claim self-verifying;
  • require third-party workflows to interpret BIOMERO metadata.

See Remote shallower contracts for the report and receipt formats. Deployment and scheduler settings belong to the services that perform and consume normalization, not to this package.