Previously, the Cloud API endpoint `/v1/compose/{id}` return value's
`image_status.status` for a running worker job was "running", which didn't
comply with the Cloud API specification. Equivalents allowed by the API
specification are "building", "uploading" or "registering".
As a result, the Image Builder API also does not comply in this regard
to its specification, because it currently just copies the status value
string returned by osbuild-composer.
Define the `image_status.status` as a reusable type in the Cloud API
specification. This forces openapi to generate an explicit type for it,
which can be then explicitly used in the code, instead of plain strings.
Return "building", instead of "running" for running compose.
Modify api integration test to check for all valid `image_status.status`
values for a compose.
Add News entry explaining this change.
Signed-off-by: Tomas Hozza <thozza@redhat.com>
|
||
|---|---|---|
| .. | ||
| 27 | ||
| 28 | ||
| 29 | ||
| unreleased | ||
| README.md | ||
Release Notes
This directory contains release notes for osbuild-composer in the form of short markdown documents, sorted into subdirectories by release.
When proposing a user-visible change, please add a release note into the
unreleased directory. The note should explain the change from the perspective
of somebody using osbuild-composer and ideally how the change affects them or
how they can make use of new functionality.
When preparing a release, a maintainer will rename the unreleased directory
and summarize its contents in NEWS.md.