Releases

Changelog

What changed in the Baobyte AML Suite, when, and whether it needs anything from you — a re-test, a configuration review, or a change on the integration side.

Entries

Release history

Placeholder — this entry is a layout example, not a release — its version number and date are placeholders and nothing described in it has shipped. Replace with sourced, approved content before this page is made public.

0.0.0 — placeholder

No release date

This is a layout example showing how a release entry is structured. It records no release, and nothing described in it has shipped.

Added

A new capability would be described here in one sentence, naming any new permission it introduces.

Changed

Behaviour that now works differently, with a note on whether existing configuration needs revisiting.

Fixed

A corrected defect, stating plainly whether it could have produced a wrong compliance outcome.

Security

Used only for a change that addresses a security issue. Otherwise omitted.

Vocabulary

What each heading means

Fixed rather than Changed, and Security rather than Fixed, are editorial decisions with operational consequences — an institution decides whether to re-run acceptance testing from these headings.

Added: New capability. If it introduces a new permission, the permission is named here.
Changed: Existing behaviour that now works differently. Anything an institution would need to re-test belongs here rather than under Fixed.
Fixed: A defect corrected. Where the defect could have produced a wrong compliance outcome, that is stated explicitly rather than described as a minor fix.
Security: A change that addresses a security issue. Used only for that, so the heading keeps its meaning.
Deprecated: Still working, but scheduled for removal, with the removal release and the migration path named.
Breaking: Requires a change on the consumer side. Always accompanied by a versioned contract and a migration window.

Versioning

Three things are versioned, and they move independently

Reading a release note for this product means checking three surfaces rather than one.

The API contract

The OpenAPI 3.1 document is the source of truth for the HTTP surface — the server types and the TypeScript client are both generated from it, so a hand-written handler signature is a defect rather than a shortcut.

A breaking contract change requires a versioned contract and a migration window. Note the definition that catches people out: adding a required field is a breaking change.

Regulatory content

Rules, risk weights, report templates and mappings ship as signed content packs with manifest hashes, and are installed through the platform’s own proposal, approval and activation flow.

A pack can be diffed against what is installed before it is activated, and rolled back. A content change is therefore attributable and reversible rather than a deployment side effect.

The database schema

Migrations are numbered and applied by the application at startup under an advisory lock, on a single connection, so two instances cannot race.

A release note that changes the schema says so, because it affects the restore and rollback plan — a restore to a point before a migration needs the matching binary.

Health and readiness are exposed at /healthz and /readyz, and the versioned route surface is under /v1. The full surface is described at the API reference.

Staying informed

How to hear about a release

Honestly: there is no mechanism yet.

Placeholder — no release feed, mailing list or notification mechanism exists, and no release cadence has been committed. Replace with sourced, approved content before this page is made public.

No feed published

There is no RSS or Atom feed, no release mailing list and no in-product release notification. There is also no committed release cadence. Customers under an agreement are notified through the contractual change route described at support.

Release planning

Know what a release will cost you before it lands

Schema migration, content pack activation, contract change, re-testing. The useful conversation is which of those a given release touches — and we would rather have it in advance.

Talk to us API reference