docker-engine-ruby 0.2.2 → 0.4.0

data/lib/docker_engine_ruby/models/container_delete_params.rb

@@ -8,30 +8,24 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute force
-      #   If the container is running, kill it before removing it.
       #
       #   @return [Boolean, nil]
       optional :force, DockerEngineRuby::Internal::Type::Boolean
 
       # @!attribute link
-      #   Remove the specified link associated with the container.
       #
       #   @return [Boolean, nil]
       optional :link, DockerEngineRuby::Internal::Type::Boolean
 
       # @!attribute v
-      #   Remove anonymous volumes associated with the container.
       #
       #   @return [Boolean, nil]
       optional :v, DockerEngineRuby::Internal::Type::Boolean
 
       # @!method initialize(force: nil, link: nil, v: nil, request_options: {})
-      #   @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 force [Boolean]
+      #   @param link [Boolean]
+      #   @param v [Boolean]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/container_exec_params.rb

@@ -8,31 +8,26 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute attach_stderr
-      #   Attach to `stderr` of the exec command.
       #
       #   @return [Boolean, nil]
       optional :attach_stderr, DockerEngineRuby::Internal::Type::Boolean, api_name: :AttachStderr
 
       # @!attribute attach_stdin
-      #   Attach to `stdin` of the exec command.
       #
       #   @return [Boolean, nil]
       optional :attach_stdin, DockerEngineRuby::Internal::Type::Boolean, api_name: :AttachStdin
 
       # @!attribute attach_stdout
-      #   Attach to `stdout` of the exec command.
       #
       #   @return [Boolean, nil]
       optional :attach_stdout, DockerEngineRuby::Internal::Type::Boolean, api_name: :AttachStdout
 
       # @!attribute cmd
-      #   Command to run, as a string or array of strings.
       #
       #   @return [Array<String>, nil]
       optional :cmd, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Cmd
 
       # @!attribute console_size
-      #   Initial console size, as an `[height, width]` array.
       #
       #   @return [Array<Integer>, nil]
       optional :console_size,
@@ -41,70 +36,47 @@ module DockerEngineRuby
                nil?: true
 
       # @!attribute detach_keys
-      #   Override the key sequence for detaching a container. Format is a single
-      #   character `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`, `@`, `^`,
-      #   `[`, `,` or `_`.
       #
       #   @return [String, nil]
       optional :detach_keys, String, api_name: :DetachKeys
 
       # @!attribute env
-      #   A list of environment variables in the form `["VAR=value", ...]`.
       #
       #   @return [Array<String>, nil]
       optional :env, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Env
 
       # @!attribute privileged
-      #   Runs the exec process with extended privileges.
       #
       #   @return [Boolean, nil]
       optional :privileged, DockerEngineRuby::Internal::Type::Boolean, api_name: :Privileged
 
       # @!attribute tty
-      #   Allocate a pseudo-TTY.
       #
       #   @return [Boolean, nil]
       optional :tty, DockerEngineRuby::Internal::Type::Boolean, api_name: :Tty
 
       # @!attribute user
-      #   The user, and optionally, group to run the exec process inside the container.
-      #   Format is one of: `user`, `user:group`, `uid`, or `uid:gid`.
       #
       #   @return [String, nil]
       optional :user, String, api_name: :User
 
       # @!attribute working_dir
-      #   The working directory for the exec process inside the container.
       #
       #   @return [String, nil]
       optional :working_dir, String, api_name: :WorkingDir
 
       # @!method initialize(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: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::ContainerExecParams} for more details.
-      #
-      #   @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 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}]
     end
   end

data/lib/docker_engine_ruby/models/container_inspect_params.rb

@@ -8,14 +8,12 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute size
-      #   Return the size of container as fields `SizeRw` and `SizeRootFs`
       #
       #   @return [Boolean, nil]
       optional :size, DockerEngineRuby::Internal::Type::Boolean
 
       # @!method initialize(size: nil, request_options: {})
-      #   @param size [Boolean] Return the size of container as fields `SizeRw` and `SizeRootFs`
-      #
+      #   @param size [Boolean]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/container_kill_params.rb

@@ -8,17 +8,12 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute signal
-      #   Signal to send to the container as an integer or string (e.g. `SIGINT`).
       #
       #   @return [String, nil]
       optional :signal, String
 
       # @!method initialize(signal: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::ContainerKillParams} for more details.
-      #
-      #   @param signal [String] Signal to send to the container as an integer or string (e.g. `SIGINT`).
-      #
+      #   @param signal [String]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/container_list_params.rb

@@ -8,62 +8,30 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute all
-      #   Return all containers. By default, only running containers are shown.
       #
       #   @return [Boolean, nil]
       optional :all, DockerEngineRuby::Internal::Type::Boolean
 
       # @!attribute filters
-      #   Filters to process on the container list, encoded as JSON (a
-      #   `map[string][]string`). For example, `{"status": ["paused"]}` will only return
-      #   paused containers.
-      #
-      #   Available filters:
-      #
-      #   - `ancestor`=(`<image-name>[:<tag>]`, `<image id>`, or `<image@digest>`)
-      #   - `before`=(`<container id>` or `<container name>`)
-      #   - `expose`=(`<port>[/<proto>]`|`<startport-endport>/[<proto>]`)
-      #   - `exited=<int>` containers with exit code of `<int>`
-      #   - `health`=(`starting`|`healthy`|`unhealthy`|`none`)
-      #   - `id=<ID>` a container's ID
-      #   - `isolation=`(`default`|`process`|`hyperv`) (Windows daemon only)
-      #   - `is-task=`(`true`|`false`)
-      #   - `label=key` or `label="key=value"` of a container label
-      #   - `name=<name>` a container's name
-      #   - `network`=(`<network id>` or `<network name>`)
-      #   - `publish`=(`<port>[/<proto>]`|`<startport-endport>/[<proto>]`)
-      #   - `since`=(`<container id>` or `<container name>`)
-      #   - `status=`(`created`|`restarting`|`running`|`removing`|`paused`|`exited`|`dead`)
-      #   - `volume`=(`<volume name>` or `<mount point destination>`)
       #
       #   @return [String, nil]
       optional :filters, String
 
       # @!attribute limit
-      #   Return this number of most recently created containers, including non-running
-      #   ones.
       #
       #   @return [Integer, nil]
       optional :limit, Integer
 
       # @!attribute size
-      #   Return the size of container as fields `SizeRw` and `SizeRootFs`.
       #
       #   @return [Boolean, nil]
       optional :size, DockerEngineRuby::Internal::Type::Boolean
 
       # @!method initialize(all: nil, filters: nil, limit: nil, size: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::ContainerListParams} for more details.
-      #
-      #   @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}]
     end
   end

data/lib/docker_engine_ruby/models/container_logs_params.rb

@@ -8,66 +8,48 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute follow
-      #   Keep connection after returning logs.
       #
       #   @return [Boolean, nil]
       optional :follow, DockerEngineRuby::Internal::Type::Boolean
 
       # @!attribute since
-      #   Only return logs since this time, as a UNIX timestamp
       #
       #   @return [Integer, nil]
       optional :since, Integer
 
       # @!attribute stderr
-      #   Return logs from `stderr`
       #
       #   @return [Boolean, nil]
       optional :stderr, DockerEngineRuby::Internal::Type::Boolean
 
       # @!attribute stdout
-      #   Return logs from `stdout`
       #
       #   @return [Boolean, nil]
       optional :stdout, DockerEngineRuby::Internal::Type::Boolean
 
       # @!attribute tail
-      #   Only return this number of log lines from the end of the logs. Specify as an
-      #   integer or `all` to output all log lines.
       #
       #   @return [String, nil]
       optional :tail, String
 
       # @!attribute timestamps
-      #   Add timestamps to every log line
       #
       #   @return [Boolean, nil]
       optional :timestamps, DockerEngineRuby::Internal::Type::Boolean
 
       # @!attribute until_
-      #   Only return logs before this time, as a UNIX timestamp
       #
       #   @return [Integer, nil]
       optional :until_, Integer
 
       # @!method initialize(follow: nil, since: nil, stderr: nil, stdout: nil, tail: nil, timestamps: nil, until_: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::ContainerLogsParams} for more details.
-      #
-      #   @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 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}]
     end
   end

data/lib/docker_engine_ruby/models/container_prune_params.rb

@@ -8,27 +8,12 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute filters
-      #   Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
-      #
-      #   Available filters:
-      #
-      #   - `until=<timestamp>` Prune containers created before this timestamp. The
-      #     `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go
-      #     duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon
-      #     machine’s time.
-      #   - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or
-      #     `label!=<key>=<value>`) Prune containers with (or without, in case
-      #     `label!=...` is used) the specified labels.
       #
       #   @return [String, nil]
       optional :filters, String
 
       # @!method initialize(filters: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::ContainerPruneParams} for more details.
-      #
-      #   @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}]
     end
   end

data/lib/docker_engine_ruby/models/container_prune_response.rb

@@ -5,7 +5,6 @@ module DockerEngineRuby
     # @see DockerEngineRuby::Resources::Containers#prune
     class ContainerPruneResponse < DockerEngineRuby::Internal::Type::BaseModel
       # @!attribute containers_deleted
-      #   Container IDs that were deleted
       #
       #   @return [Array<String>, nil]
       optional :containers_deleted,
@@ -13,15 +12,13 @@ module DockerEngineRuby
                api_name: :ContainersDeleted
 
       # @!attribute space_reclaimed
-      #   Disk space reclaimed in bytes
       #
       #   @return [Integer, nil]
       optional :space_reclaimed, Integer, api_name: :SpaceReclaimed
 
       # @!method initialize(containers_deleted: nil, space_reclaimed: nil)
-      #   @param containers_deleted [Array<String>] Container IDs that were deleted
-      #
-      #   @param space_reclaimed [Integer] Disk space reclaimed in bytes
+      #   @param containers_deleted [Array<String>]
+      #   @param space_reclaimed [Integer]
     end
   end
 end

data/lib/docker_engine_ruby/models/container_rename_params.rb

@@ -8,14 +8,12 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute name
-      #   New name for the container
       #
       #   @return [String]
       required :name, String
 
       # @!method initialize(name:, request_options: {})
-      #   @param name [String] New name for the container
-      #
+      #   @param name [String]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/container_resize_params.rb

@@ -8,22 +8,18 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute h
-      #   Height of the TTY session in characters
       #
       #   @return [Integer]
       required :h, Integer
 
       # @!attribute w
-      #   Width of the TTY session in characters
       #
       #   @return [Integer]
       required :w, Integer
 
       # @!method initialize(h:, w:, request_options: {})
-      #   @param h [Integer] Height of the TTY session in characters
-      #
-      #   @param w [Integer] Width of the TTY session in characters
-      #
+      #   @param h [Integer]
+      #   @param w [Integer]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/container_restart_params.rb

@@ -8,25 +8,18 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute signal
-      #   Signal to send to the container as an integer or string (e.g. `SIGINT`).
       #
       #   @return [String, nil]
       optional :signal, String
 
       # @!attribute t
-      #   Number of seconds to wait before killing the container
       #
       #   @return [Integer, nil]
       optional :t, Integer
 
       # @!method initialize(signal: nil, t: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::ContainerRestartParams} for more details.
-      #
-      #   @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 signal [String]
+      #   @param t [Integer]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/container_start_params.rb

@@ -8,19 +8,12 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute detach_keys
-      #   Override the key sequence for detaching a container. Format is a single
-      #   character `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`, `@`, `^`,
-      #   `[`, `,` or `_`.
       #
       #   @return [String, nil]
       optional :detach_keys, String
 
       # @!method initialize(detach_keys: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::ContainerStartParams} for more details.
-      #
-      #   @param detach_keys [String] Override the key sequence for detaching a container. Format is a
-      #
+      #   @param detach_keys [String]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/container_stats_params.rb

@@ -8,27 +8,18 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute one_shot
-      #   Only get a single stat instead of waiting for 2 cycles. Must be used with
-      #   `stream=false`.
       #
       #   @return [Boolean, nil]
       optional :one_shot, DockerEngineRuby::Internal::Type::Boolean
 
       # @!attribute stream
-      #   Stream the output. If false, the stats will be output once and then it will
-      #   disconnect.
       #
       #   @return [Boolean, nil]
       optional :stream, DockerEngineRuby::Internal::Type::Boolean
 
       # @!method initialize(one_shot: nil, stream: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::ContainerStatsParams} for more details.
-      #
-      #   @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 one_shot [Boolean]
+      #   @param stream [Boolean]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/container_stop_params.rb

@@ -8,25 +8,18 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute signal
-      #   Signal to send to the container as an integer or string (e.g. `SIGINT`).
       #
       #   @return [String, nil]
       optional :signal, String
 
       # @!attribute t
-      #   Number of seconds to wait before killing the container
       #
       #   @return [Integer, nil]
       optional :t, Integer
 
       # @!method initialize(signal: nil, t: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::ContainerStopParams} for more details.
-      #
-      #   @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 signal [String]
+      #   @param t [Integer]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/container_top_params.rb

@@ -8,14 +8,12 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute ps_args
-      #   The arguments to pass to `ps`. For example, `aux`
       #
       #   @return [String, nil]
       optional :ps_args, String
 
       # @!method initialize(ps_args: nil, request_options: {})
-      #   @param ps_args [String] The arguments to pass to `ps`. For example, `aux`
-      #
+      #   @param ps_args [String]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end