# API Changelog

This changelog records customer-visible changes to the HollyHR public API.
HollyHR is currently pre-launch and the public API is in beta, so there are no
external-client migrations to announce yet.

## 2026-06-21

### Metadata discovery

- Added `GET /metadata`, a machine-readable catalogue of public API routes,
  required scopes, path/query parameters, schema fields, field categories, and
  webhook event scope requirements.
- The catalogue is generated from the same OpenAPI/Zod contract source as the
  public reference.

No customer action is required.

### Contract lock preparation

- Documented the v1 error envelope as the public API error contract.
- Documented public API rate-limit headers and default request buckets.
- Added planned-changes, support, feedback, and OpenAPI import guidance to the
  developer docs.

No customer action is required.

## Entry format

Future entries should include:

- the date the change was published;
- the endpoint, scope, webhook event, or field affected;
- whether the change is additive, deprecated, or breaking;
- the effective date for any deprecation or sunset;
- the migration path and final failure mode.