docker-engine-ruby 0.2.2 → 0.4.0

data/rbi/docker_engine_ruby/models/volume_prune_params.rbi

@@ -14,15 +14,6 @@ module DockerEngineRuby
           )
         end
 
-      # Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
-      #
-      # Available filters:
-      #
-      # - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or
-      #   `label!=<key>=<value>`) Prune volumes with (or without, in case `label!=...`
-      #   is used) the specified labels.
-      # - `all` (`all=true`) - Consider all (local) volumes for pruning and not just
-      #   anonymous volumes.
       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(
-        # Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
-        #
-        # Available filters:
-        #
-        # - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or
-        #   `label!=<key>=<value>`) Prune volumes with (or without, in case `label!=...`
-        #   is used) the specified labels.
-        # - `all` (`all=true`) - Consider all (local) volumes for pruning and not just
-        #   anonymous volumes.
-        filters: nil,
-        request_options: {}
-      )
+      def self.new(filters: nil, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/volume_prune_response.rbi

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

data/rbi/docker_engine_ruby/models/volume_update_params.rbi

@@ -14,8 +14,6 @@ module DockerEngineRuby
           )
         end
 
-      # The version number of the volume being updated. This is required to avoid
-      # conflicting writes. Found in the volume's `ClusterVolume` field.
       sig { returns(Integer) }
       attr_accessor :version
 
@@ -36,8 +34,6 @@ module DockerEngineRuby
         ).returns(T.attached_class)
       end
       def self.new(
-        # The version number of the volume being updated. This is required to avoid
-        # conflicting writes. Found in the volume's `ClusterVolume` field.
         version:,
         # Cluster-specific options used to create the volume.
         spec: nil,
@@ -134,9 +130,6 @@ module DockerEngineRuby
               )
             end
 
-          # Requirements for the accessible topology of the volume. These fields are
-          # optional. For an in-depth description of what these fields mean, see the CSI
-          # specification.
           sig do
             returns(
               T.nilable(
@@ -154,13 +147,6 @@ module DockerEngineRuby
           end
           attr_writer :accessibility_requirements
 
-          # The availability of the volume for use in tasks.
-          #
-          # - `active` The volume is fully available for scheduling on the cluster
-          # - `pause` No new workloads should use the volume, but existing workloads are not
-          #   stopped.
-          # - `drain` All workloads using this volume should be stopped and rescheduled, and
-          #   no new ones should be started.
           sig do
             returns(
               T.nilable(
@@ -178,8 +164,6 @@ module DockerEngineRuby
           end
           attr_writer :availability
 
-          # The desired capacity that the volume should be created with. If empty, the
-          # plugin will decide the capacity.
           sig do
             returns(
               T.nilable(
@@ -197,27 +181,12 @@ module DockerEngineRuby
           end
           attr_writer :capacity_range
 
-          # Options for using this volume as a Mount-type volume.
-          #
-          #     Either MountVolume or BlockVolume, but not both, must be
-          #     present.
-          #
-          # properties: FsType: type: "string" description: | Specifies the filesystem type
-          # for the mount volume. Optional. MountFlags: type: "array" description: | Flags
-          # to pass when mounting the volume. Optional. items: type: "string" BlockVolume:
-          # type: "object" description: | Options for using this volume as a Block-type
-          # volume. Intentionally empty.
-          sig { returns(T.nilable(T.anything)) }
+          sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
           attr_reader :mount_volume
 
-          sig { params(mount_volume: T.anything).void }
+          sig { params(mount_volume: T::Hash[Symbol, T.anything]).void }
           attr_writer :mount_volume
 
-          # The set of nodes this volume can be used on at one time.
-          #
-          # - `single` The volume may only be scheduled to one node at a time.
-          # - `multi` the volume may be scheduled to any supported number of nodes at a
-          #   time.
           sig do
             returns(
               T.nilable(
@@ -235,8 +204,6 @@ module DockerEngineRuby
           end
           attr_writer :scope
 
-          # Swarm Secrets that are passed to the CSI storage plugin when operating on this
-          # volume.
           sig do
             returns(
               T.nilable(
@@ -258,14 +225,6 @@ module DockerEngineRuby
           end
           attr_writer :secrets
 
-          # The number and way that different tasks can use this volume at one time.
-          #
-          # - `none` The volume may only be used by one task at a time.
-          # - `readonly` The volume may be used by any number of tasks, but they all must
-          #   mount the volume as readonly
-          # - `onewriter` The volume may be used by any number of tasks, but only one may
-          #   mount it as read/write.
-          # - `all` The volume may have any number of readers and writers.
           sig do
             returns(
               T.nilable(
@@ -292,7 +251,7 @@ module DockerEngineRuby
                 DockerEngineRuby::VolumeUpdateParams::Spec::AccessMode::Availability::OrSymbol,
               capacity_range:
                 DockerEngineRuby::VolumeUpdateParams::Spec::AccessMode::CapacityRange::OrHash,
-              mount_volume: T.anything,
+              mount_volume: T::Hash[Symbol, T.anything],
               scope:
                 DockerEngineRuby::VolumeUpdateParams::Spec::AccessMode::Scope::OrSymbol,
               secrets:
@@ -304,49 +263,12 @@ module DockerEngineRuby
             ).returns(T.attached_class)
           end
           def self.new(
-            # Requirements for the accessible topology of the volume. These fields are
-            # optional. For an in-depth description of what these fields mean, see the CSI
-            # specification.
             accessibility_requirements: nil,
-            # The availability of the volume for use in tasks.
-            #
-            # - `active` The volume is fully available for scheduling on the cluster
-            # - `pause` No new workloads should use the volume, but existing workloads are not
-            #   stopped.
-            # - `drain` All workloads using this volume should be stopped and rescheduled, and
-            #   no new ones should be started.
             availability: nil,
-            # The desired capacity that the volume should be created with. If empty, the
-            # plugin will decide the capacity.
             capacity_range: nil,
-            # Options for using this volume as a Mount-type volume.
-            #
-            #     Either MountVolume or BlockVolume, but not both, must be
-            #     present.
-            #
-            # properties: FsType: type: "string" description: | Specifies the filesystem type
-            # for the mount volume. Optional. MountFlags: type: "array" description: | Flags
-            # to pass when mounting the volume. Optional. items: type: "string" BlockVolume:
-            # type: "object" description: | Options for using this volume as a Block-type
-            # volume. Intentionally empty.
             mount_volume: nil,
-            # The set of nodes this volume can be used on at one time.
-            #
-            # - `single` The volume may only be scheduled to one node at a time.
-            # - `multi` the volume may be scheduled to any supported number of nodes at a
-            #   time.
             scope: nil,
-            # Swarm Secrets that are passed to the CSI storage plugin when operating on this
-            # volume.
             secrets: nil,
-            # The number and way that different tasks can use this volume at one time.
-            #
-            # - `none` The volume may only be used by one task at a time.
-            # - `readonly` The volume may be used by any number of tasks, but they all must
-            #   mount the volume as readonly
-            # - `onewriter` The volume may be used by any number of tasks, but only one may
-            #   mount it as read/write.
-            # - `all` The volume may have any number of readers and writers.
             sharing: nil
           )
           end
@@ -360,7 +282,7 @@ module DockerEngineRuby
                   DockerEngineRuby::VolumeUpdateParams::Spec::AccessMode::Availability::OrSymbol,
                 capacity_range:
                   DockerEngineRuby::VolumeUpdateParams::Spec::AccessMode::CapacityRange,
-                mount_volume: T.anything,
+                mount_volume: T::Hash[Symbol, T.anything],
                 scope:
                   DockerEngineRuby::VolumeUpdateParams::Spec::AccessMode::Scope::OrSymbol,
                 secrets:
@@ -384,37 +306,25 @@ module DockerEngineRuby
                 )
               end
 
-            # A list of topologies that the volume should attempt to be provisioned in.
             sig { returns(T.nilable(T::Array[T::Hash[Symbol, String]])) }
             attr_reader :preferred
 
             sig { params(preferred: T::Array[T::Hash[Symbol, String]]).void }
             attr_writer :preferred
 
-            # A list of required topologies, at least one of which the volume must be
-            # accessible from.
             sig { returns(T.nilable(T::Array[T::Hash[Symbol, String]])) }
             attr_reader :requisite
 
             sig { params(requisite: T::Array[T::Hash[Symbol, String]]).void }
             attr_writer :requisite
 
-            # Requirements for the accessible topology of the volume. These fields are
-            # optional. For an in-depth description of what these fields mean, see the CSI
-            # specification.
             sig do
               params(
                 preferred: T::Array[T::Hash[Symbol, String]],
                 requisite: T::Array[T::Hash[Symbol, String]]
               ).returns(T.attached_class)
             end
-            def self.new(
-              # A list of topologies that the volume should attempt to be provisioned in.
-              preferred: nil,
-              # A list of required topologies, at least one of which the volume must be
-              # accessible from.
-              requisite: nil
-            )
+            def self.new(preferred: nil, requisite: nil)
             end
 
             sig do
@@ -429,13 +339,6 @@ module DockerEngineRuby
             end
           end
 
-          # The availability of the volume for use in tasks.
-          #
-          # - `active` The volume is fully available for scheduling on the cluster
-          # - `pause` No new workloads should use the volume, but existing workloads are not
-          #   stopped.
-          # - `drain` All workloads using this volume should be stopped and rescheduled, and
-          #   no new ones should be started.
           module Availability
             extend DockerEngineRuby::Internal::Type::Enum
 
@@ -484,37 +387,24 @@ module DockerEngineRuby
                 )
               end
 
-            # The volume must not be bigger than this. The value of 0 indicates an unspecified
-            # maximum.
             sig { returns(T.nilable(Integer)) }
             attr_reader :limit_bytes
 
             sig { params(limit_bytes: Integer).void }
             attr_writer :limit_bytes
 
-            # The volume must be at least this big. The value of 0 indicates an unspecified
-            # minimum
             sig { returns(T.nilable(Integer)) }
             attr_reader :required_bytes
 
             sig { params(required_bytes: Integer).void }
             attr_writer :required_bytes
 
-            # The desired capacity that the volume should be created with. If empty, the
-            # plugin will decide the capacity.
             sig do
               params(limit_bytes: Integer, required_bytes: Integer).returns(
                 T.attached_class
               )
             end
-            def self.new(
-              # The volume must not be bigger than this. The value of 0 indicates an unspecified
-              # maximum.
-              limit_bytes: nil,
-              # The volume must be at least this big. The value of 0 indicates an unspecified
-              # minimum
-              required_bytes: nil
-            )
+            def self.new(limit_bytes: nil, required_bytes: nil)
             end
 
             sig do
@@ -526,11 +416,6 @@ module DockerEngineRuby
             end
           end
 
-          # The set of nodes this volume can be used on at one time.
-          #
-          # - `single` The volume may only be scheduled to one node at a time.
-          # - `multi` the volume may be scheduled to any supported number of nodes at a
-          #   time.
           module Scope
             extend DockerEngineRuby::Internal::Type::Enum
 
@@ -574,35 +459,22 @@ module DockerEngineRuby
                 )
               end
 
-            # Key is the name of the key of the key-value pair passed to the plugin.
             sig { returns(T.nilable(String)) }
             attr_reader :key
 
             sig { params(key: String).void }
             attr_writer :key
 
-            # Secret is the swarm Secret object from which to read data. This can be a Secret
-            # name or ID. The Secret data is retrieved by swarm and used as the value of the
-            # key-value pair passed to the plugin.
             sig { returns(T.nilable(String)) }
             attr_reader :secret
 
             sig { params(secret: String).void }
             attr_writer :secret
 
-            # One cluster volume secret entry. Defines a key-value pair that is passed to the
-            # plugin.
             sig do
               params(key: String, secret: String).returns(T.attached_class)
             end
-            def self.new(
-              # Key is the name of the key of the key-value pair passed to the plugin.
-              key: nil,
-              # Secret is the swarm Secret object from which to read data. This can be a Secret
-              # name or ID. The Secret data is retrieved by swarm and used as the value of the
-              # key-value pair passed to the plugin.
-              secret: nil
-            )
+            def self.new(key: nil, secret: nil)
             end
 
             sig { override.returns({ key: String, secret: String }) }
@@ -610,14 +482,6 @@ module DockerEngineRuby
             end
           end
 
-          # The number and way that different tasks can use this volume at one time.
-          #
-          # - `none` The volume may only be used by one task at a time.
-          # - `readonly` The volume may be used by any number of tasks, but they all must
-          #   mount the volume as readonly
-          # - `onewriter` The volume may be used by any number of tasks, but only one may
-          #   mount it as read/write.
-          # - `all` The volume may have any number of readers and writers.
           module Sharing
             extend DockerEngineRuby::Internal::Type::Enum
 

data/rbi/docker_engine_ruby/models.rbi

@@ -15,6 +15,10 @@ module DockerEngineRuby
 
   ConfigListParams = DockerEngineRuby::Models::ConfigListParams
 
+  ConfigObject = DockerEngineRuby::Models::ConfigObject
+
+  ConfigSpec = DockerEngineRuby::Models::ConfigSpec
+
   ConfigUpdateParams = DockerEngineRuby::Models::ConfigUpdateParams
 
   ConnectRequest = DockerEngineRuby::Models::ConnectRequest
@@ -120,6 +124,8 @@ module DockerEngineRuby
 
   ImageSearchParams = DockerEngineRuby::Models::ImageSearchParams
 
+  ImageSummary = DockerEngineRuby::Models::ImageSummary
+
   ImageTagParams = DockerEngineRuby::Models::ImageTagParams
 
   Info = DockerEngineRuby::Models::Info
@@ -136,6 +142,8 @@ module DockerEngineRuby
 
   NetworkCreateParams = DockerEngineRuby::Models::NetworkCreateParams
 
+  NetworkCreateResponse = DockerEngineRuby::Models::NetworkCreateResponse
+
   NetworkDeleteParams = DockerEngineRuby::Models::NetworkDeleteParams
 
   NetworkDisconnectParams = DockerEngineRuby::Models::NetworkDisconnectParams
@@ -146,6 +154,8 @@ module DockerEngineRuby
 
   NetworkPruneParams = DockerEngineRuby::Models::NetworkPruneParams
 
+  NetworkSummary = DockerEngineRuby::Models::NetworkSummary
+
   Node = DockerEngineRuby::Models::Node
 
   NodeDeleteParams = DockerEngineRuby::Models::NodeDeleteParams
@@ -154,6 +164,8 @@ module DockerEngineRuby
 
   NodeListParams = DockerEngineRuby::Models::NodeListParams
 
+  NodeSpec = DockerEngineRuby::Models::NodeSpec
+
   NodeUpdateParams = DockerEngineRuby::Models::NodeUpdateParams
 
   Plugin = DockerEngineRuby::Models::Plugin
@@ -192,12 +204,16 @@ module DockerEngineRuby
 
   SecretListParams = DockerEngineRuby::Models::SecretListParams
 
+  SecretSpec = DockerEngineRuby::Models::SecretSpec
+
   SecretUpdateParams = DockerEngineRuby::Models::SecretUpdateParams
 
   Service = DockerEngineRuby::Models::Service
 
   ServiceCreateParams = DockerEngineRuby::Models::ServiceCreateParams
 
+  ServiceCreateResponse = DockerEngineRuby::Models::ServiceCreateResponse
+
   ServiceDeleteParams = DockerEngineRuby::Models::ServiceDeleteParams
 
   ServiceInspectParams = DockerEngineRuby::Models::ServiceInspectParams
@@ -206,9 +222,11 @@ module DockerEngineRuby
 
   ServiceLogsParams = DockerEngineRuby::Models::ServiceLogsParams
 
+  ServiceSpec = DockerEngineRuby::Models::ServiceSpec
+
   ServiceUpdateParams = DockerEngineRuby::Models::ServiceUpdateParams
 
-  Spec = DockerEngineRuby::Models::Spec
+  ServiceUpdateResponse = DockerEngineRuby::Models::ServiceUpdateResponse
 
   StatsResponse = DockerEngineRuby::Models::StatsResponse
 
@@ -224,6 +242,8 @@ module DockerEngineRuby
 
   SwarmLeaveParams = DockerEngineRuby::Models::SwarmLeaveParams
 
+  SwarmSpec = DockerEngineRuby::Models::SwarmSpec
+
   SwarmUnlockKeyParams = DockerEngineRuby::Models::SwarmUnlockKeyParams
 
   SwarmUnlockParams = DockerEngineRuby::Models::SwarmUnlockParams
@@ -248,6 +268,8 @@ module DockerEngineRuby
 
   TaskLogsParams = DockerEngineRuby::Models::TaskLogsParams
 
+  TaskSpec = DockerEngineRuby::Models::TaskSpec
+
   TopResponse = DockerEngineRuby::Models::TopResponse
 
   UpdateResponse = DockerEngineRuby::Models::UpdateResponse

data/rbi/docker_engine_ruby/resources/auth.rbi

@@ -3,8 +3,7 @@
 module DockerEngineRuby
   module Resources
     class Auth
-      # Validate credentials for a registry and, if available, get an identity token for
-      # accessing the registry without password.
+      # Check auth configuration
       sig do
         params(
           password: String,

data/rbi/docker_engine_ruby/resources/configs.rbi

@@ -6,11 +6,11 @@ module DockerEngineRuby
       # Create a config
       sig do
         params(
-          spec: DockerEngineRuby::ConfigCreateParams::Spec::OrHash,
+          spec: DockerEngineRuby::ConfigSpec::OrHash,
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(DockerEngineRuby::Models::ConfigCreateResponse)
       end
-      def create(spec: nil, request_options: {})
+      def create(spec:, request_options: {})
       end
 
       # Update a Config
@@ -18,18 +18,17 @@ module DockerEngineRuby
         params(
           id: String,
           version: Integer,
-          spec: DockerEngineRuby::Spec::OrHash,
+          spec: DockerEngineRuby::ConfigSpec::OrHash,
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).void
       end
       def update(
-        # Path param: The ID or name of the config
+        # Path param
         id,
-        # Query param: The version number of the config object being updated. This is
-        # required to avoid conflicting writes.
+        # Query param
         version:,
         # Body param
-        spec: nil,
+        spec:,
         request_options: {}
       )
       end
@@ -39,21 +38,9 @@ module DockerEngineRuby
         params(
           filters: String,
           request_options: DockerEngineRuby::RequestOptions::OrHash
-        ).returns(T::Array[DockerEngineRuby::Config])
+        ).returns(T::Array[DockerEngineRuby::ConfigObject])
       end
-      def list(
-        # 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 list(filters: nil, request_options: {})
       end
 
       # Delete a config
@@ -63,11 +50,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).void
       end
-      def delete(
-        # ID of the config
-        id,
-        request_options: {}
-      )
+      def delete(id, request_options: {})
       end
 
       # Inspect a config
@@ -75,13 +58,9 @@ module DockerEngineRuby
         params(
           id: String,
           request_options: DockerEngineRuby::RequestOptions::OrHash
-        ).returns(DockerEngineRuby::Config)
+        ).returns(DockerEngineRuby::ConfigObject)
       end
-      def inspect_(
-        # ID of the config
-        id,
-        request_options: {}
-      )
+      def inspect_(id, request_options: {})
       end
 
       # @api private