summaryrefslogtreecommitdiffstats
path: root/routers
diff options
context:
space:
mode:
Diffstat (limited to 'routers')
-rw-r--r--routers/api/v1/repo/tag.go4
1 files changed, 2 insertions, 2 deletions
diff --git a/routers/api/v1/repo/tag.go b/routers/api/v1/repo/tag.go
index 1753402d3a..a802048285 100644
--- a/routers/api/v1/repo/tag.go
+++ b/routers/api/v1/repo/tag.go
@@ -51,7 +51,7 @@ func ListTags(ctx *context.APIContext) {
func GetTag(ctx *context.APIContext) {
// swagger:operation GET /repos/{owner}/{repo}/git/tags/{sha} repository GetTag
// ---
- // summary: Gets the tag of a repository.
+ // summary: Gets the tag object of an annotated tag (not lightweight tags)
// produces:
// - application/json
// parameters:
@@ -67,7 +67,7 @@ func GetTag(ctx *context.APIContext) {
// required: true
// - name: sha
// in: path
- // description: sha of the tag
+ // description: sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.
// type: string
// required: true
// responses: