Add missing description of label on API (#7159)
* add missing description of label on API * fix comment head * fix swagger
This commit is contained in:
parent
367aeb169a
commit
d8168b356d
4 changed files with 32 additions and 11 deletions
|
@ -79,6 +79,7 @@ func (label *Label) APIFormat() *api.Label {
|
|||
ID: label.ID,
|
||||
Name: label.Name,
|
||||
Color: strings.TrimLeft(label.Color, "#"),
|
||||
Description: label.Description,
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
// Copyright 2016 The Gogs Authors. All rights reserved.
|
||||
// Copyright 2019 The Gitea Authors. All rights reserved.
|
||||
// Use of this source code is governed by a MIT-style
|
||||
// license that can be found in the LICENSE file.
|
||||
|
||||
|
@ -11,6 +12,7 @@ type Label struct {
|
|||
Name string `json:"name"`
|
||||
// example: 00aabb
|
||||
Color string `json:"color"`
|
||||
Description string `json:"description"`
|
||||
URL string `json:"url"`
|
||||
}
|
||||
|
||||
|
@ -21,12 +23,14 @@ type CreateLabelOption struct {
|
|||
// required:true
|
||||
// example: #00aabb
|
||||
Color string `json:"color" binding:"Required;Size(7)"`
|
||||
Description string `json:"description"`
|
||||
}
|
||||
|
||||
// EditLabelOption options for editing a label
|
||||
type EditLabelOption struct {
|
||||
Name *string `json:"name"`
|
||||
Color *string `json:"color"`
|
||||
Description *string `json:"description"`
|
||||
}
|
||||
|
||||
// IssueLabelsOption a collection of labels
|
||||
|
|
|
@ -128,6 +128,7 @@ func CreateLabel(ctx *context.APIContext, form api.CreateLabelOption) {
|
|||
Name: form.Name,
|
||||
Color: form.Color,
|
||||
RepoID: ctx.Repo.Repository.ID,
|
||||
Description: form.Description,
|
||||
}
|
||||
if err := models.NewLabel(label); err != nil {
|
||||
ctx.Error(500, "NewLabel", err)
|
||||
|
@ -185,6 +186,9 @@ func EditLabel(ctx *context.APIContext, form api.EditLabelOption) {
|
|||
if form.Color != nil {
|
||||
label.Color = *form.Color
|
||||
}
|
||||
if form.Description != nil {
|
||||
label.Description = *form.Description
|
||||
}
|
||||
if err := models.UpdateLabel(label); err != nil {
|
||||
ctx.ServerError("UpdateLabel", err)
|
||||
return
|
||||
|
|
|
@ -7245,6 +7245,10 @@
|
|||
"x-go-name": "Color",
|
||||
"example": "#00aabb"
|
||||
},
|
||||
"description": {
|
||||
"type": "string",
|
||||
"x-go-name": "Description"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"x-go-name": "Name"
|
||||
|
@ -7775,6 +7779,10 @@
|
|||
"type": "string",
|
||||
"x-go-name": "Color"
|
||||
},
|
||||
"description": {
|
||||
"type": "string",
|
||||
"x-go-name": "Description"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"x-go-name": "Name"
|
||||
|
@ -8663,6 +8671,10 @@
|
|||
"x-go-name": "Color",
|
||||
"example": "00aabb"
|
||||
},
|
||||
"description": {
|
||||
"type": "string",
|
||||
"x-go-name": "Description"
|
||||
},
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"format": "int64",
|
||||
|
|
Reference in a new issue