Versioning

The API's major version is in the path: https://api.welly.no/v1. It changes only when a change would break your integration.

What does not break#

We add these to a version without warning, so build your integration to expect them:

• a new endpoint;
• a new optional parameter;
• a new field in a response;
• a new error code;
• a new value in a field whose values are listed, unless the endpoint says the list is closed.

Ignore fields you do not know, and treat an error code you do not know by its type.

What breaks#

Removing or renaming an endpoint, a parameter or a field, making something required that was optional, or changing what a value means. Such a change comes only in a new major version, /v2.

How long a version lives#

A new major version is announced in the API changelog and runs beside the old one for at least 12 months before the old one is turned off.

The spec's info.version is the API's version: 1.0.0 today.