Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 26, 2019
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
910733c
Adds details about what tags can use the Git tags API
richmahn Aug 26, 2019
e6aa2e7
Merge branch 'master' into richmahn-api-text
sapk Aug 26, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions routers/api/v1/repo/tag.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions templates/swagger/v1_json.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
{
Expand All @@ -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
Expand Down