Skip to content

Vendor Application Versioning

To roll out a new version of your application, send a PUT request to {{baseUrl}}/vendors/:vendorEmail/:applicationName. Replace :vendorEmail with the email you used to register the vendor and :applicationName with the name of your application. The request body should be in the following format:

{
"appSourceUrl": "https://link_to_application_source.com",
"appVersion": "Application version",
"hasUpdate": true
}

If everything went successfully, you will get an empty response with status code 200.

Here’s the detailed description of the request body fields:

FieldDescriptionTypeRequired
appSourceUrlLink to the S3 artefact with your application source code. Versioning must be enabled on your bucket and object version should be included to the url as a query string parameter.StringYes
appVersionApplication version compliant with PEP 440.StringYes
hasUpdateIndicates whether the application has an update. Should be set to true when publishing a new version.BooleanYes
developVersionUsed to let the installer know that it is a developer version not intended to be installed on all customers. Can only be installed through direct installer request.BooleanNo
mandatoryVersionUsed to let the installer know that this version must appear in the deployment sequence even if there are newer versions available.BooleanNo
criticalVersionSignals the installer about a critical update that should be applied immediately. This functionality is still under development.BooleanNo

appVersion must match the following scheme: [N!]N(.N)*[{a|b|rc}N][.postN][.devN]. For example, 1.0.0, 1.0.0a1, 1.0.0.dev1, 1.0.0.post1, 1.0.0rc1. Your version must be unique and greater than the previous one. In order to check whether your version is valid, you can use this tool. To check what was the last version you published, send a GET request to {{baseUrl}}/vendors/:vendorEmail/:applicationName. Replace :vendorEmail with the email you used to register the vendor and :applicationName with the name of your application.