docker-engine-ruby 0.2.2 → 0.4.0

data/rbi/docker_engine_ruby/models/network_list_params.rbi

@@ -14,22 +14,6 @@ module DockerEngineRuby
           )
         end
 
-      # JSON encoded value of the filters (a `map[string][]string`) to process on the
-      # networks list.
-      #
-      # Available filters:
-      #
-      # - `dangling=<boolean>` When set to `true` (or `1`), returns all networks that
-      #   are not in use by a container. When set to `false` (or `0`), only networks
-      #   that are in use by one or more containers are returned.
-      # - `driver=<driver-name>` Matches a network's driver.
-      # - `id=<network-id>` Matches all or part of a network ID.
-      # - `label=<key>` or `label=<key>=<value>` of a network label.
-      # - `name=<network-name>` Matches all or part of a network name.
-      # - `scope=["swarm"|"global"|"local"]` Filters networks by scope (`swarm`,
-      #   `global`, or `local`).
-      # - `type=["custom"|"builtin"]` Filters networks by type. The `custom` keyword
-      #   returns all user-defined networks.
       sig { returns(T.nilable(String)) }
       attr_reader :filters
 
@@ -42,26 +26,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # JSON encoded value of the filters (a `map[string][]string`) to process on the
-        # networks list.
-        #
-        # Available filters:
-        #
-        # - `dangling=<boolean>` When set to `true` (or `1`), returns all networks that
-        #   are not in use by a container. When set to `false` (or `0`), only networks
-        #   that are in use by one or more containers are returned.
-        # - `driver=<driver-name>` Matches a network's driver.
-        # - `id=<network-id>` Matches all or part of a network ID.
-        # - `label=<key>` or `label=<key>=<value>` of a network label.
-        # - `name=<network-name>` Matches all or part of a network name.
-        # - `scope=["swarm"|"global"|"local"]` Filters networks by scope (`swarm`,
-        #   `global`, or `local`).
-        # - `type=["custom"|"builtin"]` Filters networks by type. The `custom` keyword
-        #   returns all user-defined networks.
-        filters: nil,
-        request_options: {}
-      )
+      def self.new(filters: nil, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/network_list_response.rbi

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

data/rbi/docker_engine_ruby/models/network_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 networks 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 networks 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 networks 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 networks 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/network_prune_response.rbi

@@ -11,7 +11,6 @@ module DockerEngineRuby
           )
         end
 
-      # Networks that were deleted
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :networks_deleted
 
@@ -21,10 +20,7 @@ module DockerEngineRuby
       sig do
         params(networks_deleted: T::Array[String]).returns(T.attached_class)
       end
-      def self.new(
-        # Networks that were deleted
-        networks_deleted: nil
-      )
+      def self.new(networks_deleted: nil)
       end
 
       sig { override.returns({ networks_deleted: T::Array[String] }) }

data/rbi/docker_engine_ruby/models/network_summary.rbi

@@ -0,0 +1,444 @@
+# typed: strong
+
+module DockerEngineRuby
+  module Models
+    class NetworkSummary < DockerEngineRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineRuby::NetworkSummary,
+            DockerEngineRuby::Internal::AnyHash
+          )
+        end
+
+      # Whether a global / swarm scope network is manually attachable by regular
+      # containers from workers in swarm mode.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :attachable
+
+      sig { params(attachable: T::Boolean).void }
+      attr_writer :attachable
+
+      # The config-only network source to provide the configuration for this network.
+      sig { returns(T.nilable(DockerEngineRuby::NetworkSummary::ConfigFrom)) }
+      attr_reader :config_from
+
+      sig do
+        params(
+          config_from: DockerEngineRuby::NetworkSummary::ConfigFrom::OrHash
+        ).void
+      end
+      attr_writer :config_from
+
+      # Whether the network is a config-only network. Config-only networks are
+      # placeholder networks for network configurations to be used by other networks.
+      # Config-only networks cannot be used directly to run containers or services.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :config_only
+
+      sig { params(config_only: T::Boolean).void }
+      attr_writer :config_only
+
+      # Date and time at which the network was created in
+      # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created
+
+      sig { params(created: Time).void }
+      attr_writer :created
+
+      # The name of the driver used to create the network (e.g. `bridge`, `overlay`).
+      sig { returns(T.nilable(String)) }
+      attr_reader :driver
+
+      sig { params(driver: String).void }
+      attr_writer :driver
+
+      # Whether the network was created with IPv4 enabled.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :enable_i_pv4
+
+      sig { params(enable_i_pv4: T::Boolean).void }
+      attr_writer :enable_i_pv4
+
+      # Whether the network was created with IPv6 enabled.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :enable_i_pv6
+
+      sig { params(enable_i_pv6: T::Boolean).void }
+      attr_writer :enable_i_pv6
+
+      # ID that uniquely identifies a network on a single machine.
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # Whether the network is providing the routing-mesh for the swarm cluster.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :ingress
+
+      sig { params(ingress: T::Boolean).void }
+      attr_writer :ingress
+
+      # Whether the network is created to only allow internal networking connectivity.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :internal
+
+      sig { params(internal: T::Boolean).void }
+      attr_writer :internal
+
+      # The network's IP Address Management.
+      sig { returns(T.nilable(DockerEngineRuby::NetworkSummary::Ipam)) }
+      attr_reader :ipam
+
+      sig { params(ipam: DockerEngineRuby::NetworkSummary::Ipam::OrHash).void }
+      attr_writer :ipam
+
+      # Metadata specific to the network being created.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :labels
+
+      sig { params(labels: T::Hash[Symbol, String]).void }
+      attr_writer :labels
+
+      # Name of the network.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # Network-specific options uses when creating the network.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :options
+
+      sig { params(options: T::Hash[Symbol, String]).void }
+      attr_writer :options
+
+      # List of peer nodes for an overlay network. This field is only present for
+      # overlay networks, and omitted for other network types.
+      sig do
+        returns(T.nilable(T::Array[DockerEngineRuby::NetworkSummary::Peer]))
+      end
+      attr_reader :peers
+
+      sig do
+        params(
+          peers: T::Array[DockerEngineRuby::NetworkSummary::Peer::OrHash]
+        ).void
+      end
+      attr_writer :peers
+
+      # The level at which the network exists (e.g. `swarm` for cluster-wide or `local`
+      # for machine level)
+      sig { returns(T.nilable(String)) }
+      attr_reader :scope
+
+      sig { params(scope: String).void }
+      attr_writer :scope
+
+      # Network list response item
+      sig do
+        params(
+          attachable: T::Boolean,
+          config_from: DockerEngineRuby::NetworkSummary::ConfigFrom::OrHash,
+          config_only: T::Boolean,
+          created: Time,
+          driver: String,
+          enable_i_pv4: T::Boolean,
+          enable_i_pv6: T::Boolean,
+          id: String,
+          ingress: T::Boolean,
+          internal: T::Boolean,
+          ipam: DockerEngineRuby::NetworkSummary::Ipam::OrHash,
+          labels: T::Hash[Symbol, String],
+          name: String,
+          options: T::Hash[Symbol, String],
+          peers: T::Array[DockerEngineRuby::NetworkSummary::Peer::OrHash],
+          scope: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Whether a global / swarm scope network is manually attachable by regular
+        # containers from workers in swarm mode.
+        attachable: nil,
+        # The config-only network source to provide the configuration for this network.
+        config_from: nil,
+        # Whether the network is a config-only network. Config-only networks are
+        # placeholder networks for network configurations to be used by other networks.
+        # Config-only networks cannot be used directly to run containers or services.
+        config_only: nil,
+        # Date and time at which the network was created in
+        # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
+        created: nil,
+        # The name of the driver used to create the network (e.g. `bridge`, `overlay`).
+        driver: nil,
+        # Whether the network was created with IPv4 enabled.
+        enable_i_pv4: nil,
+        # Whether the network was created with IPv6 enabled.
+        enable_i_pv6: nil,
+        # ID that uniquely identifies a network on a single machine.
+        id: nil,
+        # Whether the network is providing the routing-mesh for the swarm cluster.
+        ingress: nil,
+        # Whether the network is created to only allow internal networking connectivity.
+        internal: nil,
+        # The network's IP Address Management.
+        ipam: nil,
+        # Metadata specific to the network being created.
+        labels: nil,
+        # Name of the network.
+        name: nil,
+        # Network-specific options uses when creating the network.
+        options: nil,
+        # List of peer nodes for an overlay network. This field is only present for
+        # overlay networks, and omitted for other network types.
+        peers: nil,
+        # The level at which the network exists (e.g. `swarm` for cluster-wide or `local`
+        # for machine level)
+        scope: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            attachable: T::Boolean,
+            config_from: DockerEngineRuby::NetworkSummary::ConfigFrom,
+            config_only: T::Boolean,
+            created: Time,
+            driver: String,
+            enable_i_pv4: T::Boolean,
+            enable_i_pv6: T::Boolean,
+            id: String,
+            ingress: T::Boolean,
+            internal: T::Boolean,
+            ipam: DockerEngineRuby::NetworkSummary::Ipam,
+            labels: T::Hash[Symbol, String],
+            name: String,
+            options: T::Hash[Symbol, String],
+            peers: T::Array[DockerEngineRuby::NetworkSummary::Peer],
+            scope: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class ConfigFrom < DockerEngineRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              DockerEngineRuby::NetworkSummary::ConfigFrom,
+              DockerEngineRuby::Internal::AnyHash
+            )
+          end
+
+        # The name of the config-only network that provides the network's configuration.
+        # The specified network must be an existing config-only network. Only network
+        # names are allowed, not network IDs.
+        sig { returns(T.nilable(String)) }
+        attr_reader :network
+
+        sig { params(network: String).void }
+        attr_writer :network
+
+        # The config-only network source to provide the configuration for this network.
+        sig { params(network: String).returns(T.attached_class) }
+        def self.new(
+          # The name of the config-only network that provides the network's configuration.
+          # The specified network must be an existing config-only network. Only network
+          # names are allowed, not network IDs.
+          network: nil
+        )
+        end
+
+        sig { override.returns({ network: String }) }
+        def to_hash
+        end
+      end
+
+      class Ipam < DockerEngineRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              DockerEngineRuby::NetworkSummary::Ipam,
+              DockerEngineRuby::Internal::AnyHash
+            )
+          end
+
+        # List of IPAM configuration options, specified as a map:
+        #
+        # ```
+        # {"Subnet": <CIDR>, "IPRange": <CIDR>, "Gateway": <IP address>, "AuxAddress": <device_name:IP address>}
+        # ```
+        sig do
+          returns(
+            T.nilable(T::Array[DockerEngineRuby::NetworkSummary::Ipam::Config])
+          )
+        end
+        attr_reader :config
+
+        sig do
+          params(
+            config:
+              T::Array[DockerEngineRuby::NetworkSummary::Ipam::Config::OrHash]
+          ).void
+        end
+        attr_writer :config
+
+        # Name of the IPAM driver to use.
+        sig { returns(T.nilable(String)) }
+        attr_reader :driver
+
+        sig { params(driver: String).void }
+        attr_writer :driver
+
+        # Driver-specific options, specified as a map.
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_reader :options
+
+        sig { params(options: T::Hash[Symbol, String]).void }
+        attr_writer :options
+
+        # The network's IP Address Management.
+        sig do
+          params(
+            config:
+              T::Array[DockerEngineRuby::NetworkSummary::Ipam::Config::OrHash],
+            driver: String,
+            options: T::Hash[Symbol, String]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # List of IPAM configuration options, specified as a map:
+          #
+          # ```
+          # {"Subnet": <CIDR>, "IPRange": <CIDR>, "Gateway": <IP address>, "AuxAddress": <device_name:IP address>}
+          # ```
+          config: nil,
+          # Name of the IPAM driver to use.
+          driver: nil,
+          # Driver-specific options, specified as a map.
+          options: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              config: T::Array[DockerEngineRuby::NetworkSummary::Ipam::Config],
+              driver: String,
+              options: T::Hash[Symbol, String]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Config < DockerEngineRuby::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                DockerEngineRuby::NetworkSummary::Ipam::Config,
+                DockerEngineRuby::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(T::Hash[Symbol, String])) }
+          attr_reader :auxiliary_addresses
+
+          sig { params(auxiliary_addresses: T::Hash[Symbol, String]).void }
+          attr_writer :auxiliary_addresses
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :gateway
+
+          sig { params(gateway: String).void }
+          attr_writer :gateway
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :ip_range
+
+          sig { params(ip_range: String).void }
+          attr_writer :ip_range
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :subnet
+
+          sig { params(subnet: String).void }
+          attr_writer :subnet
+
+          sig do
+            params(
+              auxiliary_addresses: T::Hash[Symbol, String],
+              gateway: String,
+              ip_range: String,
+              subnet: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            auxiliary_addresses: nil,
+            gateway: nil,
+            ip_range: nil,
+            subnet: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                auxiliary_addresses: T::Hash[Symbol, String],
+                gateway: String,
+                ip_range: String,
+                subnet: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+
+      class Peer < DockerEngineRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              DockerEngineRuby::NetworkSummary::Peer,
+              DockerEngineRuby::Internal::AnyHash
+            )
+          end
+
+        # IP-address of the peer-node in the Swarm cluster.
+        sig { returns(T.nilable(String)) }
+        attr_reader :ip
+
+        sig { params(ip: String).void }
+        attr_writer :ip
+
+        # ID of the peer-node in the Swarm cluster.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # represents one peer of an overlay network.
+        sig { params(ip: String, name: String).returns(T.attached_class) }
+        def self.new(
+          # IP-address of the peer-node in the Swarm cluster.
+          ip: nil,
+          # ID of the peer-node in the Swarm cluster.
+          name: nil
+        )
+        end
+
+        sig { override.returns({ ip: String, name: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/docker_engine_ruby/models/node.rbi

@@ -10,10 +10,10 @@ module DockerEngineRuby
 
       # Date and time at which the node was added to the swarm 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
 
       # NodeDescription encapsulates the properties of the Node as reported by the
@@ -41,16 +41,15 @@ module DockerEngineRuby
 
       sig do
         params(
-          manager_status:
-            T.nilable(DockerEngineRuby::Node::ManagerStatus::OrHash)
+          manager_status: DockerEngineRuby::Node::ManagerStatus::OrHash
         ).void
       end
       attr_writer :manager_status
 
-      sig { returns(T.nilable(DockerEngineRuby::Spec)) }
+      sig { returns(T.nilable(DockerEngineRuby::NodeSpec)) }
       attr_reader :spec
 
-      sig { params(spec: DockerEngineRuby::Spec::OrHash).void }
+      sig { params(spec: DockerEngineRuby::NodeSpec::OrHash).void }
       attr_writer :spec
 
       # NodeStatus represents the status of a node.
@@ -64,10 +63,10 @@ module DockerEngineRuby
 
       # Date and time at which the node 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
@@ -87,14 +86,13 @@ module DockerEngineRuby
 
       sig do
         params(
-          created_at: String,
+          created_at: Time,
           description: DockerEngineRuby::Node::Description::OrHash,
           id: String,
-          manager_status:
-            T.nilable(DockerEngineRuby::Node::ManagerStatus::OrHash),
-          spec: DockerEngineRuby::Spec::OrHash,
+          manager_status: DockerEngineRuby::Node::ManagerStatus::OrHash,
+          spec: DockerEngineRuby::NodeSpec::OrHash,
           status: DockerEngineRuby::Node::Status::OrHash,
-          updated_at: String,
+          updated_at: Time,
           version: DockerEngineRuby::Node::Version::OrHash
         ).returns(T.attached_class)
       end
@@ -135,13 +133,13 @@ module DockerEngineRuby
       sig do
         override.returns(
           {
-            created_at: String,
+            created_at: Time,
             description: DockerEngineRuby::Node::Description,
             id: String,
-            manager_status: T.nilable(DockerEngineRuby::Node::ManagerStatus),
-            spec: DockerEngineRuby::Spec,
+            manager_status: DockerEngineRuby::Node::ManagerStatus,
+            spec: DockerEngineRuby::NodeSpec,
             status: DockerEngineRuby::Node::Status,
-            updated_at: String,
+            updated_at: Time,
             version: DockerEngineRuby::Node::Version
           }
         )
@@ -401,8 +399,6 @@ module DockerEngineRuby
               )
             end
 
-          # User-defined resources can be either Integer resources (e.g, `SSD=3`) or String
-          # resources (e.g, `GPU=UUID1`).
           sig do
             returns(
               T.nilable(
@@ -449,8 +445,6 @@ module DockerEngineRuby
             ).returns(T.attached_class)
           end
           def self.new(
-            # User-defined resources can be either Integer resources (e.g, `SSD=3`) or String
-            # resources (e.g, `GPU=UUID1`).
             generic_resources: nil,
             memory_bytes: nil,
             nano_cpus: nil

data/rbi/docker_engine_ruby/models/node_delete_params.rbi

@@ -14,7 +14,6 @@ module DockerEngineRuby
           )
         end
 
-      # Force remove a node from the swarm
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :force
 
@@ -27,11 +26,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # Force remove a node from the swarm
-        force: nil,
-        request_options: {}
-      )
+      def self.new(force: nil, request_options: {})
       end
 
       sig do