docs: document image digest in push response#51792
Open
majiayu000 wants to merge 3 commits intomoby:masterfrom
Open
docs: document image digest in push response#51792majiayu000 wants to merge 3 commits intomoby:masterfrom
majiayu000 wants to merge 3 commits intomoby:masterfrom
Conversation
Document that the image push response stream includes the image digest in the final JSON object's `aux` field. This allows clients to obtain the content-addressable digest of the pushed image without making an additional API call to inspect the image. Fixes moby#29865 Signed-off-by: majiayu000 <[email protected]>
vvoland
requested changes
Jan 5, 2026
Contributor
vvoland
left a comment
vvoland
left a comment
There was a problem hiding this comment.
Thanks!
This is only used by the content trust which is deprecated.
Aux is a bit hacky and I think it would be better to actually come up with a proper way to propagate this via a regular JSON message (and exposing it nicely through the clien'ts ImagePushResponse).
Signed-off-by: lif <[email protected]>
majiayu000
force-pushed
the
29865-doc-push-digest-response
branch
from
73cb860 to
380d02c
Compare
Signed-off-by: lif <[email protected]>
majiayu000
force-pushed
the
29865-doc-push-digest-response
branch
from
9344fab to
eb41389
Compare
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.
Summary
Document that the image push response stream includes the image digest in the final JSON object's
auxfield.Changes
Added documentation to the
/images/{name}/pushendpoint explaining:auxfieldThis allows clients to obtain the content-addressable digest of the pushed image without making an additional API call.
Fixes #29865