Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[20.10 backport] assorted swagger updates in documentation #44098

Merged
merged 3 commits into from Sep 7, 2022

Commits on Sep 6, 2022

  1. api: docs: improve documentation of ContainerConfig type (API v1.30-v…

    …1.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>
    (cherry picked from commit 07dba5d)
    Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
    thaJeztah committed Sep 6, 2022
    Copy the full SHA
    fdd438a View commit details
    Browse the repository at this point in the history
  2. docs: api: document ImageSummary fields (api v1.39-v1.41)

    Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
    (cherry picked from commit b9de761)
    Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
    thaJeztah committed Sep 6, 2022
    Copy the full SHA
    3e9e79d View commit details
    Browse the repository at this point in the history
  3. docs: api: adjust ContainerWaitResponse error as optional

    Signed-off-by: Niel Drummond <niel@drummond.lu>
    (cherry picked from commit 2359da8)
    Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
    fussybeaver authored and thaJeztah committed Sep 6, 2022
    Copy the full SHA
    23c7d84 View commit details
    Browse the repository at this point in the history