# app.upgrade_summary

Retrieve upgrade summary for `app_name`.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: app_name

#### app_name

Type: string

Name of the application to get upgrade summary for.

Must be at least `1` characters long

##### Parameter 2: options

#### options

Type: object Default: {"app_version": "latest"}

Options specifying the target version for the summary.

No Additional Properties

##

#### App Version

Type: string Default: "latest"

Target version to generate upgrade summary for. Use 'latest' for the newest available version.

Must be at least `1` characters long

##

#### AppUpgradeSummaryResult

Type: object

AppUpgradeSummaryResult return fields.

No Additional Properties

##

#### Latest Version

Type: string

Latest version available for the app.

##

#### Latest Human Version

Type: string

Latest human readable version available for the app.

##

#### Upgrade Version

Type: string

Version user has requested to be upgraded at.

##

#### Upgrade Human Version

Type: string

Human-readable version user has requested to be upgraded at.

##

#### 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

Type: string

Version of the app.

##

#### Human Version

Type: string

Human-readable version of the app.

##

#### Changelog

Changelog or release notes for the upgrade version. `null` if not available.

## Any of

Type: string

Must be at most `2147483647` characters long

Type: null

Required roles: APPS_READ