moby/docs
Sebastiaan van Stijn 07dba5d9fe
api: docs: improve documentation of ContainerConfig type (API v1.30-v1.41)
ContainerConfig is used in multiple locations (for example, both for
Image.Config and Image.ContainerConfig). Unfortunately, swagger does
not allow documenting individual uses if a type is used; for this type,
the content is _optional_ when used as Image.ContainerConfig (which is
set by the classic builder, which does a "commit" of a container, but
not used when building an image with BuildKit).

This patch attempts to address this confusion by documenting that
"it may be empty (or fields not propagated) if it's used for the
Image.ContainerConfig field".

Perhaps alternatives are possible (aliasing the type?) but we can
look at those in a follow-up.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-04-19 16:22:29 +02:00
..
api api: docs: improve documentation of ContainerConfig type (API v1.30-v1.41) 2022-04-19 16:22:29 +02:00
contributing removed mentions of the archived Docker CE repo 2022-02-23 12:13:12 +01:00
static_files Remove Docker logo 2017-10-11 13:17:59 +01:00
rootless.md Update documentation links 2021-02-25 12:11:50 +01:00