Adds details about what tags can use the Git tags API (#7989)

tokarchuk/v1.17
Richard Mahn 5 years ago committed by Antoine GIRARD
parent 954fe0e4e0
commit bb5f7cdae6
  1. 4
      routers/api/v1/repo/tag.go
  2. 4
      templates/swagger/v1_json.tmpl

@ -51,7 +51,7 @@ func ListTags(ctx *context.APIContext) {
func GetTag(ctx *context.APIContext) { func GetTag(ctx *context.APIContext) {
// swagger:operation GET /repos/{owner}/{repo}/git/tags/{sha} repository GetTag // 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: // produces:
// - application/json // - application/json
// parameters: // parameters:
@ -67,7 +67,7 @@ func GetTag(ctx *context.APIContext) {
// required: true // required: true
// - name: sha // - name: sha
// in: path // 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 // type: string
// required: true // required: true
// responses: // responses:

@ -2166,7 +2166,7 @@
"tags": [ "tags": [
"repository" "repository"
], ],
"summary": "Gets the tag of a repository.", "summary": "Gets the tag object of an annotated tag (not lightweight tags)",
"operationId": "GetTag", "operationId": "GetTag",
"parameters": [ "parameters": [
{ {
@ -2185,7 +2185,7 @@
}, },
{ {
"type": "string", "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", "name": "sha",
"in": "path", "in": "path",
"required": true "required": true

Loading…
Cancel
Save