docker-engine-api 0.2.1

data/rbi/docker_engine_api/models/wait_response.rbi

@@ -0,0 +1,78 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class WaitResponse < DockerEngineAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::WaitResponse,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # Exit code of the container
+      sig { returns(Integer) }
+      attr_accessor :status_code
+
+      # container waiting error, if any
+      sig { returns(T.nilable(DockerEngineAPI::WaitResponse::Error)) }
+      attr_reader :error
+
+      sig { params(error: DockerEngineAPI::WaitResponse::Error::OrHash).void }
+      attr_writer :error
+
+      # OK response to ContainerWait operation
+      sig do
+        params(
+          status_code: Integer,
+          error: DockerEngineAPI::WaitResponse::Error::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Exit code of the container
+        status_code:,
+        # container waiting error, if any
+        error: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          { status_code: Integer, error: DockerEngineAPI::WaitResponse::Error }
+        )
+      end
+      def to_hash
+      end
+
+      class Error < DockerEngineAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              DockerEngineAPI::WaitResponse::Error,
+              DockerEngineAPI::Internal::AnyHash
+            )
+          end
+
+        # Details of an error
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
+        # container waiting error, if any
+        sig { params(message: String).returns(T.attached_class) }
+        def self.new(
+          # Details of an error
+          message: nil
+        )
+        end
+
+        sig { override.returns({ message: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models.rbi

@@ -0,0 +1,271 @@
+# typed: strong
+
+module DockerEngineAPI
+  AuthLoginParams = DockerEngineAPI::Models::AuthLoginParams
+
+  AuthResponse = DockerEngineAPI::Models::AuthResponse
+
+  Config = DockerEngineAPI::Models::Config
+
+  ConfigCreateParams = DockerEngineAPI::Models::ConfigCreateParams
+
+  ConfigDeleteParams = DockerEngineAPI::Models::ConfigDeleteParams
+
+  ConfigInspectParams = DockerEngineAPI::Models::ConfigInspectParams
+
+  ConfigListParams = DockerEngineAPI::Models::ConfigListParams
+
+  ConfigUpdateParams = DockerEngineAPI::Models::ConfigUpdateParams
+
+  ConnectRequest = DockerEngineAPI::Models::ConnectRequest
+
+  Container = DockerEngineAPI::Models::Container
+
+  ContainerArchiveParams = DockerEngineAPI::Models::ContainerArchiveParams
+
+  ContainerAttachParams = DockerEngineAPI::Models::ContainerAttachParams
+
+  ContainerChangesParams = DockerEngineAPI::Models::ContainerChangesParams
+
+  ContainerCreateParams = DockerEngineAPI::Models::ContainerCreateParams
+
+  ContainerDeleteParams = DockerEngineAPI::Models::ContainerDeleteParams
+
+  ContainerExecParams = DockerEngineAPI::Models::ContainerExecParams
+
+  ContainerExportParams = DockerEngineAPI::Models::ContainerExportParams
+
+  ContainerInspectParams = DockerEngineAPI::Models::ContainerInspectParams
+
+  ContainerKillParams = DockerEngineAPI::Models::ContainerKillParams
+
+  ContainerListParams = DockerEngineAPI::Models::ContainerListParams
+
+  ContainerLogsParams = DockerEngineAPI::Models::ContainerLogsParams
+
+  ContainerPauseParams = DockerEngineAPI::Models::ContainerPauseParams
+
+  ContainerPruneParams = DockerEngineAPI::Models::ContainerPruneParams
+
+  ContainerRenameParams = DockerEngineAPI::Models::ContainerRenameParams
+
+  ContainerResizeParams = DockerEngineAPI::Models::ContainerResizeParams
+
+  ContainerRestartParams = DockerEngineAPI::Models::ContainerRestartParams
+
+  ContainerStartParams = DockerEngineAPI::Models::ContainerStartParams
+
+  ContainerStatsParams = DockerEngineAPI::Models::ContainerStatsParams
+
+  ContainerStopParams = DockerEngineAPI::Models::ContainerStopParams
+
+  ContainerTopParams = DockerEngineAPI::Models::ContainerTopParams
+
+  ContainerUnpauseParams = DockerEngineAPI::Models::ContainerUnpauseParams
+
+  ContainerUpdateParams = DockerEngineAPI::Models::ContainerUpdateParams
+
+  ContainerWaitParams = DockerEngineAPI::Models::ContainerWaitParams
+
+  CreateRequest = DockerEngineAPI::Models::CreateRequest
+
+  CreateResponse = DockerEngineAPI::Models::CreateResponse
+
+  DeleteItem = DockerEngineAPI::Models::DeleteItem
+
+  DisconnectRequest = DockerEngineAPI::Models::DisconnectRequest
+
+  DistributionInspectParams = DockerEngineAPI::Models::DistributionInspectParams
+
+  Error = DockerEngineAPI::Models::Error
+
+  ExecInspectParams = DockerEngineAPI::Models::ExecInspectParams
+
+  ExecResizeParams = DockerEngineAPI::Models::ExecResizeParams
+
+  ExecStartParams = DockerEngineAPI::Models::ExecStartParams
+
+  FilesystemChange = DockerEngineAPI::Models::FilesystemChange
+
+  HistoryItem = DockerEngineAPI::Models::HistoryItem
+
+  Image = DockerEngineAPI::Models::Image
+
+  ImageBuildParams = DockerEngineAPI::Models::ImageBuildParams
+
+  ImageBuildPruneParams = DockerEngineAPI::Models::ImageBuildPruneParams
+
+  ImageCommitParams = DockerEngineAPI::Models::ImageCommitParams
+
+  ImageDeleteParams = DockerEngineAPI::Models::ImageDeleteParams
+
+  ImageGetAllParams = DockerEngineAPI::Models::ImageGetAllParams
+
+  ImageGetParams = DockerEngineAPI::Models::ImageGetParams
+
+  ImageHistoryParams = DockerEngineAPI::Models::ImageHistoryParams
+
+  ImageInspectParams = DockerEngineAPI::Models::ImageInspectParams
+
+  ImageListParams = DockerEngineAPI::Models::ImageListParams
+
+  ImageLoadParams = DockerEngineAPI::Models::ImageLoadParams
+
+  ImagePruneParams = DockerEngineAPI::Models::ImagePruneParams
+
+  ImagePullParams = DockerEngineAPI::Models::ImagePullParams
+
+  ImagePushParams = DockerEngineAPI::Models::ImagePushParams
+
+  ImageSearchParams = DockerEngineAPI::Models::ImageSearchParams
+
+  ImageTagParams = DockerEngineAPI::Models::ImageTagParams
+
+  Info = DockerEngineAPI::Models::Info
+
+  Inspect = DockerEngineAPI::Models::Inspect
+
+  InspectResponse = DockerEngineAPI::Models::InspectResponse
+
+  ListResponse = DockerEngineAPI::Models::ListResponse
+
+  Network = DockerEngineAPI::Models::Network
+
+  NetworkConnectParams = DockerEngineAPI::Models::NetworkConnectParams
+
+  NetworkCreateParams = DockerEngineAPI::Models::NetworkCreateParams
+
+  NetworkDeleteParams = DockerEngineAPI::Models::NetworkDeleteParams
+
+  NetworkDisconnectParams = DockerEngineAPI::Models::NetworkDisconnectParams
+
+  NetworkInspectParams = DockerEngineAPI::Models::NetworkInspectParams
+
+  NetworkListParams = DockerEngineAPI::Models::NetworkListParams
+
+  NetworkPruneParams = DockerEngineAPI::Models::NetworkPruneParams
+
+  Node = DockerEngineAPI::Models::Node
+
+  NodeDeleteParams = DockerEngineAPI::Models::NodeDeleteParams
+
+  NodeInspectParams = DockerEngineAPI::Models::NodeInspectParams
+
+  NodeListParams = DockerEngineAPI::Models::NodeListParams
+
+  NodeUpdateParams = DockerEngineAPI::Models::NodeUpdateParams
+
+  Plugin = DockerEngineAPI::Models::Plugin
+
+  PluginCreateParams = DockerEngineAPI::Models::PluginCreateParams
+
+  PluginDeleteParams = DockerEngineAPI::Models::PluginDeleteParams
+
+  PluginDisableParams = DockerEngineAPI::Models::PluginDisableParams
+
+  PluginEnableParams = DockerEngineAPI::Models::PluginEnableParams
+
+  PluginInspectParams = DockerEngineAPI::Models::PluginInspectParams
+
+  PluginListParams = DockerEngineAPI::Models::PluginListParams
+
+  PluginPrivilegesParams = DockerEngineAPI::Models::PluginPrivilegesParams
+
+  PluginPullParams = DockerEngineAPI::Models::PluginPullParams
+
+  PluginPushParams = DockerEngineAPI::Models::PluginPushParams
+
+  PluginSetParams = DockerEngineAPI::Models::PluginSetParams
+
+  PluginUpgradeParams = DockerEngineAPI::Models::PluginUpgradeParams
+
+  Privilege = DockerEngineAPI::Models::Privilege
+
+  Secret = DockerEngineAPI::Models::Secret
+
+  SecretCreateParams = DockerEngineAPI::Models::SecretCreateParams
+
+  SecretDeleteParams = DockerEngineAPI::Models::SecretDeleteParams
+
+  SecretInspectParams = DockerEngineAPI::Models::SecretInspectParams
+
+  SecretListParams = DockerEngineAPI::Models::SecretListParams
+
+  SecretUpdateParams = DockerEngineAPI::Models::SecretUpdateParams
+
+  Service = DockerEngineAPI::Models::Service
+
+  ServiceCreateParams = DockerEngineAPI::Models::ServiceCreateParams
+
+  ServiceDeleteParams = DockerEngineAPI::Models::ServiceDeleteParams
+
+  ServiceInspectParams = DockerEngineAPI::Models::ServiceInspectParams
+
+  ServiceListParams = DockerEngineAPI::Models::ServiceListParams
+
+  ServiceLogsParams = DockerEngineAPI::Models::ServiceLogsParams
+
+  ServiceUpdateParams = DockerEngineAPI::Models::ServiceUpdateParams
+
+  Spec = DockerEngineAPI::Models::Spec
+
+  StatsResponse = DockerEngineAPI::Models::StatsResponse
+
+  Summary = DockerEngineAPI::Models::Summary
+
+  SwarmAPI = DockerEngineAPI::Models::SwarmAPI
+
+  SwarmInitParams = DockerEngineAPI::Models::SwarmInitParams
+
+  SwarmInspectParams = DockerEngineAPI::Models::SwarmInspectParams
+
+  SwarmJoinParams = DockerEngineAPI::Models::SwarmJoinParams
+
+  SwarmLeaveParams = DockerEngineAPI::Models::SwarmLeaveParams
+
+  SwarmUnlockKeyParams = DockerEngineAPI::Models::SwarmUnlockKeyParams
+
+  SwarmUnlockParams = DockerEngineAPI::Models::SwarmUnlockParams
+
+  SwarmUpdateParams = DockerEngineAPI::Models::SwarmUpdateParams
+
+  SystemDataUsageParams = DockerEngineAPI::Models::SystemDataUsageParams
+
+  SystemEventsParams = DockerEngineAPI::Models::SystemEventsParams
+
+  SystemInfoParams = DockerEngineAPI::Models::SystemInfoParams
+
+  SystemPingParams = DockerEngineAPI::Models::SystemPingParams
+
+  SystemVersionParams = DockerEngineAPI::Models::SystemVersionParams
+
+  Task = DockerEngineAPI::Models::Task
+
+  TaskInspectParams = DockerEngineAPI::Models::TaskInspectParams
+
+  TaskListParams = DockerEngineAPI::Models::TaskListParams
+
+  TaskLogsParams = DockerEngineAPI::Models::TaskLogsParams
+
+  TopResponse = DockerEngineAPI::Models::TopResponse
+
+  UpdateResponse = DockerEngineAPI::Models::UpdateResponse
+
+  Version = DockerEngineAPI::Models::Version
+
+  Volume = DockerEngineAPI::Models::Volume
+
+  VolumeCreateParams = DockerEngineAPI::Models::VolumeCreateParams
+
+  VolumeDeleteParams = DockerEngineAPI::Models::VolumeDeleteParams
+
+  VolumeInspectParams = DockerEngineAPI::Models::VolumeInspectParams
+
+  VolumeListParams = DockerEngineAPI::Models::VolumeListParams
+
+  VolumePruneParams = DockerEngineAPI::Models::VolumePruneParams
+
+  VolumeUpdateParams = DockerEngineAPI::Models::VolumeUpdateParams
+
+  WaitResponse = DockerEngineAPI::Models::WaitResponse
+end

data/rbi/docker_engine_api/request_options.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module DockerEngineAPI
+  # 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 < DockerEngineAPI::Internal::Type::BaseModel
+    OrHash =
+      T.type_alias do
+        T.any(
+          DockerEngineAPI::RequestOptions,
+          DockerEngineAPI::Internal::AnyHash
+        )
+      end
+
+    # @api private
+    sig { params(opts: DockerEngineAPI::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: DockerEngineAPI::Internal::AnyHash).returns(
+        T.attached_class
+      )
+    end
+    def self.new(values = {})
+    end
+  end
+end

data/rbi/docker_engine_api/resources/auth.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module DockerEngineAPI
+  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: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::AuthResponse)
+      end
+      def login(
+        password: nil,
+        serveraddress: nil,
+        username: 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/configs.rbi

@@ -0,0 +1,93 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Resources
+    class Configs
+      # Create a config
+      sig do
+        params(
+          spec: DockerEngineAPI::ConfigCreateParams::Spec::OrHash,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::Models::ConfigCreateResponse)
+      end
+      def create(spec: nil, request_options: {})
+      end
+
+      # Update a Config
+      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 config
+        id,
+        # Query param: The version number of the config object being updated. This is
+        # required to avoid conflicting writes.
+        version:,
+        # Body param
+        spec: nil,
+        request_options: {}
+      )
+      end
+
+      # List configs
+      sig do
+        params(
+          filters: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T::Array[DockerEngineAPI::Config])
+      end
+      def list(
+        # A JSON encoded value of the filters (a `map[string][]string`) to process on the
+        # configs list.
+        #
+        # Available filters:
+        #
+        # - `id=<config id>`
+        # - `label=<key> or label=<key>=value`
+        # - `name=<config name>`
+        # - `names=<config name>`
+        filters: nil,
+        request_options: {}
+      )
+      end
+
+      # Delete a config
+      sig do
+        params(
+          id: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # ID of the config
+        id,
+        request_options: {}
+      )
+      end
+
+      # Inspect a config
+      sig do
+        params(
+          id: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::Config)
+      end
+      def inspect_(
+        # ID of the config
+        id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: DockerEngineAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end