docker-engine-ruby 0.2.2 → 0.4.0

data/rbi/docker_engine_ruby/models/summary.rbi

@@ -89,7 +89,9 @@ module DockerEngineRuby
       sig do
         params(
           image_manifest_descriptor:
-            DockerEngineRuby::Summary::ImageManifestDescriptor::OrHash
+            T.nilable(
+              DockerEngineRuby::Summary::ImageManifestDescriptor::OrHash
+            )
         ).void
       end
       attr_writer :image_manifest_descriptor
@@ -179,7 +181,9 @@ module DockerEngineRuby
           image: String,
           image_id: String,
           image_manifest_descriptor:
-            DockerEngineRuby::Summary::ImageManifestDescriptor::OrHash,
+            T.nilable(
+              DockerEngineRuby::Summary::ImageManifestDescriptor::OrHash
+            ),
           labels: T::Hash[Symbol, String],
           mounts: T::Array[DockerEngineRuby::Summary::Mount::OrHash],
           names: T::Array[String],
@@ -271,7 +275,7 @@ module DockerEngineRuby
             image: String,
             image_id: String,
             image_manifest_descriptor:
-              DockerEngineRuby::Summary::ImageManifestDescriptor,
+              T.nilable(DockerEngineRuby::Summary::ImageManifestDescriptor),
             labels: T::Hash[Symbol, String],
             mounts: T::Array[DockerEngineRuby::Summary::Mount],
             names: T::Array[String],
@@ -296,14 +300,12 @@ module DockerEngineRuby
             )
           end
 
-        # FailingStreak is the number of consecutive failures
         sig { returns(T.nilable(Integer)) }
         attr_reader :failing_streak
 
         sig { params(failing_streak: Integer).void }
         attr_writer :failing_streak
 
-        # the health status of the container
         sig do
           returns(
             T.nilable(DockerEngineRuby::Summary::Health::Status::TaggedSymbol)
@@ -329,12 +331,7 @@ module DockerEngineRuby
             status: DockerEngineRuby::Summary::Health::Status::OrSymbol
           ).returns(T.attached_class)
         end
-        def self.new(
-          # FailingStreak is the number of consecutive failures
-          failing_streak: nil,
-          # the health status of the container
-          status: nil
-        )
+        def self.new(failing_streak: nil, status: nil)
         end
 
         sig do
@@ -348,7 +345,6 @@ module DockerEngineRuby
         def to_hash
         end
 
-        # the health status of the container
         module Status
           extend DockerEngineRuby::Internal::Type::Enum
 
@@ -398,16 +394,9 @@ module DockerEngineRuby
             )
           end
 
-        # Arbitrary key-value metadata attached to the container.
         sig { returns(T.nilable(T::Hash[Symbol, String])) }
         attr_accessor :annotations
 
-        # Networking mode (`host`, `none`, `container:<id>`) or name of the primary
-        # network the container is using.
-        #
-        # This field is primarily for backward compatibility. The container can be
-        # connected to multiple networks for which information can be found in the
-        # `NetworkSettings.Networks` field, which enumerates settings per network.
         sig { returns(T.nilable(String)) }
         attr_reader :network_mode
 
@@ -423,17 +412,7 @@ module DockerEngineRuby
             network_mode: String
           ).returns(T.attached_class)
         end
-        def self.new(
-          # Arbitrary key-value metadata attached to the container.
-          annotations: nil,
-          # Networking mode (`host`, `none`, `container:<id>`) or name of the primary
-          # network the container is using.
-          #
-          # This field is primarily for backward compatibility. The container can be
-          # connected to multiple networks for which information can be found in the
-          # `NetworkSettings.Networks` field, which enumerates settings per network.
-          network_mode: nil
-        )
+        def self.new(annotations: nil, network_mode: nil)
         end
 
         sig do
@@ -500,9 +479,7 @@ module DockerEngineRuby
         sig do
           params(
             platform:
-              T.nilable(
-                DockerEngineRuby::Summary::ImageManifestDescriptor::Platform::OrHash
-              )
+              DockerEngineRuby::Summary::ImageManifestDescriptor::Platform::OrHash
           ).void
         end
         attr_writer :platform
@@ -528,9 +505,7 @@ module DockerEngineRuby
             digest: String,
             media_type: String,
             platform:
-              T.nilable(
-                DockerEngineRuby::Summary::ImageManifestDescriptor::Platform::OrHash
-              ),
+              DockerEngineRuby::Summary::ImageManifestDescriptor::Platform::OrHash,
             size: Integer,
             urls: T.nilable(T::Array[String])
           ).returns(T.attached_class)
@@ -568,9 +543,7 @@ module DockerEngineRuby
               digest: String,
               media_type: String,
               platform:
-                T.nilable(
-                  DockerEngineRuby::Summary::ImageManifestDescriptor::Platform
-                ),
+                DockerEngineRuby::Summary::ImageManifestDescriptor::Platform,
               size: Integer,
               urls: T.nilable(T::Array[String])
             }
@@ -885,7 +858,6 @@ module DockerEngineRuby
             )
           end
 
-        # Summary of network-settings for each network the container is attached to.
         sig do
           returns(
             T.nilable(
@@ -919,10 +891,7 @@ module DockerEngineRuby
               ]
           ).returns(T.attached_class)
         end
-        def self.new(
-          # Summary of network-settings for each network the container is attached to.
-          networks: nil
-        )
+        def self.new(networks: nil)
         end
 
         sig do
@@ -1030,9 +999,7 @@ module DockerEngineRuby
           sig do
             params(
               ipam_config:
-                T.nilable(
-                  DockerEngineRuby::Summary::NetworkSettings::Network::IpamConfig::OrHash
-                )
+                DockerEngineRuby::Summary::NetworkSettings::Network::IpamConfig::OrHash
             ).void
           end
           attr_writer :ipam_config
@@ -1085,9 +1052,7 @@ module DockerEngineRuby
               gw_priority: Integer,
               ip_address: String,
               ipam_config:
-                T.nilable(
-                  DockerEngineRuby::Summary::NetworkSettings::Network::IpamConfig::OrHash
-                ),
+                DockerEngineRuby::Summary::NetworkSettings::Network::IpamConfig::OrHash,
               ip_prefix_len: Integer,
               i_pv6_gateway: String,
               links: T::Array[String],
@@ -1151,9 +1116,7 @@ module DockerEngineRuby
                 gw_priority: Integer,
                 ip_address: String,
                 ipam_config:
-                  T.nilable(
-                    DockerEngineRuby::Summary::NetworkSettings::Network::IpamConfig
-                  ),
+                  DockerEngineRuby::Summary::NetworkSettings::Network::IpamConfig,
                 ip_prefix_len: Integer,
                 i_pv6_gateway: String,
                 links: T::Array[String],

data/rbi/docker_engine_ruby/models/swarm.rbi

@@ -10,10 +10,10 @@ module DockerEngineRuby
 
       # Date and time at which the swarm was initialised in
       # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
-      sig { returns(T.nilable(String)) }
+      sig { returns(T.nilable(Time)) }
       attr_reader :created_at
 
-      sig { params(created_at: String).void }
+      sig { params(created_at: Time).void }
       attr_writer :created_at
 
       # DataPathPort specifies the data path port number for data traffic. Acceptable
@@ -56,10 +56,10 @@ module DockerEngineRuby
       attr_writer :root_rotation_in_progress
 
       # User modifiable swarm configuration.
-      sig { returns(T.nilable(DockerEngineRuby::Spec)) }
+      sig { returns(T.nilable(DockerEngineRuby::SwarmSpec)) }
       attr_reader :spec
 
-      sig { params(spec: DockerEngineRuby::Spec::OrHash).void }
+      sig { params(spec: DockerEngineRuby::SwarmSpec::OrHash).void }
       attr_writer :spec
 
       # SubnetSize specifies the subnet size of the networks created from the default
@@ -80,10 +80,10 @@ module DockerEngineRuby
 
       # Date and time at which the swarm was last updated in
       # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
-      sig { returns(T.nilable(String)) }
+      sig { returns(T.nilable(Time)) }
       attr_reader :updated_at
 
-      sig { params(updated_at: String).void }
+      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
@@ -103,16 +103,16 @@ module DockerEngineRuby
 
       sig do
         params(
-          created_at: String,
+          created_at: Time,
           data_path_port: Integer,
           default_addr_pool: T::Array[String],
           id: String,
           join_tokens: DockerEngineRuby::SwarmAPI::JoinTokens::OrHash,
           root_rotation_in_progress: T::Boolean,
-          spec: DockerEngineRuby::Spec::OrHash,
+          spec: DockerEngineRuby::SwarmSpec::OrHash,
           subnet_size: Integer,
           tls_info: DockerEngineRuby::SwarmAPI::TlsInfo::OrHash,
-          updated_at: String,
+          updated_at: Time,
           version: DockerEngineRuby::SwarmAPI::Version::OrHash
         ).returns(T.attached_class)
       end
@@ -159,16 +159,16 @@ module DockerEngineRuby
       sig do
         override.returns(
           {
-            created_at: String,
+            created_at: Time,
             data_path_port: Integer,
             default_addr_pool: T::Array[String],
             id: String,
             join_tokens: DockerEngineRuby::SwarmAPI::JoinTokens,
             root_rotation_in_progress: T::Boolean,
-            spec: DockerEngineRuby::Spec,
+            spec: DockerEngineRuby::SwarmSpec,
             subnet_size: Integer,
             tls_info: DockerEngineRuby::SwarmAPI::TlsInfo,
-            updated_at: String,
+            updated_at: Time,
             version: DockerEngineRuby::SwarmAPI::Version
           }
         )

data/rbi/docker_engine_ruby/models/swarm_init_params.rbi

@@ -14,59 +14,36 @@ module DockerEngineRuby
           )
         end
 
-      # Externally reachable address advertised to other nodes. This can either be an
-      # address/port combination in the form `192.168.1.1:4567`, or an interface
-      # followed by a port number, like `eth0:4567`. If the port number is omitted, the
-      # port number from the listen address is used. If `AdvertiseAddr` is not
-      # specified, it will be automatically detected when possible.
       sig { returns(T.nilable(String)) }
       attr_reader :advertise_addr
 
       sig { params(advertise_addr: String).void }
       attr_writer :advertise_addr
 
-      # Address or interface to use for data path traffic (format: `<ip|interface>`),
-      # for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is
-      # unspecified, the same address as `AdvertiseAddr` is used.
-      #
-      # The `DataPathAddr` specifies the address that global scope network drivers will
-      # publish towards other nodes in order to reach the containers running on this
-      # node. Using this parameter it is possible to separate the container data traffic
-      # from the management traffic of the cluster.
       sig { returns(T.nilable(String)) }
       attr_reader :data_path_addr
 
       sig { params(data_path_addr: String).void }
       attr_writer :data_path_addr
 
-      # DataPathPort specifies the data path port number for data traffic. Acceptable
-      # port range is 1024 to 49151. if no port is set or is set to 0, default port 4789
-      # will be used.
       sig { returns(T.nilable(Integer)) }
       attr_reader :data_path_port
 
       sig { params(data_path_port: Integer).void }
       attr_writer :data_path_port
 
-      # Default Address Pool specifies default subnet pools for global scope networks.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :default_addr_pool
 
       sig { params(default_addr_pool: T::Array[String]).void }
       attr_writer :default_addr_pool
 
-      # Force creation of a new swarm.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :force_new_cluster
 
       sig { params(force_new_cluster: T::Boolean).void }
       attr_writer :force_new_cluster
 
-      # Listen address used for inter-manager communication, as well as determining the
-      # networking interface used for the VXLAN Tunnel Endpoint (VTEP). This can either
-      # be an address/port combination in the form `192.168.1.1:4567`, or an interface
-      # followed by a port number, like `eth0:4567`. If the port number is omitted, the
-      # default swarm listening port is used.
       sig { returns(T.nilable(String)) }
       attr_reader :listen_addr
 
@@ -74,14 +51,12 @@ module DockerEngineRuby
       attr_writer :listen_addr
 
       # User modifiable swarm configuration.
-      sig { returns(T.nilable(DockerEngineRuby::Spec)) }
+      sig { returns(T.nilable(DockerEngineRuby::SwarmSpec)) }
       attr_reader :spec
 
-      sig { params(spec: DockerEngineRuby::Spec::OrHash).void }
+      sig { params(spec: DockerEngineRuby::SwarmSpec::OrHash).void }
       attr_writer :spec
 
-      # SubnetSize specifies the subnet size of the networks created from the default
-      # subnet pool.
       sig { returns(T.nilable(Integer)) }
       attr_reader :subnet_size
 
@@ -96,45 +71,20 @@ module DockerEngineRuby
           default_addr_pool: T::Array[String],
           force_new_cluster: T::Boolean,
           listen_addr: String,
-          spec: DockerEngineRuby::Spec::OrHash,
+          spec: DockerEngineRuby::SwarmSpec::OrHash,
           subnet_size: Integer,
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # Externally reachable address advertised to other nodes. This can either be an
-        # address/port combination in the form `192.168.1.1:4567`, or an interface
-        # followed by a port number, like `eth0:4567`. If the port number is omitted, the
-        # port number from the listen address is used. If `AdvertiseAddr` is not
-        # specified, it will be automatically detected when possible.
         advertise_addr: nil,
-        # Address or interface to use for data path traffic (format: `<ip|interface>`),
-        # for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is
-        # unspecified, the same address as `AdvertiseAddr` is used.
-        #
-        # The `DataPathAddr` specifies the address that global scope network drivers will
-        # publish towards other nodes in order to reach the containers running on this
-        # node. Using this parameter it is possible to separate the container data traffic
-        # from the management traffic of the cluster.
         data_path_addr: nil,
-        # DataPathPort specifies the data path port number for data traffic. Acceptable
-        # port range is 1024 to 49151. if no port is set or is set to 0, default port 4789
-        # will be used.
         data_path_port: nil,
-        # Default Address Pool specifies default subnet pools for global scope networks.
         default_addr_pool: nil,
-        # Force creation of a new swarm.
         force_new_cluster: nil,
-        # Listen address used for inter-manager communication, as well as determining the
-        # networking interface used for the VXLAN Tunnel Endpoint (VTEP). This can either
-        # be an address/port combination in the form `192.168.1.1:4567`, or an interface
-        # followed by a port number, like `eth0:4567`. If the port number is omitted, the
-        # default swarm listening port is used.
         listen_addr: nil,
         # User modifiable swarm configuration.
         spec: nil,
-        # SubnetSize specifies the subnet size of the networks created from the default
-        # subnet pool.
         subnet_size: nil,
         request_options: {}
       )
@@ -149,7 +99,7 @@ module DockerEngineRuby
             default_addr_pool: T::Array[String],
             force_new_cluster: T::Boolean,
             listen_addr: String,
-            spec: DockerEngineRuby::Spec,
+            spec: DockerEngineRuby::SwarmSpec,
             subnet_size: Integer,
             request_options: DockerEngineRuby::RequestOptions
           }

data/rbi/docker_engine_ruby/models/swarm_join_params.rbi

@@ -14,48 +14,30 @@ module DockerEngineRuby
           )
         end
 
-      # Externally reachable address advertised to other nodes. This can either be an
-      # address/port combination in the form `192.168.1.1:4567`, or an interface
-      # followed by a port number, like `eth0:4567`. If the port number is omitted, the
-      # port number from the listen address is used. If `AdvertiseAddr` is not
-      # specified, it will be automatically detected when possible.
       sig { returns(T.nilable(String)) }
       attr_reader :advertise_addr
 
       sig { params(advertise_addr: String).void }
       attr_writer :advertise_addr
 
-      # Address or interface to use for data path traffic (format: `<ip|interface>`),
-      # for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is
-      # unspecified, the same address as `AdvertiseAddr` is used.
-      #
-      # The `DataPathAddr` specifies the address that global scope network drivers will
-      # publish towards other nodes in order to reach the containers running on this
-      # node. Using this parameter it is possible to separate the container data traffic
-      # from the management traffic of the cluster.
       sig { returns(T.nilable(String)) }
       attr_reader :data_path_addr
 
       sig { params(data_path_addr: String).void }
       attr_writer :data_path_addr
 
-      # Secret token for joining this swarm.
       sig { returns(T.nilable(String)) }
       attr_reader :join_token
 
       sig { params(join_token: String).void }
       attr_writer :join_token
 
-      # Listen address used for inter-manager communication if the node gets promoted to
-      # manager, as well as determining the networking interface used for the VXLAN
-      # Tunnel Endpoint (VTEP).
       sig { returns(T.nilable(String)) }
       attr_reader :listen_addr
 
       sig { params(listen_addr: String).void }
       attr_writer :listen_addr
 
-      # Addresses of manager nodes already participating in the swarm.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :remote_addrs
 
@@ -73,28 +55,10 @@ module DockerEngineRuby
         ).returns(T.attached_class)
       end
       def self.new(
-        # Externally reachable address advertised to other nodes. This can either be an
-        # address/port combination in the form `192.168.1.1:4567`, or an interface
-        # followed by a port number, like `eth0:4567`. If the port number is omitted, the
-        # port number from the listen address is used. If `AdvertiseAddr` is not
-        # specified, it will be automatically detected when possible.
         advertise_addr: nil,
-        # Address or interface to use for data path traffic (format: `<ip|interface>`),
-        # for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is
-        # unspecified, the same address as `AdvertiseAddr` is used.
-        #
-        # The `DataPathAddr` specifies the address that global scope network drivers will
-        # publish towards other nodes in order to reach the containers running on this
-        # node. Using this parameter it is possible to separate the container data traffic
-        # from the management traffic of the cluster.
         data_path_addr: nil,
-        # Secret token for joining this swarm.
         join_token: nil,
-        # Listen address used for inter-manager communication if the node gets promoted to
-        # manager, as well as determining the networking interface used for the VXLAN
-        # Tunnel Endpoint (VTEP).
         listen_addr: nil,
-        # Addresses of manager nodes already participating in the swarm.
         remote_addrs: nil,
         request_options: {}
       )

data/rbi/docker_engine_ruby/models/swarm_leave_params.rbi

@@ -14,8 +14,6 @@ module DockerEngineRuby
           )
         end
 
-      # Force leave swarm, even if this is the last manager or that it will break the
-      # cluster.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :force
 
@@ -28,12 +26,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # Force leave swarm, even if this is the last manager or that it will break the
-        # cluster.
-        force: nil,
-        request_options: {}
-      )
+      def self.new(force: nil, request_options: {})
       end
 
       sig do