docker-engine 0.1.1 → 0.2.0

data/rbi/docker_engine/models/image_commit_params.rbi

@@ -0,0 +1,115 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class ImageCommitParams < DockerEngine::Models::Config
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::ImageCommitParams,
+            DockerEngine::Internal::AnyHash
+          )
+        end
+
+      # Author of the image (e.g., `John Hannibal Smith <hannibal@a-team.com>`)
+      sig { returns(T.nilable(String)) }
+      attr_reader :author
+
+      sig { params(author: String).void }
+      attr_writer :author
+
+      # `Dockerfile` instructions to apply while committing
+      sig { returns(T.nilable(String)) }
+      attr_reader :changes
+
+      sig { params(changes: String).void }
+      attr_writer :changes
+
+      # Commit message
+      sig { returns(T.nilable(String)) }
+      attr_reader :comment
+
+      sig { params(comment: String).void }
+      attr_writer :comment
+
+      # The ID or name of the container to commit
+      sig { returns(T.nilable(String)) }
+      attr_reader :container
+
+      sig { params(container: String).void }
+      attr_writer :container
+
+      # Whether to pause the container before committing
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :pause
+
+      sig { params(pause: T::Boolean).void }
+      attr_writer :pause
+
+      # Repository name for the created image
+      sig { returns(T.nilable(String)) }
+      attr_reader :repo
+
+      sig { params(repo: String).void }
+      attr_writer :repo
+
+      # Tag name for the create image
+      sig { returns(T.nilable(String)) }
+      attr_reader :tag
+
+      sig { params(tag: String).void }
+      attr_writer :tag
+
+      sig do
+        params(
+          author: String,
+          changes: String,
+          comment: String,
+          container: String,
+          pause: T::Boolean,
+          repo: String,
+          tag: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Author of the image (e.g., `John Hannibal Smith <hannibal@a-team.com>`)
+        author: nil,
+        # `Dockerfile` instructions to apply while committing
+        changes: nil,
+        # Commit message
+        comment: nil,
+        # The ID or name of the container to commit
+        container: nil,
+        # Whether to pause the container before committing
+        pause: nil,
+        # Repository name for the created image
+        repo: nil,
+        # Tag name for the create image
+        tag: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            author: String,
+            changes: String,
+            comment: String,
+            container: String,
+            pause: T::Boolean,
+            repo: String,
+            tag: String,
+            request_options: DockerEngine::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/image_commit_response.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class ImageCommitResponse < DockerEngine::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::Models::ImageCommitResponse,
+            DockerEngine::Internal::AnyHash
+          )
+        end
+
+      # The id of the newly created object.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Response to an API call that returns just an Id
+      sig { params(id: String).returns(T.attached_class) }
+      def self.new(
+        # The id of the newly created object.
+        id:
+      )
+      end
+
+      sig { override.returns({ id: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/image_delete_response.rbi

@@ -2,50 +2,9 @@
 
 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::ArrayOf[DockerEngine::DeleteItem],
         DockerEngine::Internal::Type::Converter
       )
   end

data/rbi/docker_engine/models/image_get_all_params.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class ImageGetAllParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::ImageGetAllParams,
+            DockerEngine::Internal::AnyHash
+          )
+        end
+
+      # Image names to filter by
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :names
+
+      sig { params(names: T::Array[String]).void }
+      attr_writer :names
+
+      # JSON encoded OCI platform(s) which will be used to select the platform-specific
+      # image(s) to be saved if the image is multi-platform. If not provided, the full
+      # multi-platform image will be saved.
+      #
+      # Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :platform
+
+      sig { params(platform: T::Array[String]).void }
+      attr_writer :platform
+
+      sig do
+        params(
+          names: T::Array[String],
+          platform: T::Array[String],
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Image names to filter by
+        names: nil,
+        # JSON encoded OCI platform(s) which will be used to select the platform-specific
+        # image(s) to be saved if the image is multi-platform. If not provided, the full
+        # multi-platform image will be saved.
+        #
+        # Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`
+        platform: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            names: T::Array[String],
+            platform: T::Array[String],
+            request_options: DockerEngine::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/image_get_params.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class ImageGetParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(DockerEngine::ImageGetParams, DockerEngine::Internal::AnyHash)
+        end
+
+      # JSON encoded OCI platform describing a platform which will be used to select a
+      # platform-specific image to be saved if the image is multi-platform. If not
+      # provided, the full multi-platform image will be saved.
+      #
+      # Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :platform
+
+      sig { params(platform: T::Array[String]).void }
+      attr_writer :platform
+
+      sig do
+        params(
+          platform: T::Array[String],
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # JSON encoded OCI platform describing a platform which will be used to select a
+        # platform-specific image to be saved if the image is multi-platform. If not
+        # provided, the full multi-platform image will be saved.
+        #
+        # Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`
+        platform: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            platform: T::Array[String],
+            request_options: DockerEngine::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/image_history_params.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class ImageHistoryParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::ImageHistoryParams,
+            DockerEngine::Internal::AnyHash
+          )
+        end
+
+      # JSON-encoded OCI platform to select the platform-variant. If omitted, it
+      # defaults to any locally available platform, prioritizing the daemon's host
+      # platform.
+      #
+      # If the daemon provides a multi-platform image store, this selects the
+      # platform-variant to show the history for. 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
+
+      sig do
+        params(
+          platform: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # JSON-encoded OCI platform to select the platform-variant. If omitted, it
+        # defaults to any locally available platform, prioritizing the daemon's host
+        # platform.
+        #
+        # If the daemon provides a multi-platform image store, this selects the
+        # platform-variant to show the history for. 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,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { platform: String, request_options: DockerEngine::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/image_history_response.rbi

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

data/rbi/docker_engine/models/image_load_params.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class ImageLoadParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(DockerEngine::ImageLoadParams, DockerEngine::Internal::AnyHash)
+        end
+
+      sig { returns(DockerEngine::Internal::FileInput) }
+      attr_accessor :body
+
+      # JSON encoded OCI platform(s) which will be used to select the platform-specific
+      # image(s) to load if the image is multi-platform. If not provided, the full
+      # multi-platform image will be loaded.
+      #
+      # Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :platform
+
+      sig { params(platform: T::Array[String]).void }
+      attr_writer :platform
+
+      # Suppress progress details during load.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :quiet
+
+      sig { params(quiet: T::Boolean).void }
+      attr_writer :quiet
+
+      sig do
+        params(
+          body: DockerEngine::Internal::FileInput,
+          platform: T::Array[String],
+          quiet: T::Boolean,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        body:,
+        # JSON encoded OCI platform(s) which will be used to select the platform-specific
+        # image(s) to load if the image is multi-platform. If not provided, the full
+        # multi-platform image will be loaded.
+        #
+        # Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`
+        platform: nil,
+        # Suppress progress details during load.
+        quiet: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            body: DockerEngine::Internal::FileInput,
+            platform: T::Array[String],
+            quiet: T::Boolean,
+            request_options: DockerEngine::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/image_prune_params.rbi

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

data/rbi/docker_engine/models/image_prune_response.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class ImagePruneResponse < DockerEngine::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::Models::ImagePruneResponse,
+            DockerEngine::Internal::AnyHash
+          )
+        end
+
+      # Images that were deleted
+      sig { returns(T.nilable(T::Array[DockerEngine::DeleteItem])) }
+      attr_reader :images_deleted
+
+      sig do
+        params(images_deleted: T::Array[DockerEngine::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[DockerEngine::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[DockerEngine::DeleteItem],
+            space_reclaimed: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/image_push_params.rbi

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