API Changelog
Notable changes to the public ArelHub API contract. Breaking changes are highlighted explicitly.
Policy
- Breaking changes require a minimum 60-day deprecation notice before removal.
- Non-breaking additions (new optional fields, new endpoints) do not require a deprecation period.
- Staff, internal, and deferred endpoints are excluded from this changelog.
A changelog entry is mandatory when a public route path changes, a required field is added or removed, a response field integrators rely on is renamed, a status code changes meaning, or auth scheme requirements change.
2026-08-12 — API baseline
Non-breaking · New public surface
The public API is now represented by one curated OpenAPI contract covering customer authentication, platform operations, messaging, and webhooks. Internal and staff endpoints remain outside the public contract.
Production reference artifacts
Integrators can download the public contract in JSON or YAML format:
/openapi/public.json— OpenAPI JSON document/openapi/public.yaml— OpenAPI YAML document
These endpoints provide the curated contract without exposing the internal Swagger UI or private API documents.
Auth scheme normalization
All public endpoints now carry explicit per-operation security annotations. Endpoints requiring JWT show
jwt only; endpoints accepting either scheme show both alternatives; anonymous endpoints show no
security requirement.
Baseline error responses
All public endpoints now consistently document 401, 403, 422,
429, and 500 responses. All error responses use ProblemDetails format (RFC
7807).
Older changes predating the M41 baseline are not reflected here. This changelog covers the public contract surface only.