docker-engine 0.1.1

data/rbi/docker_engine/models/volume_create_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class VolumeCreateParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::VolumeCreateParams,
+            DockerEngine::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: DockerEngine::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig do
+        override.returns({ request_options: DockerEngine::RequestOptions })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/volume_delete_params.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class VolumeDeleteParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::VolumeDeleteParams,
+            DockerEngine::Internal::AnyHash
+          )
+        end
+
+      # Force the removal of the volume
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :force
+
+      sig { params(force: T::Boolean).void }
+      attr_writer :force
+
+      sig do
+        params(
+          force: T::Boolean,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Force the removal of the volume
+        force: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { force: T::Boolean, request_options: DockerEngine::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/volume_inspect_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class VolumeInspectParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::VolumeInspectParams,
+            DockerEngine::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: DockerEngine::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig do
+        override.returns({ request_options: DockerEngine::RequestOptions })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/volume_list_params.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class VolumeListParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(DockerEngine::VolumeListParams, DockerEngine::Internal::AnyHash)
+        end
+
+      # JSON encoded value of the filters (a `map[string][]string`) to process on the
+      # volumes list. Available filters:
+      #
+      # - `dangling=<boolean>` When set to `true` (or `1`), returns all volumes that are
+      #   not in use by a container. When set to `false` (or `0`), only volumes that are
+      #   in use by one or more containers are returned.
+      # - `driver=<volume-driver-name>` Matches volumes based on their driver.
+      # - `label=<key>` or `label=<key>:<value>` Matches volumes based on the presence
+      #   of a `label` alone or a `label` and a value.
+      # - `name=<volume-name>` Matches all or part of a volume name.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filters
+
+      sig { params(filters: String).void }
+      attr_writer :filters
+
+      sig do
+        params(
+          filters: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # JSON encoded value of the filters (a `map[string][]string`) to process on the
+        # volumes list. Available filters:
+        #
+        # - `dangling=<boolean>` When set to `true` (or `1`), returns all volumes that are
+        #   not in use by a container. When set to `false` (or `0`), only volumes that are
+        #   in use by one or more containers are returned.
+        # - `driver=<volume-driver-name>` Matches volumes based on their driver.
+        # - `label=<key>` or `label=<key>:<value>` Matches volumes based on the presence
+        #   of a `label` alone or a `label` and a value.
+        # - `name=<volume-name>` Matches all or part of a volume name.
+        filters: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { filters: String, request_options: DockerEngine::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/volume_list_response.rbi

@@ -0,0 +1,55 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class VolumeListResponse < DockerEngine::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::Models::VolumeListResponse,
+            DockerEngine::Internal::AnyHash
+          )
+        end
+
+      # List of volumes
+      sig { returns(T.nilable(T::Array[DockerEngine::Volume])) }
+      attr_reader :volumes
+
+      sig { params(volumes: T::Array[DockerEngine::Volume::OrHash]).void }
+      attr_writer :volumes
+
+      # Warnings that occurred when fetching the list of volumes.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :warnings
+
+      sig { params(warnings: T::Array[String]).void }
+      attr_writer :warnings
+
+      # Volume list response
+      sig do
+        params(
+          volumes: T::Array[DockerEngine::Volume::OrHash],
+          warnings: T::Array[String]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # List of volumes
+        volumes: nil,
+        # Warnings that occurred when fetching the list of volumes.
+        warnings: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            volumes: T::Array[DockerEngine::Volume],
+            warnings: T::Array[String]
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models.rbi

@@ -0,0 +1,83 @@
+# typed: strong
+
+module DockerEngine
+  AuthLoginParams = DockerEngine::Models::AuthLoginParams
+
+  AuthResponse = DockerEngine::Models::AuthResponse
+
+  Config = DockerEngine::Models::Config
+
+  Container = DockerEngine::Models::Container
+
+  ContainerCreateParams = DockerEngine::Models::ContainerCreateParams
+
+  ContainerDeleteParams = DockerEngine::Models::ContainerDeleteParams
+
+  ContainerInspectParams = DockerEngine::Models::ContainerInspectParams
+
+  ContainerKillParams = DockerEngine::Models::ContainerKillParams
+
+  ContainerListParams = DockerEngine::Models::ContainerListParams
+
+  ContainerLogsParams = DockerEngine::Models::ContainerLogsParams
+
+  ContainerStartParams = DockerEngine::Models::ContainerStartParams
+
+  ContainerStopParams = DockerEngine::Models::ContainerStopParams
+
+  CreateRequest = DockerEngine::Models::CreateRequest
+
+  CreateResponse = DockerEngine::Models::CreateResponse
+
+  Error = DockerEngine::Models::Error
+
+  Image = DockerEngine::Models::Image
+
+  ImageDeleteParams = DockerEngine::Models::ImageDeleteParams
+
+  ImageInspectParams = DockerEngine::Models::ImageInspectParams
+
+  ImageListParams = DockerEngine::Models::ImageListParams
+
+  ImagePullParams = DockerEngine::Models::ImagePullParams
+
+  Network = DockerEngine::Models::Network
+
+  NetworkCreateParams = DockerEngine::Models::NetworkCreateParams
+
+  NetworkDeleteParams = DockerEngine::Models::NetworkDeleteParams
+
+  NetworkInspectParams = DockerEngine::Models::NetworkInspectParams
+
+  NetworkListParams = DockerEngine::Models::NetworkListParams
+
+  Service = DockerEngine::Models::Service
+
+  ServiceCreateParams = DockerEngine::Models::ServiceCreateParams
+
+  ServiceDeleteParams = DockerEngine::Models::ServiceDeleteParams
+
+  ServiceInspectParams = DockerEngine::Models::ServiceInspectParams
+
+  ServiceListParams = DockerEngine::Models::ServiceListParams
+
+  Spec = DockerEngine::Models::Spec
+
+  Summary = DockerEngine::Models::Summary
+
+  SystemInfoParams = DockerEngine::Models::SystemInfoParams
+
+  SystemPingParams = DockerEngine::Models::SystemPingParams
+
+  SystemVersionParams = DockerEngine::Models::SystemVersionParams
+
+  Volume = DockerEngine::Models::Volume
+
+  VolumeCreateParams = DockerEngine::Models::VolumeCreateParams
+
+  VolumeDeleteParams = DockerEngine::Models::VolumeDeleteParams
+
+  VolumeInspectParams = DockerEngine::Models::VolumeInspectParams
+
+  VolumeListParams = DockerEngine::Models::VolumeListParams
+end

data/rbi/docker_engine/request_options.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module DockerEngine
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < DockerEngine::Internal::Type::BaseModel
+    OrHash =
+      T.type_alias do
+        T.any(DockerEngine::RequestOptions, DockerEngine::Internal::AnyHash)
+      end
+
+    # @api private
+    sig { params(opts: DockerEngine::RequestOptions::OrHash).void }
+    def self.validate!(opts)
+    end
+
+    # Idempotency key to send with request and all associated retries. Will only be
+    # sent for write requests.
+    sig { returns(T.nilable(String)) }
+    attr_accessor :idempotency_key
+
+    # Extra query params to send with the request. These are `.merge`’d into any
+    # `query` given at the client level.
+    sig do
+      returns(
+        T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])
+      )
+    end
+    attr_accessor :extra_query
+
+    # Extra headers to send with the request. These are `.merged`’d into any
+    # `extra_headers` given at the client level.
+    sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
+    attr_accessor :extra_headers
+
+    # Extra data to send with the request. These are deep merged into any data
+    # generated as part of the normal request.
+    sig { returns(T.nilable(T.anything)) }
+    attr_accessor :extra_body
+
+    # Maximum number of retries to attempt after a failed initial request.
+    sig { returns(T.nilable(Integer)) }
+    attr_accessor :max_retries
+
+    # Request timeout in seconds.
+    sig { returns(T.nilable(Float)) }
+    attr_accessor :timeout
+
+    # Returns a new instance of RequestOptions.
+    sig do
+      params(values: DockerEngine::Internal::AnyHash).returns(T.attached_class)
+    end
+    def self.new(values = {})
+    end
+  end
+end

data/rbi/docker_engine/resources/auth.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module DockerEngine
+  module Resources
+    class Auth
+      # Validate credentials for a registry and, if available, get an identity token for
+      # accessing the registry without password.
+      sig do
+        params(
+          password: String,
+          serveraddress: String,
+          username: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(DockerEngine::AuthResponse)
+      end
+      def login(
+        password: nil,
+        serveraddress: nil,
+        username: 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/containers.rbi

@@ -0,0 +1,231 @@
+# typed: strong
+
+module DockerEngine
+  module Resources
+    class Containers
+      # Create a container
+      sig do
+        params(
+          config: DockerEngine::ContainerCreateParams::Config::OrHash,
+          name: String,
+          platform: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(DockerEngine::CreateResponse)
+      end
+      def create(
+        # Body param: Configuration for a container that is portable between hosts.
+        config:,
+        # Query param: Assign the specified name to the container. Must match
+        # `/?[a-zA-Z0-9][a-zA-Z0-9_.-]+`.
+        name: nil,
+        # Query param: Platform in the format `os[/arch[/variant]]` used for image lookup.
+        #
+        # When specified, the daemon checks if the requested image is present in the local
+        # image cache with the given OS and Architecture, and otherwise returns a `404`
+        # status.
+        #
+        # If the option is not set, the host's native OS and Architecture are used to look
+        # up the image in the image cache. However, if no platform is passed and the given
+        # image does exist in the local image cache, but its OS or architecture does not
+        # match, the container is created with the available image, and a warning is added
+        # to the `Warnings` field in the response, for example;
+        #
+        #     WARNING: The requested image's platform (linux/arm64/v8) does not
+        #              match the detected host platform (linux/amd64) and no
+        #              specific platform was requested
+        platform: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns a list of containers. For details on the format, see the
+      # [inspect endpoint](#operation/ContainerInspect).
+      #
+      # Note that it uses a different, smaller representation of a container than
+      # inspecting a single container. For example, the list of linked containers is not
+      # propagated .
+      sig do
+        params(
+          all: T::Boolean,
+          filters: String,
+          limit: Integer,
+          size: T::Boolean,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T::Array[DockerEngine::Summary])
+      end
+      def list(
+        # Return all containers. By default, only running containers are shown.
+        all: nil,
+        # Filters to process on the container list, encoded as JSON (a
+        # `map[string][]string`). For example, `{"status": ["paused"]}` will only return
+        # paused containers.
+        #
+        # Available filters:
+        #
+        # - `ancestor`=(`<image-name>[:<tag>]`, `<image id>`, or `<image@digest>`)
+        # - `before`=(`<container id>` or `<container name>`)
+        # - `expose`=(`<port>[/<proto>]`|`<startport-endport>/[<proto>]`)
+        # - `exited=<int>` containers with exit code of `<int>`
+        # - `health`=(`starting`|`healthy`|`unhealthy`|`none`)
+        # - `id=<ID>` a container's ID
+        # - `isolation=`(`default`|`process`|`hyperv`) (Windows daemon only)
+        # - `is-task=`(`true`|`false`)
+        # - `label=key` or `label="key=value"` of a container label
+        # - `name=<name>` a container's name
+        # - `network`=(`<network id>` or `<network name>`)
+        # - `publish`=(`<port>[/<proto>]`|`<startport-endport>/[<proto>]`)
+        # - `since`=(`<container id>` or `<container name>`)
+        # - `status=`(`created`|`restarting`|`running`|`removing`|`paused`|`exited`|`dead`)
+        # - `volume`=(`<volume name>` or `<mount point destination>`)
+        filters: nil,
+        # Return this number of most recently created containers, including non-running
+        # ones.
+        limit: nil,
+        # Return the size of container as fields `SizeRw` and `SizeRootFs`.
+        size: nil,
+        request_options: {}
+      )
+      end
+
+      # Remove a container
+      sig do
+        params(
+          id: String,
+          force: T::Boolean,
+          link: T::Boolean,
+          v: T::Boolean,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # ID or name of the container
+        id,
+        # If the container is running, kill it before removing it.
+        force: nil,
+        # Remove the specified link associated with the container.
+        link: nil,
+        # Remove anonymous volumes associated with the container.
+        v: nil,
+        request_options: {}
+      )
+      end
+
+      # Return low-level information about a container.
+      sig do
+        params(
+          id: String,
+          size: T::Boolean,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(DockerEngine::Container)
+      end
+      def inspect_(
+        # ID or name of the container
+        id,
+        # Return the size of container as fields `SizeRw` and `SizeRootFs`
+        size: nil,
+        request_options: {}
+      )
+      end
+
+      # Send a POSIX signal to a container, defaulting to killing to the container.
+      sig do
+        params(
+          id: String,
+          signal: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).void
+      end
+      def kill(
+        # ID or name of the container
+        id,
+        # Signal to send to the container as an integer or string (e.g. `SIGINT`).
+        signal: nil,
+        request_options: {}
+      )
+      end
+
+      # Get `stdout` and `stderr` logs from a container.
+      #
+      # Note: This endpoint works only for containers with the `json-file` or `journald`
+      # logging driver.
+      sig do
+        params(
+          id: String,
+          follow: T::Boolean,
+          since: Integer,
+          stderr: T::Boolean,
+          stdout: T::Boolean,
+          tail: String,
+          timestamps: T::Boolean,
+          until_: Integer,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(StringIO)
+      end
+      def logs(
+        # ID or name of the container
+        id,
+        # 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,
+        # Only return logs before this time, as a UNIX timestamp
+        until_: nil,
+        request_options: {}
+      )
+      end
+
+      # Start a container
+      sig do
+        params(
+          id: String,
+          detach_keys: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).void
+      end
+      def start(
+        # ID or name of the container
+        id,
+        # Override the key sequence for detaching a container. Format is a single
+        # character `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`, `@`, `^`,
+        # `[`, `,` or `_`.
+        detach_keys: nil,
+        request_options: {}
+      )
+      end
+
+      # Stop a container
+      sig do
+        params(
+          id: String,
+          signal: String,
+          t: Integer,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).void
+      end
+      def stop(
+        # ID or name of the container
+        id,
+        # Signal to send to the container as an integer or string (e.g. `SIGINT`).
+        signal: nil,
+        # Number of seconds to wait before killing the container
+        t: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: DockerEngine::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end