docker-engine-ruby 0.2.2 → 0.4.0

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_list_response.rbi

@@ -4,7 +4,9 @@ module DockerEngineRuby
   module Models
     ConfigListResponse =
       T.let(
-        DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Config],
+        DockerEngineRuby::Internal::Type::ArrayOf[
+          DockerEngineRuby::ConfigObject
+        ],
         DockerEngineRuby::Internal::Type::Converter
       )
   end

data/rbi/docker_engine_ruby/models/config_object.rbi

@@ -0,0 +1,130 @@
+# typed: strong
+
+module DockerEngineRuby
+  module Models
+    class ConfigObject < DockerEngineRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineRuby::ConfigObject,
+            DockerEngineRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_at
+
+      sig { params(created_at: Time).void }
+      attr_writer :created_at
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      sig { returns(T.nilable(DockerEngineRuby::ConfigSpec)) }
+      attr_reader :spec
+
+      sig { params(spec: DockerEngineRuby::ConfigSpec::OrHash).void }
+      attr_writer :spec
+
+      sig { returns(T.nilable(Time)) }
+      attr_reader :updated_at
+
+      sig { params(updated_at: Time).void }
+      attr_writer :updated_at
+
+      # The version number of the object such as node, service, etc. This is needed to
+      # avoid conflicting writes. The client must send the version number along with the
+      # modified specification when updating these objects.
+      #
+      # This approach ensures safe concurrency and determinism in that the change on the
+      # object may not be applied if the version number has changed from the last read.
+      # In other words, if two update requests specify the same base version, only one
+      # of the requests can succeed. As a result, two separate update requests that
+      # happen at the same time will not unintentionally overwrite each other.
+      sig { returns(T.nilable(DockerEngineRuby::ConfigObject::Version)) }
+      attr_reader :version
+
+      sig do
+        params(version: DockerEngineRuby::ConfigObject::Version::OrHash).void
+      end
+      attr_writer :version
+
+      sig do
+        params(
+          created_at: Time,
+          id: String,
+          spec: DockerEngineRuby::ConfigSpec::OrHash,
+          updated_at: Time,
+          version: DockerEngineRuby::ConfigObject::Version::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        created_at: nil,
+        id: nil,
+        spec: nil,
+        updated_at: nil,
+        # The version number of the object such as node, service, etc. This is needed to
+        # avoid conflicting writes. The client must send the version number along with the
+        # modified specification when updating these objects.
+        #
+        # This approach ensures safe concurrency and determinism in that the change on the
+        # object may not be applied if the version number has changed from the last read.
+        # In other words, if two update requests specify the same base version, only one
+        # of the requests can succeed. As a result, two separate update requests that
+        # happen at the same time will not unintentionally overwrite each other.
+        version: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            created_at: Time,
+            id: String,
+            spec: DockerEngineRuby::ConfigSpec,
+            updated_at: Time,
+            version: DockerEngineRuby::ConfigObject::Version
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Version < DockerEngineRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              DockerEngineRuby::ConfigObject::Version,
+              DockerEngineRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :index
+
+        sig { params(index: Integer).void }
+        attr_writer :index
+
+        # The version number of the object such as node, service, etc. This is needed to
+        # avoid conflicting writes. The client must send the version number along with the
+        # modified specification when updating these objects.
+        #
+        # This approach ensures safe concurrency and determinism in that the change on the
+        # object may not be applied if the version number has changed from the last read.
+        # In other words, if two update requests specify the same base version, only one
+        # of the requests can succeed. As a result, two separate update requests that
+        # happen at the same time will not unintentionally overwrite each other.
+        sig { params(index: Integer).returns(T.attached_class) }
+        def self.new(index: nil)
+        end
+
+        sig { override.returns({ index: Integer }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/docker_engine_ruby/models/config_spec.rbi

@@ -0,0 +1,127 @@
+# typed: strong
+
+module DockerEngineRuby
+  module Models
+    class ConfigSpec < DockerEngineRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineRuby::ConfigSpec,
+            DockerEngineRuby::Internal::AnyHash
+          )
+        end
+
+      # Data is the data to store as a config, formatted as a standard base64-encoded
+      # ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-4)) string. The maximum
+      # allowed size is 1000KB, as defined in
+      # [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2
+      sig { returns(T.nilable(String)) }
+      attr_reader :data
+
+      sig { params(data: String).void }
+      attr_writer :data
+
+      # User-defined key/value metadata.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :labels
+
+      sig { params(labels: T::Hash[Symbol, String]).void }
+      attr_writer :labels
+
+      # User-defined name of the config.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # Driver represents a driver (network, logging, secrets).
+      sig { returns(T.nilable(DockerEngineRuby::ConfigSpec::Templating)) }
+      attr_reader :templating
+
+      sig do
+        params(
+          templating: DockerEngineRuby::ConfigSpec::Templating::OrHash
+        ).void
+      end
+      attr_writer :templating
+
+      sig do
+        params(
+          data: String,
+          labels: T::Hash[Symbol, String],
+          name: String,
+          templating: DockerEngineRuby::ConfigSpec::Templating::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Data is the data to store as a config, formatted as a standard base64-encoded
+        # ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-4)) string. The maximum
+        # allowed size is 1000KB, as defined in
+        # [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2
+        data: nil,
+        # User-defined key/value metadata.
+        labels: nil,
+        # User-defined name of the config.
+        name: nil,
+        # Driver represents a driver (network, logging, secrets).
+        templating: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: String,
+            labels: T::Hash[Symbol, String],
+            name: String,
+            templating: DockerEngineRuby::ConfigSpec::Templating
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Templating < DockerEngineRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              DockerEngineRuby::ConfigSpec::Templating,
+              DockerEngineRuby::Internal::AnyHash
+            )
+          end
+
+        # Name of the driver.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # Key/value map of driver-specific options.
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_reader :options
+
+        sig { params(options: T::Hash[Symbol, String]).void }
+        attr_writer :options
+
+        # Driver represents a driver (network, logging, secrets).
+        sig do
+          params(name: String, options: T::Hash[Symbol, String]).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Name of the driver.
+          name:,
+          # Key/value map of driver-specific options.
+          options: nil
+        )
+        end
+
+        sig do
+          override.returns({ name: String, options: T::Hash[Symbol, String] })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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],