docker-engine-ruby 0.2.2 → 0.3.0

data/rbi/docker_engine_ruby/resources/networks.rbi

@@ -24,71 +24,32 @@ module DockerEngineRuby
         ).returns(DockerEngineRuby::CreateResponse)
       end
       def create(
-        # The network's name.
         name:,
-        # Globally scoped 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,
-        # Creates 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,
-        # Name of the network driver plugin to use.
         driver: nil,
-        # Enable IPv4 on the network.
         enable_i_pv4: nil,
-        # Enable IPv6 on the network.
         enable_i_pv6: nil,
-        # Ingress network is the network which provides the routing-mesh in swarm mode.
         ingress: nil,
-        # Restrict external access to the network.
         internal: nil,
         ipam: nil,
-        # User-defined key/value metadata.
         labels: nil,
-        # Network specific options to be used by the drivers.
         options: nil,
-        # The level at which the network exists (e.g. `swarm` for cluster-wide or `local`
-        # for machine level).
         scope: nil,
         request_options: {}
       )
       end
 
-      # 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
       sig do
         params(
           filters: String,
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T::Array[DockerEngineRuby::Summary])
       end
-      def list(
-        # 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 list(filters: nil, request_options: {})
       end
 
       # Remove a network
@@ -98,27 +59,20 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).void
       end
-      def delete(
-        # Network ID or name
-        id,
-        request_options: {}
-      )
+      def delete(id, request_options: {})
       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
       sig do
         params(
           id: String,
           container: String,
           endpoint_config:
-            DockerEngineRuby::ConnectRequest::EndpointConfig::OrHash,
+            T.nilable(DockerEngineRuby::ConnectRequest::EndpointConfig::OrHash),
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).void
       end
       def connect(
-        # Network ID or name
         id,
         # The ID or name of the container to connect to the network.
         container:,
@@ -138,7 +92,6 @@ module DockerEngineRuby
         ).void
       end
       def disconnect(
-        # Network ID or name
         id,
         # The ID or name of the container to disconnect from the network.
         container:,
@@ -157,15 +110,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(DockerEngineRuby::Models::NetworkInspectResponse)
       end
-      def inspect_(
-        # Network ID or name
-        id,
-        # Filter the network by scope (swarm, global, or local)
-        scope: nil,
-        # Detailed inspect output for troubleshooting
-        verbose: nil,
-        request_options: {}
-      )
+      def inspect_(id, scope: nil, verbose: nil, request_options: {})
       end
 
       # Delete unused networks
@@ -175,21 +120,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(DockerEngineRuby::Models::NetworkPruneResponse)
       end
-      def prune(
-        # 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 prune(filters: nil, request_options: {})
       end
 
       # @api private

data/rbi/docker_engine_ruby/resources/nodes.rbi

@@ -13,13 +13,12 @@ module DockerEngineRuby
         ).void
       end
       def update(
-        # Path param: The ID of the node
+        # Path param
         id,
-        # Query param: The version number of the node object being updated. This is
-        # required to avoid conflicting writes.
+        # Query param
         version:,
         # Body param
-        spec: nil,
+        spec:,
         request_options: {}
       )
       end
@@ -31,20 +30,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T::Array[DockerEngineRuby::Node])
       end
-      def list(
-        # Filters to process on the nodes list, encoded as JSON (a `map[string][]string`).
-        #
-        # Available filters:
-        #
-        # - `id=<node id>`
-        # - `label=<engine label>`
-        # - `membership=`(`accepted`|`pending`)`
-        # - `name=<node name>`
-        # - `node.label=<node label>`
-        # - `role=`(`manager`|`worker`)`
-        filters: nil,
-        request_options: {}
-      )
+      def list(filters: nil, request_options: {})
       end
 
       # Delete a node
@@ -55,13 +41,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).void
       end
-      def delete(
-        # The ID or name of the node
-        id,
-        # Force remove a node from the swarm
-        force: nil,
-        request_options: {}
-      )
+      def delete(id, force: nil, request_options: {})
       end
 
       # Inspect a node
@@ -71,11 +51,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(DockerEngineRuby::Node)
       end
-      def inspect_(
-        # The ID or name of the node
-        id,
-        request_options: {}
-      )
+      def inspect_(id, request_options: {})
       end
 
       # @api private

data/rbi/docker_engine_ruby/resources/plugins.rbi

@@ -12,8 +12,7 @@ module DockerEngineRuby
         ).void
       end
       def create(
-        # Query param: The name of the plugin. The `:latest` tag is optional, and is the
-        # default if omitted.
+        # Query param
         name:,
         # Body param
         body:,
@@ -21,24 +20,14 @@ module DockerEngineRuby
       )
       end
 
-      # Returns information about installed plugins.
+      # List plugins
       sig do
         params(
           filters: String,
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T::Array[DockerEngineRuby::Plugin])
       end
-      def list(
-        # A JSON encoded value of the filters (a `map[string][]string`) to process on the
-        # plugin list.
-        #
-        # Available filters:
-        #
-        # - `capability=<capability name>`
-        # - `enable=<true>|<false>`
-        filters: nil,
-        request_options: {}
-      )
+      def list(filters: nil, request_options: {})
       end
 
       # Remove a plugin
@@ -49,15 +38,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(DockerEngineRuby::Plugin)
       end
-      def delete(
-        # The name of the plugin. The `:latest` tag is optional, and is the default if
-        # omitted.
-        name,
-        # Disable the plugin before removing. This may result in issues if the plugin is
-        # in use by a container.
-        force: nil,
-        request_options: {}
-      )
+      def delete(name, force: nil, request_options: {})
       end
 
       # Disable a plugin
@@ -68,14 +49,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).void
       end
-      def disable(
-        # The name of the plugin. The `:latest` tag is optional, and is the default if
-        # omitted.
-        name,
-        # Force disable a plugin even if still in use.
-        force: nil,
-        request_options: {}
-      )
+      def disable(name, force: nil, request_options: {})
       end
 
       # Enable a plugin
@@ -86,14 +60,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).void
       end
-      def enable(
-        # The name of the plugin. The `:latest` tag is optional, and is the default if
-        # omitted.
-        name,
-        # Set the HTTP client timeout (in seconds)
-        timeout: nil,
-        request_options: {}
-      )
+      def enable(name, timeout: nil, request_options: {})
       end
 
       # Inspect a plugin
@@ -103,12 +70,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(DockerEngineRuby::Plugin)
       end
-      def inspect_(
-        # The name of the plugin. The `:latest` tag is optional, and is the default if
-        # omitted.
-        name,
-        request_options: {}
-      )
+      def inspect_(name, request_options: {})
       end
 
       # Get plugin privileges
@@ -118,59 +80,40 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T::Array[DockerEngineRuby::Privilege])
       end
-      def privileges(
-        # The name of the plugin. The `:latest` tag is optional, and is the default if
-        # omitted.
-        remote:,
-        request_options: {}
-      )
+      def privileges(remote:, request_options: {})
       end
 
-      # Pulls and installs a plugin. After the plugin is installed, it can be enabled
-      # using the
-      # [`POST /plugins/{name}/enable` endpoint](#operation/PostPluginsEnable).
+      # Install a plugin
       sig do
         params(
           remote: String,
-          name: String,
           body: T::Array[DockerEngineRuby::Privilege::OrHash],
+          name: String,
           x_registry_auth: String,
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).void
       end
       def pull(
-        # Query param: Remote reference for plugin to install.
-        #
-        # The `:latest` tag is optional, and is used as the default if omitted.
+        # Query param
         remote:,
-        # Query param: Local name for the pulled plugin.
-        #
-        # The `:latest` tag is optional, and is used as the default if omitted.
-        name: nil,
         # Body param
-        body: nil,
-        # Header param: A base64url-encoded auth configuration to use when pulling a
-        # plugin from a registry.
-        #
-        # Refer to the [authentication section](#section/Authentication) for details.
+        body:,
+        # Query param
+        name: nil,
+        # Header param
         x_registry_auth: nil,
         request_options: {}
       )
       end
 
-      # Push a plugin to the registry.
+      # Push a plugin
       sig do
         params(
           name: String,
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).void
       end
-      def push(
-        # The name of the plugin. The `:latest` tag is optional, and is the default if
-        # omitted.
-        name,
-        request_options: {}
-      )
+      def push(name, request_options: {})
       end
 
       # Configure a plugin
@@ -181,13 +124,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).void
       end
-      def set(
-        # The name of the plugin. The `:latest` tag is optional, and is the default if
-        # omitted.
-        name,
-        body: nil,
-        request_options: {}
-      )
+      def set(name, body:, request_options: {})
       end
 
       # Upgrade a plugin
@@ -201,19 +138,13 @@ module DockerEngineRuby
         ).void
       end
       def upgrade(
-        # Path param: The name of the plugin. The `:latest` tag is optional, and is the
-        # default if omitted.
+        # Path param
         name,
-        # Query param: Remote reference to upgrade to.
-        #
-        # The `:latest` tag is optional, and is used as the default if omitted.
+        # Query param
         remote:,
         # Body param
-        body: nil,
-        # Header param: A base64url-encoded auth configuration to use when pulling a
-        # plugin from a registry.
-        #
-        # Refer to the [authentication section](#section/Authentication) for details.
+        body:,
+        # Header param
         x_registry_auth: nil,
         request_options: {}
       )

data/rbi/docker_engine_ruby/resources/secrets.rbi

@@ -6,11 +6,11 @@ module DockerEngineRuby
       # Create a secret
       sig do
         params(
-          spec: DockerEngineRuby::SecretCreateParams::Spec::OrHash,
+          spec: DockerEngineRuby::Spec::OrHash,
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(DockerEngineRuby::Models::SecretCreateResponse)
       end
-      def create(spec: nil, request_options: {})
+      def create(spec:, request_options: {})
       end
 
       # Update a Secret
@@ -23,13 +23,12 @@ module DockerEngineRuby
         ).void
       end
       def update(
-        # Path param: The ID or name of the secret
+        # Path param
         id,
-        # Query param: The version number of the secret object being updated. This is
-        # required to avoid conflicting writes.
+        # Query param
         version:,
         # Body param
-        spec: nil,
+        spec:,
         request_options: {}
       )
       end
@@ -41,19 +40,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T::Array[DockerEngineRuby::Secret])
       end
-      def list(
-        # A JSON encoded value of the filters (a `map[string][]string`) to process on the
-        # secrets list.
-        #
-        # Available filters:
-        #
-        # - `id=<secret id>`
-        # - `label=<key> or label=<key>=value`
-        # - `name=<secret name>`
-        # - `names=<secret name>`
-        filters: nil,
-        request_options: {}
-      )
+      def list(filters: nil, request_options: {})
       end
 
       # Delete a secret
@@ -63,11 +50,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).void
       end
-      def delete(
-        # ID of the secret
-        id,
-        request_options: {}
-      )
+      def delete(id, request_options: {})
       end
 
       # Inspect a secret
@@ -77,11 +60,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(DockerEngineRuby::Secret)
       end
-      def inspect_(
-        # ID of the secret
-        id,
-        request_options: {}
-      )
+      def inspect_(id, request_options: {})
       end
 
       # @api private

data/rbi/docker_engine_ruby/resources/services.rbi

@@ -6,7 +6,7 @@ module DockerEngineRuby
       # Create a service
       sig do
         params(
-          spec: DockerEngineRuby::ServiceCreateParams::Spec::OrHash,
+          spec: DockerEngineRuby::Spec::OrHash,
           x_registry_auth: String,
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(DockerEngineRuby::CreateResponse)
@@ -14,10 +14,7 @@ module DockerEngineRuby
       def create(
         # Body param: User modifiable configuration for a service.
         spec:,
-        # Header param: A base64url-encoded auth configuration for pulling from private
-        # registries.
-        #
-        # Refer to the [authentication section](#section/Authentication) for details.
+        # Header param
         x_registry_auth: nil,
         request_options: {}
       )
@@ -28,7 +25,7 @@ module DockerEngineRuby
         params(
           id: String,
           version: Integer,
-          spec: DockerEngineRuby::ServiceUpdateParams::Spec::OrHash,
+          spec: DockerEngineRuby::Spec::OrHash,
           registry_auth_from:
             DockerEngineRuby::ServiceUpdateParams::RegistryAuthFrom::OrSymbol,
           rollback: String,
@@ -37,25 +34,17 @@ module DockerEngineRuby
         ).returns(DockerEngineRuby::UpdateResponse)
       end
       def update(
-        # Path param: ID or name of service.
+        # Path param
         id,
-        # Query param: The version number of the service object being updated. This is
-        # required to avoid conflicting writes. This version number should be the value as
-        # currently set on the service _before_ the update. You can find the current
-        # version by calling `GET /services/{id}`
+        # Query param
         version:,
         # Body param: User modifiable configuration for a service.
         spec:,
-        # Query param: If the `X-Registry-Auth` header is not specified, this parameter
-        # indicates where to find registry authorization credentials.
+        # Query param
         registry_auth_from: nil,
-        # Query param: Set to this parameter to `previous` to cause a server-side rollback
-        # to the previous service spec. The supplied spec will be ignored in this case.
+        # Query param
         rollback: nil,
-        # Header param: A base64url-encoded auth configuration for pulling from private
-        # registries.
-        #
-        # Refer to the [authentication section](#section/Authentication) for details.
+        # Header param
         x_registry_auth: nil,
         request_options: {}
       )
@@ -69,21 +58,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T::Array[DockerEngineRuby::Service])
       end
-      def list(
-        # A JSON encoded value of the filters (a `map[string][]string`) to process on the
-        # services list.
-        #
-        # Available filters:
-        #
-        # - `id=<service id>`
-        # - `label=<service label>`
-        # - `mode=["replicated"|"global"]`
-        # - `name=<service name>`
-        filters: nil,
-        # Include service status, with count of running and desired tasks.
-        status: nil,
-        request_options: {}
-      )
+      def list(filters: nil, status: nil, request_options: {})
       end
 
       # Delete a service
@@ -93,11 +68,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).void
       end
-      def delete(
-        # ID or name of service.
-        id,
-        request_options: {}
-      )
+      def delete(id, request_options: {})
       end
 
       # Inspect a service
@@ -108,20 +79,10 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(DockerEngineRuby::Service)
       end
-      def inspect_(
-        # ID or name of service.
-        id,
-        # Fill empty fields with default values.
-        insert_defaults: nil,
-        request_options: {}
-      )
+      def inspect_(id, insert_defaults: nil, request_options: {})
       end
 
-      # Get `stdout` and `stderr` logs from a service. See also
-      # [`/containers/{id}/logs`](#operation/ContainerLogs).
-      #
-      # **Note**: This endpoint works only for services with the `local`, `json-file` or
-      # `journald` logging drivers.
+      # Get service logs
       sig do
         params(
           id: String,
@@ -136,22 +97,13 @@ module DockerEngineRuby
         ).returns(StringIO)
       end
       def logs(
-        # ID or name of the service
         id,
-        # Show service context and extra details provided to logs.
         details: nil,
-        # Keep connection after returning logs.
         follow: nil,
-        # Only return logs since this time, as a UNIX timestamp
         since: nil,
-        # Return logs from `stderr`
         stderr: nil,
-        # Return logs from `stdout`
         stdout: nil,
-        # Only return this number of log lines from the end of the logs. Specify as an
-        # integer or `all` to output all log lines.
         tail: nil,
-        # Add timestamps to every log line
         timestamps: nil,
         request_options: {}
       )