API versioning

Non-breaking changes

We are only doing breaking changes when we change major API version - which happens infrequently.

We however do non-breaking changes all the time. You can except us to add new parameters and not publish a new api version - we consider this as a non-breaking change.

Breaking changes

Removing and renaming a parameter would be considered a breaking change and will require a major version upgrade.

Major versions change in the following way:

  1. One specific endpoint gets a breaking change. Example new path /api/parkingarea/:id/v2
  2. Full API gets a new version that is slightly changed in a non-backwards compatible way. Example new path /api/v2/*
  3. Completely new API is created. Usually the hostname changes.

All users of API are contacted at least 6 months in advance if they have to do changes on their end.