docker-engine-ruby 0.2.2 → 0.4.0

data/lib/docker_engine_ruby/resources/networks.rb

@@ -10,35 +10,35 @@ module DockerEngineRuby
       #
       # @overload create(name:, attachable: nil, config_from: nil, config_only: nil, driver: nil, enable_i_pv4: nil, enable_i_pv6: nil, ingress: nil, internal: nil, ipam: nil, labels: nil, options: nil, scope: nil, request_options: {})
       #
-      # @param name [String] The network's name.
+      # @param name [String]
       #
-      # @param attachable [Boolean] Globally scoped network is manually attachable by regular
+      # @param attachable [Boolean]
       #
       # @param config_from [DockerEngineRuby::Models::NetworkCreateParams::ConfigFrom] The config-only network source to provide the configuration for
       #
-      # @param config_only [Boolean] Creates a config-only network. Config-only networks are placeholder
+      # @param config_only [Boolean]
       #
-      # @param driver [String] Name of the network driver plugin to use.
+      # @param driver [String]
       #
-      # @param enable_i_pv4 [Boolean] Enable IPv4 on the network.
+      # @param enable_i_pv4 [Boolean]
       #
-      # @param enable_i_pv6 [Boolean] Enable IPv6 on the network.
+      # @param enable_i_pv6 [Boolean]
       #
-      # @param ingress [Boolean] Ingress network is the network which provides the routing-mesh
+      # @param ingress [Boolean]
       #
-      # @param internal [Boolean] Restrict external access to the network.
+      # @param internal [Boolean]
       #
       # @param ipam [DockerEngineRuby::Models::NetworkCreateParams::Ipam]
       #
-      # @param labels [Hash{Symbol=>String}] User-defined key/value metadata.
+      # @param labels [Hash{Symbol=>String}]
       #
-      # @param options [Hash{Symbol=>String}] Network specific options to be used by the drivers.
+      # @param options [Hash{Symbol=>String}]
       #
-      # @param scope [String] The level at which the network exists (e.g. `swarm` for cluster-wide
+      # @param scope [String]
       #
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [DockerEngineRuby::Models::CreateResponse]
+      # @return [DockerEngineRuby::Models::NetworkCreateResponse]
       #
       # @see DockerEngineRuby::Models::NetworkCreateParams
       def create(params)
@@ -47,28 +47,19 @@ module DockerEngineRuby
           method: :post,
           path: "networks/create",
           body: parsed,
-          model: DockerEngineRuby::CreateResponse,
+          model: DockerEngineRuby::NetworkCreateResponse,
           options: options
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::NetworkListParams} for more details.
-      #
-      # Returns a list of networks. For details on the format, see the
-      # [network inspect endpoint](#operation/NetworkInspect).
-      #
-      # Note that it uses a different, smaller representation of a network than
-      # inspecting a single network. For example, the list of containers attached to the
-      # network is not propagated in API versions 1.28 and up.
+      # List networks
       #
       # @overload list(filters: nil, request_options: {})
       #
-      # @param filters [String] JSON encoded value of the filters (a `map[string][]string`) to process
-      #
+      # @param filters [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Array<DockerEngineRuby::Models::Summary>]
+      # @return [Array<DockerEngineRuby::Models::NetworkSummary>]
       #
       # @see DockerEngineRuby::Models::NetworkListParams
       def list(params = {})
@@ -77,7 +68,7 @@ module DockerEngineRuby
           method: :get,
           path: "networks",
           query: parsed,
-          model: DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Summary],
+          model: DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::NetworkSummary],
           options: options
         )
       end
@@ -86,8 +77,7 @@ module DockerEngineRuby
       #
       # @overload delete(id, request_options: {})
       #
-      # @param id [String] Network ID or name
-      #
+      # @param id [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -102,17 +92,15 @@ module DockerEngineRuby
         )
       end
 
-      # The network must be either a local-scoped network or a swarm-scoped network with
-      # the `attachable` option set. A network cannot be re-attached to a running
-      # container
+      # Connect a container to a network
       #
       # @overload connect(id, container:, endpoint_config: nil, request_options: {})
       #
-      # @param id [String] Network ID or name
+      # @param id [String]
       #
       # @param container [String] The ID or name of the container to connect to the network.
       #
-      # @param endpoint_config [DockerEngineRuby::Models::ConnectRequest::EndpointConfig] Configuration for a network endpoint.
+      # @param endpoint_config [DockerEngineRuby::Models::ConnectRequest::EndpointConfig, nil] Configuration for a network endpoint.
       #
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -134,7 +122,7 @@ module DockerEngineRuby
       #
       # @overload disconnect(id, container:, force: nil, request_options: {})
       #
-      # @param id [String] Network ID or name
+      # @param id [String]
       #
       # @param container [String] The ID or name of the container to disconnect from the network.
       #
@@ -160,12 +148,9 @@ module DockerEngineRuby
       #
       # @overload inspect_(id, scope: nil, verbose: nil, request_options: {})
       #
-      # @param id [String] Network ID or name
-      #
-      # @param scope [String] Filter the network by scope (swarm, global, or local)
-      #
-      # @param verbose [Boolean] Detailed inspect output for troubleshooting
-      #
+      # @param id [String]
+      # @param scope [String]
+      # @param verbose [Boolean]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::NetworkInspectResponse]
@@ -182,15 +167,11 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::NetworkPruneParams} for more details.
-      #
       # Delete unused networks
       #
       # @overload prune(filters: nil, request_options: {})
       #
-      # @param filters [String] Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
-      #
+      # @param filters [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::NetworkPruneResponse]

data/lib/docker_engine_ruby/resources/nodes.rb

@@ -3,18 +3,15 @@
 module DockerEngineRuby
   module Resources
     class Nodes
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::NodeUpdateParams} for more details.
-      #
       # Update a node
       #
-      # @overload update(id, version:, spec: nil, request_options: {})
+      # @overload update(id, version:, spec:, request_options: {})
       #
-      # @param id [String] Path param: The ID of the node
+      # @param id [String] Path param
       #
-      # @param version [Integer] Query param: The version number of the node object being updated. This is requir
+      # @param version [Integer] Query param
       #
-      # @param spec [DockerEngineRuby::Models::Spec] Body param
+      # @param spec [DockerEngineRuby::Models::NodeSpec] Body param
       #
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -33,15 +30,11 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::NodeListParams} for more details.
-      #
       # List nodes
       #
       # @overload list(filters: nil, request_options: {})
       #
-      # @param filters [String] Filters to process on the nodes list, encoded as JSON (a `map[string][]string`).
-      #
+      # @param filters [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Array<DockerEngineRuby::Models::Node>]
@@ -62,10 +55,8 @@ module DockerEngineRuby
       #
       # @overload delete(id, force: nil, request_options: {})
       #
-      # @param id [String] The ID or name of the node
-      #
-      # @param force [Boolean] Force remove a node from the swarm
-      #
+      # @param id [String]
+      # @param force [Boolean]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -86,8 +77,7 @@ module DockerEngineRuby
       #
       # @overload inspect_(id, request_options: {})
       #
-      # @param id [String] The ID or name of the node
-      #
+      # @param id [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::Node]

data/lib/docker_engine_ruby/resources/plugins.rb

@@ -3,14 +3,11 @@
 module DockerEngineRuby
   module Resources
     class Plugins
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::PluginCreateParams} for more details.
-      #
       # Create a plugin
       #
       # @overload create(name:, body:, request_options: {})
       #
-      # @param name [String] Query param: The name of the plugin. The `:latest` tag is optional, and is the
+      # @param name [String] Query param
       #
       # @param body [Pathname, StringIO, IO, String, DockerEngineRuby::FilePart] Body param
       #
@@ -25,22 +22,18 @@ module DockerEngineRuby
           method: :post,
           path: "plugins/create",
           query: parsed.except(:body),
-          headers: {"content-type" => "application/x-tar"},
+          headers: {"content-type" => "application/octet-stream"},
           body: parsed[:body],
           model: NilClass,
           options: options
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::PluginListParams} for more details.
-      #
-      # Returns information about installed plugins.
+      # List plugins
       #
       # @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::Plugin>]
@@ -57,17 +50,12 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::PluginDeleteParams} for more details.
-      #
       # Remove a plugin
       #
       # @overload delete(name, force: nil, request_options: {})
       #
-      # @param name [String] The name of the plugin. The `:latest` tag is optional, and is the
-      #
-      # @param force [Boolean] Disable the plugin before removing. This may result in issues if the
-      #
+      # @param name [String]
+      # @param force [Boolean]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::Plugin]
@@ -84,17 +72,12 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::PluginDisableParams} for more details.
-      #
       # Disable a plugin
       #
       # @overload disable(name, force: nil, request_options: {})
       #
-      # @param name [String] The name of the plugin. The `:latest` tag is optional, and is the
-      #
-      # @param force [Boolean] Force disable a plugin even if still in use.
-      #
+      # @param name [String]
+      # @param force [Boolean]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -111,17 +94,12 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::PluginEnableParams} for more details.
-      #
       # Enable a plugin
       #
       # @overload enable(name, timeout: nil, request_options: {})
       #
-      # @param name [String] The name of the plugin. The `:latest` tag is optional, and is the
-      #
-      # @param timeout [Integer] Set the HTTP client timeout (in seconds)
-      #
+      # @param name [String]
+      # @param timeout [Integer]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -138,15 +116,11 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::PluginInspectParams} for more details.
-      #
       # Inspect a plugin
       #
       # @overload inspect_(name, request_options: {})
       #
-      # @param name [String] The name of the plugin. The `:latest` tag is optional, and is the
-      #
+      # @param name [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::Plugin]
@@ -161,15 +135,11 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::PluginPrivilegesParams} for more details.
-      #
       # Get plugin privileges
       #
       # @overload privileges(remote:, request_options: {})
       #
-      # @param remote [String] The name of the plugin. The `:latest` tag is optional, and is the
-      #
+      # @param remote [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Array<DockerEngineRuby::Models::Privilege>]
@@ -186,22 +156,17 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::PluginPullParams} for more details.
+      # Install a plugin
       #
-      # Pulls and installs a plugin. After the plugin is installed, it can be enabled
-      # using the
-      # [`POST /plugins/{name}/enable` endpoint](#operation/PostPluginsEnable).
+      # @overload pull(remote:, body:, name: nil, x_registry_auth: nil, request_options: {})
       #
-      # @overload pull(remote:, name: nil, body: nil, x_registry_auth: nil, request_options: {})
-      #
-      # @param remote [String] Query param: Remote reference for plugin to install.
-      #
-      # @param name [String] Query param: Local name for the pulled plugin.
+      # @param remote [String] Query param
       #
       # @param body [Array<DockerEngineRuby::Models::Privilege>] Body param
       #
-      # @param x_registry_auth [String] Header param: A base64url-encoded auth configuration to use when pulling a plugi
+      # @param name [String] Query param
+      #
+      # @param x_registry_auth [String] Header param
       #
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -222,15 +187,11 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::PluginPushParams} for more details.
-      #
-      # Push a plugin to the registry.
+      # Push a plugin
       #
       # @overload push(name, request_options: {})
       #
-      # @param name [String] The name of the plugin. The `:latest` tag is optional, and is the
-      #
+      # @param name [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -245,23 +206,18 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::PluginSetParams} for more details.
-      #
       # Configure a plugin
       #
-      # @overload set(name, body: nil, request_options: {})
-      #
-      # @param name [String] The name of the plugin. The `:latest` tag is optional, and is the
+      # @overload set(name, body:, request_options: {})
       #
+      # @param name [String]
       # @param body [Array<String>]
-      #
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
       #
       # @see DockerEngineRuby::Models::PluginSetParams
-      def set(name, params = {})
+      def set(name, params)
         parsed, options = DockerEngineRuby::PluginSetParams.dump_request(params)
         @client.request(
           method: :post,
@@ -272,20 +228,17 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::PluginUpgradeParams} for more details.
-      #
       # Upgrade a plugin
       #
-      # @overload upgrade(name, remote:, body: nil, x_registry_auth: nil, request_options: {})
+      # @overload upgrade(name, remote:, body:, x_registry_auth: nil, request_options: {})
       #
-      # @param name [String] Path param: The name of the plugin. The `:latest` tag is optional, and is the
+      # @param name [String] Path param
       #
-      # @param remote [String] Query param: Remote reference to upgrade to.
+      # @param remote [String] Query param
       #
       # @param body [Array<DockerEngineRuby::Models::Privilege>] Body param
       #
-      # @param x_registry_auth [String] Header param: A base64url-encoded auth configuration to use when pulling a plugi
+      # @param x_registry_auth [String] Header param
       #
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/docker_engine_ruby/resources/secrets.rb

@@ -5,15 +5,15 @@ module DockerEngineRuby
     class Secrets
       # Create a secret
       #
-      # @overload create(spec: nil, request_options: {})
+      # @overload create(spec:, request_options: {})
       #
-      # @param spec [DockerEngineRuby::Models::SecretCreateParams::Spec]
+      # @param spec [DockerEngineRuby::Models::SecretSpec]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::SecretCreateResponse]
       #
       # @see DockerEngineRuby::Models::SecretCreateParams
-      def create(params = {})
+      def create(params)
         parsed, options = DockerEngineRuby::SecretCreateParams.dump_request(params)
         @client.request(
           method: :post,
@@ -24,18 +24,15 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::SecretUpdateParams} for more details.
-      #
       # Update a Secret
       #
-      # @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 secret
+      # @param id [String] Path param
       #
-      # @param version [Integer] Query param: The version number of the secret object being updated. This is
+      # @param version [Integer] Query param
       #
-      # @param spec [DockerEngineRuby::Models::Spec] Body param
+      # @param spec [DockerEngineRuby::Models::SecretSpec] Body param
       #
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -54,15 +51,11 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::SecretListParams} for more details.
-      #
       # List secrets
       #
       # @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::Secret>]
@@ -83,8 +76,7 @@ module DockerEngineRuby
       #
       # @overload delete(id, request_options: {})
       #
-      # @param id [String] ID of the secret
-      #
+      # @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 secret
-      #
+      # @param id [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::Secret]