Skip to main content
The version sits in the path, immediately after the endpoint it belongs to:
There is no suite-wide version. Each endpoint moves on its own schedule, so a new version of one never moves another, and no migration is ever required across all of them at once.

​
What a new version means

A version holds a shape steady. gst/v1/gst-info.1 keeps taking the fields it takes today and keeps returning the fields it returns today. Anything that would break an integration built against it ships as gst/v2/gst-info.1, served alongside it. Changes made within a version:
  • adding a new optional request field
  • adding a new field to a response
A response is open: a field may be added to one within its version. Changes that get a new version:
  • removing or renaming a field
  • making an optional request field required
  • changing the type or meaning of an existing field
Two endpoints that verify the same thing by different methods, such as penny drop and penny-less, are separate endpoints rather than versions of each other. Neither is withdrawn in favour of the other without notice.