semver.
app
Make versioning as easy as 1.2.3
Documentation
Authentication
The authentication mechanism of version-it rely on a global acccess key named V_KEY. You can use this key either in the query params or in the headers of any HTTP request.
You can find your own access key on this page.
Endpoints
GET
Display current version of a branch
/api
/{organization}/{project}/{branch}
Route params
| organization | The name of the organization |
| project | The name of the project |
| branch | The name of the branch |
Query params
Empty
Body
Empty
Authentication
Response
string
The version to be displayed, as a string.
POST
Set/reset version for a branch
/api
/{organization}/{project}/{branch}
Route params
| organization | The name of the organization |
| project | The name of the project |
| branch | The name of the branch |
Query params
Empty
Body
| major | Major part (semver) of the version |
| minor | Minor part (semver) of the version |
| patch | Patch part (semver) of the version |
| revision | Optional, revision part (semver) of the version |
| suffix | Optional, the suffix to apply on this project branch |
Authentication
Response
string
The version to be displayed, as a string.
DELETE
Delete branch version
/api
/{organization}/{project}/{branch}
Route params
| organization | The name of the organization |
| project | The name of the project |
| branch | The name of the branch |
Query params
Empty
Body
Empty
Authentication
Response
Empty
POST
Bump version of a branch, using PATCH increment
Recommended for CI versioning
/api
/{organization}/{project}/{branch}/bump
Route params
| organization | The name of the organization |
| project | The name of the project |
| branch | The name of the branch |
Query params
Empty
Body
Empty
Authentication
Response
string
The version to be displayed, as a string.
POST
Bump version of a branch
/api
/{organization}/{project}/{branch}/bump/{level}
Route params
| organization | The name of the organization |
| project | The name of the project |
| branch | The name of the branch |
| level | The bump function to apply, one of the following values: MAJOR, MINOR, PATCH, REVISION |
Query params
Empty
Body
Empty
Authentication
Response
string
The version to be displayed, as a string.