Skip to content

api/docs: remove temporary "full" example for image config#50910

Merged
thaJeztah merged 2 commits intomoby:masterfrom
thaJeztah:api_docs_image_config
Sep 5, 2025
Merged

api/docs: remove temporary "full" example for image config#50910
thaJeztah merged 2 commits intomoby:masterfrom
thaJeztah:api_docs_image_config

Conversation

@thaJeztah
Copy link
Copy Markdown
Member

@thaJeztah thaJeztah commented Sep 5, 2025

relates to:

api/docs: remove temporary "full" example for image config

This example was added in 5e0e34f so that
the deprecated fields could be omitted from the example. Those fields were
removed from the swagger in 4dc961d, but
the temporary example was not removed.

This patch removes the example, in favor of the per-field examples, which
were already in place.

- How to verify it

- Human readable description for the release notes

- A picture of a cute animal (not mandatory but encouraged)

@thaJeztah thaJeztah added this to the 29.0.0 milestone Sep 5, 2025
@thaJeztah thaJeztah force-pushed the api_docs_image_config branch from 0cbbe8e to 302d7b7 Compare September 5, 2025 16:33
@thaJeztah thaJeztah marked this pull request as draft September 5, 2025 16:34
@thaJeztah thaJeztah force-pushed the api_docs_image_config branch from 302d7b7 to 974b5a9 Compare September 5, 2025 16:36
@thaJeztah thaJeztah marked this pull request as ready for review September 5, 2025 16:36
@thaJeztah
Copy link
Copy Markdown
Member Author

Actually; learned that the swagger considers the default to be omit-empty? I can drop the last 2 commits (or keep them for later); #50855 (comment)

This example was added in 5e0e34f so that
the deprecated fields could be omitted from the example. Those fields were
removed from the swagger in 4dc961d, but
the temporary example was not removed.

This patch removes the example, in favor of the per-field examples, which
were already in place.

Signed-off-by: Sebastiaan van Stijn <[email protected]>
….51)

This example was added in 5e0e34f so that
the deprecated fields could be omitted from the example. Those fields were
removed from the swagger in 4dc961d, but
the temporary example was not removed.

This patch removes the example, in favor of the per-field examples, which
were already in place.

Signed-off-by: Sebastiaan van Stijn <[email protected]>
@thaJeztah thaJeztah force-pushed the api_docs_image_config branch from 974b5a9 to 0fe1af9 Compare September 5, 2025 17:23
@thaJeztah thaJeztah merged commit 7777b86 into moby:master Sep 5, 2025
54 checks passed
@thaJeztah thaJeztah deleted the api_docs_image_config branch September 5, 2025 17:59
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.

4 participants