Pull upstream changes for the OpenAPI spec

api-model-v1-41/docker-engine-api-v1.41.yaml

@@ -577,17 +577,6 @@ definitions:
         type: "array"
         items:
           $ref: "#/definitions/DeviceRequest"
-      KernelMemory:
-        description: |
-          Kernel memory limit in bytes.
-
-          <p><br /></p>
-
-          > **Deprecated**: This field is deprecated as the kernel 5.4 deprecated
-          > `kmem.limit_in_bytes`.
-        type: "integer"
-        format: "int64"
-        example: 209715200
       KernelMemoryTCP:
         description: |
           Hard limit for kernel TCP buffer memory (in bytes). Depending on the
@@ -1116,6 +1105,7 @@ definitions:
               remapping option is enabled.
           ShmSize:
             type: "integer"
+            format: "int64"
             description: |
               Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.
             minimum: 0
@@ -1720,6 +1710,12 @@ definitions:
         type: "string"
         x-nullable: false
         example: "arm"
+      Variant:
+        description: |
+          CPU architecture variant (presently ARM-only).
+        type: "string"
+        x-nullable: true
+        example: "v7"
       Os:
         description: |
           Operating System the image is built to run on.
@@ -1835,7 +1831,7 @@ definitions:
           List of image names/tags in the local image cache that reference this
           image.
 
-          Multiple image tags can refer to the same image and this list may be
+          Multiple image tags can refer to the same image, 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"
@@ -2042,6 +2038,7 @@ definitions:
             x-nullable: false
           RefCount:
             type: "integer"
+            format: "int64"
             default: -1
             description: |
               The number of containers referencing this volume. This field
@@ -2086,6 +2083,25 @@ definitions:
           com.example.some-label: "some-value"
           com.example.some-other-label: "some-other-value"
 
+  VolumeListResponse:
+    type: "object"
+    title: "VolumeListResponse"
+    x-go-name: "VolumeListOKBody"
+    description: "Volume list response"
+    properties:
+      Volumes:
+        type: "array"
+        description: "List of volumes"
+        items:
+          $ref: "#/definitions/Volume"
+      Warnings:
+        type: "array"
+        description: |
+          Warnings that occurred when fetching the list of volumes.
+        items:
+          type: "string"
+        example: []
+
   Network:
     type: "object"
     properties:
@@ -3693,7 +3709,7 @@ definitions:
           Limits:
             description: "Define resources limits."
             $ref: "#/definitions/Limit"
-          Reservation:
+          Reservations:
             description: "Define resources reservation."
             $ref: "#/definitions/ResourceObject"
       RestartPolicy:
@@ -4821,14 +4837,13 @@ definitions:
         description: "Indicates if the host has memory swap limit support enabled."
         type: "boolean"
         example: true
-      KernelMemory:
+      KernelMemoryTCP:
         description: |
-          Indicates if the host has kernel memory limit support enabled.
-
-          <p><br /></p>
+          Indicates if the host has kernel memory TCP limit support enabled. This
+          field is omitted if not supported.
 
-          > **Deprecated**: This field is deprecated as the kernel 5.4 deprecated
-          > `kmem.limit_in_bytes`.
+          Kernel memory TCP limits are not supported when using cgroups v2, which
+          does not support the corresponding `memory.kmem.tcp.limit_in_bytes` cgroup.
         type: "boolean"
         example: true
       CpuCfsPeriod:
@@ -6281,7 +6296,6 @@ paths:
                       property1: "string"
                       property2: "string"
                 IpcMode: ""
-                LxcConf: []
                 Memory: 0
                 MemorySwap: 0
                 MemoryReservation: 0
@@ -6483,6 +6497,9 @@ paths:
 
         Note: This endpoint works only for containers with the `json-file` or
         `journald` logging driver.
+      produces:
+        - "application/vnd.docker.raw-stream"
+        - "application/vnd.docker.multiplexed-stream"
       operationId: "ContainerLogs"
       responses:
         200:
@@ -7185,7 +7202,8 @@ paths:
         ### Stream format
 
         When the TTY setting is disabled in [`POST /containers/create`](#operation/ContainerCreate),
-        the stream over the hijacked connected is multiplexed to separate out
+        the HTTP Content-Type header is set to application/vnd.docker.multiplexed-stream
+        and the stream over the hijacked connected is multiplexed to separate out
         `stdout` and `stderr`. The stream consists of a series of frames, each
         containing a header and a payload.
 
@@ -7229,6 +7247,7 @@ paths:
       operationId: "ContainerAttach"
       produces:
         - "application/vnd.docker.raw-stream"
+        - "application/vnd.docker.multiplexed-stream"
       responses:
         101:
           description: "no error, hints proxy about hijacking"
@@ -8983,6 +9002,7 @@ paths:
         - "application/json"
       produces:
         - "application/vnd.docker.raw-stream"
+        - "application/vnd.docker.multiplexed-stream"
       responses:
         200:
           description: "No error"
@@ -9137,24 +9157,7 @@ paths:
         200:
           description: "Summary volume data that matches the query"
           schema:
-            type: "object"
-            title: "VolumeListResponse"
-            description: "Volume list response"
-            required: [Volumes, Warnings]
-            properties:
-              Volumes:
-                type: "array"
-                x-nullable: false
-                description: "List of volumes"
-                items:
-                  $ref: "#/definitions/Volume"
-              Warnings:
-                type: "array"
-                x-nullable: true
-                description: |
-                  Warnings that occurred when fetching the list of volumes.
-                items:
-                  type: "string"
+            $ref: "#/definitions/VolumeListResponse"
         500:
           description: "Server error"
           schema:
@@ -10900,6 +10903,9 @@ paths:
 
         **Note**: This endpoint works only for services with the `local`,
         `json-file` or `journald` logging drivers.
+      produces:
+        - "application/vnd.docker.raw-stream"
+        - "application/vnd.docker.multiplexed-stream"
       operationId: "ServiceLogs"
       responses:
         200:
@@ -11155,6 +11161,9 @@ paths:
         **Note**: This endpoint works only for services with the `local`,
         `json-file` or `journald` logging drivers.
       operationId: "TaskLogs"
+      produces:
+        - "application/vnd.docker.raw-stream"
+        - "application/vnd.docker.multiplexed-stream"
       responses:
         200:
           description: "logs returned as a stream in response body"

api-model-v1-41/docs/HostConfig.md

@@ -22,7 +22,6 @@ Name | Type | Description | Notes
 **devices** | [**kotlin.collections.MutableList<DeviceMapping>**](DeviceMapping.md) | A list of devices to add to the container. |  [optional]
 **deviceCgroupRules** | **kotlin.collections.MutableList<kotlin.String>** | a list of cgroup rules to apply to the container |  [optional]
 **deviceRequests** | [**kotlin.collections.MutableList<DeviceRequest>**](DeviceRequest.md) | A list of requests for devices to be sent to device drivers.  |  [optional]
-**kernelMemory** | **kotlin.Long** | Kernel memory limit in bytes.  <p><br /></p>  > **Deprecated**: This field is deprecated as the kernel 5.4 deprecated > `kmem.limit_in_bytes`.  |  [optional]
 **kernelMemoryTCP** | **kotlin.Long** | Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime.  This field is omitted when empty.  |  [optional]
 **memoryReservation** | **kotlin.Long** | Memory soft limit in bytes. |  [optional]
 **memorySwap** | **kotlin.Long** | Total memory limit (memory + swap). Set as `-1` to enable unlimited swap.  |  [optional]
@@ -67,7 +66,7 @@ Name | Type | Description | Notes
 **tmpfs** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options. For example:  ``` { \"/run\": \"rw,noexec,nosuid,size=65536k\" } ```  |  [optional]
 **utSMode** | **kotlin.String** | UTS namespace to use for the container. |  [optional]
 **usernsMode** | **kotlin.String** | Sets the usernamespace mode for the container when usernamespace remapping option is enabled.  |  [optional]
-**shmSize** | **kotlin.Int** | Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.  |  [optional]
+**shmSize** | **kotlin.Long** | Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.  |  [optional]
 **sysctls** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A list of kernel parameters (sysctls) to set in the container. For example:  ``` {\"net.ipv4.ip_forward\": \"1\"} ```  |  [optional]
 **runtime** | **kotlin.String** | Runtime to use with this container. |  [optional]
 **consoleSize** | **kotlin.collections.MutableList<kotlin.Int>** | Initial console size, as an `[height, width]` array. (Windows only)  |  [optional]

api-model-v1-41/docs/HostConfigAllOf.md

@@ -35,7 +35,7 @@ Name | Type | Description | Notes
 **tmpfs** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options. For example:  ``` { \"/run\": \"rw,noexec,nosuid,size=65536k\" } ```  |  [optional]
 **utSMode** | **kotlin.String** | UTS namespace to use for the container. |  [optional]
 **usernsMode** | **kotlin.String** | Sets the usernamespace mode for the container when usernamespace remapping option is enabled.  |  [optional]
-**shmSize** | **kotlin.Int** | Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.  |  [optional]
+**shmSize** | **kotlin.Long** | Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.  |  [optional]
 **sysctls** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A list of kernel parameters (sysctls) to set in the container. For example:  ``` {\"net.ipv4.ip_forward\": \"1\"} ```  |  [optional]
 **runtime** | **kotlin.String** | Runtime to use with this container. |  [optional]
 **consoleSize** | **kotlin.collections.MutableList<kotlin.Int>** | Initial console size, as an `[height, width]` array. (Windows only)  |  [optional]

api-model-v1-41/docs/ImageInspect.md

@@ -16,6 +16,7 @@ Name | Type | Description | Notes
 **author** | **kotlin.String** | Name of the author that was specified when committing the image, or as specified through MAINTAINER (deprecated) in the Dockerfile.  |  [optional]
 **config** | [**ContainerConfig**](ContainerConfig.md) |  |  [optional]
 **architecture** | **kotlin.String** | Hardware CPU architecture that the image runs on.  |  [optional]
+**variant** | **kotlin.String** | CPU architecture variant (presently ARM-only).  |  [optional]
 **os** | **kotlin.String** | Operating System the image is built to run on.  |  [optional]
 **osVersion** | **kotlin.String** | Operating System version the image is built to run on (especially for Windows).  |  [optional]
 **propertySize** | **kotlin.Long** | Total size of the image including all layers it is composed of.  |  [optional]

api-model-v1-41/docs/ImageSummary.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **sharedSize** | **kotlin.Long** | 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.  | 
 **virtualSize** | **kotlin.Long** | 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.  | 
 **containers** | **kotlin.Int** | 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.  | 
-**repoTags** | **kotlin.collections.MutableList<kotlin.String>** | List of image names/tags in the local image cache that reference this image.  Multiple image tags can refer to the same image 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.  |  [optional]
+**repoTags** | **kotlin.collections.MutableList<kotlin.String>** | List of image names/tags in the local image cache that reference this image.  Multiple image tags can refer to the same image, 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.  |  [optional]
 **repoDigests** | **kotlin.collections.MutableList<kotlin.String>** | 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.  |  [optional]
 **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. |  [optional]
 

api-model-v1-41/docs/Resources.md

@@ -22,7 +22,6 @@ Name | Type | Description | Notes
 **devices** | [**kotlin.collections.MutableList<DeviceMapping>**](DeviceMapping.md) | A list of devices to add to the container. |  [optional]
 **deviceCgroupRules** | **kotlin.collections.MutableList<kotlin.String>** | a list of cgroup rules to apply to the container |  [optional]
 **deviceRequests** | [**kotlin.collections.MutableList<DeviceRequest>**](DeviceRequest.md) | A list of requests for devices to be sent to device drivers.  |  [optional]
-**kernelMemory** | **kotlin.Long** | Kernel memory limit in bytes.  <p><br /></p>  > **Deprecated**: This field is deprecated as the kernel 5.4 deprecated > `kmem.limit_in_bytes`.  |  [optional]
 **kernelMemoryTCP** | **kotlin.Long** | Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime.  This field is omitted when empty.  |  [optional]
 **memoryReservation** | **kotlin.Long** | Memory soft limit in bytes. |  [optional]
 **memorySwap** | **kotlin.Long** | Total memory limit (memory + swap). Set as `-1` to enable unlimited swap.  |  [optional]

api-model-v1-41/docs/SystemInfo.md

@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 **plugins** | [**PluginsInfo**](PluginsInfo.md) |  |  [optional]
 **memoryLimit** | **kotlin.Boolean** | Indicates if the host has memory limit support enabled. |  [optional]
 **swapLimit** | **kotlin.Boolean** | Indicates if the host has memory swap limit support enabled. |  [optional]
-**kernelMemory** | **kotlin.Boolean** | Indicates if the host has kernel memory limit support enabled.  <p><br /></p>  > **Deprecated**: This field is deprecated as the kernel 5.4 deprecated > `kmem.limit_in_bytes`.  |  [optional]
+**kernelMemoryTCP** | **kotlin.Boolean** | Indicates if the host has kernel memory TCP limit support enabled. This field is omitted if not supported.  Kernel memory TCP limits are not supported when using cgroups v2, which does not support the corresponding `memory.kmem.tcp.limit_in_bytes` cgroup.  |  [optional]
 **cpuCfsPeriod** | **kotlin.Boolean** | Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host.  |  [optional]
 **cpuCfsQuota** | **kotlin.Boolean** | Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host.  |  [optional]
 **cpUShares** | **kotlin.Boolean** | Indicates if CPU Shares limiting is supported by the host.  |  [optional]

api-model-v1-41/docs/TaskSpecResources.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **limits** | [**Limit**](Limit.md) |  |  [optional]
-**reservation** | [**ResourceObject**](ResourceObject.md) |  |  [optional]
+**reservations** | [**ResourceObject**](ResourceObject.md) |  |  [optional]
 
 
 

api-model-v1-41/docs/VolumeListResponse.md

@@ -4,8 +4,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**volumes** | [**kotlin.collections.MutableList<Volume>**](Volume.md) | List of volumes | 
-**warnings** | **kotlin.collections.MutableList<kotlin.String>** | Warnings that occurred when fetching the list of volumes.  | 
+**volumes** | [**kotlin.collections.MutableList<Volume>**](Volume.md) | List of volumes |  [optional]
+**warnings** | **kotlin.collections.MutableList<kotlin.String>** | Warnings that occurred when fetching the list of volumes.  |  [optional]
 
 
 

api-model-v1-41/docs/VolumeUsageData.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **propertySize** | **kotlin.Long** | Amount of disk space used by the volume (in bytes). This information is only available for volumes created with the `\"local\"` volume driver. For volumes created with other volume drivers, this field is set to `-1` (\"not available\")  | 
-**refCount** | **kotlin.Int** | The number of containers referencing this volume. This field is set to `-1` if the reference-count is not available.  | 
+**refCount** | **kotlin.Long** | The number of containers referencing this volume. This field is set to `-1` if the reference-count is not available.  | 
 
 
 

api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateRequest.kt

@@ -47,8 +47,7 @@ import com.squareup.moshi.JsonClass
  * @param devices A list of devices to add to the container.
  * @param deviceCgroupRules a list of cgroup rules to apply to the container
  * @param deviceRequests A list of requests for devices to be sent to device drivers.
- * @param kernelMemory Kernel memory limit in bytes.  <p><br /></p>  > **Deprecated**: This field is deprecated as the kernel 5.4 deprecated > `kmem.limit_in_bytes`.
- * @param kernelMemoryTCP Hard limit for kernel TCP buffer memory (in bytes).
+ * @param kernelMemoryTCP Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime.  This field is omitted when empty.
  * @param memoryReservation Memory soft limit in bytes.
  * @param memorySwap Total memory limit (memory + swap). Set as `-1` to enable unlimited swap.
  * @param memorySwappiness Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
@@ -137,11 +136,7 @@ data class ContainerUpdateRequest(
   @Json(name = "DeviceRequests")
   var deviceRequests: kotlin.collections.MutableList<DeviceRequest>? = null,
 
-  /* Kernel memory limit in bytes.  <p><br /></p>  > **Deprecated**: This field is deprecated as the kernel 5.4 deprecated > `kmem.limit_in_bytes`.  */
-  @Json(name = "KernelMemory")
-  var kernelMemory: kotlin.Long? = null,
-
-  /* Hard limit for kernel TCP buffer memory (in bytes). */
+  /* Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime.  This field is omitted when empty.  */
   @Json(name = "KernelMemoryTCP")
   var kernelMemoryTCP: kotlin.Long? = null,