app.upgrade_summary

Retrieve upgrade summary for app_name.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: app_name

app_name

Type: string

Must be at least 1 characters long

Parameter 2: options

options

Type: object Default: {"app_version": "latest"}
No Additional Properties

app_version

App Version

Type: string Default: "latest"

Must be at least 1 characters long

Return value

AppUpgradeSummaryResult

Type: object
No Additional Properties

latest_version Required

Latest Version

Type: string

Latest version available for the app

latest_human_version Required

Latest Human Version

Type: string

Latest human readable version available for the app

upgrade_version Required

Upgrade Version

Type: string

Version user has requested to be upgraded at

upgrade_human_version Required

Upgrade Human Version

Type: string

Human readable version user has requested to be upgraded at

available_versions_for_upgrade Required

Available Versions For Upgrade

Type: array of object

List of available versions for upgrade

No Additional Items

Each item of this array must be:

AppVersionInfo

Type: object
No Additional Properties

version Required

Version

Type: string

Version of the app

human_version Required

Human Version

Type: string

Human readable version of the app

changelog Required

Changelog

Any of

• Option 1
• Option 2

Type: string

Type: null

Required roles: APPS_READ