docker-engine-api 0.2.1

data/rbi/docker_engine_api/models/image_commit_params.rbi

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

data/rbi/docker_engine_api/models/image_commit_response.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ImageCommitResponse < DockerEngineAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::Models::ImageCommitResponse,
+            DockerEngineAPI::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_api/models/image_delete_params.rbi

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

data/rbi/docker_engine_api/models/image_delete_response.rbi

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

data/rbi/docker_engine_api/models/image_get_all_params.rbi

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

data/rbi/docker_engine_api/models/image_get_params.rbi

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

data/rbi/docker_engine_api/models/image_history_params.rbi

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

data/rbi/docker_engine_api/models/image_history_response.rbi

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

data/rbi/docker_engine_api/models/image_inspect_params.rbi

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

data/rbi/docker_engine_api/models/image_list_params.rbi

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

data/rbi/docker_engine_api/models/image_list_response.rbi

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

data/rbi/docker_engine_api/models/image_load_params.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ImageLoadParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ImageLoadParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      sig { returns(DockerEngineAPI::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: DockerEngineAPI::Internal::FileInput,
+          platform: T::Array[String],
+          quiet: T::Boolean,
+          request_options: DockerEngineAPI::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: DockerEngineAPI::Internal::FileInput,
+            platform: T::Array[String],
+            quiet: T::Boolean,
+            request_options: DockerEngineAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end