iRetail PRO store node 1.0.0-m1: updater

2 operations

← All documentation · Source: contracts openapi/store-v1.yaml at 8000474.

Operations

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

POST /v1/updater/report The updater reports its state for the target's record version; a report for an older record version is ignored.

operationId postUpdaterReport

Every error response.

The step a failed or rolled back update stopped at.

download · verify · backup · rehearse · load · migrate · start · check

`running_version` required	`string`
`previous_version` required	`string \| null`
`exchange_connected` required	`boolean \| null`	The store's exchange with its hub is open; null for a store with no hub and at the hub.
`target` required	`object \| null`

`record_version` required	`integer (int64)`
`state` required	`"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` required	`string`
`healthz`	`"ok" \| "failing" \| null`	The last probe of the node's GET /healthz.