docker-engine-ruby 0.2.2 → 0.3.0

data/rbi/docker_engine_ruby/models/container_delete_params.rbi

@@ -14,21 +14,18 @@ module DockerEngineRuby
           )
         end
 
-      # If the container is running, kill it before removing it.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :force
 
       sig { params(force: T::Boolean).void }
       attr_writer :force
 
-      # Remove the specified link associated with the container.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :link
 
       sig { params(link: T::Boolean).void }
       attr_writer :link
 
-      # Remove anonymous volumes associated with the container.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :v
 
@@ -43,15 +40,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # If the container is running, kill it before removing it.
-        force: nil,
-        # Remove the specified link associated with the container.
-        link: nil,
-        # Remove anonymous volumes associated with the container.
-        v: nil,
-        request_options: {}
-      )
+      def self.new(force: nil, link: nil, v: nil, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/container_exec_params.rbi

@@ -14,77 +14,63 @@ module DockerEngineRuby
           )
         end
 
-      # Attach to `stderr` of the exec command.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :attach_stderr
 
       sig { params(attach_stderr: T::Boolean).void }
       attr_writer :attach_stderr
 
-      # Attach to `stdin` of the exec command.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :attach_stdin
 
       sig { params(attach_stdin: T::Boolean).void }
       attr_writer :attach_stdin
 
-      # Attach to `stdout` of the exec command.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :attach_stdout
 
       sig { params(attach_stdout: T::Boolean).void }
       attr_writer :attach_stdout
 
-      # Command to run, as a string or array of strings.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :cmd
 
       sig { params(cmd: T::Array[String]).void }
       attr_writer :cmd
 
-      # Initial console size, as an `[height, width]` array.
       sig { returns(T.nilable(T::Array[Integer])) }
       attr_accessor :console_size
 
-      # 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 `_`.
       sig { returns(T.nilable(String)) }
       attr_reader :detach_keys
 
       sig { params(detach_keys: String).void }
       attr_writer :detach_keys
 
-      # A list of environment variables in the form `["VAR=value", ...]`.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :env
 
       sig { params(env: T::Array[String]).void }
       attr_writer :env
 
-      # Runs the exec process with extended privileges.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :privileged
 
       sig { params(privileged: T::Boolean).void }
       attr_writer :privileged
 
-      # Allocate a pseudo-TTY.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :tty
 
       sig { params(tty: T::Boolean).void }
       attr_writer :tty
 
-      # The user, and optionally, group to run the exec process inside the container.
-      # Format is one of: `user`, `user:group`, `uid`, or `uid:gid`.
       sig { returns(T.nilable(String)) }
       attr_reader :user
 
       sig { params(user: String).void }
       attr_writer :user
 
-      # The working directory for the exec process inside the container.
       sig { returns(T.nilable(String)) }
       attr_reader :working_dir
 
@@ -108,30 +94,16 @@ module DockerEngineRuby
         ).returns(T.attached_class)
       end
       def self.new(
-        # Attach to `stderr` of the exec command.
         attach_stderr: nil,
-        # Attach to `stdin` of the exec command.
         attach_stdin: nil,
-        # Attach to `stdout` of the exec command.
         attach_stdout: nil,
-        # Command to run, as a string or array of strings.
         cmd: nil,
-        # Initial console size, as an `[height, width]` array.
         console_size: nil,
-        # 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 `_`.
         detach_keys: nil,
-        # A list of environment variables in the form `["VAR=value", ...]`.
         env: nil,
-        # Runs the exec process with extended privileges.
         privileged: nil,
-        # Allocate a pseudo-TTY.
         tty: nil,
-        # The user, and optionally, group to run the exec process inside the container.
-        # Format is one of: `user`, `user:group`, `uid`, or `uid:gid`.
         user: nil,
-        # The working directory for the exec process inside the container.
         working_dir: nil,
         request_options: {}
       )

data/rbi/docker_engine_ruby/models/container_inspect_params.rbi

@@ -14,7 +14,6 @@ module DockerEngineRuby
           )
         end
 
-      # Return the size of container as fields `SizeRw` and `SizeRootFs`
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :size
 
@@ -27,11 +26,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # Return the size of container as fields `SizeRw` and `SizeRootFs`
-        size: nil,
-        request_options: {}
-      )
+      def self.new(size: nil, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/container_kill_params.rbi

@@ -14,7 +14,6 @@ module DockerEngineRuby
           )
         end
 
-      # Signal to send to the container as an integer or string (e.g. `SIGINT`).
       sig { returns(T.nilable(String)) }
       attr_reader :signal
 
@@ -27,11 +26,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # Signal to send to the container as an integer or string (e.g. `SIGINT`).
-        signal: nil,
-        request_options: {}
-      )
+      def self.new(signal: nil, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/container_list_params.rbi

@@ -14,49 +14,24 @@ module DockerEngineRuby
           )
         end
 
-      # Return all containers. By default, only running containers are shown.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :all
 
       sig { params(all: T::Boolean).void }
       attr_writer :all
 
-      # 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>`)
       sig { returns(T.nilable(String)) }
       attr_reader :filters
 
       sig { params(filters: String).void }
       attr_writer :filters
 
-      # Return this number of most recently created containers, including non-running
-      # ones.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
       sig { params(limit: Integer).void }
       attr_writer :limit
 
-      # Return the size of container as fields `SizeRw` and `SizeRootFs`.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :size
 
@@ -73,34 +48,9 @@ module DockerEngineRuby
         ).returns(T.attached_class)
       end
       def self.new(
-        # Return all containers. By default, only running containers are shown.
         all: nil,
-        # 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>`)
         filters: nil,
-        # Return this number of most recently created containers, including non-running
-        # ones.
         limit: nil,
-        # Return the size of container as fields `SizeRw` and `SizeRootFs`.
         size: nil,
         request_options: {}
       )

data/rbi/docker_engine_ruby/models/container_logs_params.rbi

@@ -14,50 +14,42 @@ module DockerEngineRuby
           )
         end
 
-      # Keep connection after returning logs.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :follow
 
       sig { params(follow: T::Boolean).void }
       attr_writer :follow
 
-      # Only return logs since this time, as a UNIX timestamp
       sig { returns(T.nilable(Integer)) }
       attr_reader :since
 
       sig { params(since: Integer).void }
       attr_writer :since
 
-      # Return logs from `stderr`
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :stderr
 
       sig { params(stderr: T::Boolean).void }
       attr_writer :stderr
 
-      # Return logs from `stdout`
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :stdout
 
       sig { params(stdout: T::Boolean).void }
       attr_writer :stdout
 
-      # Only return this number of log lines from the end of the logs. Specify as an
-      # integer or `all` to output all log lines.
       sig { returns(T.nilable(String)) }
       attr_reader :tail
 
       sig { params(tail: String).void }
       attr_writer :tail
 
-      # Add timestamps to every log line
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :timestamps
 
       sig { params(timestamps: T::Boolean).void }
       attr_writer :timestamps
 
-      # Only return logs before this time, as a UNIX timestamp
       sig { returns(T.nilable(Integer)) }
       attr_reader :until_
 
@@ -77,20 +69,12 @@ module DockerEngineRuby
         ).returns(T.attached_class)
       end
       def self.new(
-        # Keep connection after returning logs.
         follow: nil,
-        # Only return logs since this time, as a UNIX timestamp
         since: nil,
-        # Return logs from `stderr`
         stderr: nil,
-        # Return logs from `stdout`
         stdout: nil,
-        # Only return this number of log lines from the end of the logs. Specify as an
-        # integer or `all` to output all log lines.
         tail: nil,
-        # Add timestamps to every log line
         timestamps: nil,
-        # Only return logs before this time, as a UNIX timestamp
         until_: nil,
         request_options: {}
       )

data/rbi/docker_engine_ruby/models/container_prune_params.rbi

@@ -14,17 +14,6 @@ module DockerEngineRuby
           )
         end
 
-      # 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.
       sig { returns(T.nilable(String)) }
       attr_reader :filters
 
@@ -37,21 +26,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # 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.
-        filters: nil,
-        request_options: {}
-      )
+      def self.new(filters: nil, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/container_prune_response.rbi

@@ -11,14 +11,12 @@ module DockerEngineRuby
           )
         end
 
-      # Container IDs that were deleted
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :containers_deleted
 
       sig { params(containers_deleted: T::Array[String]).void }
       attr_writer :containers_deleted
 
-      # Disk space reclaimed in bytes
       sig { returns(T.nilable(Integer)) }
       attr_reader :space_reclaimed
 
@@ -31,12 +29,7 @@ module DockerEngineRuby
           space_reclaimed: Integer
         ).returns(T.attached_class)
       end
-      def self.new(
-        # Container IDs that were deleted
-        containers_deleted: nil,
-        # Disk space reclaimed in bytes
-        space_reclaimed: nil
-      )
+      def self.new(containers_deleted: nil, space_reclaimed: nil)
       end
 
       sig do

data/rbi/docker_engine_ruby/models/container_rename_params.rbi

@@ -14,7 +14,6 @@ module DockerEngineRuby
           )
         end
 
-      # New name for the container
       sig { returns(String) }
       attr_accessor :name
 
@@ -24,11 +23,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # New name for the container
-        name:,
-        request_options: {}
-      )
+      def self.new(name:, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/container_resize_params.rbi

@@ -14,11 +14,9 @@ module DockerEngineRuby
           )
         end
 
-      # Height of the TTY session in characters
       sig { returns(Integer) }
       attr_accessor :h
 
-      # Width of the TTY session in characters
       sig { returns(Integer) }
       attr_accessor :w
 
@@ -29,13 +27,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # Height of the TTY session in characters
-        h:,
-        # Width of the TTY session in characters
-        w:,
-        request_options: {}
-      )
+      def self.new(h:, w:, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/container_restart_params.rbi

@@ -14,14 +14,12 @@ module DockerEngineRuby
           )
         end
 
-      # Signal to send to the container as an integer or string (e.g. `SIGINT`).
       sig { returns(T.nilable(String)) }
       attr_reader :signal
 
       sig { params(signal: String).void }
       attr_writer :signal
 
-      # Number of seconds to wait before killing the container
       sig { returns(T.nilable(Integer)) }
       attr_reader :t
 
@@ -35,13 +33,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # Signal to send to the container as an integer or string (e.g. `SIGINT`).
-        signal: nil,
-        # Number of seconds to wait before killing the container
-        t: nil,
-        request_options: {}
-      )
+      def self.new(signal: nil, t: nil, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/container_start_params.rbi

@@ -14,9 +14,6 @@ module DockerEngineRuby
           )
         end
 
-      # 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 `_`.
       sig { returns(T.nilable(String)) }
       attr_reader :detach_keys
 
@@ -29,13 +26,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # 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 `_`.
-        detach_keys: nil,
-        request_options: {}
-      )
+      def self.new(detach_keys: nil, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/container_stats_params.rbi

@@ -14,16 +14,12 @@ module DockerEngineRuby
           )
         end
 
-      # Only get a single stat instead of waiting for 2 cycles. Must be used with
-      # `stream=false`.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :one_shot
 
       sig { params(one_shot: T::Boolean).void }
       attr_writer :one_shot
 
-      # Stream the output. If false, the stats will be output once and then it will
-      # disconnect.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :stream
 
@@ -37,15 +33,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # Only get a single stat instead of waiting for 2 cycles. Must be used with
-        # `stream=false`.
-        one_shot: nil,
-        # Stream the output. If false, the stats will be output once and then it will
-        # disconnect.
-        stream: nil,
-        request_options: {}
-      )
+      def self.new(one_shot: nil, stream: nil, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/container_stop_params.rbi

@@ -14,14 +14,12 @@ module DockerEngineRuby
           )
         end
 
-      # Signal to send to the container as an integer or string (e.g. `SIGINT`).
       sig { returns(T.nilable(String)) }
       attr_reader :signal
 
       sig { params(signal: String).void }
       attr_writer :signal
 
-      # Number of seconds to wait before killing the container
       sig { returns(T.nilable(Integer)) }
       attr_reader :t
 
@@ -35,13 +33,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # Signal to send to the container as an integer or string (e.g. `SIGINT`).
-        signal: nil,
-        # Number of seconds to wait before killing the container
-        t: nil,
-        request_options: {}
-      )
+      def self.new(signal: nil, t: nil, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/container_top_params.rbi

@@ -14,7 +14,6 @@ module DockerEngineRuby
           )
         end
 
-      # The arguments to pass to `ps`. For example, `aux`
       sig { returns(T.nilable(String)) }
       attr_reader :ps_args
 
@@ -27,11 +26,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # The arguments to pass to `ps`. For example, `aux`
-        ps_args: nil,
-        request_options: {}
-      )
+      def self.new(ps_args: nil, request_options: {})
       end
 
       sig do