GitList

Browse code

docs: improve description of image tag API endpoint

Clarify what the /images/{name}/tag endpoint does by explaining that
it creates an additional reference (tag) to the source image, and that
existing tags will be overwritten.

The previous description "Tag an image so that it becomes part of a
repository" was unclear about what the operation actually does.

Fixes #22402

Signed-off-by: majiayu000 <1835304752@qq.com>

majiayu000 authored on 2025/12/26 18:50:09
Showing 1 changed files

api/swagger.yaml

History View file @ 22345e3

@@ -10002,7 +10002,12 @@ paths:
                        /images/{name}/tag:
                          post:
                            summary: "Tag an image"
                     -      description: "Tag an image so that it becomes part of a repository."
                     +      description: |
                     +        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.
                            operationId: "ImageTag"
                            responses:
 :