API: improve swagger and go-doc for ImageInspect structs#43300
Merged
thaJeztah merged 6 commits intomoby:masterfrom Mar 5, 2022
Merged
API: improve swagger and go-doc for ImageInspect structs#43300thaJeztah merged 6 commits intomoby:masterfrom
thaJeztah merged 6 commits intomoby:masterfrom
Conversation
b76069e to
71cdde7
Compare
8895364 to
c7025c3
Compare
tianon
approved these changes
Mar 2, 2022
Member
tianon
left a comment
There was a problem hiding this comment.
Overall I like it, just a few nits on the specific terminology added to the godocs, which I realized later might not actually be new verbiage (rather copied from elsewhere)?
- rename definition in swagger from `Image` to `ImageInspect` to match the go type - improve (or add) documentation for various fields - move example values in-line in the "definitions" section - remove the `required` fields from `ImageInspect`, as the type is only used as response type (not to make requests). Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
5428:7 warning comment not indented like content (comments-indentation) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
- rename definition in swagger from `Image` to `ImageInspect` to match the go type - improve (or add) documentation for various fields - move example values in-line in the "definitions" section - remove the `required` fields from `ImageInspect`, as the type is only used as response type (not to make requests). Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
5428:7 warning comment not indented like content (comments-indentation) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
c7025c3 to
565b1f5
Compare
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
565b1f5 to
06df530
Compare
Member
Author
|
@tianon updated, PTAL ❤️ |
Member
Author
|
Bringing this one in; I have a couple more follow-up changes in the swagger file(s) |
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
2 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.
addresses ContainerConfig field missing with buildkit docker/cli#2868ImagetoImageInspectto match the go typerequiredfields fromImageInspect, as the type is only used asresponse type (not to make requests).
also improve go-doc for some structs accordingly, and update API docs for v1.39-v1.41 with the same changes