summaryrefslogtreecommitdiffstats
path: root/routers/api
diff options
context:
space:
mode:
authorRichard Mahn <richmahn@users.noreply.github.com>2019-08-26 15:52:04 -0400
committerAntoine GIRARD <sapk@users.noreply.github.com>2019-08-26 21:52:04 +0200
commitbb5f7cdae6276a2e48f106c3cf84ab7d2de74aa4 (patch)
treed97708c6659444f2425f7b584fa5c09cde1d5d2f /routers/api
parent954fe0e4e0ab61516f200a171cf9a3bfb49c8906 (diff)
downloadgitea-bb5f7cdae6276a2e48f106c3cf84ab7d2de74aa4.tar.gz
gitea-bb5f7cdae6276a2e48f106c3cf84ab7d2de74aa4.zip
Adds details about what tags can use the Git tags API (#7989)
Diffstat (limited to 'routers/api')
-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: