docker-engine-ruby 0.2.2 → 0.3.0

data/lib/docker_engine_ruby/resources/swarm.rb

@@ -3,22 +3,19 @@
 module DockerEngineRuby
   module Resources
     class Swarm
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::SwarmUpdateParams} for more details.
-      #
       # Update a swarm
       #
       # @overload update(version:, spec:, rotate_manager_token: nil, rotate_manager_unlock_key: nil, rotate_worker_token: nil, request_options: {})
       #
-      # @param version [Integer] Query param: The version number of the swarm object being updated. This is
+      # @param version [Integer] Query param
       #
       # @param spec [DockerEngineRuby::Models::Spec] Body param: User modifiable swarm configuration.
       #
-      # @param rotate_manager_token [Boolean] Query param: Rotate the manager join token.
+      # @param rotate_manager_token [Boolean] Query param
       #
-      # @param rotate_manager_unlock_key [Boolean] Query param: Rotate the manager unlock key.
+      # @param rotate_manager_unlock_key [Boolean] Query param
       #
-      # @param rotate_worker_token [Boolean] Query param: Rotate the worker join token.
+      # @param rotate_worker_token [Boolean] Query param
       #
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -41,28 +38,25 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::SwarmInitParams} for more details.
-      #
       # Initialize a new swarm
       #
       # @overload init(advertise_addr: nil, data_path_addr: nil, data_path_port: nil, default_addr_pool: nil, force_new_cluster: nil, listen_addr: nil, spec: nil, subnet_size: nil, request_options: {})
       #
-      # @param advertise_addr [String] Externally reachable address advertised to other nodes. This
+      # @param advertise_addr [String]
       #
-      # @param data_path_addr [String] Address or interface to use for data path traffic (format:
+      # @param data_path_addr [String]
       #
-      # @param data_path_port [Integer] DataPathPort specifies the data path port number for data traffic.
+      # @param data_path_port [Integer]
       #
-      # @param default_addr_pool [Array<String>] Default Address Pool specifies default subnet pools for global
+      # @param default_addr_pool [Array<String>]
       #
-      # @param force_new_cluster [Boolean] Force creation of a new swarm.
+      # @param force_new_cluster [Boolean]
       #
-      # @param listen_addr [String] Listen address used for inter-manager communication, as well
+      # @param listen_addr [String]
       #
       # @param spec [DockerEngineRuby::Models::Spec] User modifiable swarm configuration.
       #
-      # @param subnet_size [Integer] SubnetSize specifies the subnet size of the networks created
+      # @param subnet_size [Integer]
       #
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -71,7 +65,14 @@ module DockerEngineRuby
       # @see DockerEngineRuby::Models::SwarmInitParams
       def init(params = {})
         parsed, options = DockerEngineRuby::SwarmInitParams.dump_request(params)
-        @client.request(method: :post, path: "swarm/init", body: parsed, model: String, options: options)
+        @client.request(
+          method: :post,
+          path: "swarm/init",
+          headers: {"accept" => "text/plain"},
+          body: parsed,
+          model: String,
+          options: options
+        )
       end
 
       # Inspect swarm
@@ -92,23 +93,15 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::SwarmJoinParams} for more details.
-      #
       # Join an existing swarm
       #
       # @overload join(advertise_addr: nil, data_path_addr: nil, join_token: nil, listen_addr: nil, remote_addrs: nil, request_options: {})
       #
-      # @param advertise_addr [String] Externally reachable address advertised to other nodes. This
-      #
-      # @param data_path_addr [String] Address or interface to use for data path traffic (format:
-      #
-      # @param join_token [String] Secret token for joining this swarm.
-      #
-      # @param listen_addr [String] Listen address used for inter-manager communication if the node
-      #
-      # @param remote_addrs [Array<String>] Addresses of manager nodes already participating in the swarm.
-      #
+      # @param advertise_addr [String]
+      # @param data_path_addr [String]
+      # @param join_token [String]
+      # @param listen_addr [String]
+      # @param remote_addrs [Array<String>]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -119,15 +112,11 @@ module DockerEngineRuby
         @client.request(method: :post, path: "swarm/join", body: parsed, model: NilClass, options: options)
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::SwarmLeaveParams} for more details.
-      #
       # Leave a swarm
       #
       # @overload leave(force: nil, request_options: {})
       #
-      # @param force [Boolean] Force leave swarm, even if this is the last manager or that it will
-      #
+      # @param force [Boolean]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -142,8 +131,7 @@ module DockerEngineRuby
       #
       # @overload unlock(unlock_key: nil, request_options: {})
       #
-      # @param unlock_key [String] The swarm's unlock key.
-      #
+      # @param unlock_key [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]

data/lib/docker_engine_ruby/resources/system.rb

@@ -3,17 +3,12 @@
 module DockerEngineRuby
   module Resources
     class System
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::SystemDataUsageParams} for more details.
-      #
       # Get data usage information
       #
       # @overload data_usage(type: nil, verbose: nil, request_options: {})
       #
-      # @param type [Array<Symbol, DockerEngineRuby::Models::SystemDataUsageParams::Type>] Object types, for which to compute and return data.
-      #
-      # @param verbose [Boolean] Show detailed information on space usage.
-      #
+      # @param type [Symbol, Array<Symbol, DockerEngineRuby::Models::SystemDataUsageParams::Type::UnionMember1>, DockerEngineRuby::Models::SystemDataUsageParams::Type]
+      # @param verbose [Boolean]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::SystemDataUsageResponse]
@@ -30,47 +25,13 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::SystemEventsParams} for more details.
-      #
-      # Stream real-time events from the server.
-      #
-      # Various objects within Docker report events when something happens to them.
-      #
-      # Containers report these events: `attach`, `commit`, `copy`, `create`, `destroy`,
-      # `detach`, `die`, `exec_create`, `exec_detach`, `exec_start`, `exec_die`,
-      # `export`, `health_status`, `kill`, `oom`, `pause`, `rename`, `resize`,
-      # `restart`, `start`, `stop`, `top`, `unpause`, `update`, and `prune`
-      #
-      # Images report these events: `create`, `delete`, `import`, `load`, `pull`,
-      # `push`, `save`, `tag`, `untag`, and `prune`
-      #
-      # Volumes report these events: `create`, `mount`, `unmount`, `destroy`, and
-      # `prune`
-      #
-      # Networks report these events: `create`, `connect`, `disconnect`, `destroy`,
-      # `update`, `remove`, and `prune`
-      #
-      # The Docker daemon reports these events: `reload`
-      #
-      # Services report these events: `create`, `update`, and `remove`
-      #
-      # Nodes report these events: `create`, `update`, and `remove`
-      #
-      # Secrets report these events: `create`, `update`, and `remove`
-      #
-      # Configs report these events: `create`, `update`, and `remove`
-      #
-      # The Builder reports `prune` events
+      # Monitor events
       #
       # @overload events(filters: nil, since: nil, until_: nil, request_options: {})
       #
-      # @param filters [String] A JSON encoded value of filters (a `map[string][]string`) to process on the even
-      #
-      # @param since [String] Show events created since this timestamp then stream new events.
-      #
-      # @param until_ [String] Show events created until this timestamp then stop streaming.
-      #
+      # @param filters [String]
+      # @param since [String]
+      # @param until_ [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::SystemEventsResponse]
@@ -82,7 +43,6 @@ module DockerEngineRuby
           method: :get,
           path: "events",
           query: parsed.transform_keys(until_: "until"),
-          headers: {"accept" => "application/json-seq"},
           model: DockerEngineRuby::Models::SystemEventsResponse,
           options: options
         )
@@ -106,7 +66,7 @@ module DockerEngineRuby
         )
       end
 
-      # This is a dummy endpoint you can use to test if the server is accessible.
+      # Ping
       #
       # @overload ping(request_options: {})
       #
@@ -125,8 +85,7 @@ module DockerEngineRuby
         )
       end
 
-      # Returns the version of Docker that is running and various information about the
-      # system that Docker is running on.
+      # Get version
       #
       # @overload version(request_options: {})
       #

data/lib/docker_engine_ruby/resources/tasks.rb

@@ -3,15 +3,11 @@
 module DockerEngineRuby
   module Resources
     class Tasks
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::TaskListParams} for more details.
-      #
       # List tasks
       #
       # @overload list(filters: nil, request_options: {})
       #
-      # @param filters [String] A JSON encoded value of the filters (a `map[string][]string`) to
-      #
+      # @param filters [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Array<DockerEngineRuby::Models::Task>]
@@ -32,8 +28,7 @@ module DockerEngineRuby
       #
       # @overload inspect_(id, request_options: {})
       #
-      # @param id [String] ID of the task
-      #
+      # @param id [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::Task]
@@ -48,33 +43,18 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::TaskLogsParams} for more details.
-      #
-      # Get `stdout` and `stderr` logs from a task. See also
-      # [`/containers/{id}/logs`](#operation/ContainerLogs).
-      #
-      # **Note**: This endpoint works only for services with the `local`, `json-file` or
-      # `journald` logging drivers.
+      # Get task logs
       #
       # @overload logs(id, details: nil, follow: nil, since: nil, stderr: nil, stdout: nil, tail: nil, timestamps: nil, request_options: {})
       #
-      # @param id [String] ID of the task
-      #
-      # @param details [Boolean] Show task context and extra details provided to logs.
-      #
-      # @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 id [String]
+      # @param details [Boolean]
+      # @param follow [Boolean]
+      # @param since [Integer]
+      # @param stderr [Boolean]
+      # @param stdout [Boolean]
+      # @param tail [String]
+      # @param timestamps [Boolean]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [StringIO]
@@ -86,7 +66,7 @@ module DockerEngineRuby
           method: :get,
           path: ["tasks/%1$s/logs", id],
           query: parsed,
-          headers: {"accept" => "application/vnd.docker.multiplexed-stream"},
+          headers: {"accept" => "application/octet-stream"},
           model: StringIO,
           options: options
         )

data/lib/docker_engine_ruby/resources/volumes.rb

@@ -25,16 +25,13 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::VolumeUpdateParams} for more details.
-      #
       # "Update a volume. Valid only for Swarm cluster volumes"
       #
       # @overload update(name, version:, spec: nil, request_options: {})
       #
-      # @param name [String] Path param: The name or ID of the volume
+      # @param name [String] Path param
       #
-      # @param version [Integer] Query param: The version number of the volume being updated. This is required to
+      # @param version [Integer] Query param
       #
       # @param spec [DockerEngineRuby::Models::VolumeUpdateParams::Spec] Body param: Cluster-specific options used to create the volume.
       #
@@ -56,15 +53,11 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::VolumeListParams} for more details.
-      #
       # List volumes
       #
       # @overload list(filters: nil, request_options: {})
       #
-      # @param filters [String] JSON encoded value of the filters (a `map[string][]string`) to
-      #
+      # @param filters [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::ListResponse]
@@ -81,14 +74,12 @@ module DockerEngineRuby
         )
       end
 
-      # Instruct the driver to remove the volume.
+      # Remove a volume
       #
       # @overload delete(name, force: nil, request_options: {})
       #
-      # @param name [String] Volume name or ID
-      #
-      # @param force [Boolean] Force the removal of the volume
-      #
+      # @param name [String]
+      # @param force [Boolean]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -109,8 +100,7 @@ module DockerEngineRuby
       #
       # @overload inspect_(name, request_options: {})
       #
-      # @param name [String] Volume name or ID
-      #
+      # @param name [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::Volume]
@@ -125,15 +115,11 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::VolumePruneParams} for more details.
-      #
       # Delete unused volumes
       #
       # @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::VolumePruneResponse]

data/lib/docker_engine_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DockerEngineRuby
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/rbi/docker_engine_ruby/models/config.rbi

@@ -70,7 +70,7 @@ module DockerEngineRuby
       # An object mapping ports to an empty object in the form:
       #
       # `{"<port>/<tcp|udp|sctp>": {}}`
-      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      sig { returns(T.nilable(T::Hash[Symbol, T::Hash[Symbol, T.anything]])) }
       attr_accessor :exposed_ports
 
       # A test to perform to check that the container is healthy. Healthcheck commands
@@ -158,10 +158,10 @@ module DockerEngineRuby
       attr_writer :user
 
       # An object mapping mount point paths inside the container to empty objects.
-      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      sig { returns(T.nilable(T::Hash[Symbol, T::Hash[Symbol, T.anything]])) }
       attr_reader :volumes
 
-      sig { params(volumes: T::Hash[Symbol, T.anything]).void }
+      sig { params(volumes: T::Hash[Symbol, T::Hash[Symbol, T.anything]]).void }
       attr_writer :volumes
 
       # The working directory for commands to run in.
@@ -182,7 +182,8 @@ module DockerEngineRuby
           domainname: String,
           entrypoint: T::Array[String],
           env: T::Array[String],
-          exposed_ports: T.nilable(T::Hash[Symbol, T.anything]),
+          exposed_ports:
+            T.nilable(T::Hash[Symbol, T::Hash[Symbol, T.anything]]),
           healthcheck: DockerEngineRuby::Config::Healthcheck::OrHash,
           hostname: String,
           image: String,
@@ -196,7 +197,7 @@ module DockerEngineRuby
           stop_timeout: T.nilable(Integer),
           tty: T::Boolean,
           user: String,
-          volumes: T::Hash[Symbol, T.anything],
+          volumes: T::Hash[Symbol, T::Hash[Symbol, T.anything]],
           working_dir: String
         ).returns(T.attached_class)
       end
@@ -277,7 +278,8 @@ module DockerEngineRuby
             domainname: String,
             entrypoint: T::Array[String],
             env: T::Array[String],
-            exposed_ports: T.nilable(T::Hash[Symbol, T.anything]),
+            exposed_ports:
+              T.nilable(T::Hash[Symbol, T::Hash[Symbol, T.anything]]),
             healthcheck: DockerEngineRuby::Config::Healthcheck,
             hostname: String,
             image: String,
@@ -291,7 +293,7 @@ module DockerEngineRuby
             stop_timeout: T.nilable(Integer),
             tty: T::Boolean,
             user: String,
-            volumes: T::Hash[Symbol, T.anything],
+            volumes: T::Hash[Symbol, T::Hash[Symbol, T.anything]],
             working_dir: String
           }
         )

data/rbi/docker_engine_ruby/models/config_create_params.rbi

@@ -14,51 +14,19 @@ module DockerEngineRuby
           )
         end
 
-      sig { returns(T.nilable(DockerEngineRuby::ConfigCreateParams::Spec)) }
-      attr_reader :spec
-
-      sig do
-        params(spec: DockerEngineRuby::ConfigCreateParams::Spec::OrHash).void
-      end
-      attr_writer :spec
-
       sig do
         params(
-          spec: DockerEngineRuby::ConfigCreateParams::Spec::OrHash,
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(spec: nil, request_options: {})
+      def self.new(request_options: {})
       end
 
       sig do
-        override.returns(
-          {
-            spec: DockerEngineRuby::ConfigCreateParams::Spec,
-            request_options: DockerEngineRuby::RequestOptions
-          }
-        )
+        override.returns({ request_options: DockerEngineRuby::RequestOptions })
       end
       def to_hash
       end
-
-      class Spec < DockerEngineRuby::Models::Spec
-        OrHash =
-          T.type_alias do
-            T.any(
-              DockerEngineRuby::ConfigCreateParams::Spec,
-              DockerEngineRuby::Internal::AnyHash
-            )
-          end
-
-        sig { returns(T.attached_class) }
-        def self.new
-        end
-
-        sig { override.returns({}) }
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/docker_engine_ruby/models/config_list_params.rbi

@@ -14,15 +14,6 @@ module DockerEngineRuby
           )
         end
 
-      # A JSON encoded value of the filters (a `map[string][]string`) to process on the
-      # configs list.
-      #
-      # Available filters:
-      #
-      # - `id=<config id>`
-      # - `label=<key> or label=<key>=value`
-      # - `name=<config name>`
-      # - `names=<config name>`
       sig { returns(T.nilable(String)) }
       attr_reader :filters
 
@@ -35,19 +26,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # A JSON encoded value of the filters (a `map[string][]string`) to process on the
-        # configs list.
-        #
-        # Available filters:
-        #
-        # - `id=<config id>`
-        # - `label=<key> or label=<key>=value`
-        # - `name=<config name>`
-        # - `names=<config name>`
-        filters: nil,
-        request_options: {}
-      )
+      def self.new(filters: nil, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/config_update_params.rbi

@@ -14,8 +14,6 @@ module DockerEngineRuby
           )
         end
 
-      # The version number of the config object being updated. This is required to avoid
-      # conflicting writes.
       sig { returns(Integer) }
       attr_accessor :version
 
@@ -25,12 +23,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # The version number of the config object being updated. This is required to avoid
-        # conflicting writes.
-        version:,
-        request_options: {}
-      )
+      def self.new(version:, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/connect_request.rbi

@@ -24,7 +24,7 @@ module DockerEngineRuby
       sig do
         params(
           endpoint_config:
-            DockerEngineRuby::ConnectRequest::EndpointConfig::OrHash
+            T.nilable(DockerEngineRuby::ConnectRequest::EndpointConfig::OrHash)
         ).void
       end
       attr_writer :endpoint_config
@@ -35,7 +35,7 @@ module DockerEngineRuby
         params(
           container: String,
           endpoint_config:
-            DockerEngineRuby::ConnectRequest::EndpointConfig::OrHash
+            T.nilable(DockerEngineRuby::ConnectRequest::EndpointConfig::OrHash)
         ).returns(T.attached_class)
       end
       def self.new(
@@ -50,7 +50,8 @@ module DockerEngineRuby
         override.returns(
           {
             container: String,
-            endpoint_config: DockerEngineRuby::ConnectRequest::EndpointConfig
+            endpoint_config:
+              T.nilable(DockerEngineRuby::ConnectRequest::EndpointConfig)
           }
         )
       end
@@ -148,9 +149,7 @@ module DockerEngineRuby
         sig do
           params(
             ipam_config:
-              T.nilable(
-                DockerEngineRuby::ConnectRequest::EndpointConfig::IpamConfig::OrHash
-              )
+              DockerEngineRuby::ConnectRequest::EndpointConfig::IpamConfig::OrHash
           ).void
         end
         attr_writer :ipam_config
@@ -203,9 +202,7 @@ module DockerEngineRuby
             gw_priority: Integer,
             ip_address: String,
             ipam_config:
-              T.nilable(
-                DockerEngineRuby::ConnectRequest::EndpointConfig::IpamConfig::OrHash
-              ),
+              DockerEngineRuby::ConnectRequest::EndpointConfig::IpamConfig::OrHash,
             ip_prefix_len: Integer,
             i_pv6_gateway: String,
             links: T::Array[String],
@@ -269,9 +266,7 @@ module DockerEngineRuby
               gw_priority: Integer,
               ip_address: String,
               ipam_config:
-                T.nilable(
-                  DockerEngineRuby::ConnectRequest::EndpointConfig::IpamConfig
-                ),
+                DockerEngineRuby::ConnectRequest::EndpointConfig::IpamConfig,
               ip_prefix_len: Integer,
               i_pv6_gateway: String,
               links: T::Array[String],