docker-engine 0.1.1 → 0.2.0

data/lib/docker_engine/models/image_commit_params.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Images#commit
+    class ImageCommitParams < DockerEngine::Models::Config
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute author
+      #   Author of the image (e.g., `John Hannibal Smith <hannibal@a-team.com>`)
+      #
+      #   @return [String, nil]
+      optional :author, String
+
+      # @!attribute changes
+      #   `Dockerfile` instructions to apply while committing
+      #
+      #   @return [String, nil]
+      optional :changes, String
+
+      # @!attribute comment
+      #   Commit message
+      #
+      #   @return [String, nil]
+      optional :comment, String
+
+      # @!attribute container
+      #   The ID or name of the container to commit
+      #
+      #   @return [String, nil]
+      optional :container, String
+
+      # @!attribute pause
+      #   Whether to pause the container before committing
+      #
+      #   @return [Boolean, nil]
+      optional :pause, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute repo
+      #   Repository name for the created image
+      #
+      #   @return [String, nil]
+      optional :repo, String
+
+      # @!attribute tag
+      #   Tag name for the create image
+      #
+      #   @return [String, nil]
+      optional :tag, String
+
+      # @!method initialize(author: nil, changes: nil, comment: nil, container: nil, pause: nil, repo: nil, tag: nil, request_options: {})
+      #   @param author [String] Author of the image (e.g., `John Hannibal Smith <hannibal@a-team.com>`)
+      #
+      #   @param changes [String] `Dockerfile` instructions to apply while committing
+      #
+      #   @param comment [String] Commit message
+      #
+      #   @param container [String] The ID or name of the container to commit
+      #
+      #   @param pause [Boolean] Whether to pause the container before committing
+      #
+      #   @param repo [String] Repository name for the created image
+      #
+      #   @param tag [String] Tag name for the create image
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/image_commit_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Images#commit
+    class ImageCommitResponse < DockerEngine::Internal::Type::BaseModel
+      # @!attribute id
+      #   The id of the newly created object.
+      #
+      #   @return [String]
+      required :id, String, api_name: :Id
+
+      # @!method initialize(id:)
+      #   Response to an API call that returns just an Id
+      #
+      #   @param id [String] The id of the newly created object.
+    end
+  end
+end

data/lib/docker_engine/models/image_delete_response.rb

@@ -2,27 +2,7 @@
 
 module DockerEngine
   module Models
-    class ImageDeleteResponseItem < DockerEngine::Internal::Type::BaseModel
-      # @!attribute deleted
-      #   The image ID of an image that was deleted
-      #
-      #   @return [String, nil]
-      optional :deleted, String, api_name: :Deleted
-
-      # @!attribute untagged
-      #   The image ID of an image that was untagged
-      #
-      #   @return [String, nil]
-      optional :untagged, String, api_name: :Untagged
-
-      # @!method initialize(deleted: nil, untagged: nil)
-      #   @param deleted [String] The image ID of an image that was deleted
-      #
-      #   @param untagged [String] The image ID of an image that was untagged
-    end
-
     # @type [DockerEngine::Internal::Type::Converter]
-    ImageDeleteResponse =
-      DockerEngine::Internal::Type::ArrayOf[-> { DockerEngine::Models::ImageDeleteResponseItem }]
+    ImageDeleteResponse = DockerEngine::Internal::Type::ArrayOf[-> { DockerEngine::DeleteItem }]
   end
 end

data/lib/docker_engine/models/image_get_all_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Images#get_all
+    class ImageGetAllParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute names
+      #   Image names to filter by
+      #
+      #   @return [Array<String>, nil]
+      optional :names, DockerEngine::Internal::Type::ArrayOf[String]
+
+      # @!attribute platform
+      #   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"}`
+      #
+      #   @return [Array<String>, nil]
+      optional :platform, DockerEngine::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(names: nil, platform: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::ImageGetAllParams} for more details.
+      #
+      #   @param names [Array<String>] Image names to filter by
+      #
+      #   @param platform [Array<String>] JSON encoded OCI platform(s) which will be used to select the
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/image_get_params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Images#get
+    class ImageGetParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute platform
+      #   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"}`
+      #
+      #   @return [Array<String>, nil]
+      optional :platform, DockerEngine::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(platform: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::ImageGetParams} for more details.
+      #
+      #   @param platform [Array<String>] JSON encoded OCI platform describing a platform which will be used
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/image_history_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Images#history
+    class ImageHistoryParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute platform
+      #   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"}`
+      #
+      #   @return [String, nil]
+      optional :platform, String
+
+      # @!method initialize(platform: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::ImageHistoryParams} for more details.
+      #
+      #   @param platform [String] JSON-encoded OCI platform to select the platform-variant.
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/image_history_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @type [DockerEngine::Internal::Type::Converter]
+    ImageHistoryResponse = DockerEngine::Internal::Type::ArrayOf[-> { DockerEngine::HistoryItem }]
+  end
+end

data/lib/docker_engine/models/image_load_params.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Images#load_
+    class ImageLoadParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute body
+      #
+      #   @return [Pathname, StringIO, IO, String, DockerEngine::FilePart]
+      required :body, DockerEngine::Internal::Type::FileInput
+
+      # @!attribute platform
+      #   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"}`
+      #
+      #   @return [Array<String>, nil]
+      optional :platform, DockerEngine::Internal::Type::ArrayOf[String]
+
+      # @!attribute quiet
+      #   Suppress progress details during load.
+      #
+      #   @return [Boolean, nil]
+      optional :quiet, DockerEngine::Internal::Type::Boolean
+
+      # @!method initialize(body:, platform: nil, quiet: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::ImageLoadParams} for more details.
+      #
+      #   @param body [Pathname, StringIO, IO, String, DockerEngine::FilePart]
+      #
+      #   @param platform [Array<String>] JSON encoded OCI platform(s) which will be used to select the
+      #
+      #   @param quiet [Boolean] Suppress progress details during load.
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/image_prune_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Images#prune
+    class ImagePruneParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute filters
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :filters, String
+
+      # @!method initialize(filters: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::ImagePruneParams} for more details.
+      #
+      #   @param filters [String] Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/image_prune_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Images#prune
+    class ImagePruneResponse < DockerEngine::Internal::Type::BaseModel
+      # @!attribute images_deleted
+      #   Images that were deleted
+      #
+      #   @return [Array<DockerEngine::Models::DeleteItem>, nil]
+      optional :images_deleted,
+               -> { DockerEngine::Internal::Type::ArrayOf[DockerEngine::DeleteItem] },
+               api_name: :ImagesDeleted
+
+      # @!attribute space_reclaimed
+      #   Disk space reclaimed in bytes
+      #
+      #   @return [Integer, nil]
+      optional :space_reclaimed, Integer, api_name: :SpaceReclaimed
+
+      # @!method initialize(images_deleted: nil, space_reclaimed: nil)
+      #   @param images_deleted [Array<DockerEngine::Models::DeleteItem>] Images that were deleted
+      #
+      #   @param space_reclaimed [Integer] Disk space reclaimed in bytes
+    end
+  end
+end

data/lib/docker_engine/models/image_push_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Images#push
+    class ImagePushParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute x_registry_auth
+      #
+      #   @return [String]
+      required :x_registry_auth, String
+
+      # @!attribute platform
+      #   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"}`
+      #
+      #   @return [String, nil]
+      optional :platform, String
+
+      # @!attribute tag
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :tag, String
+
+      # @!method initialize(x_registry_auth:, platform: nil, tag: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::ImagePushParams} for more details.
+      #
+      #   @param x_registry_auth [String]
+      #
+      #   @param platform [String] JSON-encoded OCI platform to select the platform-variant to push.
+      #
+      #   @param tag [String] Tag of the image to push. For example, `latest`. If no tag is provided,
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/image_search_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Images#search
+    class ImageSearchParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute term
+      #   Term to search
+      #
+      #   @return [String]
+      required :term, String
+
+      # @!attribute filters
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :filters, String
+
+      # @!attribute limit
+      #   Maximum number of results to return
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(term:, filters: nil, limit: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::ImageSearchParams} for more details.
+      #
+      #   @param term [String] Term to search
+      #
+      #   @param filters [String] A JSON encoded value of the filters (a `map[string][]string`) to process on the
+      #
+      #   @param limit [Integer] Maximum number of results to return
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/image_search_response.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    class ImageSearchResponseItem < DockerEngine::Internal::Type::BaseModel
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute is_automated
+      #   Whether this repository has automated builds enabled.
+      #
+      #   <p><br /></p>
+      #
+      #   > **Deprecated**: This field is deprecated and will always be "false".
+      #
+      #   @return [Boolean, nil]
+      optional :is_automated, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute is_official
+      #
+      #   @return [Boolean, nil]
+      optional :is_official, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute star_count
+      #
+      #   @return [Integer, nil]
+      optional :star_count, Integer
+
+      # @!method initialize(description: nil, is_automated: nil, is_official: nil, name: nil, star_count: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::ImageSearchResponseItem} for more details.
+      #
+      #   @param description [String]
+      #
+      #   @param is_automated [Boolean] Whether this repository has automated builds enabled.
+      #
+      #   @param is_official [Boolean]
+      #
+      #   @param name [String]
+      #
+      #   @param star_count [Integer]
+    end
+
+    # @type [DockerEngine::Internal::Type::Converter]
+    ImageSearchResponse =
+      DockerEngine::Internal::Type::ArrayOf[-> { DockerEngine::Models::ImageSearchResponseItem }]
+  end
+end

data/lib/docker_engine/models/image_tag_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Images#tag
+    class ImageTagParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute repo
+      #   The repository to tag in. For example, `someuser/someimage`.
+      #
+      #   @return [String, nil]
+      optional :repo, String
+
+      # @!attribute tag
+      #   The name of the new tag.
+      #
+      #   @return [String, nil]
+      optional :tag, String
+
+      # @!method initialize(repo: nil, tag: nil, request_options: {})
+      #   @param repo [String] The repository to tag in. For example, `someuser/someimage`.
+      #
+      #   @param tag [String] The name of the new tag.
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end