Changelog

All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.

13.0.0

  • [BREAKING] Renames EBStatus to OSOEBStatus

  • [BREAKING] Changes status history reference fields from *_id to *_ref for consistency.

  • StatusHistory entities now default to a Metadata(version=1)

12.0.1

  • fix: RequestResponse.response_received_at was mandatory rather than optional.

12.0.0

  • Adopts Pydantic for all PDM objects.

  • Unifies formerly auto-generated models and hand-written models.

  • Unifies models and serialisation schemas, removing all Marshmallow schemas.

  • New ‘source of truth’: OpenAPI schema yaml is generated from Python code.

  • sb_definition.ScanDefinition.pointing_correction is non-nullable, with a default value of MAINTAIN.

  • EquatorialCoordinates.unit and HorizontalCoordinates.unit are now always a two-element tuple (array in JSON) - previously it could be a single string if both axes of the reference frame had the same units.

  • Added RadialVelocity to Target object representation shared by ProposalInfo and SBDefinition.

  • [BREAKING] Pydantic models do not accept positional arguments. Previously, many objects required keyword arguments, but some allowed positional.

  • [BREAKING] ResponseResponse and ResponseError renamed to ResponseWrapper and ErrorWrapper.

  • [BREAKING] Pydantic models enforce runtime correctness. Attempting to instantiate an object with invalid data will raise a ValidationError

  • [BREAKING] schemas,generated and entities removed: Import directly from ska_oso_pdm or from an entity-specific subpackage e.g. ska_oso_pdm.proposal

  • [BREAKING] proposal.ProposalInfo.targets is now a list of Target objects:proposal.Target and sb_definition.Target are now a single, unified representation.

  • [BREAKING] Many field names changed to add _ref suffix to distinguish between inline objects and references to IDs of other objects.

  • [POSSIBLE BREAKING] Datetime strings in JSON use Z (Zulu time) instead of +00:00 to indicate UTC. These are equivalent under ISO 8601.