docker-engine-ruby 0.2.2 → 0.3.0

data/lib/docker_engine_ruby/resources/containers.rb

@@ -3,18 +3,15 @@
 module DockerEngineRuby
   module Resources
     class Containers
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ContainerCreateParams} for more details.
-      #
       # Create a container
       #
       # @overload create(config:, name: nil, platform: nil, request_options: {})
       #
-      # @param config [DockerEngineRuby::Models::ContainerCreateParams::Config] Body param: Configuration for a container that is portable between hosts.
+      # @param config [DockerEngineRuby::Models::Config] Body param: Configuration for a container that is portable between hosts.
       #
-      # @param name [String] Query param: Assign the specified name to the container. Must match
+      # @param name [String] Query param
       #
-      # @param platform [String] Query param: Platform in the format `os[/arch[/variant]]` used for image lookup.
+      # @param platform [String] Query param
       #
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -36,12 +33,11 @@ module DockerEngineRuby
       # Some parameter documentations has been truncated, see
       # {DockerEngineRuby::Models::ContainerUpdateParams} for more details.
       #
-      # Change various configuration options of a container without having to recreate
-      # it.
+      # Update a container
       #
-      # @overload update(id, blkio_device_read_bps: nil, blkio_device_read_i_ops: nil, blkio_device_write_bps: nil, blkio_device_write_i_ops: nil, blkio_weight: nil, blkio_weight_device: nil, cgroup_parent: nil, cpu_count: nil, cpu_percent: nil, cpu_period: nil, cpu_quota: nil, cpu_realtime_period: nil, cpu_realtime_runtime: nil, cpuset_cpus: nil, cpuset_mems: nil, cpu_shares: nil, device_cgroup_rules: nil, device_requests: nil, devices: nil, init: nil, io_maximum_bandwidth: nil, io_maximum_i_ops: nil, memory: nil, memory_reservation: nil, memory_swap: nil, memory_swappiness: nil, nano_cpus: nil, oom_kill_disable: nil, pids_limit: nil, restart_policy: nil, ulimits: nil, request_options: {})
+      # @overload update(id, blkio_device_read_bps: nil, blkio_device_read_i_ops: nil, blkio_device_write_bps: nil, blkio_device_write_i_ops: nil, blkio_weight: nil, blkio_weight_device: nil, cgroup_parent: nil, cpu_count: nil, cpu_percent: nil, cpu_period: nil, cpu_quota: nil, cpu_realtime_period: nil, cpu_realtime_runtime: nil, cpuset_cpus: nil, cpuset_mems: nil, cpu_shares: nil, device_cgroup_rules: nil, device_requests: nil, devices: nil, init: nil, io_maximum_bandwidth: nil, io_maximum_i_ops: nil, memory: nil, memory_reservation: nil, memory_swap: nil, memory_swappiness: nil, nano_cpus: nil, oom_kill_disable: nil, pids_limit: nil, ulimits: nil, request_options: {})
       #
-      # @param id [String] ID or name of the container
+      # @param id [String]
       #
       # @param blkio_device_read_bps [Array<DockerEngineRuby::Models::ContainerUpdateParams::BlkioDeviceReadBp>] Limit read rate (bytes per second) from a device, in the form:
       #
@@ -101,8 +97,6 @@ module DockerEngineRuby
       #
       # @param pids_limit [Integer, nil] Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null`
       #
-      # @param restart_policy [DockerEngineRuby::Models::ContainerUpdateParams::RestartPolicy] The behavior to apply when the container exits. The default is not to
-      #
       # @param ulimits [Array<DockerEngineRuby::Models::ContainerUpdateParams::Ulimit>] A list of resource limits to set in the container. For example:
       #
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -121,26 +115,14 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ContainerListParams} for more details.
-      #
-      # Returns a list of containers. For details on the format, see the
-      # [inspect endpoint](#operation/ContainerInspect).
-      #
-      # Note that it uses a different, smaller representation of a container than
-      # inspecting a single container. For example, the list of linked containers is not
-      # propagated .
+      # List containers
       #
       # @overload list(all: nil, filters: nil, limit: nil, size: nil, request_options: {})
       #
-      # @param all [Boolean] Return all containers. By default, only running containers are shown.
-      #
-      # @param filters [String] Filters to process on the container list, encoded as JSON (a
-      #
-      # @param limit [Integer] Return this number of most recently created containers, including
-      #
-      # @param size [Boolean] Return the size of container as fields `SizeRw` and `SizeRootFs`.
-      #
+      # @param all [Boolean]
+      # @param filters [String]
+      # @param limit [Integer]
+      # @param size [Boolean]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Array<DockerEngineRuby::Models::Summary>]
@@ -161,14 +143,10 @@ module DockerEngineRuby
       #
       # @overload delete(id, force: nil, link: nil, v: nil, request_options: {})
       #
-      # @param id [String] ID or name of the container
-      #
-      # @param force [Boolean] If the container is running, kill it before removing it.
-      #
-      # @param link [Boolean] Remove the specified link associated with the container.
-      #
-      # @param v [Boolean] Remove anonymous volumes associated with the container.
-      #
+      # @param id [String]
+      # @param force [Boolean]
+      # @param link [Boolean]
+      # @param v [Boolean]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -185,14 +163,12 @@ module DockerEngineRuby
         )
       end
 
-      # Get a tar archive of a resource in the filesystem of container id.
+      # Get an archive of a filesystem resource in a container
       #
       # @overload archive(id, path:, request_options: {})
       #
-      # @param id [String] ID or name of the container
-      #
-      # @param path [String] Resource in the container’s filesystem to archive.
-      #
+      # @param id [String]
+      # @param path [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -209,121 +185,17 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ContainerAttachParams} for more details.
-      #
-      # Attach to a container to read its output or send it input. You can attach to the
-      # same container multiple times and you can reattach to containers that have been
-      # detached.
-      #
-      # Either the `stream` or `logs` parameter must be `true` for this endpoint to do
-      # anything.
-      #
-      # See the
-      # [documentation for the `docker attach` command](https://docs.docker.com/engine/reference/commandline/attach/)
-      # for more details.
-      #
-      # ### Hijacking
-      #
-      # This endpoint hijacks the HTTP connection to transport `stdin`, `stdout`, and
-      # `stderr` on the same socket.
-      #
-      # This is the response from the daemon for an attach request:
-      #
-      # ```
-      # HTTP/1.1 200 OK
-      # Content-Type: application/vnd.docker.raw-stream
-      #
-      # [STREAM]
-      # ```
-      #
-      # After the headers and two new lines, the TCP connection can now be used for raw,
-      # bidirectional communication between the client and server.
-      #
-      # To hint potential proxies about connection hijacking, the Docker client can also
-      # optionally send connection upgrade headers.
-      #
-      # For example, the client sends this request to upgrade the connection:
-      #
-      # ```
-      # POST /containers/16253994b7c4/attach?stream=1&stdout=1 HTTP/1.1
-      # Upgrade: tcp
-      # Connection: Upgrade
-      # ```
-      #
-      # The Docker daemon will respond with a `101 UPGRADED` response, and will
-      # similarly follow with the raw stream:
-      #
-      # ```
-      # HTTP/1.1 101 UPGRADED
-      # Content-Type: application/vnd.docker.raw-stream
-      # Connection: Upgrade
-      # Upgrade: tcp
-      #
-      # [STREAM]
-      # ```
-      #
-      # ### Stream format
-      #
-      # When the TTY setting is disabled in
-      # [`POST /containers/create`](#operation/ContainerCreate), 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.
-      #
-      # The header contains the information which the stream writes (`stdout` or
-      # `stderr`). It also contains the size of the associated frame encoded in the last
-      # four bytes (`uint32`).
-      #
-      # It is encoded on the first eight bytes like this:
-      #
-      # ```go
-      # header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
-      # ```
-      #
-      # `STREAM_TYPE` can be:
-      #
-      # - 0: `stdin` (is written on `stdout`)
-      # - 1: `stdout`
-      # - 2: `stderr`
-      #
-      # `SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of the `uint32` size encoded as
-      # big endian.
-      #
-      # Following the header is the payload, which is the specified number of bytes of
-      # `STREAM_TYPE`.
-      #
-      # The simplest way to implement this protocol is the following:
-      #
-      # 1. Read 8 bytes.
-      # 2. Choose `stdout` or `stderr` depending on the first byte.
-      # 3. Extract the frame size from the last four bytes.
-      # 4. Read the extracted size and output it on the correct output.
-      # 5. Goto 1.
-      #
-      # ### Stream format when using a TTY
-      #
-      # When the TTY setting is enabled in
-      # [`POST /containers/create`](#operation/ContainerCreate), the stream is not
-      # multiplexed. The data exchanged over the hijacked connection is simply the raw
-      # data from the process PTY and client's `stdin`.
+      # Attach to a container
       #
       # @overload attach(id, detach_keys: nil, logs: nil, stderr: nil, stdin: nil, stdout: nil, stream: nil, request_options: {})
       #
-      # @param id [String] ID or name of the container
-      #
-      # @param detach_keys [String] Override the key sequence for detaching a container.Format is a single
-      #
-      # @param logs [Boolean] Replay previous logs from the container.
-      #
-      # @param stderr [Boolean] Attach to `stderr`
-      #
-      # @param stdin [Boolean] Attach to `stdin`
-      #
-      # @param stdout [Boolean] Attach to `stdout`
-      #
-      # @param stream [Boolean] Stream attached streams from the time the request was made onwards.
-      #
+      # @param id [String]
+      # @param detach_keys [String]
+      # @param logs [Boolean]
+      # @param stderr [Boolean]
+      # @param stdin [Boolean]
+      # @param stdout [Boolean]
+      # @param stream [Boolean]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -340,17 +212,11 @@ module DockerEngineRuby
         )
       end
 
-      # Returns which files in a container's filesystem have been added, deleted, or
-      # modified. The `Kind` of modification can be one of:
-      #
-      # - `0`: Modified ("C")
-      # - `1`: Added ("A")
-      # - `2`: Deleted ("D")
+      # Get changes on a container’s filesystem
       #
       # @overload changes(id, request_options: {})
       #
-      # @param id [String] ID or name of the container
-      #
+      # @param id [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Array<DockerEngineRuby::Models::FilesystemChange>]
@@ -365,37 +231,22 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ContainerExecParams} for more details.
-      #
-      # Run a command inside a running container.
+      # Create an exec instance
       #
       # @overload exec_(id, attach_stderr: nil, attach_stdin: nil, attach_stdout: nil, cmd: nil, console_size: nil, detach_keys: nil, env: nil, privileged: nil, tty: nil, user: nil, working_dir: nil, request_options: {})
       #
-      # @param id [String] ID or name of container
-      #
-      # @param attach_stderr [Boolean] Attach to `stderr` of the exec command.
-      #
-      # @param attach_stdin [Boolean] Attach to `stdin` of the exec command.
-      #
-      # @param attach_stdout [Boolean] Attach to `stdout` of the exec command.
-      #
-      # @param cmd [Array<String>] Command to run, as a string or array of strings.
-      #
-      # @param console_size [Array<Integer>, nil] Initial console size, as an `[height, width]` array.
-      #
-      # @param detach_keys [String] Override the key sequence for detaching a container. Format is
-      #
-      # @param env [Array<String>] A list of environment variables in the form `["VAR=value", ...]`.
-      #
-      # @param privileged [Boolean] Runs the exec process with extended privileges.
-      #
-      # @param tty [Boolean] Allocate a pseudo-TTY.
-      #
-      # @param user [String] The user, and optionally, group to run the exec process inside
-      #
-      # @param working_dir [String] The working directory for the exec process inside the container.
-      #
+      # @param id [String]
+      # @param attach_stderr [Boolean]
+      # @param attach_stdin [Boolean]
+      # @param attach_stdout [Boolean]
+      # @param cmd [Array<String>]
+      # @param console_size [Array<Integer>, nil]
+      # @param detach_keys [String]
+      # @param env [Array<String>]
+      # @param privileged [Boolean]
+      # @param tty [Boolean]
+      # @param user [String]
+      # @param working_dir [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::ContainerExecResponse]
@@ -412,12 +263,11 @@ module DockerEngineRuby
         )
       end
 
-      # Export the contents of a container as a tarball.
+      # Export a container
       #
       # @overload export(id, request_options: {})
       #
-      # @param id [String] ID or name of the container
-      #
+      # @param id [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -432,14 +282,12 @@ module DockerEngineRuby
         )
       end
 
-      # Return low-level information about a container.
+      # Inspect a container
       #
       # @overload inspect_(id, size: nil, request_options: {})
       #
-      # @param id [String] ID or name of the container
-      #
-      # @param size [Boolean] Return the size of container as fields `SizeRw` and `SizeRootFs`
-      #
+      # @param id [String]
+      # @param size [Boolean]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::Container]
@@ -456,17 +304,12 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ContainerKillParams} for more details.
-      #
-      # Send a POSIX signal to a container, defaulting to killing to the container.
+      # Kill a container
       #
       # @overload kill(id, signal: nil, request_options: {})
       #
-      # @param id [String] ID or name of the container
-      #
-      # @param signal [String] Signal to send to the container as an integer or string (e.g. `SIGINT`).
-      #
+      # @param id [String]
+      # @param signal [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -483,32 +326,18 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ContainerLogsParams} for more details.
-      #
-      # Get `stdout` and `stderr` logs from a container.
-      #
-      # Note: This endpoint works only for containers with the `json-file` or `journald`
-      # logging driver.
+      # Get container logs
       #
       # @overload logs(id, follow: nil, since: nil, stderr: nil, stdout: nil, tail: nil, timestamps: nil, until_: nil, request_options: {})
       #
-      # @param id [String] ID or name of the container
-      #
-      # @param follow [Boolean] Keep connection after returning logs.
-      #
-      # @param since [Integer] Only return logs since this time, as a UNIX timestamp
-      #
-      # @param stderr [Boolean] Return logs from `stderr`
-      #
-      # @param stdout [Boolean] Return logs from `stdout`
-      #
-      # @param tail [String] Only return this number of log lines from the end of the logs.
-      #
-      # @param timestamps [Boolean] Add timestamps to every log line
-      #
-      # @param until_ [Integer] Only return logs before this time, as a UNIX timestamp
-      #
+      # @param id [String]
+      # @param follow [Boolean]
+      # @param since [Integer]
+      # @param stderr [Boolean]
+      # @param stdout [Boolean]
+      # @param tail [String]
+      # @param timestamps [Boolean]
+      # @param until_ [Integer]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [StringIO]
@@ -520,23 +349,17 @@ module DockerEngineRuby
           method: :get,
           path: ["containers/%1$s/logs", id],
           query: parsed.transform_keys(until_: "until"),
-          headers: {"accept" => "application/vnd.docker.multiplexed-stream"},
+          headers: {"accept" => "application/octet-stream"},
           model: StringIO,
           options: options
         )
       end
 
-      # Use the freezer cgroup to suspend all processes in a container.
-      #
-      # Traditionally, when suspending a process the `SIGSTOP` signal is used, which is
-      # observable by the process being suspended. With the freezer cgroup the process
-      # is unaware, and unable to capture, that it is being suspended, and subsequently
-      # resumed.
+      # Pause a container
       #
       # @overload pause(id, request_options: {})
       #
-      # @param id [String] ID or name of the container
-      #
+      # @param id [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -551,15 +374,11 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ContainerPruneParams} for more details.
-      #
       # Delete stopped containers
       #
       # @overload prune(filters: nil, request_options: {})
       #
-      # @param filters [String] Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
-      #
+      # @param filters [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::ContainerPruneResponse]
@@ -580,10 +399,8 @@ module DockerEngineRuby
       #
       # @overload rename(id, name:, request_options: {})
       #
-      # @param id [String] ID or name of the container
-      #
-      # @param name [String] New name for the container
-      #
+      # @param id [String]
+      # @param name [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -600,16 +417,13 @@ module DockerEngineRuby
         )
       end
 
-      # Resize the TTY for a container.
+      # Resize a container TTY
       #
       # @overload resize(id, h:, w:, request_options: {})
       #
-      # @param id [String] ID or name of the container
-      #
-      # @param h [Integer] Height of the TTY session in characters
-      #
-      # @param w [Integer] Width of the TTY session in characters
-      #
+      # @param id [String]
+      # @param h [Integer]
+      # @param w [Integer]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -626,19 +440,13 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ContainerRestartParams} for more details.
-      #
       # Restart a container
       #
       # @overload restart(id, signal: nil, t: nil, request_options: {})
       #
-      # @param id [String] ID or name of the container
-      #
-      # @param signal [String] Signal to send to the container as an integer or string (e.g. `SIGINT`).
-      #
-      # @param t [Integer] Number of seconds to wait before killing the container
-      #
+      # @param id [String]
+      # @param signal [String]
+      # @param t [Integer]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -655,17 +463,12 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ContainerStartParams} for more details.
-      #
       # Start a container
       #
       # @overload start(id, detach_keys: nil, request_options: {})
       #
-      # @param id [String] ID or name of the container
-      #
-      # @param detach_keys [String] Override the key sequence for detaching a container. Format is a
-      #
+      # @param id [String]
+      # @param detach_keys [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -682,50 +485,13 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ContainerStatsParams} for more details.
-      #
-      # This endpoint returns a live stream of a container’s resource usage statistics.
-      #
-      # The `precpu_stats` is the CPU statistic of the _previous_ read, and is used to
-      # calculate the CPU usage percentage. It is not an exact copy of the `cpu_stats`
-      # field.
-      #
-      # If either `precpu_stats.online_cpus` or `cpu_stats.online_cpus` is nil then for
-      # compatibility with older daemons the length of the corresponding
-      # `cpu_usage.percpu_usage` array should be used.
-      #
-      # On a cgroup v2 host, the following fields are not set
-      #
-      # - `blkio_stats`: all fields other than `io_service_bytes_recursive`
-      # - `cpu_stats`: `cpu_usage.percpu_usage`
-      # - `memory_stats`: `max_usage` and `failcnt` Also, `memory_stats.stats` fields
-      #   are incompatible with cgroup v1.
-      #
-      # To calculate the values shown by the `stats` command of the docker cli tool the
-      # following formulas can be used:
-      #
-      # - used_memory = `memory_stats.usage - memory_stats.stats.cache` (cgroups v1)
-      # - used_memory = `memory_stats.usage - memory_stats.stats.inactive_file` (cgroups
-      #   v2)
-      # - available_memory = `memory_stats.limit`
-      # - Memory usage % = `(used_memory / available_memory) * 100.0`
-      # - cpu_delta =
-      #   `cpu_stats.cpu_usage.total_usage - precpu_stats.cpu_usage.total_usage`
-      # - system_cpu_delta =
-      #   `cpu_stats.system_cpu_usage - precpu_stats.system_cpu_usage`
-      # - number_cpus = `length(cpu_stats.cpu_usage.percpu_usage)` or
-      #   `cpu_stats.online_cpus`
-      # - CPU usage % = `(cpu_delta / system_cpu_delta) * number_cpus * 100.0`
+      # Get container stats based on resource usage
       #
       # @overload stats(id, one_shot: nil, stream: nil, request_options: {})
       #
-      # @param id [String] ID or name of the container
-      #
-      # @param one_shot [Boolean] Only get a single stat instead of waiting for 2 cycles. Must be used
-      #
-      # @param stream [Boolean] Stream the output. If false, the stats will be output once and then
-      #
+      # @param id [String]
+      # @param one_shot [Boolean]
+      # @param stream [Boolean]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::StatsResponse]
@@ -742,19 +508,13 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ContainerStopParams} for more details.
-      #
       # Stop a container
       #
       # @overload stop(id, signal: nil, t: nil, request_options: {})
       #
-      # @param id [String] ID or name of the container
-      #
-      # @param signal [String] Signal to send to the container as an integer or string (e.g. `SIGINT`).
-      #
-      # @param t [Integer] Number of seconds to wait before killing the container
-      #
+      # @param id [String]
+      # @param signal [String]
+      # @param t [Integer]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -771,15 +531,12 @@ module DockerEngineRuby
         )
       end
 
-      # On Unix systems, this is done by running the `ps` command. This endpoint is not
-      # supported on Windows.
+      # List processes running inside a container
       #
       # @overload top(id, ps_args: nil, request_options: {})
       #
-      # @param id [String] ID or name of the container
-      #
-      # @param ps_args [String] The arguments to pass to `ps`. For example, `aux`
-      #
+      # @param id [String]
+      # @param ps_args [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::TopResponse]
@@ -796,12 +553,11 @@ module DockerEngineRuby
         )
       end
 
-      # Resume a container which has been paused.
+      # Unpause a container
       #
       # @overload unpause(id, request_options: {})
       #
-      # @param id [String] ID or name of the container
-      #
+      # @param id [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -816,17 +572,12 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ContainerWaitParams} for more details.
-      #
-      # Block until a container stops, then returns the exit code.
+      # Wait for a container
       #
       # @overload wait(id, condition: nil, request_options: {})
       #
-      # @param id [String] ID or name of the container
-      #
-      # @param condition [Symbol, DockerEngineRuby::Models::ContainerWaitParams::Condition] Wait until a container state reaches the given condition.
-      #
+      # @param id [String]
+      # @param condition [Symbol, DockerEngineRuby::Models::ContainerWaitParams::Condition]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::WaitResponse]

data/lib/docker_engine_ruby/resources/distribution.rb

@@ -3,12 +3,11 @@
 module DockerEngineRuby
   module Resources
     class Distribution
-      # Return image digest and platform information by contacting the registry.
+      # Get image information from the registry
       #
       # @overload inspect_(name, request_options: {})
       #
-      # @param name [String] Image name or id
-      #
+      # @param name [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::Inspect]