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
toOSOEBStatus
[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 ofMAINTAIN
.EquatorialCoordinates.unit
andHorizontalCoordinates.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
toTarget
object representation shared byProposalInfo
andSBDefinition
.[BREAKING] Pydantic models do not accept positional arguments. Previously, many objects required keyword arguments, but some allowed positional.
[BREAKING]
ResponseResponse
andResponseError
renamed toResponseWrapper
andErrorWrapper
.[BREAKING] Pydantic models enforce runtime correctness. Attempting to instantiate an object with invalid data will raise a
ValidationError
[BREAKING]
schemas
,generated
andentities
removed: Import directly fromska_oso_pdm
or from an entity-specific subpackage e.g.ska_oso_pdm.proposal
[BREAKING]
proposal.ProposalInfo.targets
is now a list ofTarget
objects:proposal.Target
andsb_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.