api: swagger: fix documentation for image push endpoint#48443
Merged
thaJeztah merged 2 commits intomoby:masterfrom Sep 11, 2024
Merged
api: swagger: fix documentation for image push endpoint#48443thaJeztah merged 2 commits intomoby:masterfrom
thaJeztah merged 2 commits intomoby:masterfrom
Conversation
thaJeztah
added
area/api
Member
Author
|
Opening as draft, because I'm not really sold on the wording 😂 - once we get to better wording, I can update the versioned copies that are used in the docs. cc @dvdksn perhaps you have good suggestions |
dvdksn
reviewed
Sep 9, 2024
The documentation was incorrect and didn't properly document the use of tags; - Image push currently only accepts an image-name, not an ID / digest. - When giving a name, it's expected to be without tag included; when including a tag, it is ignored. - The tag parameter is required when pushing a single image (i.e., it does not default to "latest"); omitting the tag parameter will push all tags of the given image. Signed-off-by: Sebastiaan van Stijn <[email protected]>
thaJeztah
force-pushed
the
fix_push_docs
branch
from
1c72ed4 to
07e31e3
Compare
The documentation was incorrect and didn't properly document the use of tags; - Image push currently only accepts an image-name, not an ID / digest. - When giving a name, it's expected to be without tag included; when including a tag, it is ignored. - The tag parameter is required when pushing a single image (i.e., it does not default to "latest"); omitting the tag parameter will push all tags of the given image. Signed-off-by: Sebastiaan van Stijn <[email protected]>
Member
Author
|
Updated; also updated the versioned files used in the docs |
vvoland
approved these changes
Sep 11, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The documentation was incorrect and didn't properly document the use of tags;
- Description for the changelog
- A picture of a cute animal (not mandatory but encouraged)