Adds details about what tags can use the Git tags API (#7989)
This commit is contained in:
parent
954fe0e4e0
commit
bb5f7cdae6
2 changed files with 4 additions and 4 deletions
|
@ -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:
|
||||
|
|
|
@ -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
|
||||
|
|
Reference in a new issue