Search loading...


Explore and Make use of Nationally Defined Messaging APIs


Guide Versioning

An overview of how this implementation guidance is versioned.

Semantic Versioning

Given a version number MAJOR.MINOR.PATCH, increment the:

  • MAJOR version when you make incompatible API changes,
  • MINOR version when you add functionality in a backwards-compatible manner, and
  • PATCH version when you make backwards-compatible bug fixes.

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

A pre-release version MAY be denoted by appending a hyphen (refer to Semantic Versioning - Item 9)

For examples: 1.0.0-alpha.1 is a valid pre-release version.

Pre-release Labels

These labels will be taken from the GDS development process stages, and will be one of:

  • Experimental: Early development/proof of concept version of an API for early sight during discovery.
  • Alpha: Initial test APIs, likely to change substantially.
    • Typical Usage: Engagement with others interested in being involved with early development work and influencing the direction taken.
  • Beta: APIs that are still under active development and subject to change
    • Typical Usage: Engagement with ‘first of type’ or early adopters by the creation of first of type or pilot systems for testing, proof of concept etc. This development can assist in progression to a release candidate for a wider rollout.
  • Release Candidate: APIs that are largely complete, unlikely to change substantially, but still need further testing by a wider group of implementers before becoming live.
    • Typical Usage: After having been previously implemented by ‘first of type’ or pilot sites and now to be rolled out to a wider group of implementers.
  • Live: Release live APIs
  • Discontinued: APIs which have been discontinued and should not be used for new development
Tags: overview

All content is available under the Open Government Licence v3.0, except where otherwise stated