docker-engine-api 0.2.1

data/rbi/docker_engine_api/resources/networks.rbi

@@ -0,0 +1,200 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Resources
+    class Networks
+      # Create a network
+      sig do
+        params(
+          name: String,
+          attachable: T::Boolean,
+          config_from: DockerEngineAPI::NetworkCreateParams::ConfigFrom::OrHash,
+          config_only: T::Boolean,
+          driver: String,
+          enable_i_pv4: T::Boolean,
+          enable_i_pv6: T::Boolean,
+          ingress: T::Boolean,
+          internal: T::Boolean,
+          ipam: DockerEngineAPI::NetworkCreateParams::Ipam::OrHash,
+          labels: T::Hash[Symbol, String],
+          options: T::Hash[Symbol, String],
+          scope: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::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.
+      sig do
+        params(
+          filters: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T::Array[DockerEngineAPI::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: {}
+      )
+      end
+
+      # Remove a network
+      sig do
+        params(
+          id: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # Network ID or name
+        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
+      sig do
+        params(
+          id: String,
+          container: String,
+          endpoint_config:
+            DockerEngineAPI::ConnectRequest::EndpointConfig::OrHash,
+          request_options: DockerEngineAPI::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: DockerEngineAPI::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(
+          id: String,
+          scope: String,
+          verbose: T::Boolean,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::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: {}
+      )
+      end
+
+      # Delete unused networks
+      sig do
+        params(
+          filters: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::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: DockerEngineAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/resources/nodes.rbi

@@ -0,0 +1,87 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Resources
+    class Nodes
+      # Update a node
+      sig do
+        params(
+          id: String,
+          version: Integer,
+          spec: DockerEngineAPI::Spec::OrHash,
+          request_options: DockerEngineAPI::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: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T::Array[DockerEngineAPI::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: DockerEngineAPI::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: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::Node)
+      end
+      def inspect_(
+        # The ID or name of the node
+        id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: DockerEngineAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/resources/plugins.rbi

@@ -0,0 +1,228 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Resources
+    class Plugins
+      # Create a plugin
+      sig do
+        params(
+          name: String,
+          body: DockerEngineAPI::Internal::FileInput,
+          request_options: DockerEngineAPI::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: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T::Array[DockerEngineAPI::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: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::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: DockerEngineAPI::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: DockerEngineAPI::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: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::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: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T::Array[DockerEngineAPI::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[DockerEngineAPI::Privilege::OrHash],
+          x_registry_auth: String,
+          request_options: DockerEngineAPI::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: DockerEngineAPI::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: DockerEngineAPI::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[DockerEngineAPI::Privilege::OrHash],
+          x_registry_auth: String,
+          request_options: DockerEngineAPI::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: DockerEngineAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/resources/secrets.rbi

@@ -0,0 +1,93 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Resources
+    class Secrets
+      # Create a secret
+      sig do
+        params(
+          spec: DockerEngineAPI::SecretCreateParams::Spec::OrHash,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::Models::SecretCreateResponse)
+      end
+      def create(spec: nil, request_options: {})
+      end
+
+      # Update a Secret
+      sig do
+        params(
+          id: String,
+          version: Integer,
+          spec: DockerEngineAPI::Spec::OrHash,
+          request_options: DockerEngineAPI::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: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T::Array[DockerEngineAPI::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: DockerEngineAPI::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # ID of the secret
+        id,
+        request_options: {}
+      )
+      end
+
+      # Inspect a secret
+      sig do
+        params(
+          id: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::Secret)
+      end
+      def inspect_(
+        # ID of the secret
+        id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: DockerEngineAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end