Data API documentationContract changelog
Versioned public contract

Data API contract changelog

Follow compatibility-relevant changes to the five-operation read-only integration contract in one human and machine-readable release trail.

Read the API guideChangelog JSONChangelog Markdown
Current version
1.0.0-beta.1
Status
beta
Operations
Five read-only routes
Deprecated now
None
Release trail

Published contract versions

Each release records one category and the SHA-256 fingerprint of the reviewed wire surface. CI rejects drift from the current entry.

additive1.0.0-beta.1

Initial versioned public contract

Published the reviewed five-operation read-only contract with one explicit beta version and lifecycle metadata.

Published
2026-08-21
Status
beta
Contract SHA-256
77eba320e8e2eb1676f3b244ac596bd08bedcbb99adf1389353bc15264a1500b
  • Pinned catalog, preview, schema, structured query, and versioned export as the complete public operation inventory.
  • Published consistent HTML, Markdown, OpenAPI 3.1, and machine-readable contract discovery paths.
  • Defined additive, clarification, deprecated, and breaking change categories without marking any current operation deprecated.

No operation is deprecated in this version.

Classification

How changes are labeled

additive

A new optional field, parameter, operation, media type, or other backwards-compatible capability.

clarification

Documentation or examples become more precise without changing request or response behavior.

deprecated

An existing operation or field remains available but gains explicit replacement and announcement metadata.

breaking

A removal, rename, new requirement, narrowed input, or incompatible response change that requires a new contract version.

Client migration

Deprecation metadata appears only when real

A future deprecated operation will be marked in the manifest and OpenAPI with its announcement date and optional replacement. An explicit sunset value and runtime Deprecation and Sunset headers will appear only after the matching server behavior exists. There is no deprecated operation in the current contract.

Scope

Operational diagnostics are outside the client contract

The /health and /ready routes help operate the service. They are not part of the five public Data API operations and do not define client compatibility or availability commitments. Use this changelog and the versioned contract for integration decisions.