Skip to content

api: swagger: use explicit definitions, use inline examples, and fix indentation.#43334

Merged
thaJeztah merged 8 commits into
moby:masterfrom
thaJeztah:api_swagger_inline_examples
Mar 25, 2022
Merged

api: swagger: use explicit definitions, use inline examples, and fix indentation.#43334
thaJeztah merged 8 commits into
moby:masterfrom
thaJeztah:api_swagger_inline_examples

Conversation

@thaJeztah
Copy link
Copy Markdown
Member

Some commits from #43332, leaving out the List response (which was problematic), but including a commit to carry #41748

Generating the ContainerWaitResponse as explicit types, makes them land in separate files, therefore "fixes" the CI flakiness for that type where the order of the types within the same file would randomise.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This should help with CI being unstable when generating the types (due
to Go randomizing order). Unfortunately, the (file) names are a bit ugly,
but addressing that in a follow-up.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Copy link
Copy Markdown
Member

@tianon tianon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally seems OK, but I don't love that moving to definitions requires code changes / restructuring to be fully useful? 🙈

Comment thread api/swagger.yaml
Comment thread api/swagger.yaml
@thaJeztah
Copy link
Copy Markdown
Member Author

Thx for review! Let me get this one in

@thaJeztah thaJeztah merged commit 4a26fdd into moby:master Mar 25, 2022
@thaJeztah thaJeztah deleted the api_swagger_inline_examples branch March 25, 2022 08:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants