@@ -26,13 +26,19 @@ info:

   x-logo:

     url: "https://docs.docker.com/images/logo-docker-main.png"

   description: |

-    The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API.

+    The Engine API is an HTTP API served by Docker Engine. It is the API the

+    Docker client uses to communicate with the Engine, so everything the Docker

+    client can do can be done with the API.

-    Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls.

+    Most of the client's commands map directly to API endpoints (e.g. `docker ps`

+    is `GET /containers/json`). The notable exception is running containers,

+    which consists of several API calls.

     # Errors

-    The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format:

+    The API uses standard HTTP status codes to indicate the success or failure

+    of the API call. The body of the response will be JSON in the following

+    format:

     ```

     {

@@ -65,7 +71,11 @@ info:

     # Authentication

-    Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a Base64 encoded (JSON) string with the following structure:

+    Authentication for registries is handled client side. The client has to send

+    authentication details to various endpoints that need to communicate with

+    registries, such as `POST /images/(name)/push`. These are sent as

+    `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5)

+    (JSON) string with the following structure:

     ```

     {

@@ -76,9 +86,11 @@ info:

     }

     ```

-    The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required.

+    The `serveraddress` is a domain/IP without a protocol. Throughout this

+    structure, double quotes are required.

-    If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials:

+    If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth),

+    you can just pass this instead of credentials:

     ```

     {

@@ -104,7 +116,9 @@ tags:

   - name: "Network"

     x-displayName: "Networks"

     description: |

-      Networks are user-defined networks that containers can be attached to. See the [networking documentation](https://docs.docker.com/engine/userguide/networking/) for more information.

+      Networks are user-defined networks that containers can be attached to.

+      See the [networking documentation](https://docs.docker.com/network/)

+      for more information.

   - name: "Volume"

     x-displayName: "Volumes"

     description: |

@@ -112,34 +126,46 @@ tags:

   - name: "Exec"

     x-displayName: "Exec"

     description: |

-      Run new commands inside running containers. See the [command-line reference](https://docs.docker.com/engine/reference/commandline/exec/) for more information.

+      Run new commands inside running containers. Refer to the

+      [command-line reference](https://docs.docker.com/engine/reference/commandline/exec/)

+      for more information.

+

+      To exec a command in a container, you first need to create an exec instance,

+      then start it. These two API endpoints are wrapped up in a single command-line

+      command, `docker exec`.

-      To exec a command in a container, you first need to create an exec instance, then start it. These two API endpoints are wrapped up in a single command-line command, `docker exec`.

   # Swarm things

   - name: "Swarm"

     x-displayName: "Swarm"

     description: |

-      Engines can be clustered together in a swarm. See [the swarm mode documentation](https://docs.docker.com/engine/swarm/) for more information.

+      Engines can be clustered together in a swarm. Refer to the

+      [swarm mode documentation](https://docs.docker.com/engine/swarm/)

+      for more information.

   - name: "Node"

     x-displayName: "Nodes"

     description: |

-      Nodes are instances of the Engine participating in a swarm. Swarm mode must be enabled for these endpoints to work.

+      Nodes are instances of the Engine participating in a swarm. Swarm mode

+      must be enabled for these endpoints to work.

   - name: "Service"

     x-displayName: "Services"

     description: |

-      Services are the definitions of tasks to run on a swarm. Swarm mode must be enabled for these endpoints to work.

+      Services are the definitions of tasks to run on a swarm. Swarm mode must

+      be enabled for these endpoints to work.

   - name: "Task"

     x-displayName: "Tasks"

     description: |

-      A task is a container running on a swarm. It is the atomic scheduling unit of swarm. Swarm mode must be enabled for these endpoints to work.

+      A task is a container running on a swarm. It is the atomic scheduling unit

+      of swarm. Swarm mode must be enabled for these endpoints to work.

   - name: "Secret"

     x-displayName: "Secrets"

     description: |

-      Secrets are sensitive data that can be used by services. Swarm mode must be enabled for these endpoints to work.

+      Secrets are sensitive data that can be used by services. Swarm mode must

+      be enabled for these endpoints to work.

   - name: "Config"

     x-displayName: "Configs"

     description: |

-      Configs are application configurations that can be used by services. Swarm mode must be enabled for these endpoints to work.

+      Configs are application configurations that can be used by services. Swarm

+      mode must be enabled for these endpoints to work.

   # System things

   - name: "Plugin"

     x-displayName: "Plugins"

@@ -345,9 +371,11 @@ definitions:

   RestartPolicy:

     description: |

-      The behavior to apply when the container exits. The default is not to restart.

+      The behavior to apply when the container exits. The default is not to

+      restart.

-      An ever increasing delay (double the previous delay, starting at 100ms) is added before each restart to prevent flooding the server.

+      An ever increasing delay (double the previous delay, starting at 100ms) is

+      added before each restart to prevent flooding the server.

     type: "object"

     properties:

       Name:

@@ -364,7 +392,8 @@ definitions:

           - "on-failure"

       MaximumRetryCount:

         type: "integer"

-        description: "If `on-failure` is used, the number of times to retry before giving up"

+        description: |

+          If `on-failure` is used, the number of times to retry before giving up.

   Resources:

     description: "A container's resources (cgroups config, ulimits, etc)"

@@ -372,7 +401,9 @@ definitions:

     properties:

       # Applicable to all platforms

       CpuShares:

-        description: "An integer value representing this container's relative CPU weight versus other containers."

+        description: |

+          An integer value representing this container's relative CPU weight

+          versus other containers.

         type: "integer"

       Memory:

         description: "Memory limit in bytes."

@@ -381,7 +412,11 @@ definitions:

         default: 0

       # Applicable to UNIX platforms

       CgroupParent:

-        description: "Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist."

+        description: |

+          Path to `cgroups` under which the container's `cgroup` is created. If

+          the path is not absolute, the path is considered to be relative to the

+          `cgroups` path of the init process. Cgroups are created if they do not

+          already exist.

         type: "string"

       BlkioWeight:

         description: "Block IO weight (relative weight)."

@@ -390,7 +425,11 @@ definitions:

         maximum: 1000

       BlkioWeightDevice:

         description: |

-          Block IO weight (relative device weight) in the form `[{"Path": "device_path", "Weight": weight}]`.

+          Block IO weight (relative device weight) in the form:

+

+          ```

+          [{"Path": "device_path", "Weight": weight}]

+          ```

         type: "array"

         items:

           type: "object"

@@ -402,25 +441,41 @@ definitions:

               minimum: 0

       BlkioDeviceReadBps:

         description: |

-          Limit read rate (bytes per second) from a device, in the form `[{"Path": "device_path", "Rate": rate}]`.

+          Limit read rate (bytes per second) from a device, in the form:

+

+          ```

+          [{"Path": "device_path", "Rate": rate}]

+          ```

         type: "array"

         items:

           $ref: "#/definitions/ThrottleDevice"

       BlkioDeviceWriteBps:

         description: |

-          Limit write rate (bytes per second) to a device, in the form `[{"Path": "device_path", "Rate": rate}]`.

+          Limit write rate (bytes per second) to a device, in the form:

+

+          ```

+          [{"Path": "device_path", "Rate": rate}]

+          ```

         type: "array"

         items:

           $ref: "#/definitions/ThrottleDevice"

       BlkioDeviceReadIOps:

         description: |

-          Limit read rate (IO per second) from a device, in the form `[{"Path": "device_path", "Rate": rate}]`.

+          Limit read rate (IO per second) from a device, in the form:

+

+          ```

+          [{"Path": "device_path", "Rate": rate}]

+          ```

         type: "array"

         items:

           $ref: "#/definitions/ThrottleDevice"

       BlkioDeviceWriteIOps:

         description: |

-          Limit write rate (IO per second) to a device, in the form `[{"Path": "device_path", "Rate": rate}]`.

+          Limit write rate (IO per second) to a device, in the form:

+

+          ```

+          [{"Path": "device_path", "Rate": rate}]

+          ```

         type: "array"

         items:

           $ref: "#/definitions/ThrottleDevice"

@@ -429,23 +484,31 @@ definitions:

         type: "integer"

         format: "int64"

       CpuQuota:

-        description: "Microseconds of CPU time that the container can get in a CPU period."

+        description: |

+          Microseconds of CPU time that the container can get in a CPU period.

         type: "integer"

         format: "int64"

       CpuRealtimePeriod:

-        description: "The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks."

+        description: |

+          The length of a CPU real-time period in microseconds. Set to 0 to

+          allocate no time allocated to real-time tasks.

         type: "integer"

         format: "int64"

       CpuRealtimeRuntime:

-        description: "The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks."

+        description: |

+          The length of a CPU real-time runtime in microseconds. Set to 0 to

+          allocate no time allocated to real-time tasks.

         type: "integer"

         format: "int64"

       CpusetCpus:

-        description: "CPUs in which to allow execution (e.g., `0-3`, `0,1`)"

+        description: |

+          CPUs in which to allow execution (e.g., `0-3`, `0,1`).

         type: "string"

         example: "0-3"

       CpusetMems:

-        description: "Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems."

+        description: |

+          Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only

+          effective on NUMA systems.

         type: "string"

       Devices:

         description: "A list of devices to add to the container."

@@ -459,7 +522,8 @@ definitions:

           type: "string"

           example: "c 13:* rwm"

       DeviceRequests:

-        description: "a list of requests for devices to be sent to device drivers"

+        description: |

+          A list of requests for devices to be sent to device drivers.

         type: "array"

         items:

           $ref: "#/definitions/DeviceRequest"

@@ -477,11 +541,15 @@ definitions:

         type: "integer"

         format: "int64"

       MemorySwap:

-        description: "Total memory limit (memory + swap). Set as `-1` to enable unlimited swap."

+        description: |

+          Total memory limit (memory + swap). Set as `-1` to enable unlimited

+          swap.

         type: "integer"

         format: "int64"

       MemorySwappiness:

-        description: "Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100."

+        description: |

+          Tune a container's memory swappiness behavior. Accepts an integer

+          between 0 and 100.

         type: "integer"

         format: "int64"

         minimum: 0

@@ -494,18 +562,26 @@ definitions:

         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."

+        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 `0` or `-1` for unlimited, or `null` to not change.

+          Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null`

+          to not change.

         type: "integer"

         format: "int64"

         x-nullable: true

       Ulimits:

         description: |

-          A list of resource limits to set in the container. For example: `{"Name": "nofile", "Soft": 1024, "Hard": 2048}`"

+          A list of resource limits to set in the container. For example:

+

+          ```

+          {"Name": "nofile", "Soft": 1024, "Hard": 2048}

+          ```

         type: "array"

         items:

           type: "object"

@@ -524,14 +600,18 @@ definitions:

         description: |

           The number of usable CPUs (Windows only).

-          On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last.

+          On Windows Server containers, the processor resource controls are

+          mutually exclusive. The order of precedence is `CPUCount` first, then

+          `CPUShares`, and `CPUPercent` last.

         type: "integer"

         format: "int64"

       CpuPercent:

         description: |

           The usable percentage of the available CPUs (Windows only).

-          On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last.

+          On Windows Server containers, the processor resource controls are

+          mutually exclusive. The order of precedence is `CPUCount` first, then

+          `CPUShares`, and `CPUPercent` last.

         type: "integer"

         format: "int64"

       IOMaximumIOps:

@@ -539,12 +619,16 @@ definitions:

         type: "integer"

         format: "int64"

       IOMaximumBandwidth:

-        description: "Maximum IO in bytes per second for the container system drive (Windows only)"

+        description: |

+          Maximum IO in bytes per second for the container system drive

+          (Windows only).

         type: "integer"

         format: "int64"

   ResourceObject:

-    description: "An object describing the resources which can be advertised by a node and requested by a task"

+    description: |

+      An object describing the resources which can be advertised by a node and

+      requested by a task.

     type: "object"

     properties:

       NanoCPUs:

@@ -559,7 +643,9 @@ definitions:

         $ref: "#/definitions/GenericResources"

   GenericResources:

-    description: "User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`)"

+    description: |

+      User-defined resources can be either Integer resources (e.g, `SSD=3`) or

+      String resources (e.g, `GPU=UUID1`).

     type: "array"

     items:

       type: "object"

@@ -606,16 +692,25 @@ definitions:

         items:

           type: "string"

       Interval:

-        description: "The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit."

+        description: |

+          The time to wait between checks in nanoseconds. It should be 0 or at

+          least 1000000 (1 ms). 0 means inherit.

         type: "integer"

       Timeout:

-        description: "The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit."

+        description: |

+          The time to wait before considering the check to have hung. It should

+          be 0 or at least 1000000 (1 ms). 0 means inherit.

         type: "integer"

       Retries:

-        description: "The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit."

+        description: |

+          The number of consecutive failures needed to consider a container as

+          unhealthy. 0 means inherit.

         type: "integer"

       StartPeriod:

-        description: "Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit."

+        description: |

+          Start period for the container to initialize before starting

+          health-retries countdown in nanoseconds. It should be 0 or at least

+          1000000 (1 ms). 0 means inherit.

         type: "integer"

   Health:

@@ -758,25 +853,33 @@ definitions:

                   type: "string"

           NetworkMode:

             type: "string"

-            description: "Network mode to use for this container. Supported standard values are: `bridge`, `host`, `none`, and `container:<name|id>`. Any other value is taken

-              as a custom network's name to which this container should connect to."

+            description: |

+              Network mode to use for this container. Supported standard values

+              are: `bridge`, `host`, `none`, and `container:<name|id>`. Any

+              other value is taken as a custom network's name to which this

+              container should connect to.

           PortBindings:

             $ref: "#/definitions/PortMap"

           RestartPolicy:

             $ref: "#/definitions/RestartPolicy"

           AutoRemove:

             type: "boolean"

-            description: "Automatically remove the container when the container's process exits. This has no effect if `RestartPolicy` is set."

+            description: |

+              Automatically remove the container when the container's process

+              exits. This has no effect if `RestartPolicy` is set.

           VolumeDriver:

             type: "string"

             description: "Driver that this container uses to mount volumes."

           VolumesFrom:

             type: "array"

-            description: "A list of volumes to inherit from another container, specified in the form `<container name>[:<ro|rw>]`."

+            description: |

+              A list of volumes to inherit from another container, specified in

+              the form `<container name>[:<ro|rw>]`.

             items:

               type: "string"

           Mounts:

-            description: "Specification for mounts to be added to the container."

+            description: |

+              Specification for mounts to be added to the container.

             type: "array"

             items:

               $ref: "#/definitions/Mount"

@@ -785,19 +888,24 @@ definitions:

           Capabilities:

             type: "array"

             description: |

-              A list of kernel capabilities to be available for container (this overrides the default set).

+              A list of kernel capabilities to be available for container (this

+              overrides the default set).

               Conflicts with options 'CapAdd' and 'CapDrop'"

             items:

               type: "string"

           CapAdd:

             type: "array"

-            description: "A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'"

+            description: |

+              A list of kernel capabilities to add to the container. Conflicts

+              with option 'Capabilities'.

             items:

               type: "string"

           CapDrop:

             type: "array"

-            description: "A list of kernel capabilities to drop from the container. Conflicts with option 'Capabilities'"

+            description: |

+              A list of kernel capabilities to drop from the container. Conflicts

+              with option 'Capabilities'.

             items:

               type: "string"

           Dns:

@@ -818,43 +926,49 @@ definitions:

           ExtraHosts:

             type: "array"

             description: |

-              A list of hostnames/IP mappings to add to the container's `/etc/hosts` file. Specified in the form `["hostname:IP"]`.

+              A list of hostnames/IP mappings to add to the container's `/etc/hosts`

+              file. Specified in the form `["hostname:IP"]`.

             items:

               type: "string"

           GroupAdd:

             type: "array"

-            description: "A list of additional groups that the container process will run as."

+            description: |

+              A list of additional groups that the container process will run as.

             items:

               type: "string"

           IpcMode:

             type: "string"

             description: |

-                    IPC sharing mode for the container. Possible values are:

+              IPC sharing mode for the container. Possible values are:

-                    - `"none"`: own private IPC namespace, with /dev/shm not mounted

-                    - `"private"`: own private IPC namespace

-                    - `"shareable"`: own private IPC namespace, with a possibility to share it with other containers

-                    - `"container:<name|id>"`: join another (shareable) container's IPC namespace

-                    - `"host"`: use the host system's IPC namespace

+              - `"none"`: own private IPC namespace, with /dev/shm not mounted

+              - `"private"`: own private IPC namespace

+              - `"shareable"`: own private IPC namespace, with a possibility to share it with other containers

+              - `"container:<name|id>"`: join another (shareable) container's IPC namespace

+              - `"host"`: use the host system's IPC namespace

-                    If not specified, daemon default is used, which can either be `"private"`

-                    or `"shareable"`, depending on daemon version and configuration.

+              If not specified, daemon default is used, which can either be `"private"`

+              or `"shareable"`, depending on daemon version and configuration.

           Cgroup:

             type: "string"

             description: "Cgroup to use for the container."

           Links:

             type: "array"

-            description: "A list of links for the container in the form `container_name:alias`."

+            description: |

+              A list of links for the container in the form `container_name:alias`.

             items:

               type: "string"

           OomScoreAdj:

             type: "integer"

-            description: "An integer value containing the score given to the container in order to tune OOM killer preferences."

+            description: |

+              An integer value containing the score given to the container in

+              order to tune OOM killer preferences.

             example: 500

           PidMode:

             type: "string"

             description: |

-              Set the PID (Process) Namespace mode for the container. It can be either:

+              Set the PID (Process) Namespace mode for the container. It can be

+              either:

               - `"container:<name|id>"`: joins another container's PID namespace

               - `"host"`: use the host's PID namespace inside the container

@@ -867,11 +981,13 @@ definitions:

               Allocates an ephemeral host port for all of a container's

               exposed ports.

-              Ports are de-allocated when the container stops and allocated when the container starts.

-              The allocated port might be changed when restarting the container.

+              Ports are de-allocated when the container stops and allocated when

+              the container starts. The allocated port might be changed when

+              restarting the container.

-              The port is selected from the ephemeral port range that depends on the kernel.

-              For example, on Linux the range is defined by `/proc/sys/net/ipv4/ip_local_port_range`.

+              The port is selected from the ephemeral port range that depends on

+              the kernel. For example, on Linux the range is defined by

+              `/proc/sys/net/ipv4/ip_local_port_range`.

           ReadonlyRootfs:

             type: "boolean"

             description: "Mount the container's root filesystem as read only."

@@ -890,7 +1006,12 @@ definitions:

           Tmpfs:

             type: "object"

             description: |

-              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" }`.

+              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" }

+              ```

             additionalProperties:

               type: "string"

           UTSMode:

@@ -898,15 +1019,23 @@ definitions:

             description: "UTS namespace to use for the container."

           UsernsMode:

             type: "string"

-            description: "Sets the usernamespace mode for the container when usernamespace remapping option is enabled."

+            description: |

+              Sets the usernamespace mode for the container when usernamespace

+              remapping option is enabled.

           ShmSize:

             type: "integer"

-            description: "Size of `/dev/shm` in bytes. If omitted, the system uses 64MB."

+            description: |

+              Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.

             minimum: 0

           Sysctls:

             type: "object"

             description: |

-              A list of kernel parameters (sysctls) to set in the container. For example: `{"net.ipv4.ip_forward": "1"}`

+              A list of kernel parameters (sysctls) to set in the container.

+              For example:

+

+              ```

+              {"net.ipv4.ip_forward": "1"}

+              ```

             additionalProperties:

               type: "string"

           Runtime:

@@ -915,7 +1044,8 @@ definitions:

           # Applicable to Windows

           ConsoleSize:

             type: "array"

-            description: "Initial console size, as an `[height, width]` array. (Windows only)"

+            description: |

+              Initial console size, as an `[height, width]` array. (Windows only)

             minItems: 2

             maxItems: 2

             items:

@@ -923,19 +1053,24 @@ definitions:

               minimum: 0

           Isolation:

             type: "string"

-            description: "Isolation technology of the container. (Windows only)"

+            description: |

+              Isolation technology of the container. (Windows only)

             enum:

               - "default"

               - "process"

               - "hyperv"

           MaskedPaths:

             type: "array"

-            description: "The list of paths to be masked inside the container (this overrides the default set of paths)"

+            description: |

+              The list of paths to be masked inside the container (this overrides

+              the default set of paths).

             items:

               type: "string"

           ReadonlyPaths:

             type: "array"

-            description: "The list of paths to be set as read-only inside the container (this overrides the default set of paths)"

+            description: |

+              The list of paths to be set as read-only inside the container

+              (this overrides the default set of paths).

             items:

               type: "string"

@@ -976,7 +1111,8 @@ definitions:

             - {}

           default: {}

       Tty:

-        description: "Attach standard streams to a TTY, including `stdin` if it is not closed."

+        description: |

+          Attach standard streams to a TTY, including `stdin` if it is not closed.

         type: "boolean"

         default: false

       OpenStdin:

@@ -989,12 +1125,15 @@ definitions:

         default: false

       Env:

         description: |

-          A list of environment variables to set inside the container in the form `["VAR=value", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value.

+          A list of environment variables to set inside the container in the

+          form `["VAR=value", ...]`. A variable without `=` is removed from the

+          environment, rather than to have an empty value.

         type: "array"

         items:

           type: "string"

       Cmd:

-        description: "Command to run specified as a string or an array of strings."

+        description: |

+          Command to run specified as a string or an array of strings.

         type: "array"

         items:

           type: "string"

@@ -1004,10 +1143,13 @@ definitions:

         description: "Command is already escaped (Windows only)"

         type: "boolean"

       Image:

-        description: "The name of the image to use when creating the container"

+        description: |

+          The name of the image to use when creating the container/

         type: "string"

       Volumes:

-        description: "An object mapping mount point paths inside the container to empty objects."

+        description: |

+          An object mapping mount point paths inside the container to empty

+          objects.

         type: "object"

         additionalProperties:

           type: "object"

@@ -1021,7 +1163,9 @@ definitions:

         description: |

           The entry point for the container as a string or an array of strings.

-          If the array consists of exactly one empty string (`[""]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`).

+          If the array consists of exactly one empty string (`[""]`) then the

+          entry point is reset to system default (i.e., the entry point used by

+          docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`).

         type: "array"

         items:

           type: "string"

@@ -1032,7 +1176,8 @@ definitions:

         description: "MAC address of the container."

         type: "string"

       OnBuild:

-        description: "`ONBUILD` metadata that were defined in the image's `Dockerfile`."

+        description: |

+          `ONBUILD` metadata that were defined in the image's `Dockerfile`.

         type: "array"

         items:

           type: "string"

@@ -1042,7 +1187,8 @@ definitions:

         additionalProperties:

           type: "string"

       StopSignal:

-        description: "Signal to stop a container as a string or unsigned integer."

+        description: |

+          Signal to stop a container as a string or unsigned integer.

         type: "string"

         default: "SIGTERM"

       StopTimeout:

@@ -1050,7 +1196,8 @@ definitions:

         type: "integer"

         default: 10

       Shell:

-        description: "Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell."

+        description: |

+          Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.

         type: "array"

         items:

           type: "string"

@@ -1497,13 +1644,16 @@ definitions:

           type: "string"

       Scope:

         type: "string"

-        description: "The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level."

+        description: |

+          The level at which the volume exists. Either `global` for cluster-wide,

+          or `local` for machine level.

         default: "local"

         x-nullable: false

         enum: ["local", "global"]

       Options:

         type: "object"

-        description: "The driver specific options used when creating the volume."

+        description: |

+          The driver specific options used when creating the volume.

         additionalProperties:

           type: "string"

       UsageData:

@@ -1621,7 +1771,12 @@ definitions:

         type: "string"

         default: "default"

       Config:

-        description: "List of IPAM configuration options, specified as a map: `{\"Subnet\": <CIDR>, \"IPRange\": <CIDR>, \"Gateway\": <IP address>, \"AuxAddress\": <device_name:IP address>}`"

+        description: |

+          List of IPAM configuration options, specified as a map:

+

+          ```

+          {"Subnet": <CIDR>, "IPRange": <CIDR>, "Gateway": <IP address>, "AuxAddress": <device_name:IP address>}

+          ```

         type: "array"

         items:

           type: "object"

@@ -1967,7 +2122,9 @@ definitions:

         x-nullable: false

         example: "tiborvass/sample-volume-plugin"

       Enabled:

-        description: "True if the plugin is running. False if the plugin is not running, only installed."

+        description:

+          True if the plugin is running. False if the plugin is not running,

+          only installed.

         type: "boolean"

         x-nullable: false

         example: true

@@ -2169,13 +2326,16 @@ definitions:

   ObjectVersion:

     description: |

-      The version number of the object such as node, service, etc. This is needed to avoid conflicting writes.

-      The client must send the version number along with the modified specification when updating these objects.

-      This approach ensures safe concurrency and determinism in that the change on the object

-      may not be applied if the version number has changed from the last read. In other words,

-      if two update requests specify the same base version, only one of the requests can succeed.

-      As a result, two separate update requests that happen at the same time will not

-      unintentionally overwrite each other.

+      The version number of the object such as node, service, etc. This is needed

+      to avoid conflicting writes. The client must send the version number along

+      with the modified specification when updating these objects.

+

+      This approach ensures safe concurrency and determinism in that the change

+      on the object may not be applied if the version number has changed from the

+      last read. In other words, if two update requests specify the same base

+      version, only one of the requests can succeed. As a result, two separate

+      update requests that happen at the same time will not unintentionally

+      overwrite each other.

     type: "object"

     properties:

       Index:

@@ -2344,17 +2504,23 @@ definitions:

             Name: "vieux/sshfs:latest"

   TLSInfo:

-    description: "Information about the issuer of leaf TLS certificates and the trusted root CA certificate"

+    description: |

+      Information about the issuer of leaf TLS certificates and the trusted root

+      CA certificate.

     type: "object"

     properties:

       TrustRoot:

-        description: "The root CA certificate(s) that are used to validate leaf TLS certificates"

+        description: |

+          The root CA certificate(s) that are used to validate leaf TLS

+          certificates.

         type: "string"

       CertIssuerSubject:

-        description: "The base64-url-safe-encoded raw subject bytes of the issuer"

+        description:

+          The base64-url-safe-encoded raw subject bytes of the issuer.

         type: "string"

       CertIssuerPublicKey:

-        description: "The base64-url-safe-encoded raw public key bytes of the issuer"

+        description: |

+          The base64-url-safe-encoded raw public key bytes of the issuer.

         type: "string"

     example:

       TrustRoot: |

@@ -2450,7 +2616,9 @@ definitions:

         x-nullable: true

         properties:

           TaskHistoryRetentionLimit:

-            description: "The number of historic tasks to keep per instance or node. If negative, never remove completed or failed tasks."

+            description: |

+              The number of historic tasks to keep per instance or node. If

+              negative, never remove completed or failed tasks.

             type: "integer"

             format: "int64"

             example: 10

@@ -2464,26 +2632,34 @@ definitions:

             format: "uint64"

             example: 10000

           KeepOldSnapshots:

-            description: "The number of snapshots to keep beyond the current snapshot."

+            description: |

+              The number of snapshots to keep beyond the current snapshot.

             type: "integer"

             format: "uint64"

           LogEntriesForSlowFollowers:

-            description: "The number of log entries to keep around to sync up slow followers after a snapshot is created."

+            description: |

+              The number of log entries to keep around to sync up slow followers

+              after a snapshot is created.

             type: "integer"

             format: "uint64"

             example: 500

           ElectionTick:

             description: |

-              The number of ticks that a follower will wait for a message from the leader before becoming a candidate and starting an election. `ElectionTick` must be greater than `HeartbeatTick`.

+              The number of ticks that a follower will wait for a message from

+              the leader before becoming a candidate and starting an election.

+              `ElectionTick` must be greater than `HeartbeatTick`.

-              A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed.

+              A tick currently defaults to one second, so these translate

+              directly to seconds currently, but this is NOT guaranteed.

             type: "integer"

             example: 3

           HeartbeatTick:

             description: |

-              The number of ticks between heartbeats. Every HeartbeatTick ticks, the leader will send a heartbeat to the followers.

+              The number of ticks between heartbeats. Every HeartbeatTick ticks,

+              the leader will send a heartbeat to the followers.

-              A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed.

+              A tick currently defaults to one second, so these translate

+              directly to seconds currently, but this is NOT guaranteed.

             type: "integer"

             example: 1

       Dispatcher:

@@ -2492,7 +2668,8 @@ definitions:

         x-nullable: true

         properties:

           HeartbeatPeriod:

-            description: "The delay for an agent to send a heartbeat to the dispatcher."

+            description: |

+              The delay for an agent to send a heartbeat to the dispatcher.

             type: "integer"

             format: "int64"

             example: 5000000000

@@ -2507,36 +2684,53 @@ definitions:

             format: "int64"

             example: 7776000000000000

           ExternalCAs:

-            description: "Configuration for forwarding signing requests to an external certificate authority."

+            description: |

+              Configuration for forwarding signing requests to an external

+              certificate authority.

             type: "array"

             items:

               type: "object"

               properties:

                 Protocol:

-                  description: "Protocol for communication with the external CA (currently only `cfssl` is supported)."

+                  description: |

+                    Protocol for communication with the external CA (currently

+                    only `cfssl` is supported).

                   type: "string"

                   enum:

                     - "cfssl"

                   default: "cfssl"

                 URL:

-                  description: "URL where certificate signing requests should be sent."

+                  description: |

+                    URL where certificate signing requests should be sent.

                   type: "string"

                 Options:

-                  description: "An object with key/value pairs that are interpreted as protocol-specific options for the external CA driver."

+                  description: |

+                    An object with key/value pairs that are interpreted as

+                    protocol-specific options for the external CA driver.

                   type: "object"

                   additionalProperties: