docker-engine-ruby 0.2.2 → 0.3.0

data/lib/docker_engine_ruby/models/image_commit_params.rb

@@ -8,62 +8,48 @@ module DockerEngineRuby
       include DockerEngineRuby::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, DockerEngineRuby::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 author [String]
+      #   @param changes [String]
+      #   @param comment [String]
+      #   @param container [String]
+      #   @param pause [Boolean]
+      #   @param repo [String]
+      #   @param tag [String]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/image_delete_params.rb

@@ -8,35 +8,24 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute force
-      #   Remove the image even if it is being used by stopped containers or has other
-      #   tags
       #
       #   @return [Boolean, nil]
       optional :force, DockerEngineRuby::Internal::Type::Boolean
 
       # @!attribute noprune
-      #   Do not delete untagged parent images
       #
       #   @return [Boolean, nil]
       optional :noprune, DockerEngineRuby::Internal::Type::Boolean
 
       # @!attribute platforms
-      #   Select platform-specific content to delete. Multiple values are accepted. Each
-      #   platform is a OCI platform encoded as a JSON string.
       #
       #   @return [Array<String>, nil]
       optional :platforms, DockerEngineRuby::Internal::Type::ArrayOf[String]
 
       # @!method initialize(force: nil, noprune: nil, platforms: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::ImageDeleteParams} for more details.
-      #
-      #   @param force [Boolean] Remove the image even if it is being used by stopped containers or has other tag
-      #
-      #   @param noprune [Boolean] Do not delete untagged parent images
-      #
-      #   @param platforms [Array<String>] Select platform-specific content to delete.
-      #
+      #   @param force [Boolean]
+      #   @param noprune [Boolean]
+      #   @param platforms [Array<String>]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/image_get_all_params.rb

@@ -8,29 +8,18 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute names
-      #   Image names to filter by
       #
       #   @return [Array<String>, nil]
       optional :names, DockerEngineRuby::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, DockerEngineRuby::Internal::Type::ArrayOf[String]
 
       # @!method initialize(names: nil, platform: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::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 names [Array<String>]
+      #   @param platform [Array<String>]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/image_get_params.rb

@@ -8,21 +8,12 @@ module DockerEngineRuby
       include DockerEngineRuby::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, DockerEngineRuby::Internal::Type::ArrayOf[String]
 
       # @!method initialize(platform: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::ImageGetParams} for more details.
-      #
-      #   @param platform [Array<String>] JSON encoded OCI platform describing a platform which will be used
-      #
+      #   @param platform [Array<String>]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/image_history_params.rb

@@ -8,26 +8,12 @@ module DockerEngineRuby
       include DockerEngineRuby::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
-      #   {DockerEngineRuby::Models::ImageHistoryParams} for more details.
-      #
-      #   @param platform [String] JSON-encoded OCI platform to select the platform-variant.
-      #
+      #   @param platform [String]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/image_inspect_params.rb

@@ -8,14 +8,12 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute manifests
-      #   Include Manifests in the image summary.
       #
       #   @return [Boolean, nil]
       optional :manifests, DockerEngineRuby::Internal::Type::Boolean
 
       # @!method initialize(manifests: nil, request_options: {})
-      #   @param manifests [Boolean] Include Manifests in the image summary.
-      #
+      #   @param manifests [Boolean]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/image_list_params.rb

@@ -8,60 +8,36 @@ module DockerEngineRuby
       include DockerEngineRuby::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, DockerEngineRuby::Internal::Type::Boolean
 
       # @!attribute digests
-      #   Show digest information as a `RepoDigests` field on each image.
       #
       #   @return [Boolean, nil]
       optional :digests, DockerEngineRuby::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, DockerEngineRuby::Internal::Type::Boolean
 
       # @!attribute shared_size
-      #   Compute and show shared size as a `SharedSize` field on each image.
       #
       #   @return [Boolean, nil]
       optional :shared_size, DockerEngineRuby::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
-      #   {DockerEngineRuby::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 all [Boolean]
+      #   @param digests [Boolean]
+      #   @param filters [String]
+      #   @param manifests [Boolean]
+      #   @param shared_size [Boolean]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/image_load_params.rb

@@ -13,31 +13,19 @@ module DockerEngineRuby
       required :body, DockerEngineRuby::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, DockerEngineRuby::Internal::Type::ArrayOf[String]
 
       # @!attribute quiet
-      #   Suppress progress details during load.
       #
       #   @return [Boolean, nil]
       optional :quiet, DockerEngineRuby::Internal::Type::Boolean
 
       # @!method initialize(body:, platform: nil, quiet: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::ImageLoadParams} for more details.
-      #
       #   @param body [Pathname, StringIO, IO, String, DockerEngineRuby::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 platform [Array<String>]
+      #   @param quiet [Boolean]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/image_prune_params.rb

@@ -8,27 +8,12 @@ module DockerEngineRuby
       include DockerEngineRuby::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
-      #   {DockerEngineRuby::Models::ImagePruneParams} for more details.
-      #
-      #   @param filters [String] Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
-      #
+      #   @param filters [String]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/image_prune_response.rb

@@ -5,7 +5,6 @@ module DockerEngineRuby
     # @see DockerEngineRuby::Resources::Images#prune
     class ImagePruneResponse < DockerEngineRuby::Internal::Type::BaseModel
       # @!attribute images_deleted
-      #   Images that were deleted
       #
       #   @return [Array<DockerEngineRuby::Models::DeleteItem>, nil]
       optional :images_deleted,
@@ -13,15 +12,13 @@ module DockerEngineRuby
                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<DockerEngineRuby::Models::DeleteItem>] Images that were deleted
-      #
-      #   @param space_reclaimed [Integer] Disk space reclaimed in bytes
+      #   @param images_deleted [Array<DockerEngineRuby::Models::DeleteItem>]
+      #   @param space_reclaimed [Integer]
     end
   end
 end

data/lib/docker_engine_ruby/models/image_pull_params.rb

@@ -7,108 +7,61 @@ module DockerEngineRuby
       extend DockerEngineRuby::Internal::Type::RequestParameters::Converter
       include DockerEngineRuby::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.
+      # @!attribute body
       #
-      #   Supported `Dockerfile` instructions:
-      #   `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`
+      #   @return [String]
+      required :body, String
+
+      # @!attribute changes
       #
       #   @return [Array<String>, nil]
       optional :changes, DockerEngineRuby::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
-      #   {DockerEngineRuby::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
-      #
+      # @!method initialize(body:, changes: nil, from_image: nil, from_src: nil, message: nil, platform: nil, repo: nil, tag: nil, x_registry_auth: nil, request_options: {})
       #   @param body [String]
-      #
+      #   @param changes [Array<String>]
+      #   @param from_image [String]
+      #   @param from_src [String]
+      #   @param message [String]
+      #   @param platform [String]
+      #   @param repo [String]
+      #   @param tag [String]
       #   @param x_registry_auth [String]
-      #
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/image_push_params.rb

@@ -13,36 +13,19 @@ module DockerEngineRuby
       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
-      #   {DockerEngineRuby::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 platform [String]
+      #   @param tag [String]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/image_search_params.rb

@@ -8,37 +8,24 @@ module DockerEngineRuby
       include DockerEngineRuby::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
-      #   {DockerEngineRuby::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 term [String]
+      #   @param filters [String]
+      #   @param limit [Integer]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/image_search_response.rb

@@ -9,11 +9,6 @@ module DockerEngineRuby
       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, DockerEngineRuby::Internal::Type::Boolean
@@ -34,17 +29,10 @@ module DockerEngineRuby
       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
-      #   {DockerEngineRuby::Models::ImageSearchResponseItem} for more details.
-      #
       #   @param description [String]
-      #
-      #   @param is_automated [Boolean] Whether this repository has automated builds enabled.
-      #
+      #   @param is_automated [Boolean]
       #   @param is_official [Boolean]
-      #
       #   @param name [String]
-      #
       #   @param star_count [Integer]
     end
 

data/lib/docker_engine_ruby/models/image_tag_params.rb

@@ -8,22 +8,18 @@ module DockerEngineRuby
       include DockerEngineRuby::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 repo [String]
+      #   @param tag [String]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end