diff --git a/routers/api/v1/repo/tag.go b/routers/api/v1/repo/tag.go index 1753402d3a8..a802048285d 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: diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index 2e4af809e81..8d164cd7e31 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -2166,7 +2166,7 @@ "tags": [ "repository" ], - "summary": "Gets the tag of a repository.", + "summary": "Gets the tag object of an annotated tag (not lightweight tags)", "operationId": "GetTag", "parameters": [ { @@ -2185,7 +2185,7 @@ }, { "type": "string", - "description": "sha of the tag", + "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.", "name": "sha", "in": "path", "required": true