docker-engine 0.1.1 → 0.2.0

data/rbi/docker_engine/resources/networks.rbi

@@ -20,7 +20,7 @@ module DockerEngine
           options: T::Hash[Symbol, String],
           scope: String,
           request_options: DockerEngine::RequestOptions::OrHash
-        ).returns(DockerEngine::Models::NetworkCreateResponse)
+        ).returns(DockerEngine::CreateResponse)
       end
       def create(
         # The network's name.
@@ -104,6 +104,48 @@ module DockerEngine
       )
       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
+      sig do
+        params(
+          id: String,
+          container: String,
+          endpoint_config: DockerEngine::ConnectRequest::EndpointConfig::OrHash,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).void
+      end
+      def connect(
+        # Network ID or name
+        id,
+        # The ID or name of the container to connect to the network.
+        container:,
+        # Configuration for a network endpoint.
+        endpoint_config: nil,
+        request_options: {}
+      )
+      end
+
+      # Disconnect a container from a network
+      sig do
+        params(
+          id: String,
+          container: String,
+          force: T::Boolean,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).void
+      end
+      def disconnect(
+        # Network ID or name
+        id,
+        # The ID or name of the container to disconnect from the network.
+        container:,
+        # Force the container to disconnect from the network.
+        force: nil,
+        request_options: {}
+      )
+      end
+
       # Inspect a network
       sig do
         params(
@@ -124,6 +166,30 @@ module DockerEngine
       )
       end
 
+      # Delete unused networks
+      sig do
+        params(
+          filters: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(DockerEngine::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: {}
+      )
+      end
+
       # @api private
       sig { params(client: DockerEngine::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/docker_engine/resources/nodes.rbi

@@ -0,0 +1,87 @@
+# typed: strong
+
+module DockerEngine
+  module Resources
+    class Nodes
+      # Update a node
+      sig do
+        params(
+          id: String,
+          version: Integer,
+          spec: DockerEngine::Spec::OrHash,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).void
+      end
+      def update(
+        # Path param: The ID of the node
+        id,
+        # Query param: The version number of the node object being updated. This is
+        # required to avoid conflicting writes.
+        version:,
+        # Body param
+        spec: nil,
+        request_options: {}
+      )
+      end
+
+      # List nodes
+      sig do
+        params(
+          filters: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T::Array[DockerEngine::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: {}
+      )
+      end
+
+      # Delete a node
+      sig do
+        params(
+          id: String,
+          force: T::Boolean,
+          request_options: DockerEngine::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: {}
+      )
+      end
+
+      # Inspect a node
+      sig do
+        params(
+          id: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(DockerEngine::Node)
+      end
+      def inspect_(
+        # The ID or name of the node
+        id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: DockerEngine::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/docker_engine/resources/plugins.rbi

@@ -0,0 +1,228 @@
+# typed: strong
+
+module DockerEngine
+  module Resources
+    class Plugins
+      # Create a plugin
+      sig do
+        params(
+          name: String,
+          body: DockerEngine::Internal::FileInput,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).void
+      end
+      def create(
+        # Query param: The name of the plugin. The `:latest` tag is optional, and is the
+        # default if omitted.
+        name:,
+        # Body param
+        body:,
+        request_options: {}
+      )
+      end
+
+      # Returns information about installed plugins.
+      sig do
+        params(
+          filters: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T::Array[DockerEngine::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: {}
+      )
+      end
+
+      # Remove a plugin
+      sig do
+        params(
+          name: String,
+          force: T::Boolean,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(DockerEngine::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: {}
+      )
+      end
+
+      # Disable a plugin
+      sig do
+        params(
+          name: String,
+          force: T::Boolean,
+          request_options: DockerEngine::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: {}
+      )
+      end
+
+      # Enable a plugin
+      sig do
+        params(
+          name: String,
+          timeout: Integer,
+          request_options: DockerEngine::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: {}
+      )
+      end
+
+      # Inspect a plugin
+      sig do
+        params(
+          name: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(DockerEngine::Plugin)
+      end
+      def inspect_(
+        # The name of the plugin. The `:latest` tag is optional, and is the default if
+        # omitted.
+        name,
+        request_options: {}
+      )
+      end
+
+      # Get plugin privileges
+      sig do
+        params(
+          remote: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T::Array[DockerEngine::Privilege])
+      end
+      def privileges(
+        # The name of the plugin. The `:latest` tag is optional, and is the default if
+        # omitted.
+        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).
+      sig do
+        params(
+          remote: String,
+          name: String,
+          body: T::Array[DockerEngine::Privilege::OrHash],
+          x_registry_auth: String,
+          request_options: DockerEngine::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.
+        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.
+        x_registry_auth: nil,
+        request_options: {}
+      )
+      end
+
+      # Push a plugin to the registry.
+      sig do
+        params(
+          name: String,
+          request_options: DockerEngine::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: {}
+      )
+      end
+
+      # Configure a plugin
+      sig do
+        params(
+          name: String,
+          body: T::Array[String],
+          request_options: DockerEngine::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: {}
+      )
+      end
+
+      # Upgrade a plugin
+      sig do
+        params(
+          name: String,
+          remote: String,
+          body: T::Array[DockerEngine::Privilege::OrHash],
+          x_registry_auth: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).void
+      end
+      def upgrade(
+        # Path param: The name of the plugin. The `:latest` tag is optional, and is the
+        # default if omitted.
+        name,
+        # Query param: Remote reference to upgrade to.
+        #
+        # The `:latest` tag is optional, and is used as the default if omitted.
+        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.
+        x_registry_auth: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: DockerEngine::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/docker_engine/resources/secrets.rbi

@@ -0,0 +1,93 @@
+# typed: strong
+
+module DockerEngine
+  module Resources
+    class Secrets
+      # Create a secret
+      sig do
+        params(
+          spec: DockerEngine::SecretCreateParams::Spec::OrHash,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(DockerEngine::Models::SecretCreateResponse)
+      end
+      def create(spec: nil, request_options: {})
+      end
+
+      # Update a Secret
+      sig do
+        params(
+          id: String,
+          version: Integer,
+          spec: DockerEngine::Spec::OrHash,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).void
+      end
+      def update(
+        # Path param: The ID or name of the secret
+        id,
+        # Query param: The version number of the secret object being updated. This is
+        # required to avoid conflicting writes.
+        version:,
+        # Body param
+        spec: nil,
+        request_options: {}
+      )
+      end
+
+      # List secrets
+      sig do
+        params(
+          filters: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T::Array[DockerEngine::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: {}
+      )
+      end
+
+      # Delete a secret
+      sig do
+        params(
+          id: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # ID of the secret
+        id,
+        request_options: {}
+      )
+      end
+
+      # Inspect a secret
+      sig do
+        params(
+          id: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(DockerEngine::Secret)
+      end
+      def inspect_(
+        # ID of the secret
+        id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: DockerEngine::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/docker_engine/resources/services.rbi

@@ -9,7 +9,7 @@ module DockerEngine
           spec: DockerEngine::ServiceCreateParams::Spec::OrHash,
           x_registry_auth: String,
           request_options: DockerEngine::RequestOptions::OrHash
-        ).returns(DockerEngine::Models::ServiceCreateResponse)
+        ).returns(DockerEngine::CreateResponse)
       end
       def create(
         # Body param: User modifiable configuration for a service.
@@ -23,6 +23,44 @@ module DockerEngine
       )
       end
 
+      # Update a service
+      sig do
+        params(
+          id: String,
+          version: Integer,
+          spec: DockerEngine::ServiceUpdateParams::Spec::OrHash,
+          registry_auth_from:
+            DockerEngine::ServiceUpdateParams::RegistryAuthFrom::OrSymbol,
+          rollback: String,
+          x_registry_auth: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(DockerEngine::UpdateResponse)
+      end
+      def update(
+        # Path param: ID or name of service.
+        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}`
+        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.
+        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.
+        rollback: nil,
+        # Header param: A base64url-encoded auth configuration for pulling from private
+        # registries.
+        #
+        # Refer to the [authentication section](#section/Authentication) for details.
+        x_registry_auth: nil,
+        request_options: {}
+      )
+      end
+
       # List services
       sig do
         params(
@@ -79,6 +117,46 @@ module DockerEngine
       )
       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.
+      sig do
+        params(
+          id: String,
+          details: T::Boolean,
+          follow: T::Boolean,
+          since: Integer,
+          stderr: T::Boolean,
+          stdout: T::Boolean,
+          tail: String,
+          timestamps: T::Boolean,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).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: {}
+      )
+      end
+
       # @api private
       sig { params(client: DockerEngine::Client).returns(T.attached_class) }
       def self.new(client:)