docker-engine-api 0.2.1

data/lib/docker_engine_api/models/image_list_params.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Images#list
+    class ImageListParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      # @!attribute all
+      #   Show all images. Only images from a final layer (no children) are shown by
+      #   default.
+      #
+      #   @return [Boolean, nil]
+      optional :all, DockerEngineAPI::Internal::Type::Boolean
+
+      # @!attribute digests
+      #   Show digest information as a `RepoDigests` field on each image.
+      #
+      #   @return [Boolean, nil]
+      optional :digests, DockerEngineAPI::Internal::Type::Boolean
+
+      # @!attribute filters
+      #   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>`
+      #
+      #   @return [String, nil]
+      optional :filters, String
+
+      # @!attribute manifests
+      #   Include `Manifests` in the image summary.
+      #
+      #   @return [Boolean, nil]
+      optional :manifests, DockerEngineAPI::Internal::Type::Boolean
+
+      # @!attribute shared_size
+      #   Compute and show shared size as a `SharedSize` field on each image.
+      #
+      #   @return [Boolean, nil]
+      optional :shared_size, DockerEngineAPI::Internal::Type::Boolean
+
+      # @!method initialize(all: nil, digests: nil, filters: nil, manifests: nil, shared_size: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineAPI::Models::ImageListParams} for more details.
+      #
+      #   @param all [Boolean] Show all images. Only images from a final layer (no children) are shown by defau
+      #
+      #   @param digests [Boolean] Show digest information as a `RepoDigests` field on each image.
+      #
+      #   @param filters [String] A JSON encoded value of the filters (a `map[string][]string`) to
+      #
+      #   @param manifests [Boolean] Include `Manifests` in the image summary.
+      #
+      #   @param shared_size [Boolean] Compute and show shared size as a `SharedSize` field on each image.
+      #
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine_api/models/image_list_response.rb

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

data/lib/docker_engine_api/models/image_load_params.rb

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

data/lib/docker_engine_api/models/image_prune_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Images#prune
+    class ImagePruneParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::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
+      #   {DockerEngineAPI::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 [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine_api/models/image_prune_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Images#prune
+    class ImagePruneResponse < DockerEngineAPI::Internal::Type::BaseModel
+      # @!attribute images_deleted
+      #   Images that were deleted
+      #
+      #   @return [Array<DockerEngineAPI::Models::DeleteItem>, nil]
+      optional :images_deleted,
+               -> { DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::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<DockerEngineAPI::Models::DeleteItem>] Images that were deleted
+      #
+      #   @param space_reclaimed [Integer] Disk space reclaimed in bytes
+    end
+  end
+end

data/lib/docker_engine_api/models/image_pull_params.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Images#pull
+    class ImagePullParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      # @!attribute changes
+      #   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`
+      #
+      #   @return [Array<String>, nil]
+      optional :changes, DockerEngineAPI::Internal::Type::ArrayOf[String]
+
+      # @!attribute from_image
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :from_image, String
+
+      # @!attribute from_src
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :from_src, String
+
+      # @!attribute message
+      #   Set commit message for imported image.
+      #
+      #   @return [String, nil]
+      optional :message, String
+
+      # @!attribute platform
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :platform, String
+
+      # @!attribute repo
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :repo, String
+
+      # @!attribute tag
+      #   Tag or digest. If empty when pulling an image, this causes all tags for the
+      #   given image to be pulled.
+      #
+      #   @return [String, nil]
+      optional :tag, String
+
+      # @!attribute body
+      #
+      #   @return [String, nil]
+      optional :body, String
+
+      # @!attribute x_registry_auth
+      #
+      #   @return [String, nil]
+      optional :x_registry_auth, String
+
+      # @!method initialize(changes: nil, from_image: nil, from_src: nil, message: nil, platform: nil, repo: nil, tag: nil, body: nil, x_registry_auth: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineAPI::Models::ImagePullParams} for more details.
+      #
+      #   @param changes [Array<String>] Apply `Dockerfile` instructions to the image that is created,
+      #
+      #   @param from_image [String] Name of the image to pull. If the name includes a tag or digest, specific behavi
+      #
+      #   @param from_src [String] Source to import. The value may be a URL from which the image can be retrieved o
+      #
+      #   @param message [String] Set commit message for imported image.
+      #
+      #   @param platform [String] Platform in the format os[/arch[/variant]].
+      #
+      #   @param repo [String] Repository name given to an image when it is imported. The repo may include a ta
+      #
+      #   @param tag [String] Tag or digest. If empty when pulling an image, this causes all tags for the give
+      #
+      #   @param body [String]
+      #
+      #   @param x_registry_auth [String]
+      #
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine_api/models/image_push_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Images#push
+    class ImagePushParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::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
+      #   {DockerEngineAPI::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 [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine_api/models/image_search_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Images#search
+    class ImageSearchParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::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
+      #   {DockerEngineAPI::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 [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine_api/models/image_search_response.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    class ImageSearchResponseItem < DockerEngineAPI::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, DockerEngineAPI::Internal::Type::Boolean
+
+      # @!attribute is_official
+      #
+      #   @return [Boolean, nil]
+      optional :is_official, DockerEngineAPI::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
+      #   {DockerEngineAPI::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 [DockerEngineAPI::Internal::Type::Converter]
+    ImageSearchResponse =
+      DockerEngineAPI::Internal::Type::ArrayOf[-> { DockerEngineAPI::Models::ImageSearchResponseItem }]
+  end
+end

data/lib/docker_engine_api/models/image_tag_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Images#tag
+    class ImageTagParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::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 [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end