docker-engine-ruby 0.2.2 → 0.3.0

data/lib/docker_engine_ruby/models/volume_update_params.rb

@@ -8,8 +8,6 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute version
-      #   The version number of the volume being updated. This is required to avoid
-      #   conflicting writes. Found in the volume's `ClusterVolume` field.
       #
       #   @return [Integer]
       required :version, Integer
@@ -21,10 +19,7 @@ module DockerEngineRuby
       optional :spec, -> { DockerEngineRuby::VolumeUpdateParams::Spec }, api_name: :Spec
 
       # @!method initialize(version:, spec: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::VolumeUpdateParams} for more details.
-      #
-      #   @param version [Integer] The version number of the volume being updated. This is required to
+      #   @param version [Integer]
       #
       #   @param spec [DockerEngineRuby::Models::VolumeUpdateParams::Spec] Cluster-specific options used to create the volume.
       #
@@ -62,9 +57,6 @@ module DockerEngineRuby
         # @see DockerEngineRuby::Models::VolumeUpdateParams::Spec#access_mode
         class AccessMode < DockerEngineRuby::Internal::Type::BaseModel
           # @!attribute accessibility_requirements
-          #   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.
           #
           #   @return [DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode::AccessibilityRequirements, nil]
           optional :accessibility_requirements,
@@ -72,13 +64,6 @@ module DockerEngineRuby
                    api_name: :AccessibilityRequirements
 
           # @!attribute availability
-          #   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.
           #
           #   @return [Symbol, DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode::Availability, nil]
           optional :availability,
@@ -86,8 +71,6 @@ module DockerEngineRuby
                    api_name: :Availability
 
           # @!attribute capacity_range
-          #   The desired capacity that the volume should be created with. If empty, the
-          #   plugin will decide the capacity.
           #
           #   @return [DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode::CapacityRange, nil]
           optional :capacity_range,
@@ -95,26 +78,13 @@ module DockerEngineRuby
                    api_name: :CapacityRange
 
           # @!attribute mount_volume
-          #   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.
           #
-          #   @return [Object, nil]
-          optional :mount_volume, DockerEngineRuby::Internal::Type::Unknown, api_name: :MountVolume
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :mount_volume,
+                   DockerEngineRuby::Internal::Type::HashOf[DockerEngineRuby::Internal::Type::Unknown],
+                   api_name: :MountVolume
 
           # @!attribute scope
-          #   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.
           #
           #   @return [Symbol, DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode::Scope, nil]
           optional :scope,
@@ -122,8 +92,6 @@ module DockerEngineRuby
                    api_name: :Scope
 
           # @!attribute secrets
-          #   Swarm Secrets that are passed to the CSI storage plugin when operating on this
-          #   volume.
           #
           #   @return [Array<DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode::Secret>, nil]
           optional :secrets,
@@ -133,14 +101,6 @@ module DockerEngineRuby
                    api_name: :Secrets
 
           # @!attribute sharing
-          #   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.
           #
           #   @return [Symbol, DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode::Sharing, nil]
           optional :sharing,
@@ -148,30 +108,19 @@ module DockerEngineRuby
                    api_name: :Sharing
 
           # @!method initialize(accessibility_requirements: nil, availability: nil, capacity_range: nil, mount_volume: nil, scope: nil, secrets: nil, sharing: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode} for more
-          #   details.
-          #
           #   Defines how the volume is used by tasks.
           #
-          #   @param accessibility_requirements [DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode::AccessibilityRequirements] Requirements for the accessible topology of the volume. These
-          #
-          #   @param availability [Symbol, DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode::Availability] The availability of the volume for use in tasks.
-          #
-          #   @param capacity_range [DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode::CapacityRange] The desired capacity that the volume should be created with. If
-          #
-          #   @param mount_volume [Object] Options for using this volume as a Mount-type volume.
-          #
-          #   @param scope [Symbol, DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode::Scope] The set of nodes this volume can be used on at one time.
-          #
-          #   @param secrets [Array<DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode::Secret>] Swarm Secrets that are passed to the CSI storage plugin when
-          #
-          #   @param sharing [Symbol, DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode::Sharing] The number and way that different tasks can use this volume
+          #   @param accessibility_requirements [DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode::AccessibilityRequirements]
+          #   @param availability [Symbol, DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode::Availability]
+          #   @param capacity_range [DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode::CapacityRange]
+          #   @param mount_volume [Hash{Symbol=>Object}]
+          #   @param scope [Symbol, DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode::Scope]
+          #   @param secrets [Array<DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode::Secret>]
+          #   @param sharing [Symbol, DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode::Sharing]
 
           # @see DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode#accessibility_requirements
           class AccessibilityRequirements < DockerEngineRuby::Internal::Type::BaseModel
             # @!attribute preferred
-            #   A list of topologies that the volume should attempt to be provisioned in.
             #
             #   @return [Array<Hash{Symbol=>String}>, nil]
             optional :preferred,
@@ -179,8 +128,6 @@ module DockerEngineRuby
                      api_name: :Preferred
 
             # @!attribute requisite
-            #   A list of required topologies, at least one of which the volume must be
-            #   accessible from.
             #
             #   @return [Array<Hash{Symbol=>String}>, nil]
             optional :requisite,
@@ -188,27 +135,10 @@ module DockerEngineRuby
                      api_name: :Requisite
 
             # @!method initialize(preferred: nil, requisite: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode::AccessibilityRequirements}
-            #   for more details.
-            #
-            #   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.
-            #
-            #   @param preferred [Array<Hash{Symbol=>String}>] A list of topologies that the volume should attempt to be
-            #
-            #   @param requisite [Array<Hash{Symbol=>String}>] A list of required topologies, at least one of which the
+            #   @param preferred [Array<Hash{Symbol=>String}>]
+            #   @param requisite [Array<Hash{Symbol=>String}>]
           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.
-          #
           # @see DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode#availability
           module Availability
             extend DockerEngineRuby::Internal::Type::Enum
@@ -224,38 +154,20 @@ module DockerEngineRuby
           # @see DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode#capacity_range
           class CapacityRange < DockerEngineRuby::Internal::Type::BaseModel
             # @!attribute limit_bytes
-            #   The volume must not be bigger than this. The value of 0 indicates an unspecified
-            #   maximum.
             #
             #   @return [Integer, nil]
             optional :limit_bytes, Integer, api_name: :LimitBytes
 
             # @!attribute required_bytes
-            #   The volume must be at least this big. The value of 0 indicates an unspecified
-            #   minimum
             #
             #   @return [Integer, nil]
             optional :required_bytes, Integer, api_name: :RequiredBytes
 
             # @!method initialize(limit_bytes: nil, required_bytes: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode::CapacityRange}
-            #   for more details.
-            #
-            #   The desired capacity that the volume should be created with. If empty, the
-            #   plugin will decide the capacity.
-            #
-            #   @param limit_bytes [Integer] The volume must not be bigger than this. The value of 0
-            #
-            #   @param required_bytes [Integer] The volume must be at least this big. The value of 0
+            #   @param limit_bytes [Integer]
+            #   @param required_bytes [Integer]
           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.
-          #
           # @see DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode#scope
           module Scope
             extend DockerEngineRuby::Internal::Type::Enum
@@ -269,41 +181,20 @@ module DockerEngineRuby
 
           class Secret < DockerEngineRuby::Internal::Type::BaseModel
             # @!attribute key
-            #   Key is the name of the key of the key-value pair passed to the plugin.
             #
             #   @return [String, nil]
             optional :key, String, api_name: :Key
 
             # @!attribute secret
-            #   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.
             #
             #   @return [String, nil]
             optional :secret, String, api_name: :Secret
 
             # @!method initialize(key: nil, secret: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode::Secret} for
-            #   more details.
-            #
-            #   One cluster volume secret entry. Defines a key-value pair that is passed to the
-            #   plugin.
-            #
-            #   @param key [String] Key is the name of the key of the key-value pair passed to
-            #
-            #   @param secret [String] Secret is the swarm Secret object from which to read data.
+            #   @param key [String]
+            #   @param secret [String]
           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.
-          #
           # @see DockerEngineRuby::Models::VolumeUpdateParams::Spec::AccessMode#sharing
           module Sharing
             extend DockerEngineRuby::Internal::Type::Enum

data/lib/docker_engine_ruby/resources/auth.rb

@@ -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
       #
       # @overload login(password: nil, serveraddress: nil, username: nil, request_options: {})
       #

data/lib/docker_engine_ruby/resources/configs.rb

@@ -5,15 +5,15 @@ module DockerEngineRuby
     class Configs
       # Create a config
       #
-      # @overload create(spec: nil, request_options: {})
+      # @overload create(spec:, request_options: {})
       #
-      # @param spec [DockerEngineRuby::Models::ConfigCreateParams::Spec]
+      # @param spec [DockerEngineRuby::Models::Spec]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::ConfigCreateResponse]
       #
       # @see DockerEngineRuby::Models::ConfigCreateParams
-      def create(params = {})
+      def create(params)
         parsed, options = DockerEngineRuby::ConfigCreateParams.dump_request(params)
         @client.request(
           method: :post,
@@ -24,16 +24,13 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ConfigUpdateParams} for more details.
-      #
       # Update a Config
       #
-      # @overload update(id, version:, spec: nil, request_options: {})
+      # @overload update(id, version:, spec:, request_options: {})
       #
-      # @param id [String] Path param: The ID or name of the config
+      # @param id [String] Path param
       #
-      # @param version [Integer] Query param: The version number of the config object being updated. This is
+      # @param version [Integer] Query param
       #
       # @param spec [DockerEngineRuby::Models::Spec] Body param
       #
@@ -54,15 +51,11 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ConfigListParams} for more details.
-      #
       # List configs
       #
       # @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::Config>]
@@ -83,8 +76,7 @@ module DockerEngineRuby
       #
       # @overload delete(id, request_options: {})
       #
-      # @param id [String] ID of the config
-      #
+      # @param id [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -103,8 +95,7 @@ module DockerEngineRuby
       #
       # @overload inspect_(id, request_options: {})
       #
-      # @param id [String] ID of the config
-      #
+      # @param id [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::Config]