VERSIONING.md

Service, and API versioning

• Acronyms
• Overview
• Use Cases when updating the version of the API and Services
• Version change examples
  • Defect fix on the plans service
  • Add functionality to the plans service
  • Change or remove functionality to the plans service

Acronyms

Acronym	Description
API	Application Program Interface

Overview

A PackIt Platform release consists of a specific versioned set of services, which expose RESTful APIs. All RESTful APIs are also versioned.

Release notes are published for each release summarising the release changes.

Versioning policies are important internally, to manage software changes and ensure that correct component versions are deployed together, and externally, to ensure compatibility for external clients.

This document summarises the relevant versioning policies.

Use Cases when updating the version of the API and Services

Use Case	Service Version	API Version
Defect Fix	Patch change to services impacted	No change
Add functionality	Minor change to services impacted	No change
Remove functionality	Major change to services impacted	Increment
Change functionality	Major change to services impacted	Increment

Version change examples

Defect fix on the plans service

	Service Version	API Version
Pre change	Plans service 1.0.0	v1
Post change	Plans service 1.0.1	v1

Add functionality to the plans service

	Service Version	API Version
Pre change	Plans service 1.0.1	v1
Post change	Plans service 1.1.0	v1

Change or remove functionality to the plans service

	Service Version	API Version
Pre change	Plans service 1.0.1	v1
Post change	Plans service 2.0.0	v2