AppUpdateReport
iRetail PRO store node 1.0.0-m1
← All documentation · Source: contracts openapi/store-v1.yaml at 8000474.
← iRetail PRO store node 1.0.0-m1
ReleasePlatform "linux-x64" | "linux-arm64" | "windows-x64" | "macos-universal"
A platform a release ships for (spec/RELEASES.md).
linux-x64 · linux-arm64 · windows-x64 · macos-universal
AppId "cashier" | "manager" | "gateway"
An app that updates itself from its node (spec/RELEASES.md, The apps, The gateway); the manifest's component.
cashier · manager · gateway
AppUpdateState "idle" | "downloading" | "ready" | "waiting" | "installing" | "installed" | "failed" | "rolled_back"
Where an app's update stands (spec/RELEASES.md, Reporting).
idle · downloading · ready · waiting · installing · installed · failed · rolled_back
AppUpdateStep "download" | "verify" | "migrate" | "install" | "start"
The step a failed or rolled back app update stopped at.
download · verify · migrate · install · start
AppUpdateError "malformed" | "unsupported_format" | "unknown_key" | "bad_signature" | "downgrade" | "missing_artifact" | "size_mismatch" | "sha256_mismatch" | "unknown_artifact" | "install_marker" | "source_unreachable" | "storage_failed" | "install_failed" | "start_failed"
Why an app update stopped, one code, never text from outside (spec/RELEASES.md, Reporting).
malformed · unsupported_format · unknown_key · bad_signature · downgrade · missing_artifact · size_mismatch · sha256_mismatch · unknown_artifact · install_marker · source_unreachable · storage_failed · install_failed · start_failed
AppUpdateReport object
At most 1 KiB. step and error are given exactly for failed and rolled_back; target_version except in idle, and equal to version in installed.
app required
|
AppId |
|
platform required
|
ReleasePlatform |
|
version required
|
string |
The version it runs. |
previous_version required
|
string | null |
The version it keeps for one rollback; null for none. |
target_version required
|
string | null |
The version it is updating to, or that failed; null in idle. |
state required
|
AppUpdateState |
|
step required
|
AppUpdateStep | null |
|
error required
|
AppUpdateError | null |