docker-engine-ruby 0.2.2 → 0.3.0

data/lib/docker_engine_ruby/resources/exec.rb

@@ -3,12 +3,11 @@
 module DockerEngineRuby
   module Resources
     class Exec
-      # Return low-level information about an exec instance.
+      # Inspect an exec instance
       #
       # @overload inspect_(id, request_options: {})
       #
-      # @param id [String] Exec instance ID
-      #
+      # @param id [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::ExecInspectResponse]
@@ -23,17 +22,13 @@ module DockerEngineRuby
         )
       end
 
-      # Resize the TTY session used by an exec instance. This endpoint only works if
-      # `tty` was specified as part of creating and starting the exec instance.
+      # Resize an exec instance
       #
       # @overload resize(id, h:, w:, request_options: {})
       #
-      # @param id [String] Exec instance ID
-      #
-      # @param h [Integer] Height of the TTY session in characters
-      #
-      # @param w [Integer] Width of the TTY session in characters
-      #
+      # @param id [String]
+      # @param h [Integer]
+      # @param w [Integer]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -50,20 +45,14 @@ module DockerEngineRuby
         )
       end
 
-      # Starts a previously set up exec instance. If detach is true, this endpoint
-      # returns immediately after starting the command. Otherwise, it sets up an
-      # interactive session with the command.
+      # Start an exec instance
       #
       # @overload start(id, console_size: nil, detach: nil, tty: nil, request_options: {})
       #
-      # @param id [String] Exec instance ID
-      #
-      # @param console_size [Array<Integer>, nil] Initial console size, as an `[height, width]` array.
-      #
-      # @param detach [Boolean] Detach from the command.
-      #
-      # @param tty [Boolean] Allocate a pseudo-TTY.
-      #
+      # @param id [String]
+      # @param console_size [Array<Integer>, nil]
+      # @param detach [Boolean]
+      # @param tty [Boolean]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]

data/lib/docker_engine_ruby/resources/images.rb

@@ -3,24 +3,15 @@
 module DockerEngineRuby
   module Resources
     class Images
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ImageListParams} for more details.
-      #
-      # Returns a list of images on the server. Note that it uses a different, smaller
-      # representation of an image than inspecting a single image.
+      # List Images
       #
       # @overload list(all: nil, digests: nil, filters: nil, manifests: nil, shared_size: nil, request_options: {})
       #
-      # @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}, nil]
       #
       # @return [Array<DockerEngineRuby::Models::Summary>]
@@ -37,25 +28,14 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ImageDeleteParams} for more details.
-      #
-      # Remove an image, along with any untagged parent images that were referenced by
-      # that image.
-      #
-      # Images can't be removed if they have descendant images, are being used by a
-      # running container or are being used by a build.
+      # Remove an image
       #
       # @overload delete(name, force: nil, noprune: nil, platforms: nil, request_options: {})
       #
-      # @param name [String] Image name or ID
-      #
-      # @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 name [String]
+      # @param force [Boolean]
+      # @param noprune [Boolean]
+      # @param platforms [Array<String>]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Array<DockerEngineRuby::Models::DeleteItem>]
@@ -72,79 +52,63 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ImageBuildParams} for more details.
-      #
-      # Build an image from a tar archive with a `Dockerfile` in it.
-      #
-      # The `Dockerfile` specifies how the image is built from the tar archive. It is
-      # typically in the archive's root, but can be at a different path or have a
-      # different name by specifying the `dockerfile` parameter.
-      # [See the `Dockerfile` reference for more information](https://docs.docker.com/engine/reference/builder/).
-      #
-      # The Docker daemon performs a preliminary validation of the `Dockerfile` before
-      # starting the build, and returns an error if the syntax is incorrect. After that,
-      # each instruction is run one-by-one until the ID of the new image is output.
-      #
-      # The build is canceled if the client drops the connection by quitting or being
-      # killed.
+      # Build an image
       #
       # @overload build(body:, buildargs: nil, cachefrom: nil, cpuperiod: nil, cpuquota: nil, cpusetcpus: nil, cpushares: nil, dockerfile: nil, extrahosts: nil, forcerm: nil, labels: nil, memory: nil, memswap: nil, networkmode: nil, nocache: nil, outputs: nil, platform: nil, pull: nil, q: nil, remote: nil, rm: nil, shmsize: nil, squash: nil, t: nil, target: nil, version: nil, x_registry_config: nil, request_options: {})
       #
       # @param body [Pathname, StringIO, IO, String, DockerEngineRuby::FilePart] Body param
       #
-      # @param buildargs [String] Query param: JSON map of string pairs for build-time variables. Users pass these
+      # @param buildargs [String] Query param
       #
-      # @param cachefrom [String] Query param: JSON array of images used for build cache resolution.
+      # @param cachefrom [String] Query param
       #
-      # @param cpuperiod [Integer] Query param: The length of a CPU period in microseconds.
+      # @param cpuperiod [Integer] Query param
       #
-      # @param cpuquota [Integer] Query param: Microseconds of CPU time that the container can get in a CPU period
+      # @param cpuquota [Integer] Query param
       #
-      # @param cpusetcpus [String] Query param: CPUs in which to allow execution (e.g., `0-3`, `0,1`).
+      # @param cpusetcpus [String] Query param
       #
-      # @param cpushares [Integer] Query param: CPU shares (relative weight).
+      # @param cpushares [Integer] Query param
       #
-      # @param dockerfile [String] Query param: Path within the build context to the `Dockerfile`. This is ignored
+      # @param dockerfile [String] Query param
       #
-      # @param extrahosts [String] Query param: Extra hosts to add to /etc/hosts
+      # @param extrahosts [String] Query param
       #
-      # @param forcerm [Boolean] Query param: Always remove intermediate containers, even upon failure.
+      # @param forcerm [Boolean] Query param
       #
-      # @param labels [String] Query param: Arbitrary key/value labels to set on the image, as a JSON map of st
+      # @param labels [String] Query param
       #
-      # @param memory [Integer] Query param: Set memory limit for build.
+      # @param memory [Integer] Query param
       #
-      # @param memswap [Integer] Query param: Total memory (memory + swap). Set as `-1` to disable swap.
+      # @param memswap [Integer] Query param
       #
-      # @param networkmode [String] Query param: Sets the networking mode for the run commands during build. Support
+      # @param networkmode [String] Query param
       #
-      # @param nocache [Boolean] Query param: Do not use the cache when building the image.
+      # @param nocache [Boolean] Query param
       #
-      # @param outputs [String] Query param: BuildKit output configuration in the format of a stringified JSON a
+      # @param outputs [String] Query param
       #
-      # @param platform [String] Query param: Platform in the format os[/arch[/variant]]
+      # @param platform [String] Query param
       #
-      # @param pull [String] Query param: Attempt to pull the image even if an older image exists locally.
+      # @param pull [String] Query param
       #
-      # @param q [Boolean] Query param: Suppress verbose build output.
+      # @param q [Boolean] Query param
       #
-      # @param remote [String] Query param: A Git repository URI or HTTP/HTTPS context URI. If the URI points t
+      # @param remote [String] Query param
       #
-      # @param rm [Boolean] Query param: Remove intermediate containers after a successful build.
+      # @param rm [Boolean] Query param
       #
-      # @param shmsize [Integer] Query param: Size of `/dev/shm` in bytes. The size must be greater than 0. If om
+      # @param shmsize [Integer] Query param
       #
-      # @param squash [Boolean] Query param: Squash the resulting images layers into a single layer.
-      # \*(Experimen
+      # @param squash [Boolean] Query param
       #
-      # @param t [String] Query param: A name and optional tag to apply to the image in the `name:tag` for
+      # @param t [String] Query param
       #
-      # @param target [String] Query param: Target build stage
+      # @param target [String] Query param
       #
-      # @param version [Symbol, DockerEngineRuby::Models::ImageBuildParams::Version] Query param: Version of the builder backend to use.
+      # @param version [Symbol, DockerEngineRuby::Models::ImageBuildParams::Version] Query param
       #
-      # @param x_registry_config [String] Header param: This is a base64-encoded JSON object with auth configurations for
+      # @param x_registry_config [String] Header param
       #
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -186,7 +150,7 @@ module DockerEngineRuby
           path: "build",
           query: parsed.slice(*query_params),
           headers: {
-            "content-type" => "application/octet-stream",
+            "content-type" => "application/x-tar",
             **parsed.except(:body, *query_params)
           }.transform_keys(
             x_registry_config: "x-registry-config"
@@ -197,23 +161,15 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ImageBuildPruneParams} for more details.
-      #
       # Delete builder cache
       #
       # @overload build_prune(all: nil, filters: nil, max_used_space: nil, min_free_space: nil, reserved_space: nil, request_options: {})
       #
-      # @param all [Boolean] Remove all types of build cache
-      #
-      # @param filters [String] A JSON encoded value of the filters (a `map[string][]string`) to
-      #
-      # @param max_used_space [Integer] Maximum amount of disk space allowed to keep for cache
-      #
-      # @param min_free_space [Integer] Target amount of free disk space after pruning
-      #
-      # @param reserved_space [Integer] Amount of disk space in bytes to keep for cache
-      #
+      # @param all [Boolean]
+      # @param filters [String]
+      # @param max_used_space [Integer]
+      # @param min_free_space [Integer]
+      # @param reserved_space [Integer]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::ImageBuildPruneResponse]
@@ -241,19 +197,19 @@ module DockerEngineRuby
       #
       # @overload commit(author: nil, changes: nil, comment: nil, container: nil, pause: nil, repo: nil, tag: nil, args_escaped: nil, attach_stderr: nil, attach_stdin: nil, attach_stdout: nil, cmd: nil, domainname: nil, entrypoint: nil, env: nil, exposed_ports: nil, healthcheck: nil, hostname: nil, image: nil, labels: nil, network_disabled: nil, on_build: nil, open_stdin: nil, shell: nil, stdin_once: nil, stop_signal: nil, stop_timeout: nil, tty: nil, user: nil, volumes: nil, working_dir: nil, request_options: {})
       #
-      # @param author [String] Query param: Author of the image (e.g., `John Hannibal Smith <hannibal@a-team.co
+      # @param author [String] Query param
       #
-      # @param changes [String] Query param: `Dockerfile` instructions to apply while committing
+      # @param changes [String] Query param
       #
-      # @param comment [String] Query param: Commit message
+      # @param comment [String] Query param
       #
-      # @param container [String] Query param: The ID or name of the container to commit
+      # @param container [String] Query param
       #
-      # @param pause [Boolean] Query param: Whether to pause the container before committing
+      # @param pause [Boolean] Query param
       #
-      # @param repo [String] Query param: Repository name for the created image
+      # @param repo [String] Query param
       #
-      # @param tag [String] Query param: Tag name for the create image
+      # @param tag [String] Query param
       #
       # @param args_escaped [Boolean, nil] Body param: Command is already escaped (Windows only)
       #
@@ -271,7 +227,7 @@ module DockerEngineRuby
       #
       # @param env [Array<String>] Body param: A list of environment variables to set inside the container in the
       #
-      # @param exposed_ports [Hash{Symbol=>Object}, nil] Body param: An object mapping ports to an empty object in the form:
+      # @param exposed_ports [Hash{Symbol=>Hash{Symbol=>Object}}, nil] Body param: An object mapping ports to an empty object in the form:
       #
       # @param healthcheck [DockerEngineRuby::Models::Config::Healthcheck] Body param: A test to perform to check that the container is healthy.
       #
@@ -299,7 +255,7 @@ module DockerEngineRuby
       #
       # @param user [String] Body param: Commands run as this user inside the container. If omitted, commands
       #
-      # @param volumes [Hash{Symbol=>Object}] Body param: An object mapping mount point paths inside the container to empty
+      # @param volumes [Hash{Symbol=>Hash{Symbol=>Object}}] Body param: An object mapping mount point paths inside the container to empty
       #
       # @param working_dir [String] Body param: The working directory for commands to run in.
       #
@@ -321,42 +277,12 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ImageGetParams} for more details.
-      #
-      # Get a tarball containing all images and metadata for a repository.
-      #
-      # If `name` is a specific name and tag (e.g. `ubuntu:latest`), then only that
-      # image (and its parents) are returned. If `name` is an image ID, similarly only
-      # that image (and its parents) are returned, but with the exclusion of the
-      # `repositories` file in the tarball, as there were no image names referenced.
-      #
-      # ### Image tarball format
-      #
-      # An image tarball contains
-      # [Content as defined in the OCI Image Layout Specification](https://github.com/opencontainers/image-spec/blob/v1.1.1/image-layout.md#content).
-      #
-      # Additionally, includes the manifest.json file associated with a backwards
-      # compatible docker save format.
-      #
-      # If the tarball defines a repository, the tarball should also include a
-      # `repositories` file at the root that contains a list of repository and tag names
-      # mapped to layer IDs.
-      #
-      # ```json
-      # {
-      #   "hello-world": {
-      #     "latest": "565a9d68a73f6706862bfe8409a7f659776d4d60a8d096eb4a3cbce6999cc2a1"
-      #   }
-      # }
-      # ```
+      # Export an image
       #
       # @overload get(name, platform: nil, request_options: {})
       #
-      # @param name [String] Image name or ID
-      #
-      # @param platform [Array<String>] JSON encoded OCI platform describing a platform which will be used
-      #
+      # @param name [String]
+      # @param platform [Array<String>]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [StringIO]
@@ -368,30 +294,18 @@ module DockerEngineRuby
           method: :get,
           path: ["images/%1$s/get", name],
           query: parsed,
-          headers: {"accept" => "application/x-tar"},
+          headers: {"accept" => "application/octet-stream"},
           model: StringIO,
           options: options
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ImageGetAllParams} for more details.
-      #
-      # Get a tarball containing all images and metadata for several image repositories.
-      #
-      # For each value of the `names` parameter: if it is a specific name and tag (e.g.
-      # `ubuntu:latest`), then only that image (and its parents) are returned; if it is
-      # an image ID, similarly only that image (and its parents) are returned and there
-      # would be no names referenced in the 'repositories' file for this image ID.
-      #
-      # For details on the format, see the [export image endpoint](#operation/ImageGet).
+      # Export several images
       #
       # @overload get_all(names: nil, platform: nil, request_options: {})
       #
-      # @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}, nil]
       #
       # @return [StringIO]
@@ -403,23 +317,18 @@ module DockerEngineRuby
           method: :get,
           path: "images/get",
           query: parsed,
-          headers: {"accept" => "application/x-tar"},
+          headers: {"accept" => "application/octet-stream"},
           model: StringIO,
           options: options
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ImageHistoryParams} for more details.
-      #
-      # Return parent layers of an image.
+      # Get the history of an image
       #
       # @overload history(name, platform: nil, request_options: {})
       #
-      # @param name [String] Image name or ID
-      #
-      # @param platform [String] JSON-encoded OCI platform to select the platform-variant.
-      #
+      # @param name [String]
+      # @param platform [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Array<DockerEngineRuby::Models::HistoryItem>]
@@ -436,14 +345,12 @@ module DockerEngineRuby
         )
       end
 
-      # Return low-level information about an image.
+      # Inspect an image
       #
       # @overload inspect_(name, manifests: nil, request_options: {})
       #
-      # @param name [String] Image name or id
-      #
-      # @param manifests [Boolean] Include Manifests in the image summary.
-      #
+      # @param name [String]
+      # @param manifests [Boolean]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::Image]
@@ -460,20 +367,15 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ImageLoadParams} for more details.
-      #
-      # Load a set of images and tags into a repository.
-      #
-      # For details on the format, see the [export image endpoint](#operation/ImageGet).
+      # Import images
       #
       # @overload load_(body:, platform: nil, quiet: nil, request_options: {})
       #
       # @param body [Pathname, StringIO, IO, String, DockerEngineRuby::FilePart] Body param
       #
-      # @param platform [Array<String>] Query param: JSON encoded OCI platform(s) which will be used to select the
+      # @param platform [Array<String>] Query param
       #
-      # @param quiet [Boolean] Query param: Suppress progress details during load.
+      # @param quiet [Boolean] Query param
       #
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -486,22 +388,18 @@ module DockerEngineRuby
           method: :post,
           path: "images/load",
           query: parsed.except(:body),
-          headers: {"content-type" => "application/x-tar"},
+          headers: {"content-type" => "application/octet-stream"},
           body: parsed[:body],
           model: NilClass,
           options: options
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ImagePruneParams} for more details.
-      #
       # Delete unused images
       #
       # @overload prune(filters: nil, request_options: {})
       #
-      # @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}, nil]
       #
       # @return [DockerEngineRuby::Models::ImagePruneResponse]
@@ -518,47 +416,41 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ImagePullParams} for more details.
-      #
-      # Pull or import an image.
+      # Create an image
       #
-      # @overload pull(changes: nil, from_image: nil, from_src: nil, message: nil, platform: nil, repo: nil, tag: nil, body: nil, x_registry_auth: nil, request_options: {})
+      # @overload pull(body:, changes: nil, from_image: nil, from_src: nil, message: nil, platform: nil, repo: nil, tag: nil, x_registry_auth: nil, request_options: {})
       #
-      # @param changes [Array<String>] Query param: Apply `Dockerfile` instructions to the image that is created,
+      # @param body [String] Body param
       #
-      # @param from_image [String] Query param: Name of the image to pull. If the name includes a tag or digest, sp
+      # @param changes [Array<String>] Query param
       #
-      # @param from_src [String] Query param: Source to import. The value may be a URL from which the image can b
+      # @param from_image [String] Query param
       #
-      # @param message [String] Query param: Set commit message for imported image.
+      # @param from_src [String] Query param
       #
-      # @param platform [String] Query param: Platform in the format os[/arch[/variant]].
+      # @param message [String] Query param
       #
-      # @param repo [String] Query param: Repository name given to an image when it is imported. The repo may
+      # @param platform [String] Query param
       #
-      # @param tag [String] Query param: Tag or digest. If empty when pulling an image, this causes all tags
+      # @param repo [String] Query param
       #
-      # @param body [String] Body param
+      # @param tag [String] Query param
       #
-      # @param x_registry_auth [String] Header param: A base64url-encoded auth configuration.
+      # @param x_registry_auth [String] Header param
       #
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
       #
       # @see DockerEngineRuby::Models::ImagePullParams
-      def pull(params = {})
+      def pull(params)
         parsed, options = DockerEngineRuby::ImagePullParams.dump_request(params)
         query_params = [:changes, :from_image, :from_src, :message, :platform, :repo, :tag]
         @client.request(
           method: :post,
           path: "images/create",
           query: parsed.slice(*query_params).transform_keys(from_image: "fromImage", from_src: "fromSrc"),
-          headers: {
-            "content-type" => "application/octet-stream",
-            **parsed.except(:body, *query_params)
-          }.transform_keys(
+          headers: {"content-type" => "text/plain", **parsed.except(:body, *query_params)}.transform_keys(
             x_registry_auth: "x-registry-auth"
           ),
           body: parsed[:body],
@@ -567,26 +459,17 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ImagePushParams} for more details.
-      #
-      # Push an image to a registry.
-      #
-      # If you wish to push an image on to a private registry, that image must already
-      # have a tag which references the registry. For example,
-      # `registry.example.com/myimage:latest`.
-      #
-      # The push is cancelled if the HTTP connection is closed.
+      # Push an image
       #
       # @overload push(name, x_registry_auth:, platform: nil, tag: nil, request_options: {})
       #
-      # @param name [String] Path param: Name of the image to push. For example, `registry.example.com/myimag
+      # @param name [String] Path param
       #
-      # @param x_registry_auth [String] Header param: A base64url-encoded auth configuration.
+      # @param x_registry_auth [String] Header param
       #
-      # @param platform [String] Query param: JSON-encoded OCI platform to select the platform-variant to push.
+      # @param platform [String] Query param
       #
-      # @param tag [String] Query param: Tag of the image to push. For example, `latest`. If no tag is provi
+      # @param tag [String] Query param
       #
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -606,19 +489,13 @@ module DockerEngineRuby
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {DockerEngineRuby::Models::ImageSearchParams} for more details.
-      #
-      # Search for an image on Docker Hub.
+      # Search images
       #
       # @overload search(term:, filters: nil, limit: nil, request_options: {})
       #
-      # @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}, nil]
       #
       # @return [Array<DockerEngineRuby::Models::ImageSearchResponseItem>]
@@ -635,20 +512,13 @@ module DockerEngineRuby
         )
       end
 
-      # Create a tag that refers to a source image.
-      #
-      # This creates an additional reference (tag) to the source image. The tag can
-      # include a different repository name and/or tag. If the repository or tag already
-      # exists, it will be overwritten.
+      # Tag an image
       #
       # @overload tag(name, repo: nil, tag: nil, request_options: {})
       #
-      # @param name [String] Image name or ID to tag.
-      #
-      # @param repo [String] The repository to tag in. For example, `someuser/someimage`.
-      #
-      # @param tag [String] The name of the new tag.
-      #
+      # @param name [String]
+      # @param repo [String]
+      # @param tag [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]