docs: add missing manifest parameter to build API endpoints #27263
Conversation
openshift-ci
bot
added
do-not-merge/work-in-progress
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: Honny1 The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
github-actions
bot
added
the
kind/api-change
|
cc @inknos |
Honny1
added
the
No New Tests
openshift-ci
bot
removed
the
do-not-merge/work-in-progress
pkg/api/server/register_images.go
Outdated
| // type: string | ||
| // default: | ||
| // description: | | ||
| // Add the image to the specified manifest list. Creates manifest list if it does not exist. |
There was a problem hiding this comment.
| // Add the image to the specified manifest list. Creates manifest list if it does not exist. | |
| // Add the image to the specified manifest list. Creates a manifest list if it does not exist. |
I'm not sure if it should be "a manifest", or "the manifest". Your pick, but please add one or the other.
pkg/api/server/register_images.go
Outdated
| // type: string | ||
| // default: | ||
| // description: | | ||
| // Add the image to the specified manifest list. Creates manifest list if it does not exist. |
There was a problem hiding this comment.
Ditto prior comment. Add a or the before manifest list in the second sentence.
|
Once the nits are squished, |
Add manifest parameter documentation to /libpod/build, and /libpod/local/build endpoints in OpenAPI spec. Fixes: containers#27261 Signed-off-by: Jan Rodák <[email protected]>
|
Thanks @Honny1 , once the comments are addressed, it LGTM |
|
I addressed comments. @TomSweeneyRedHat @inknos |
|
no more comments from my side LGTM again! |
3 participants
Add manifest parameter documentation to
/libpod/build, and/libpod/local/buildendpoints in OpenAPI spec.Fixes: #27261
For reviewer: I am not sure if I should add this to the compat API. The Docker documentation didn't mention
Manifest, but our implementation will work with that query argument for the compat API.Does this PR introduce a user-facing change?