API Versioning

Open Bank Project APIs are marked as either STABLE, DRAFT, DEPRECIATED or BLEEDING-EDGE.

The latest version on develop branch should be considered BLEEDING-EDGE.

We try to introduce a limited number of end-points per version so that each version can stabalise in a reasonable time.

Once an API version (say 1.4.0) is marked as STABLE, we won't introduce any breaking changes to it. What, then, do we consider to be "non breaking" changes? i.e. Which changes are allowed for a STABLE version?

Adding new API resources.
Adding new optional request parameters to existing API methods.
Adding new properties to existing API responses.
Changing the order of properties in existing API responses.
Changing the length or format of object IDs or other opaque strings.
Changing the ResourceDoc for an endpoint (as long as this wouldn't impact the endpoint itself)
Adding an additional authorisation method for an endpoint. 

(props to Stripe for the inspiration to create a page like this)