Gelato and the API Lifecycle

This guide is a quick run through of the API Version states you can use in Gelato, and how they correspond to your API Lifecycle.

We're currently working on expanding this feature, so if you have suggestions please let us know


API Versions which are in Draft are not visible to your Developers. You can preview what the Version will look like once it's out of Draft using the "Preview" button in the top-right hand corner of the documentation editor.


"Beta" versions are visible to your Developers, but they will include a warning that the API Version is still in testing, and that bugs :bug: may occur!

The warning looks something like this:

Beta Warning


Published APIs are visible to your Developers, ready for them to build upon!


If you have multiple published versions (say, Version 3.0 and 2.0 are both published and live) then the older versions will include a warning like the following:

Latest Version Warning


You can mark older API Versions that shouldn't be used as "Deprecated" using this state. Your Developers will get a serious warning that they should upgrade their apps to use the latest version!

Deprecation Warning