From fdd438ae03b16ed70571c58937b376baeecab6fe Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Mon, 4 Apr 2022 20:17:39 +0200 Subject: [PATCH 1/3] 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 (cherry picked from commit 07dba5d9fe302c6e41aea8983427c5edda8eb83f) Signed-off-by: Sebastiaan van Stijn --- docs/api/v1.30.yaml | 10 +++++++++- docs/api/v1.31.yaml | 10 +++++++++- docs/api/v1.32.yaml | 10 +++++++++- docs/api/v1.33.yaml | 10 +++++++++- docs/api/v1.34.yaml | 10 +++++++++- docs/api/v1.35.yaml | 10 +++++++++- docs/api/v1.36.yaml | 10 +++++++++- docs/api/v1.37.yaml | 10 +++++++++- docs/api/v1.38.yaml | 10 +++++++++- docs/api/v1.39.yaml | 7 +++++++ docs/api/v1.40.yaml | 7 +++++++ docs/api/v1.41.yaml | 7 +++++++ 12 files changed, 102 insertions(+), 9 deletions(-) diff --git a/docs/api/v1.30.yaml b/docs/api/v1.30.yaml index 10eaf654cf5cf..0f79e7dc66e04 100644 --- a/docs/api/v1.30.yaml +++ b/docs/api/v1.30.yaml @@ -757,7 +757,15 @@ definitions: - "hyperv" ContainerConfig: - description: "Configuration for a container that is portable between hosts" + description: | + Configuration for a container that is portable between hosts. + + When used as `ContainerConfig` field in an image, `ContainerConfig` is an + optional field containing the configuration of the container that was last + committed when creating the image. + + Previous versions of Docker builder used this field to store build cache, + and it is not in active use anymore. type: "object" properties: Hostname: diff --git a/docs/api/v1.31.yaml b/docs/api/v1.31.yaml index 31da655635da5..82610d6f5bfc6 100644 --- a/docs/api/v1.31.yaml +++ b/docs/api/v1.31.yaml @@ -758,7 +758,15 @@ definitions: - "hyperv" ContainerConfig: - description: "Configuration for a container that is portable between hosts" + description: | + Configuration for a container that is portable between hosts. + + When used as `ContainerConfig` field in an image, `ContainerConfig` is an + optional field containing the configuration of the container that was last + committed when creating the image. + + Previous versions of Docker builder used this field to store build cache, + and it is not in active use anymore. type: "object" properties: Hostname: diff --git a/docs/api/v1.32.yaml b/docs/api/v1.32.yaml index 762e69e81514a..3195f31bef19a 100644 --- a/docs/api/v1.32.yaml +++ b/docs/api/v1.32.yaml @@ -821,7 +821,15 @@ definitions: - "hyperv" ContainerConfig: - description: "Configuration for a container that is portable between hosts" + description: | + Configuration for a container that is portable between hosts. + + When used as `ContainerConfig` field in an image, `ContainerConfig` is an + optional field containing the configuration of the container that was last + committed when creating the image. + + Previous versions of Docker builder used this field to store build cache, + and it is not in active use anymore. type: "object" properties: Hostname: diff --git a/docs/api/v1.33.yaml b/docs/api/v1.33.yaml index 16840bd0e4acf..dee83da409aef 100644 --- a/docs/api/v1.33.yaml +++ b/docs/api/v1.33.yaml @@ -826,7 +826,15 @@ definitions: - "hyperv" ContainerConfig: - description: "Configuration for a container that is portable between hosts" + description: | + Configuration for a container that is portable between hosts. + + When used as `ContainerConfig` field in an image, `ContainerConfig` is an + optional field containing the configuration of the container that was last + committed when creating the image. + + Previous versions of Docker builder used this field to store build cache, + and it is not in active use anymore. type: "object" properties: Hostname: diff --git a/docs/api/v1.34.yaml b/docs/api/v1.34.yaml index 1b99c8f1f2c1d..713072a075302 100644 --- a/docs/api/v1.34.yaml +++ b/docs/api/v1.34.yaml @@ -837,7 +837,15 @@ definitions: - "hyperv" ContainerConfig: - description: "Configuration for a container that is portable between hosts" + description: | + Configuration for a container that is portable between hosts. + + When used as `ContainerConfig` field in an image, `ContainerConfig` is an + optional field containing the configuration of the container that was last + committed when creating the image. + + Previous versions of Docker builder used this field to store build cache, + and it is not in active use anymore. type: "object" properties: Hostname: diff --git a/docs/api/v1.35.yaml b/docs/api/v1.35.yaml index 296546b4f6510..5471745bda324 100644 --- a/docs/api/v1.35.yaml +++ b/docs/api/v1.35.yaml @@ -817,7 +817,15 @@ definitions: - "hyperv" ContainerConfig: - description: "Configuration for a container that is portable between hosts" + description: | + Configuration for a container that is portable between hosts. + + When used as `ContainerConfig` field in an image, `ContainerConfig` is an + optional field containing the configuration of the container that was last + committed when creating the image. + + Previous versions of Docker builder used this field to store build cache, + and it is not in active use anymore. type: "object" properties: Hostname: diff --git a/docs/api/v1.36.yaml b/docs/api/v1.36.yaml index eff6fb712096a..bd26aa0cc94cf 100644 --- a/docs/api/v1.36.yaml +++ b/docs/api/v1.36.yaml @@ -817,7 +817,15 @@ definitions: - "hyperv" ContainerConfig: - description: "Configuration for a container that is portable between hosts" + description: | + Configuration for a container that is portable between hosts. + + When used as `ContainerConfig` field in an image, `ContainerConfig` is an + optional field containing the configuration of the container that was last + committed when creating the image. + + Previous versions of Docker builder used this field to store build cache, + and it is not in active use anymore. type: "object" properties: Hostname: diff --git a/docs/api/v1.37.yaml b/docs/api/v1.37.yaml index 47331f5608293..8d922ff3caa4b 100644 --- a/docs/api/v1.37.yaml +++ b/docs/api/v1.37.yaml @@ -821,7 +821,15 @@ definitions: - "hyperv" ContainerConfig: - description: "Configuration for a container that is portable between hosts" + description: | + Configuration for a container that is portable between hosts. + + When used as `ContainerConfig` field in an image, `ContainerConfig` is an + optional field containing the configuration of the container that was last + committed when creating the image. + + Previous versions of Docker builder used this field to store build cache, + and it is not in active use anymore. type: "object" properties: Hostname: diff --git a/docs/api/v1.38.yaml b/docs/api/v1.38.yaml index e8a342939722c..f2d5fe99857af 100644 --- a/docs/api/v1.38.yaml +++ b/docs/api/v1.38.yaml @@ -832,7 +832,15 @@ definitions: type: "string" ContainerConfig: - description: "Configuration for a container that is portable between hosts" + description: | + Configuration for a container that is portable between hosts. + + When used as `ContainerConfig` field in an image, `ContainerConfig` is an + optional field containing the configuration of the container that was last + committed when creating the image. + + Previous versions of Docker builder used this field to store build cache, + and it is not in active use anymore. type: "object" properties: Hostname: diff --git a/docs/api/v1.39.yaml b/docs/api/v1.39.yaml index 9fa91139af3c7..a988ba1be38d3 100644 --- a/docs/api/v1.39.yaml +++ b/docs/api/v1.39.yaml @@ -1067,6 +1067,13 @@ definitions: ContainerConfig: description: | Configuration for a container that is portable between hosts. + + When used as `ContainerConfig` field in an image, `ContainerConfig` is an + optional field containing the configuration of the container that was last + committed when creating the image. + + Previous versions of Docker builder used this field to store build cache, + and it is not in active use anymore. type: "object" properties: Hostname: diff --git a/docs/api/v1.40.yaml b/docs/api/v1.40.yaml index 5fd9a3f8a158b..b994f6cd2c28e 100644 --- a/docs/api/v1.40.yaml +++ b/docs/api/v1.40.yaml @@ -1128,6 +1128,13 @@ definitions: ContainerConfig: description: | Configuration for a container that is portable between hosts. + + When used as `ContainerConfig` field in an image, `ContainerConfig` is an + optional field containing the configuration of the container that was last + committed when creating the image. + + Previous versions of Docker builder used this field to store build cache, + and it is not in active use anymore. type: "object" properties: Hostname: diff --git a/docs/api/v1.41.yaml b/docs/api/v1.41.yaml index 13a4a707c6672..27e5f50404441 100644 --- a/docs/api/v1.41.yaml +++ b/docs/api/v1.41.yaml @@ -1160,6 +1160,13 @@ definitions: ContainerConfig: description: | Configuration for a container that is portable between hosts. + + When used as `ContainerConfig` field in an image, `ContainerConfig` is an + optional field containing the configuration of the container that was last + committed when creating the image. + + Previous versions of Docker builder used this field to store build cache, + and it is not in active use anymore. type: "object" properties: Hostname: From 3e9e79d134acb9caf094cd16ce6690cf218fd9de Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Tue, 19 Apr 2022 16:03:37 +0200 Subject: [PATCH 2/3] docs: api: document ImageSummary fields (api v1.39-v1.41) Signed-off-by: Sebastiaan van Stijn (cherry picked from commit b9de761c261a537a14564148a82d6d60db22307f) Signed-off-by: Sebastiaan van Stijn --- docs/api/v1.39.yaml | 109 ++++++++++++++++++++++++++++++++------------ docs/api/v1.40.yaml | 109 ++++++++++++++++++++++++++++++++------------ docs/api/v1.41.yaml | 109 ++++++++++++++++++++++++++++++++------------ 3 files changed, 237 insertions(+), 90 deletions(-) diff --git a/docs/api/v1.39.yaml b/docs/api/v1.39.yaml index a988ba1be38d3..0acde862fcccc 100644 --- a/docs/api/v1.39.yaml +++ b/docs/api/v1.39.yaml @@ -1520,7 +1520,7 @@ definitions: description: | ID is the content-addressable ID of an image. - This identified is a content-addressable digest calculated from the + This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). @@ -1708,41 +1708,119 @@ definitions: - Containers properties: Id: + description: | + ID is the content-addressable ID of an image. + + This identifier is a content-addressable digest calculated from the + image's configuration (which includes the digests of layers used by + the image). + + Note that this digest differs from the `RepoDigests` below, which + holds digests of image manifests that reference the image. type: "string" x-nullable: false + example: "sha256:ec3f0931a6e6b6855d76b2d7b0be30e81860baccd891b2e243280bf1cd8ad710" ParentId: + description: | + ID of the parent image. + + Depending on how the image was created, this field may be empty and + is only set for images that were built/created locally. This field + is empty if the image was pulled from an image registry. type: "string" x-nullable: false + example: "" RepoTags: + description: | + List of image names/tags in the local image cache that reference this + image. + + Multiple image tags can refer to the same imagem and this list may be + empty if no tags reference the image, in which case the image is + "untagged", in which case it can still be referenced by its ID. type: "array" x-nullable: false items: type: "string" + example: + - "example:1.0" + - "example:latest" + - "example:stable" + - "internal.registry.example.com:5000/example:1.0" RepoDigests: + description: | + List of content-addressable digests of locally available image manifests + that the image is referenced from. Multiple manifests can refer to the + same image. + + These digests are usually only available if the image was either pulled + from a registry, or if the image was pushed to a registry, which is when + the manifest is generated and its digest calculated. type: "array" x-nullable: false items: type: "string" + example: + - "example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb" + - "internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578" Created: + description: | + Date and time at which the image was created as a Unix timestamp + (number of seconds sinds EPOCH). type: "integer" x-nullable: false + example: "1644009612" Size: + description: | + Total size of the image including all layers it is composed of. type: "integer" + format: "int64" x-nullable: false + example: 172064416 SharedSize: + description: | + Total size of image layers that are shared between this image and other + images. + + This size is not calculated by default. `-1` indicates that the value + has not been set / calculated. type: "integer" x-nullable: false + example: 1239828 VirtualSize: + description: | + Total size of the image including all layers it is composed of. + + In versions of Docker before v1.10, this field was calculated from + the image itself and all of its parent images. Docker v1.10 and up + store images self-contained, and no longer use a parent-chain, making + this field an equivalent of the Size field. + + This field is kept for backward compatibility, but may be removed in + a future version of the API. type: "integer" + format: "int64" x-nullable: false + example: 172064416 Labels: + description: "User-defined key/value metadata." type: "object" x-nullable: false additionalProperties: type: "string" + example: + com.example.some-label: "some-value" + com.example.some-other-label: "some-other-value" Containers: + description: | + Number of containers using this image. Includes both stopped and running + containers. + + This size is not calculated by default, and depends on which API endpoint + is used. `-1` indicates that the value has not been set / calculated. x-nullable: false type: "integer" + example: 2 AuthConfig: type: "object" @@ -7096,35 +7174,6 @@ paths: type: "array" items: $ref: "#/definitions/ImageSummary" - examples: - application/json: - - Id: "sha256:e216a057b1cb1efc11f8a268f37ef62083e70b1b38323ba252e25ac88904a7e8" - ParentId: "" - RepoTags: - - "ubuntu:12.04" - - "ubuntu:precise" - RepoDigests: - - "ubuntu@sha256:992069aee4016783df6345315302fa59681aae51a8eeb2f889dea59290f21787" - Created: 1474925151 - Size: 103579269 - VirtualSize: 103579269 - SharedSize: 0 - Labels: {} - Containers: 2 - - Id: "sha256:3e314f95dcace0f5e4fd37b10862fe8398e3c60ed36600bc0ca5fda78b087175" - ParentId: "" - RepoTags: - - "ubuntu:12.10" - - "ubuntu:quantal" - RepoDigests: - - "ubuntu@sha256:002fba3e3255af10be97ea26e476692a7ebed0bb074a9ab960b2e7a1526b15d7" - - "ubuntu@sha256:68ea0200f0b90df725d99d823905b04cf844f6039ef60c60bf3e019915017bd3" - Created: 1403128455 - Size: 172064416 - VirtualSize: 172064416 - SharedSize: 0 - Labels: {} - Containers: 5 500: description: "server error" schema: diff --git a/docs/api/v1.40.yaml b/docs/api/v1.40.yaml index b994f6cd2c28e..557a2e17d07b1 100644 --- a/docs/api/v1.40.yaml +++ b/docs/api/v1.40.yaml @@ -1581,7 +1581,7 @@ definitions: description: | ID is the content-addressable ID of an image. - This identified is a content-addressable digest calculated from the + This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). @@ -1769,41 +1769,119 @@ definitions: - Containers properties: Id: + description: | + ID is the content-addressable ID of an image. + + This identifier is a content-addressable digest calculated from the + image's configuration (which includes the digests of layers used by + the image). + + Note that this digest differs from the `RepoDigests` below, which + holds digests of image manifests that reference the image. type: "string" x-nullable: false + example: "sha256:ec3f0931a6e6b6855d76b2d7b0be30e81860baccd891b2e243280bf1cd8ad710" ParentId: + description: | + ID of the parent image. + + Depending on how the image was created, this field may be empty and + is only set for images that were built/created locally. This field + is empty if the image was pulled from an image registry. type: "string" x-nullable: false + example: "" RepoTags: + description: | + List of image names/tags in the local image cache that reference this + image. + + Multiple image tags can refer to the same imagem and this list may be + empty if no tags reference the image, in which case the image is + "untagged", in which case it can still be referenced by its ID. type: "array" x-nullable: false items: type: "string" + example: + - "example:1.0" + - "example:latest" + - "example:stable" + - "internal.registry.example.com:5000/example:1.0" RepoDigests: + description: | + List of content-addressable digests of locally available image manifests + that the image is referenced from. Multiple manifests can refer to the + same image. + + These digests are usually only available if the image was either pulled + from a registry, or if the image was pushed to a registry, which is when + the manifest is generated and its digest calculated. type: "array" x-nullable: false items: type: "string" + example: + - "example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb" + - "internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578" Created: + description: | + Date and time at which the image was created as a Unix timestamp + (number of seconds sinds EPOCH). type: "integer" x-nullable: false + example: "1644009612" Size: + description: | + Total size of the image including all layers it is composed of. type: "integer" + format: "int64" x-nullable: false + example: 172064416 SharedSize: + description: | + Total size of image layers that are shared between this image and other + images. + + This size is not calculated by default. `-1` indicates that the value + has not been set / calculated. type: "integer" x-nullable: false + example: 1239828 VirtualSize: + description: | + Total size of the image including all layers it is composed of. + + In versions of Docker before v1.10, this field was calculated from + the image itself and all of its parent images. Docker v1.10 and up + store images self-contained, and no longer use a parent-chain, making + this field an equivalent of the Size field. + + This field is kept for backward compatibility, but may be removed in + a future version of the API. type: "integer" + format: "int64" x-nullable: false + example: 172064416 Labels: + description: "User-defined key/value metadata." type: "object" x-nullable: false additionalProperties: type: "string" + example: + com.example.some-label: "some-value" + com.example.some-other-label: "some-other-value" Containers: + description: | + Number of containers using this image. Includes both stopped and running + containers. + + This size is not calculated by default, and depends on which API endpoint + is used. `-1` indicates that the value has not been set / calculated. x-nullable: false type: "integer" + example: 2 AuthConfig: type: "object" @@ -7402,35 +7480,6 @@ paths: type: "array" items: $ref: "#/definitions/ImageSummary" - examples: - application/json: - - Id: "sha256:e216a057b1cb1efc11f8a268f37ef62083e70b1b38323ba252e25ac88904a7e8" - ParentId: "" - RepoTags: - - "ubuntu:12.04" - - "ubuntu:precise" - RepoDigests: - - "ubuntu@sha256:992069aee4016783df6345315302fa59681aae51a8eeb2f889dea59290f21787" - Created: 1474925151 - Size: 103579269 - VirtualSize: 103579269 - SharedSize: 0 - Labels: {} - Containers: 2 - - Id: "sha256:3e314f95dcace0f5e4fd37b10862fe8398e3c60ed36600bc0ca5fda78b087175" - ParentId: "" - RepoTags: - - "ubuntu:12.10" - - "ubuntu:quantal" - RepoDigests: - - "ubuntu@sha256:002fba3e3255af10be97ea26e476692a7ebed0bb074a9ab960b2e7a1526b15d7" - - "ubuntu@sha256:68ea0200f0b90df725d99d823905b04cf844f6039ef60c60bf3e019915017bd3" - Created: 1403128455 - Size: 172064416 - VirtualSize: 172064416 - SharedSize: 0 - Labels: {} - Containers: 5 500: description: "server error" schema: diff --git a/docs/api/v1.41.yaml b/docs/api/v1.41.yaml index 27e5f50404441..c67482acb41ea 100644 --- a/docs/api/v1.41.yaml +++ b/docs/api/v1.41.yaml @@ -1613,7 +1613,7 @@ definitions: description: | ID is the content-addressable ID of an image. - This identified is a content-addressable digest calculated from the + This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). @@ -1801,41 +1801,119 @@ definitions: - Containers properties: Id: + description: | + ID is the content-addressable ID of an image. + + This identifier is a content-addressable digest calculated from the + image's configuration (which includes the digests of layers used by + the image). + + Note that this digest differs from the `RepoDigests` below, which + holds digests of image manifests that reference the image. type: "string" x-nullable: false + example: "sha256:ec3f0931a6e6b6855d76b2d7b0be30e81860baccd891b2e243280bf1cd8ad710" ParentId: + description: | + ID of the parent image. + + Depending on how the image was created, this field may be empty and + is only set for images that were built/created locally. This field + is empty if the image was pulled from an image registry. type: "string" x-nullable: false + example: "" RepoTags: + description: | + List of image names/tags in the local image cache that reference this + image. + + Multiple image tags can refer to the same imagem and this list may be + empty if no tags reference the image, in which case the image is + "untagged", in which case it can still be referenced by its ID. type: "array" x-nullable: false items: type: "string" + example: + - "example:1.0" + - "example:latest" + - "example:stable" + - "internal.registry.example.com:5000/example:1.0" RepoDigests: + description: | + List of content-addressable digests of locally available image manifests + that the image is referenced from. Multiple manifests can refer to the + same image. + + These digests are usually only available if the image was either pulled + from a registry, or if the image was pushed to a registry, which is when + the manifest is generated and its digest calculated. type: "array" x-nullable: false items: type: "string" + example: + - "example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb" + - "internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578" Created: + description: | + Date and time at which the image was created as a Unix timestamp + (number of seconds sinds EPOCH). type: "integer" x-nullable: false + example: "1644009612" Size: + description: | + Total size of the image including all layers it is composed of. type: "integer" + format: "int64" x-nullable: false + example: 172064416 SharedSize: + description: | + Total size of image layers that are shared between this image and other + images. + + This size is not calculated by default. `-1` indicates that the value + has not been set / calculated. type: "integer" x-nullable: false + example: 1239828 VirtualSize: + description: | + Total size of the image including all layers it is composed of. + + In versions of Docker before v1.10, this field was calculated from + the image itself and all of its parent images. Docker v1.10 and up + store images self-contained, and no longer use a parent-chain, making + this field an equivalent of the Size field. + + This field is kept for backward compatibility, but may be removed in + a future version of the API. type: "integer" + format: "int64" x-nullable: false + example: 172064416 Labels: + description: "User-defined key/value metadata." type: "object" x-nullable: false additionalProperties: type: "string" + example: + com.example.some-label: "some-value" + com.example.some-other-label: "some-other-value" Containers: + description: | + Number of containers using this image. Includes both stopped and running + containers. + + This size is not calculated by default, and depends on which API endpoint + is used. `-1` indicates that the value has not been set / calculated. x-nullable: false type: "integer" + example: 2 AuthConfig: type: "object" @@ -7605,35 +7683,6 @@ paths: type: "array" items: $ref: "#/definitions/ImageSummary" - examples: - application/json: - - Id: "sha256:e216a057b1cb1efc11f8a268f37ef62083e70b1b38323ba252e25ac88904a7e8" - ParentId: "" - RepoTags: - - "ubuntu:12.04" - - "ubuntu:precise" - RepoDigests: - - "ubuntu@sha256:992069aee4016783df6345315302fa59681aae51a8eeb2f889dea59290f21787" - Created: 1474925151 - Size: 103579269 - VirtualSize: 103579269 - SharedSize: 0 - Labels: {} - Containers: 2 - - Id: "sha256:3e314f95dcace0f5e4fd37b10862fe8398e3c60ed36600bc0ca5fda78b087175" - ParentId: "" - RepoTags: - - "ubuntu:12.10" - - "ubuntu:quantal" - RepoDigests: - - "ubuntu@sha256:002fba3e3255af10be97ea26e476692a7ebed0bb074a9ab960b2e7a1526b15d7" - - "ubuntu@sha256:68ea0200f0b90df725d99d823905b04cf844f6039ef60c60bf3e019915017bd3" - Created: 1403128455 - Size: 172064416 - VirtualSize: 172064416 - SharedSize: 0 - Labels: {} - Containers: 5 500: description: "server error" schema: From 23c7d84b8444ce5adafd128e93ab220db726fc6c Mon Sep 17 00:00:00 2001 From: Niel Drummond Date: Mon, 30 May 2022 16:36:49 +0100 Subject: [PATCH 3/3] docs: api: adjust ContainerWaitResponse error as optional Signed-off-by: Niel Drummond (cherry picked from commit 2359da802beab2bd809ee3646839b22080b8d454) Signed-off-by: Sebastiaan van Stijn --- docs/api/v1.39.yaml | 2 +- docs/api/v1.40.yaml | 2 +- docs/api/v1.41.yaml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/v1.39.yaml b/docs/api/v1.39.yaml index 0acde862fcccc..c457247aab738 100644 --- a/docs/api/v1.39.yaml +++ b/docs/api/v1.39.yaml @@ -4347,7 +4347,7 @@ definitions: type: "object" x-go-name: "ContainerWaitOKBody" title: "ContainerWaitResponse" - required: [StatusCode, Error] + required: [StatusCode] properties: StatusCode: description: "Exit code of the container" diff --git a/docs/api/v1.40.yaml b/docs/api/v1.40.yaml index 557a2e17d07b1..d68202f32d1b1 100644 --- a/docs/api/v1.40.yaml +++ b/docs/api/v1.40.yaml @@ -4472,7 +4472,7 @@ definitions: type: "object" x-go-name: "ContainerWaitOKBody" title: "ContainerWaitResponse" - required: [StatusCode, Error] + required: [StatusCode] properties: StatusCode: description: "Exit code of the container" diff --git a/docs/api/v1.41.yaml b/docs/api/v1.41.yaml index c67482acb41ea..c831a33f6f967 100644 --- a/docs/api/v1.41.yaml +++ b/docs/api/v1.41.yaml @@ -4638,7 +4638,7 @@ definitions: type: "object" x-go-name: "ContainerWaitOKBody" title: "ContainerWaitResponse" - required: [StatusCode, Error] + required: [StatusCode] properties: StatusCode: description: "Exit code of the container"