Add missing description of label on API (#7159)

* add missing description of label on API

* fix comment head

* fix swagger

models/issue_label.go

@@ -76,9 +76,10 @@ type Label struct {
 // APIFormat converts a Label to the api.Label format
 func (label *Label) APIFormat() *api.Label {
 	return &api.Label{
-		ID:    label.ID,
+		ID:          label.ID,
-		Name:  label.Name,
+		Name:        label.Name,
-		Color: strings.TrimLeft(label.Color, "#"),
+		Color:       strings.TrimLeft(label.Color, "#"),
+		Description: label.Description,
 	}
 }
 

modules/structs/issue_label.go

@@ -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.
 
@@ -10,8 +11,9 @@ type Label struct {
 	ID   int64  `json:"id"`
 	Name string `json:"name"`
 	// example: 00aabb
-	Color string `json:"color"`
+	Color       string `json:"color"`
-	URL   string `json:"url"`
+	Description string `json:"description"`
+	URL         string `json:"url"`
 }
 
 // CreateLabelOption options for creating a label
@@ -20,13 +22,15 @@ type CreateLabelOption struct {
 	Name string `json:"name" binding:"Required"`
 	// required:true
 	// example: #00aabb
-	Color string `json:"color" binding:"Required;Size(7)"`
+	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"`
+	Name        *string `json:"name"`
-	Color *string `json:"color"`
+	Color       *string `json:"color"`
+	Description *string `json:"description"`
 }
 
 // IssueLabelsOption a collection of labels

routers/api/v1/repo/label.go

@@ -125,9 +125,10 @@ func CreateLabel(ctx *context.APIContext, form api.CreateLabelOption) {
 	//   "201":
 	//     "$ref": "#/responses/Label"
 	label := &models.Label{
-		Name:   form.Name,
+		Name:        form.Name,
-		Color:  form.Color,
+		Color:       form.Color,
-		RepoID: ctx.Repo.Repository.ID,
+		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

templates/swagger/v1_json.tmpl

@@ -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",