docker-engine 0.1.1

data/rbi/docker_engine/models/image_delete_params.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class ImageDeleteParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::ImageDeleteParams,
+            DockerEngine::Internal::AnyHash
+          )
+        end
+
+      # Remove the image even if it is being used by stopped containers or has other
+      # tags
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :force
+
+      sig { params(force: T::Boolean).void }
+      attr_writer :force
+
+      # Do not delete untagged parent images
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :noprune
+
+      sig { params(noprune: T::Boolean).void }
+      attr_writer :noprune
+
+      # Select platform-specific content to delete. Multiple values are accepted. Each
+      # platform is a OCI platform encoded as a JSON string.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :platforms
+
+      sig { params(platforms: T::Array[String]).void }
+      attr_writer :platforms
+
+      sig do
+        params(
+          force: T::Boolean,
+          noprune: T::Boolean,
+          platforms: T::Array[String],
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Remove the image even if it is being used by stopped containers or has other
+        # tags
+        force: nil,
+        # Do not delete untagged parent images
+        noprune: nil,
+        # Select platform-specific content to delete. Multiple values are accepted. Each
+        # platform is a OCI platform encoded as a JSON string.
+        platforms: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            force: T::Boolean,
+            noprune: T::Boolean,
+            platforms: T::Array[String],
+            request_options: DockerEngine::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/image_delete_response.rbi

@@ -0,0 +1,52 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class ImageDeleteResponseItem < DockerEngine::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::Models::ImageDeleteResponseItem,
+            DockerEngine::Internal::AnyHash
+          )
+        end
+
+      # The image ID of an image that was deleted
+      sig { returns(T.nilable(String)) }
+      attr_reader :deleted
+
+      sig { params(deleted: String).void }
+      attr_writer :deleted
+
+      # The image ID of an image that was untagged
+      sig { returns(T.nilable(String)) }
+      attr_reader :untagged
+
+      sig { params(untagged: String).void }
+      attr_writer :untagged
+
+      sig do
+        params(deleted: String, untagged: String).returns(T.attached_class)
+      end
+      def self.new(
+        # The image ID of an image that was deleted
+        deleted: nil,
+        # The image ID of an image that was untagged
+        untagged: nil
+      )
+      end
+
+      sig { override.returns({ deleted: String, untagged: String }) }
+      def to_hash
+      end
+    end
+
+    ImageDeleteResponse =
+      T.let(
+        DockerEngine::Internal::Type::ArrayOf[
+          DockerEngine::Models::ImageDeleteResponseItem
+        ],
+        DockerEngine::Internal::Type::Converter
+      )
+  end
+end

data/rbi/docker_engine/models/image_inspect_params.rbi

@@ -0,0 +1,49 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class ImageInspectParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::ImageInspectParams,
+            DockerEngine::Internal::AnyHash
+          )
+        end
+
+      # Include Manifests in the image summary.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :manifests
+
+      sig { params(manifests: T::Boolean).void }
+      attr_writer :manifests
+
+      sig do
+        params(
+          manifests: T::Boolean,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Include Manifests in the image summary.
+        manifests: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            manifests: T::Boolean,
+            request_options: DockerEngine::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/image_list_params.rbi

@@ -0,0 +1,112 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class ImageListParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(DockerEngine::ImageListParams, DockerEngine::Internal::AnyHash)
+        end
+
+      # Show all images. Only images from a final layer (no children) are shown by
+      # default.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :all
+
+      sig { params(all: T::Boolean).void }
+      attr_writer :all
+
+      # Show digest information as a `RepoDigests` field on each image.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :digests
+
+      sig { params(digests: T::Boolean).void }
+      attr_writer :digests
+
+      # A JSON encoded value of the filters (a `map[string][]string`) to process on the
+      # images list.
+      #
+      # Available filters:
+      #
+      # - `before`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)
+      # - `dangling=true`
+      # - `label=key` or `label="key=value"` of an image label
+      # - `reference`=(`<image-name>[:<tag>]`)
+      # - `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)
+      # - `until=<timestamp>`
+      sig { returns(T.nilable(String)) }
+      attr_reader :filters
+
+      sig { params(filters: String).void }
+      attr_writer :filters
+
+      # Include `Manifests` in the image summary.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :manifests
+
+      sig { params(manifests: T::Boolean).void }
+      attr_writer :manifests
+
+      # Compute and show shared size as a `SharedSize` field on each image.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :shared_size
+
+      sig { params(shared_size: T::Boolean).void }
+      attr_writer :shared_size
+
+      sig do
+        params(
+          all: T::Boolean,
+          digests: T::Boolean,
+          filters: String,
+          manifests: T::Boolean,
+          shared_size: T::Boolean,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Show all images. Only images from a final layer (no children) are shown by
+        # default.
+        all: nil,
+        # Show digest information as a `RepoDigests` field on each image.
+        digests: nil,
+        # A JSON encoded value of the filters (a `map[string][]string`) to process on the
+        # images list.
+        #
+        # Available filters:
+        #
+        # - `before`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)
+        # - `dangling=true`
+        # - `label=key` or `label="key=value"` of an image label
+        # - `reference`=(`<image-name>[:<tag>]`)
+        # - `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)
+        # - `until=<timestamp>`
+        filters: nil,
+        # Include `Manifests` in the image summary.
+        manifests: nil,
+        # Compute and show shared size as a `SharedSize` field on each image.
+        shared_size: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            all: T::Boolean,
+            digests: T::Boolean,
+            filters: String,
+            manifests: T::Boolean,
+            shared_size: T::Boolean,
+            request_options: DockerEngine::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/image_list_response.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    ImageListResponse =
+      T.let(
+        DockerEngine::Internal::Type::ArrayOf[DockerEngine::Summary],
+        DockerEngine::Internal::Type::Converter
+      )
+  end
+end

data/rbi/docker_engine/models/image_pull_params.rbi

@@ -0,0 +1,186 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class ImagePullParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(DockerEngine::ImagePullParams, DockerEngine::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: DockerEngine::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: DockerEngine::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end