v 1.37

docker-swagger.yaml

@@ -19,10 +19,10 @@ produces:
 consumes:
   - "application/json"
   - "text/plain"
-basePath: "/v1.36"
+basePath: "/v1.37"
 info:
   title: "Docker Engine API"
-  version: "1.36"
+  version: "1.37"
   x-logo:
     url: "https://docs.docker.com/images/logo-docker-main.png"
   description: |
@@ -49,7 +49,7 @@ info:
     the URL is not supported by the daemon, a HTTP `400 Bad Request` error message
     is returned.
 
-    If you omit the version-prefix, the current version of the API (v1.36) is used.
+    If you omit the version-prefix, the current version of the API (v1.37) is used.
     For example, calling `/info` is the same as calling `/v1.36/info`. Using the
     API without a version-prefix is deprecated and will be removed in a future release.
 
@@ -167,7 +167,7 @@ definitions:
       Type:
         type: "string"
         x-nullable: false
-        enum: ["tcp", "udp"]
+        enum: ["tcp", "udp", "sctp"]
     example:
       PrivatePort: 8080
       PublicPort: 80
@@ -443,6 +443,10 @@ definitions:
       OomKillDisable:
         description: "Disable OOM Killer for the container."
         type: "boolean"
+      Init:
+        description: "Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used."
+        type: "boolean"
+        x-nullable: true
       PidsLimit:
         description: "Tune a container's pids limit. Set -1 for unlimited."
         type: "integer"
@@ -797,7 +801,7 @@ definitions:
         description: |
           An object mapping ports to an empty object in the form:
 
-          `{"<port>/<tcp|udp>": {}}`
+          `{"<port>/<tcp|udp|sctp>": {}}`
         type: "object"
         additionalProperties:
           type: "object"
@@ -1062,8 +1066,8 @@ definitions:
       container's port-number and protocol as key in the format `<port>/<protocol>`,
       for example, `80/udp`.
 
-      If a container's port is mapped for both `tcp` and `udp`, two separate
-      entries are added to the mapping table.
+      If a container's port is mapped for multiple protocols, separate entries
+      are added to the mapping table.
     type: "object"
     additionalProperties:
       type: "array"
@@ -2800,6 +2804,8 @@ definitions:
       - "shutdown"
       - "failed"
       - "rejected"
+      - "remove"
+      - "orphaned"
 
   Task:
     type: "object"
@@ -3040,6 +3046,7 @@ definitions:
         enum:
           - "tcp"
           - "udp"
+          - "sctp"
       TargetPort:
         description: "The port inside the container."
         type: "integer"
@@ -3331,6 +3338,13 @@ definitions:
       Driver:
         description: "Name of the secrets driver used to fetch the secret's value from an external secret store"
         $ref: "#/definitions/Driver"
+      Templating:
+        description: |
+          Templating driver, if applicable
+
+          Templating controls whether and how to evaluate the config payload as
+          a template. If no driver is set, no templating is used.
+        $ref: "#/definitions/Driver"
 
   Secret:
     type: "object"
@@ -3367,6 +3381,13 @@ definitions:
           Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-3.2))
           config data.
         type: "string"
+      Templating:
+        description: |
+          Templating driver, if applicable
+
+          Templating controls whether and how to evaluate the config payload as
+          a template. If no driver is set, no templating is used.
+        $ref: "#/definitions/Driver"
 
   Config:
     type: "object"
@@ -4640,7 +4661,7 @@ paths:
               AppArmorProfile:
                 type: "string"
               ExecIDs:
-                type: "string"
+                type: "array"
               HostConfig:
                 $ref: "#/definitions/HostConfig"
               GraphDriver:
@@ -5349,6 +5370,13 @@ paths:
           examples:
             application/json:
               message: "No such container: c2ada9df5af8"
+        409:
+          description: "container is not running"
+          schema:
+            $ref: "#/definitions/ErrorResponse"
+          examples:
+            application/json:
+              message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running"
         500:
           description: "server error"
           schema:
@@ -6159,7 +6187,18 @@ paths:
           type: "integer"
         - name: "buildargs"
           in: "query"
-          description: "JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the buildargs as the environment context for commands run via the `Dockerfile` RUN instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for passing secret values. [Read more about the buildargs instruction.](https://docs.docker.com/engine/reference/builder/#arg)"
+          description: >
+            JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker
+            uses the buildargs as the environment context for commands run via the `Dockerfile` RUN
+            instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for
+            passing secret values.
+
+
+            For example, the build arg `FOO=bar` would become `{"FOO":"bar"}` in JSON. This would result in the
+            the query parameter `buildargs={"FOO":"bar"}`. Note that `{"FOO":"bar"}` should be URI component encoded.
+
+
+            [Read more about the buildargs instruction.](https://docs.docker.com/engine/reference/builder/#arg)
           type: "string"
         - name: "shmsize"
           in: "query"

src/Client.php

@@ -293,6 +293,7 @@ public function containerRestart(string $id, array $queryParameters = [], string
      * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
      *
      * @throws \Docker\API\Exception\ContainerKillNotFoundException
+     * @throws \Docker\API\Exception\ContainerKillConflictException
      * @throws \Docker\API\Exception\ContainerKillInternalServerErrorException
      *
      * @return null|\Psr\Http\Message\ResponseInterface
@@ -683,7 +684,8 @@ public function imageList(array $queryParameters = [], string $fetch = self::FET
      *     @var string $cpusetcpus CPUs in which to allow execution (e.g., `0-3`, `0,1`).
      *     @var int $cpuperiod the length of a CPU period in microseconds
      *     @var int $cpuquota microseconds of CPU time that the container can get in a CPU period
-     *     @var string $buildargs JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the buildargs as the environment context for commands run via the `Dockerfile` RUN instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for passing secret values. [Read more about the buildargs instruction.](https://docs.docker.com/engine/reference/builder/#arg)
+     *     @var string $buildargs JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the buildargs as the environment context for commands run via the `Dockerfile` RUN instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for passing secret values.
+
      *     @var int $shmsize Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the system uses 64MB.
      *     @var bool $squash Squash the resulting images layers into a single layer. *(Experimental release only.)*
      *     @var string $labels arbitrary key/value labels to set on the image, as a JSON map of string pairs
@@ -2200,7 +2202,7 @@ public static function create($httpClient = null)
         if (null === $httpClient) {
             $httpClient = \Http\Discovery\HttpClientDiscovery::find();
             $plugins = [];
-            $uri = \Http\Discovery\UriFactoryDiscovery::find()->createUri('v1.36');
+            $uri = \Http\Discovery\UriFactoryDiscovery::find()->createUri('v1.37');
             $plugins[] = new \Http\Client\Common\Plugin\AddPathPlugin($uri);
             $httpClient = new \Http\Client\Common\PluginClient($httpClient, $plugins);
         }

src/ClientAsync.php

@@ -293,6 +293,7 @@ public function containerRestart(string $id, array $queryParameters = [], string
      * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
      *
      * @throws \Docker\API\Exception\ContainerKillNotFoundException
+     * @throws \Docker\API\Exception\ContainerKillConflictException
      * @throws \Docker\API\Exception\ContainerKillInternalServerErrorException
      *
      * @return \Amp\Promise<null|\Amp\Artax\Response>
@@ -683,7 +684,8 @@ public function imageList(array $queryParameters = [], string $fetch = self::FET
      *     @var string $cpusetcpus CPUs in which to allow execution (e.g., `0-3`, `0,1`).
      *     @var int $cpuperiod the length of a CPU period in microseconds
      *     @var int $cpuquota microseconds of CPU time that the container can get in a CPU period
-     *     @var string $buildargs JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the buildargs as the environment context for commands run via the `Dockerfile` RUN instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for passing secret values. [Read more about the buildargs instruction.](https://docs.docker.com/engine/reference/builder/#arg)
+     *     @var string $buildargs JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the buildargs as the environment context for commands run via the `Dockerfile` RUN instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for passing secret values.
+
      *     @var int $shmsize Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the system uses 64MB.
      *     @var bool $squash Squash the resulting images layers into a single layer. *(Experimental release only.)*
      *     @var string $labels arbitrary key/value labels to set on the image, as a JSON map of string pairs

src/Endpoint/ContainerKill.php

@@ -66,6 +66,7 @@ protected function getQueryOptionsResolver(): \Symfony\Component\OptionsResolver
      * {@inheritdoc}
      *
      * @throws \Docker\API\Exception\ContainerKillNotFoundException
+     * @throws \Docker\API\Exception\ContainerKillConflictException
      * @throws \Docker\API\Exception\ContainerKillInternalServerErrorException
      */
     protected function transformResponseBody(string $body, int $status, \Symfony\Component\Serializer\SerializerInterface $serializer)
@@ -76,6 +77,9 @@ protected function transformResponseBody(string $body, int $status, \Symfony\Com
         if (404 === $status) {
             throw new \Docker\API\Exception\ContainerKillNotFoundException($serializer->deserialize($body, 'Docker\\API\\Model\\ErrorResponse', 'json'));
         }
+        if (409 === $status) {
+            throw new \Docker\API\Exception\ContainerKillConflictException($serializer->deserialize($body, 'Docker\\API\\Model\\ErrorResponse', 'json'));
+        }
         if (500 === $status) {
             throw new \Docker\API\Exception\ContainerKillInternalServerErrorException($serializer->deserialize($body, 'Docker\\API\\Model\\ErrorResponse', 'json'));
         }

src/Endpoint/ImageBuild.php

@@ -41,7 +41,8 @@ class ImageBuild extends \Jane\OpenApiRuntime\Client\BaseEndpoint implements \Ja
      *     @var string $cpusetcpus CPUs in which to allow execution (e.g., `0-3`, `0,1`).
      *     @var int $cpuperiod the length of a CPU period in microseconds
      *     @var int $cpuquota microseconds of CPU time that the container can get in a CPU period
-     *     @var string $buildargs JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the buildargs as the environment context for commands run via the `Dockerfile` RUN instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for passing secret values. [Read more about the buildargs instruction.](https://docs.docker.com/engine/reference/builder/#arg)
+     *     @var string $buildargs JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the buildargs as the environment context for commands run via the `Dockerfile` RUN instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for passing secret values.
+
      *     @var int $shmsize Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the system uses 64MB.
      *     @var bool $squash Squash the resulting images layers into a single layer. *(Experimental release only.)*
      *     @var string $labels arbitrary key/value labels to set on the image, as a JSON map of string pairs

src/Exception/ContainerKillConflictException.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file has been auto generated by Jane,
+ *
+ * Do no edit it directly.
+ */
+
+namespace Docker\API\Exception;
+
+class ContainerKillConflictException extends \RuntimeException implements ClientException
+{
+    private $errorResponse;
+
+    public function __construct(\Docker\API\Model\ErrorResponse $errorResponse)
+    {
+        parent::__construct('container is not running', 409);
+        $this->errorResponse = $errorResponse;
+    }
+
+    public function getErrorResponse()
+    {
+        return $this->errorResponse;
+    }
+}

src/Model/ConfigSpec.php

@@ -32,6 +32,12 @@ class ConfigSpec
      * @var string
      */
     protected $data;
+    /**
+     * Driver represents a driver (network, logging, secrets).
+     *
+     * @var Driver
+     */
+    protected $templating;
 
     /**
      * User-defined name of the config.
@@ -108,4 +114,28 @@ public function setData(?string $data): self
 
         return $this;
     }
+
+    /**
+     * Driver represents a driver (network, logging, secrets).
+     *
+     * @return Driver
+     */
+    public function getTemplating(): ?Driver
+    {
+        return $this->templating;
+    }
+
+    /**
+     * Driver represents a driver (network, logging, secrets).
+     *
+     * @param Driver $templating
+     *
+     * @return self
+     */
+    public function setTemplating(?Driver $templating): self
+    {
+        $this->templating = $templating;
+
+        return $this;
+    }
 }

src/Model/ConfigsCreatePostBody.php

@@ -32,6 +32,12 @@ class ConfigsCreatePostBody
      * @var string
      */
     protected $data;
+    /**
+     * Driver represents a driver (network, logging, secrets).
+     *
+     * @var Driver
+     */
+    protected $templating;
 
     /**
      * User-defined name of the config.
@@ -108,4 +114,28 @@ public function setData(?string $data): self
 
         return $this;
     }
+
+    /**
+     * Driver represents a driver (network, logging, secrets).
+     *
+     * @return Driver
+     */
+    public function getTemplating(): ?Driver
+    {
+        return $this->templating;
+    }
+
+    /**
+     * Driver represents a driver (network, logging, secrets).
+     *
+     * @param Driver $templating
+     *
+     * @return self
+     */
+    public function setTemplating(?Driver $templating): self
+    {
+        $this->templating = $templating;
+
+        return $this;
+    }
 }

src/Model/ContainerConfig.php

@@ -51,7 +51,7 @@ class ContainerConfig
     /**
      * An object mapping ports to an empty object in the form:.
 
-    `{"<port>/<tcp|udp>": {}}`
+    `{"<port>/<tcp|udp|sctp>": {}}`
 
      *
      * @var mixed[]
@@ -316,7 +316,7 @@ public function setAttachStderr(?bool $attachStderr): self
     /**
      * An object mapping ports to an empty object in the form:.
 
-    `{"<port>/<tcp|udp>": {}}`
+    `{"<port>/<tcp|udp|sctp>": {}}`
 
      *
      * @return mixed[]
@@ -329,7 +329,7 @@ public function getExposedPorts(): ?\ArrayObject
     /**
      * An object mapping ports to an empty object in the form:.
 
-    `{"<port>/<tcp|udp>": {}}`
+    `{"<port>/<tcp|udp|sctp>": {}}`
 
      *
      * @param mixed[] $exposedPorts

src/Model/ContainersCreatePostBody.php

@@ -51,7 +51,7 @@ class ContainersCreatePostBody
     /**
      * An object mapping ports to an empty object in the form:.
 
-    `{"<port>/<tcp|udp>": {}}`
+    `{"<port>/<tcp|udp|sctp>": {}}`
 
      *
      * @var mixed[]
@@ -328,7 +328,7 @@ public function setAttachStderr(?bool $attachStderr): self
     /**
      * An object mapping ports to an empty object in the form:.
 
-    `{"<port>/<tcp|udp>": {}}`
+    `{"<port>/<tcp|udp|sctp>": {}}`
 
      *
      * @return mixed[]
@@ -341,7 +341,7 @@ public function getExposedPorts(): ?\ArrayObject
     /**
      * An object mapping ports to an empty object in the form:.
 
-    `{"<port>/<tcp|udp>": {}}`
+    `{"<port>/<tcp|udp|sctp>": {}}`
 
      *
      * @param mixed[] $exposedPorts