docker-engine-api 0.2.1

data/rbi/docker_engine_api/resources/services.rbi

@@ -0,0 +1,166 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Resources
+    class Services
+      # Create a service
+      sig do
+        params(
+          spec: DockerEngineAPI::ServiceCreateParams::Spec::OrHash,
+          x_registry_auth: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::CreateResponse)
+      end
+      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.
+        x_registry_auth: nil,
+        request_options: {}
+      )
+      end
+
+      # Update a service
+      sig do
+        params(
+          id: String,
+          version: Integer,
+          spec: DockerEngineAPI::ServiceUpdateParams::Spec::OrHash,
+          registry_auth_from:
+            DockerEngineAPI::ServiceUpdateParams::RegistryAuthFrom::OrSymbol,
+          rollback: String,
+          x_registry_auth: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::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(
+          filters: String,
+          status: T::Boolean,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T::Array[DockerEngineAPI::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: {}
+      )
+      end
+
+      # Delete a service
+      sig do
+        params(
+          id: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # ID or name of service.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Inspect a service
+      sig do
+        params(
+          id: String,
+          insert_defaults: T::Boolean,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::Service)
+      end
+      def inspect_(
+        # ID or name of service.
+        id,
+        # Fill empty fields with default values.
+        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.
+      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: DockerEngineAPI::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: DockerEngineAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/resources/swarm.rbi

@@ -0,0 +1,178 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Resources
+    class Swarm
+      # Update a swarm
+      sig do
+        params(
+          version: Integer,
+          spec: DockerEngineAPI::Spec::OrHash,
+          rotate_manager_token: T::Boolean,
+          rotate_manager_unlock_key: T::Boolean,
+          rotate_worker_token: T::Boolean,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).void
+      end
+      def update(
+        # Query param: The version number of the swarm object being updated. This is
+        # required to avoid conflicting writes.
+        version:,
+        # Body param: User modifiable swarm configuration.
+        spec:,
+        # Query param: Rotate the manager join token.
+        rotate_manager_token: nil,
+        # Query param: Rotate the manager unlock key.
+        rotate_manager_unlock_key: nil,
+        # Query param: Rotate the worker join token.
+        rotate_worker_token: nil,
+        request_options: {}
+      )
+      end
+
+      # Initialize a new swarm
+      sig do
+        params(
+          advertise_addr: String,
+          data_path_addr: String,
+          data_path_port: Integer,
+          default_addr_pool: T::Array[String],
+          force_new_cluster: T::Boolean,
+          listen_addr: String,
+          spec: DockerEngineAPI::Spec::OrHash,
+          subnet_size: Integer,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(String)
+      end
+      def init(
+        # Externally reachable address advertised to other nodes. This can either be an
+        # address/port combination in the form `192.168.1.1:4567`, or an interface
+        # followed by a port number, like `eth0:4567`. If the port number is omitted, the
+        # port number from the listen address is used. If `AdvertiseAddr` is not
+        # specified, it will be automatically detected when possible.
+        advertise_addr: nil,
+        # Address or interface to use for data path traffic (format: `<ip|interface>`),
+        # for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is
+        # unspecified, the same address as `AdvertiseAddr` is used.
+        #
+        # The `DataPathAddr` specifies the address that global scope network drivers will
+        # publish towards other nodes in order to reach the containers running on this
+        # node. Using this parameter it is possible to separate the container data traffic
+        # from the management traffic of the cluster.
+        data_path_addr: nil,
+        # DataPathPort specifies the data path port number for data traffic. Acceptable
+        # port range is 1024 to 49151. if no port is set or is set to 0, default port 4789
+        # will be used.
+        data_path_port: nil,
+        # Default Address Pool specifies default subnet pools for global scope networks.
+        default_addr_pool: nil,
+        # Force creation of a new swarm.
+        force_new_cluster: nil,
+        # Listen address used for inter-manager communication, as well as determining the
+        # networking interface used for the VXLAN Tunnel Endpoint (VTEP). This can either
+        # be an address/port combination in the form `192.168.1.1:4567`, or an interface
+        # followed by a port number, like `eth0:4567`. If the port number is omitted, the
+        # default swarm listening port is used.
+        listen_addr: nil,
+        # User modifiable swarm configuration.
+        spec: nil,
+        # SubnetSize specifies the subnet size of the networks created from the default
+        # subnet pool.
+        subnet_size: nil,
+        request_options: {}
+      )
+      end
+
+      # Inspect swarm
+      sig do
+        params(
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::SwarmAPI)
+      end
+      def inspect_(request_options: {})
+      end
+
+      # Join an existing swarm
+      sig do
+        params(
+          advertise_addr: String,
+          data_path_addr: String,
+          join_token: String,
+          listen_addr: String,
+          remote_addrs: T::Array[String],
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).void
+      end
+      def join(
+        # Externally reachable address advertised to other nodes. This can either be an
+        # address/port combination in the form `192.168.1.1:4567`, or an interface
+        # followed by a port number, like `eth0:4567`. If the port number is omitted, the
+        # port number from the listen address is used. If `AdvertiseAddr` is not
+        # specified, it will be automatically detected when possible.
+        advertise_addr: nil,
+        # Address or interface to use for data path traffic (format: `<ip|interface>`),
+        # for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is
+        # unspecified, the same address as `AdvertiseAddr` is used.
+        #
+        # The `DataPathAddr` specifies the address that global scope network drivers will
+        # publish towards other nodes in order to reach the containers running on this
+        # node. Using this parameter it is possible to separate the container data traffic
+        # from the management traffic of the cluster.
+        data_path_addr: nil,
+        # Secret token for joining this swarm.
+        join_token: nil,
+        # Listen address used for inter-manager communication if the node gets promoted to
+        # manager, as well as determining the networking interface used for the VXLAN
+        # Tunnel Endpoint (VTEP).
+        listen_addr: nil,
+        # Addresses of manager nodes already participating in the swarm.
+        remote_addrs: nil,
+        request_options: {}
+      )
+      end
+
+      # Leave a swarm
+      sig do
+        params(
+          force: T::Boolean,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).void
+      end
+      def leave(
+        # Force leave swarm, even if this is the last manager or that it will break the
+        # cluster.
+        force: nil,
+        request_options: {}
+      )
+      end
+
+      # Unlock a locked manager
+      sig do
+        params(
+          unlock_key: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).void
+      end
+      def unlock(
+        # The swarm's unlock key.
+        unlock_key: nil,
+        request_options: {}
+      )
+      end
+
+      # Get the unlock key
+      sig do
+        params(
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::Models::SwarmUnlockKeyResponse)
+      end
+      def unlock_key(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/system.rbi

@@ -0,0 +1,123 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Resources
+    class System
+      # Get data usage information
+      sig do
+        params(
+          type:
+            T::Array[DockerEngineAPI::SystemDataUsageParams::Type::OrSymbol],
+          verbose: T::Boolean,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::Models::SystemDataUsageResponse)
+      end
+      def data_usage(
+        # Object types, for which to compute and return data.
+        type: nil,
+        # Show detailed information on space usage.
+        verbose: nil,
+        request_options: {}
+      )
+      end
+
+      # Stream real-time events from the server.
+      #
+      # Various objects within Docker report events when something happens to them.
+      #
+      # Containers report these events: `attach`, `commit`, `copy`, `create`, `destroy`,
+      # `detach`, `die`, `exec_create`, `exec_detach`, `exec_start`, `exec_die`,
+      # `export`, `health_status`, `kill`, `oom`, `pause`, `rename`, `resize`,
+      # `restart`, `start`, `stop`, `top`, `unpause`, `update`, and `prune`
+      #
+      # Images report these events: `create`, `delete`, `import`, `load`, `pull`,
+      # `push`, `save`, `tag`, `untag`, and `prune`
+      #
+      # Volumes report these events: `create`, `mount`, `unmount`, `destroy`, and
+      # `prune`
+      #
+      # Networks report these events: `create`, `connect`, `disconnect`, `destroy`,
+      # `update`, `remove`, and `prune`
+      #
+      # The Docker daemon reports these events: `reload`
+      #
+      # Services report these events: `create`, `update`, and `remove`
+      #
+      # Nodes report these events: `create`, `update`, and `remove`
+      #
+      # Secrets report these events: `create`, `update`, and `remove`
+      #
+      # Configs report these events: `create`, `update`, and `remove`
+      #
+      # The Builder reports `prune` events
+      sig do
+        params(
+          filters: String,
+          since: String,
+          until_: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::Models::SystemEventsResponse)
+      end
+      def events(
+        # A JSON encoded value of filters (a `map[string][]string`) to process on the
+        # event list. Available filters:
+        #
+        # - `config=<string>` config name or ID
+        # - `container=<string>` container name or ID
+        # - `daemon=<string>` daemon name or ID
+        # - `event=<string>` event type
+        # - `image=<string>` image name or ID
+        # - `label=<string>` image or container label
+        # - `network=<string>` network name or ID
+        # - `node=<string>` node ID
+        # - `plugin`=<string> plugin name or ID
+        # - `scope`=<string> local or swarm
+        # - `secret=<string>` secret name or ID
+        # - `service=<string>` service name or ID
+        # - `type=<string>` object to filter by, one of `container`, `image`, `volume`,
+        #   `network`, `daemon`, `plugin`, `node`, `service`, `secret` or `config`
+        # - `volume=<string>` volume name
+        filters: nil,
+        # Show events created since this timestamp then stream new events.
+        since: nil,
+        # Show events created until this timestamp then stop streaming.
+        until_: nil,
+        request_options: {}
+      )
+      end
+
+      # Get system information
+      sig do
+        params(
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::Info)
+      end
+      def info(request_options: {})
+      end
+
+      # This is a dummy endpoint you can use to test if the server is accessible.
+      sig do
+        params(
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(String)
+      end
+      def ping(request_options: {})
+      end
+
+      # Returns the version of Docker that is running and various information about the
+      # system that Docker is running on.
+      sig do
+        params(
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::Version)
+      end
+      def version(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/tasks.rbi

@@ -0,0 +1,90 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Resources
+    class Tasks
+      # List tasks
+      sig do
+        params(
+          filters: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T::Array[DockerEngineAPI::Task])
+      end
+      def list(
+        # A JSON encoded value of the filters (a `map[string][]string`) to process on the
+        # tasks list.
+        #
+        # Available filters:
+        #
+        # - `desired-state=(running | shutdown | accepted)`
+        # - `id=<task id>`
+        # - `label=key` or `label="key=value"`
+        # - `name=<task name>`
+        # - `node=<node id or name>`
+        # - `service=<service name>`
+        filters: nil,
+        request_options: {}
+      )
+      end
+
+      # Inspect a task
+      sig do
+        params(
+          id: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::Task)
+      end
+      def inspect_(
+        # ID of the task
+        id,
+        request_options: {}
+      )
+      end
+
+      # Get `stdout` and `stderr` logs from a task. 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: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(StringIO)
+      end
+      def logs(
+        # ID of the task
+        id,
+        # Show task 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: DockerEngineAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/resources/volumes.rbi

@@ -0,0 +1,123 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Resources
+    class Volumes
+      # Create a volume
+      sig do
+        params(
+          create_request: DockerEngineAPI::CreateRequest::OrHash,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::Volume)
+      end
+      def create(
+        # Volume configuration
+        create_request:,
+        request_options: {}
+      )
+      end
+
+      # "Update a volume. Valid only for Swarm cluster volumes"
+      sig do
+        params(
+          name: String,
+          version: Integer,
+          spec: DockerEngineAPI::VolumeUpdateParams::Spec::OrHash,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).void
+      end
+      def update(
+        # Path param: The name or ID of the volume
+        name,
+        # Query param: The version number of the volume being updated. This is required to
+        # avoid conflicting writes. Found in the volume's `ClusterVolume` field.
+        version:,
+        # Body param: Cluster-specific options used to create the volume.
+        spec: nil,
+        request_options: {}
+      )
+      end
+
+      # List volumes
+      sig do
+        params(
+          filters: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::ListResponse)
+      end
+      def list(
+        # 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
+
+      # Instruct the driver to remove the volume.
+      sig do
+        params(
+          name: String,
+          force: T::Boolean,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # Volume name or ID
+        name,
+        # Force the removal of the volume
+        force: nil,
+        request_options: {}
+      )
+      end
+
+      # Inspect a volume
+      sig do
+        params(
+          name: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::Volume)
+      end
+      def inspect_(
+        # Volume name or ID
+        name,
+        request_options: {}
+      )
+      end
+
+      # Delete unused volumes
+      sig do
+        params(
+          filters: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(DockerEngineAPI::Models::VolumePruneResponse)
+      end
+      def prune(
+        # Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
+        #
+        # Available filters:
+        #
+        # - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or
+        #   `label!=<key>=<value>`) Prune volumes with (or without, in case `label!=...`
+        #   is used) the specified labels.
+        # - `all` (`all=true`) - Consider all (local) volumes for pruning and not just
+        #   anonymous volumes.
+        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/version.rbi

@@ -0,0 +1,5 @@
+# typed: strong
+
+module DockerEngineAPI
+  VERSION = T.let(T.unsafe(nil), String)
+end