Versioning

The version is in the path: /api/v1. Every answer also says PressProve-Api-Version: v1.

Docs menu

Inside v1

We only add. Write your code so that it does not break when these happen:

  • A new field in an object. Ignore fields you do not know.
  • A new optional parameter.
  • A new event type. Ignore types you do not handle.
  • A new error code. Treat a code you do not know by its status and type.
  • A new reason inside an unknown. Show it as it is.

A code or a field never changes its meaning inside v1, and we do not remove one.

A new version

A change that could break your code would be /api/v2. We would keep v1 running for at least 12 months after announcing the change on the changelog.

Changes

Dated changes to the API are on the changelog.