api: swagger: add IPAMConfig on IPAM#43372
Merged
thaJeztah merged 2 commits intomoby:masterfrom Mar 16, 2022
Merged
Conversation
thaJeztah
requested changes
Mar 15, 2022
Member
thaJeztah
left a comment
There was a problem hiding this comment.
Thanks for contributing! I see this PR is updating the swagger file for v1.41 in the docs directory; could you add a commit that updates the swagger file inside the API directory as well? https://github.com/moby/moby/blob/master/api/swagger.yaml
The file inside the API directory is the one that's used to generate (some of) the API code, and (on the main/master branch) is used for the upcoming v1.42 API.
For these, it's good to keep them as separate commits (in case we want to cherry-pick to the 20.10 release branch, in which cause we could decide to only backport the docs changes).
Signed-off-by: Niel Drummond <niel@drummond.lu>
Signed-off-by: Niel Drummond <niel@drummond.lu>
d4bf5b1 to
98f0278
Compare
Contributor
Author
|
Thanks for checking. I've added a new commit for the |
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
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.
Signed-off-by: Niel Drummond niel@drummond.lu
fixes #43292
ref: fussybeaver/bollard#201
- What I did
Changed the swagger documentation signature for the
IPAMConfigfield from an array of strings, to a newIPAMConfigtype.- How I did it
Amended the YAML documentation for version 1.41.
- How to verify it
I used a swagger generator on the new type to verify the yaml and new type are created. Testing executed with the newly generated codebase by the original issue owner.
- Description for the changelog
Changed swagger documentation IPAM config from array to IPAMConfig type
- A picture of a cute animal (not mandatory but encouraged)