Skip to content

Commit bb5f7cd

Browse files
richmahnsapk
authored andcommitted
Adds details about what tags can use the Git tags API (#7989)
1 parent 954fe0e commit bb5f7cd

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

routers/api/v1/repo/tag.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ func ListTags(ctx *context.APIContext) {
5151
func GetTag(ctx *context.APIContext) {
5252
// swagger:operation GET /repos/{owner}/{repo}/git/tags/{sha} repository GetTag
5353
// ---
54-
// summary: Gets the tag of a repository.
54+
// summary: Gets the tag object of an annotated tag (not lightweight tags)
5555
// produces:
5656
// - application/json
5757
// parameters:
@@ -67,7 +67,7 @@ func GetTag(ctx *context.APIContext) {
6767
// required: true
6868
// - name: sha
6969
// in: path
70-
// description: sha of the tag
70+
// description: sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.
7171
// type: string
7272
// required: true
7373
// responses:

templates/swagger/v1_json.tmpl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2166,7 +2166,7 @@
21662166
"tags": [
21672167
"repository"
21682168
],
2169-
"summary": "Gets the tag of a repository.",
2169+
"summary": "Gets the tag object of an annotated tag (not lightweight tags)",
21702170
"operationId": "GetTag",
21712171
"parameters": [
21722172
{
@@ -2185,7 +2185,7 @@
21852185
},
21862186
{
21872187
"type": "string",
2188-
"description": "sha of the tag",
2188+
"description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.",
21892189
"name": "sha",
21902190
"in": "path",
21912191
"required": true

0 commit comments

Comments
 (0)