Versioning
The API version lives in the path. This is HAPI v3, served under /v3/HAPI. A new major version would live under a new prefix, so your integration keeps working until you choose to move.
What is stable
Within v3 we make only backward-compatible changes: we add new endpoints, new optional request fields, and new response fields. We do not rename or remove existing fields, and we do not change the type of a field, within the version.
| We may | We will not (within v3) |
|---|---|
| Add a new endpoint. | Remove or rename an endpoint. |
| Add a new field to a response. | Remove or rename a response field. |
| Add a new optional request parameter. | Make a previously optional parameter required. |
| Add a new value to an enum. | Change the type of a field. |
Build tolerant clients
Because new fields can appear, ignore unknown fields rather than failing on them, and do not assume the set of enum values is closed. That way a compatible addition never breaks your integration.
The spec is the source of truth.
The machine-readable OpenAPI spec always matches this reference. Import it into your client to generate types and stay in sync.
Was this page helpful?