docker-engine-api 0.2.1

data/rbi/docker_engine_api/models/image_prune_params.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ImagePruneParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ImagePruneParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
+      # Available filters:
+      #
+      # - `dangling=<boolean>` When set to `true` (or `1`), prune only unused _and_
+      #   untagged images. When set to `false` (or `0`), all unused images are pruned.
+      # - `until=<string>` Prune images 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 images with (or without, in case `label!=...` is
+      #   used) the specified labels.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filters
+
+      sig { params(filters: String).void }
+      attr_writer :filters
+
+      sig do
+        params(
+          filters: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
+        # Available filters:
+        #
+        # - `dangling=<boolean>` When set to `true` (or `1`), prune only unused _and_
+        #   untagged images. When set to `false` (or `0`), all unused images are pruned.
+        # - `until=<string>` Prune images 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 images with (or without, in case `label!=...` is
+        #   used) the specified labels.
+        filters: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { filters: String, request_options: DockerEngineAPI::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/image_prune_response.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ImagePruneResponse < DockerEngineAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::Models::ImagePruneResponse,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # Images that were deleted
+      sig { returns(T.nilable(T::Array[DockerEngineAPI::DeleteItem])) }
+      attr_reader :images_deleted
+
+      sig do
+        params(
+          images_deleted: T::Array[DockerEngineAPI::DeleteItem::OrHash]
+        ).void
+      end
+      attr_writer :images_deleted
+
+      # Disk space reclaimed in bytes
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :space_reclaimed
+
+      sig { params(space_reclaimed: Integer).void }
+      attr_writer :space_reclaimed
+
+      sig do
+        params(
+          images_deleted: T::Array[DockerEngineAPI::DeleteItem::OrHash],
+          space_reclaimed: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Images that were deleted
+        images_deleted: nil,
+        # Disk space reclaimed in bytes
+        space_reclaimed: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            images_deleted: T::Array[DockerEngineAPI::DeleteItem],
+            space_reclaimed: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/image_pull_params.rbi

@@ -0,0 +1,189 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ImagePullParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ImagePullParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # Apply `Dockerfile` instructions to the image that is created, for example:
+      # `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component
+      # encoded.
+      #
+      # Supported `Dockerfile` instructions:
+      # `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :changes
+
+      sig { params(changes: T::Array[String]).void }
+      attr_writer :changes
+
+      # Name of the image to pull. If the name includes a tag or digest, specific
+      # behavior applies:
+      #
+      # - If only `fromImage` includes a tag, that tag is used.
+      # - If both `fromImage` and `tag` are provided, `tag` takes precedence.
+      # - If `fromImage` includes a digest, the image is pulled by digest, and `tag` is
+      #   ignored.
+      # - If neither a tag nor digest is specified, all tags are pulled.
+      sig { returns(T.nilable(String)) }
+      attr_reader :from_image
+
+      sig { params(from_image: String).void }
+      attr_writer :from_image
+
+      # Source to import. The value may be a URL from which the image can be retrieved
+      # or `-` to read the image from the request body. This parameter may only be used
+      # when importing an image.
+      sig { returns(T.nilable(String)) }
+      attr_reader :from_src
+
+      sig { params(from_src: String).void }
+      attr_writer :from_src
+
+      # Set commit message for imported image.
+      sig { returns(T.nilable(String)) }
+      attr_reader :message
+
+      sig { params(message: String).void }
+      attr_writer :message
+
+      # Platform in the format os[/arch[/variant]].
+      #
+      # When used in combination with the `fromImage` option, the daemon checks if the
+      # given image is present in the local image cache with the given OS and
+      # Architecture, and otherwise attempts to pull the image. If the option is not
+      # set, the host's native OS and Architecture are used. If the given image does not
+      # exist in the local image cache, the daemon attempts to pull the image with the
+      # host's native OS and Architecture. If the given image does exists in the local
+      # image cache, but its OS or architecture does not match, a warning is produced.
+      #
+      # When used with the `fromSrc` option to import an image from an archive, this
+      # option sets the platform information for the imported image. If the option is
+      # not set, the host's native OS and Architecture are used for the imported image.
+      sig { returns(T.nilable(String)) }
+      attr_reader :platform
+
+      sig { params(platform: String).void }
+      attr_writer :platform
+
+      # Repository name given to an image when it is imported. The repo may include a
+      # tag. This parameter may only be used when importing an image.
+      sig { returns(T.nilable(String)) }
+      attr_reader :repo
+
+      sig { params(repo: String).void }
+      attr_writer :repo
+
+      # Tag or digest. If empty when pulling an image, this causes all tags for the
+      # given image to be pulled.
+      sig { returns(T.nilable(String)) }
+      attr_reader :tag
+
+      sig { params(tag: String).void }
+      attr_writer :tag
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :body
+
+      sig { params(body: String).void }
+      attr_writer :body
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_registry_auth
+
+      sig { params(x_registry_auth: String).void }
+      attr_writer :x_registry_auth
+
+      sig do
+        params(
+          changes: T::Array[String],
+          from_image: String,
+          from_src: String,
+          message: String,
+          platform: String,
+          repo: String,
+          tag: String,
+          body: String,
+          x_registry_auth: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Apply `Dockerfile` instructions to the image that is created, for example:
+        # `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component
+        # encoded.
+        #
+        # Supported `Dockerfile` instructions:
+        # `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`
+        changes: nil,
+        # Name of the image to pull. If the name includes a tag or digest, specific
+        # behavior applies:
+        #
+        # - If only `fromImage` includes a tag, that tag is used.
+        # - If both `fromImage` and `tag` are provided, `tag` takes precedence.
+        # - If `fromImage` includes a digest, the image is pulled by digest, and `tag` is
+        #   ignored.
+        # - If neither a tag nor digest is specified, all tags are pulled.
+        from_image: nil,
+        # Source to import. The value may be a URL from which the image can be retrieved
+        # or `-` to read the image from the request body. This parameter may only be used
+        # when importing an image.
+        from_src: nil,
+        # Set commit message for imported image.
+        message: nil,
+        # Platform in the format os[/arch[/variant]].
+        #
+        # When used in combination with the `fromImage` option, the daemon checks if the
+        # given image is present in the local image cache with the given OS and
+        # Architecture, and otherwise attempts to pull the image. If the option is not
+        # set, the host's native OS and Architecture are used. If the given image does not
+        # exist in the local image cache, the daemon attempts to pull the image with the
+        # host's native OS and Architecture. If the given image does exists in the local
+        # image cache, but its OS or architecture does not match, a warning is produced.
+        #
+        # When used with the `fromSrc` option to import an image from an archive, this
+        # option sets the platform information for the imported image. If the option is
+        # not set, the host's native OS and Architecture are used for the imported image.
+        platform: nil,
+        # Repository name given to an image when it is imported. The repo may include a
+        # tag. This parameter may only be used when importing an image.
+        repo: nil,
+        # Tag or digest. If empty when pulling an image, this causes all tags for the
+        # given image to be pulled.
+        tag: nil,
+        body: nil,
+        x_registry_auth: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            changes: T::Array[String],
+            from_image: String,
+            from_src: String,
+            message: String,
+            platform: String,
+            repo: String,
+            tag: String,
+            body: String,
+            x_registry_auth: String,
+            request_options: DockerEngineAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/image_push_params.rbi

@@ -0,0 +1,84 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ImagePushParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ImagePushParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :x_registry_auth
+
+      # JSON-encoded OCI platform to select the platform-variant to push. If not
+      # provided, all available variants will attempt to be pushed.
+      #
+      # If the daemon provides a multi-platform image store, this selects the
+      # platform-variant to push to the registry. If the image is a single-platform
+      # image, or if the multi-platform image does not provide a variant matching the
+      # given platform, an error is returned.
+      #
+      # Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`
+      sig { returns(T.nilable(String)) }
+      attr_reader :platform
+
+      sig { params(platform: String).void }
+      attr_writer :platform
+
+      # Tag of the image to push. For example, `latest`. If no tag is provided, all tags
+      # of the given image that are present in the local image store are pushed.
+      sig { returns(T.nilable(String)) }
+      attr_reader :tag
+
+      sig { params(tag: String).void }
+      attr_writer :tag
+
+      sig do
+        params(
+          x_registry_auth: String,
+          platform: String,
+          tag: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        x_registry_auth:,
+        # JSON-encoded OCI platform to select the platform-variant to push. If not
+        # provided, all available variants will attempt to be pushed.
+        #
+        # If the daemon provides a multi-platform image store, this selects the
+        # platform-variant to push to the registry. If the image is a single-platform
+        # image, or if the multi-platform image does not provide a variant matching the
+        # given platform, an error is returned.
+        #
+        # Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`
+        platform: nil,
+        # Tag of the image to push. For example, `latest`. If no tag is provided, all tags
+        # of the given image that are present in the local image store are pushed.
+        tag: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            x_registry_auth: String,
+            platform: String,
+            tag: String,
+            request_options: DockerEngineAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/image_search_params.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ImageSearchParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ImageSearchParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # Term to search
+      sig { returns(String) }
+      attr_accessor :term
+
+      # A JSON encoded value of the filters (a `map[string][]string`) to process on the
+      # images list. Available filters:
+      #
+      # - `is-official=(true|false)`
+      # - `stars=<number>` Matches images that has at least 'number' stars.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filters
+
+      sig { params(filters: String).void }
+      attr_writer :filters
+
+      # Maximum number of results to return
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig do
+        params(
+          term: String,
+          filters: String,
+          limit: Integer,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Term to search
+        term:,
+        # A JSON encoded value of the filters (a `map[string][]string`) to process on the
+        # images list. Available filters:
+        #
+        # - `is-official=(true|false)`
+        # - `stars=<number>` Matches images that has at least 'number' stars.
+        filters: nil,
+        # Maximum number of results to return
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            term: String,
+            filters: String,
+            limit: Integer,
+            request_options: DockerEngineAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/image_search_response.rbi

@@ -0,0 +1,95 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ImageSearchResponseItem < DockerEngineAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::Models::ImageSearchResponseItem,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :description
+
+      sig { params(description: String).void }
+      attr_writer :description
+
+      # Whether this repository has automated builds enabled.
+      #
+      # <p><br /></p>
+      #
+      # > **Deprecated**: This field is deprecated and will always be "false".
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :is_automated
+
+      sig { params(is_automated: T::Boolean).void }
+      attr_writer :is_automated
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :is_official
+
+      sig { params(is_official: T::Boolean).void }
+      attr_writer :is_official
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :star_count
+
+      sig { params(star_count: Integer).void }
+      attr_writer :star_count
+
+      sig do
+        params(
+          description: String,
+          is_automated: T::Boolean,
+          is_official: T::Boolean,
+          name: String,
+          star_count: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        description: nil,
+        # Whether this repository has automated builds enabled.
+        #
+        # <p><br /></p>
+        #
+        # > **Deprecated**: This field is deprecated and will always be "false".
+        is_automated: nil,
+        is_official: nil,
+        name: nil,
+        star_count: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            description: String,
+            is_automated: T::Boolean,
+            is_official: T::Boolean,
+            name: String,
+            star_count: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+
+    ImageSearchResponse =
+      T.let(
+        DockerEngineAPI::Internal::Type::ArrayOf[
+          DockerEngineAPI::Models::ImageSearchResponseItem
+        ],
+        DockerEngineAPI::Internal::Type::Converter
+      )
+  end
+end

data/rbi/docker_engine_api/models/image_tag_params.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ImageTagParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ImageTagParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # The repository to tag in. For example, `someuser/someimage`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :repo
+
+      sig { params(repo: String).void }
+      attr_writer :repo
+
+      # The name of the new tag.
+      sig { returns(T.nilable(String)) }
+      attr_reader :tag
+
+      sig { params(tag: String).void }
+      attr_writer :tag
+
+      sig do
+        params(
+          repo: String,
+          tag: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The repository to tag in. For example, `someuser/someimage`.
+        repo: nil,
+        # The name of the new tag.
+        tag: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            repo: String,
+            tag: String,
+            request_options: DockerEngineAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end