iRetail PRO store node 1.0.0-m1: updater
2 операции
← Вся документация · Источник: контракты, openapi/store-v1.yaml на коммите 8000474.
Справочники на английском — на языке контрактов, из которых они созданы.
← iRetail PRO store node 1.0.0-m1
Операции
GET
/v1/updater/target
The updater reads its node's target (spec/RELEASES.md, The updater's API); 404 when the node has no updater token.
operationId
getUpdaterTarget
Ответы
-
200OKUpdaterTarget -
401Error (spec/API.md).Error -
404Error (spec/API.md).Error
POST
/v1/updater/report
The updater reports its state for the target's record version; a report for an older record version is ignored.
Схемы
Error object
Every error response.
error обязательный
|
string |
Stable code, see spec/API.md. |
message обязательный
|
string |
English text for logs. |
details
|
object |
UpdateStep "download" | "verify" | "backup" | "rehearse" | "load" | "migrate" | "start" | "check"
The step a failed or rolled back update stopped at.
download · verify · backup · rehearse · load · migrate · start · check
UpdaterTarget object
running_version обязательный
|
string |
|
previous_version обязательный
|
string | null |
|
exchange_connected обязательный
|
boolean | null |
The store's exchange with its hub is open; null for a store with no hub and at the hub. |
target обязательный
|
object | null |
UpdaterReport object
record_version обязательный
|
integer (int64) |
|
state обязательный
|
"applying" | "verifying" | "done" | "failed" | "rolled_back" |
|
step
|
UpdateStep | null |
|
error
|
string | null |
A short code, never a log's text. |
backup
|
"taken" | "skipped" | "failed" | null |
The archive before applying (spec/BACKUP.md, Before an update); a current updater never skips it, skipped comes only from an updater before 1.1. |
rehearsal
|
"passed" | "failed" | "skipped" | null |
The rehearsal of the migrations (spec/RELEASES.md, Rehearsal); null before it. |
rehearsal_reason
|
"too_large" | "disk" | "not_permitted" | null |
Why the rehearsal was skipped; null otherwise. |
running_version обязательный
|
string |
|
healthz
|
"ok" | "failing" | null |
The last probe of the node's GET /healthz. |