Add API for Label templates (#24602)

This adds API that allows getting the Label templates of the Gitea
Instance
This commit is contained in:
JakobDev 2023-05-23 12:10:23 +02:00 committed by GitHub
parent abcf5a7b5e
commit 25dc1556cd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 258 additions and 0 deletions

View file

@ -723,6 +723,8 @@ func Routes(ctx gocontext.Context) *web.Route {
m.Get("/gitignore/templates/{name}", misc.GetGitignoreTemplateInfo)
m.Get("/licenses", misc.ListLicenseTemplates)
m.Get("/licenses/{name}", misc.GetLicenseTemplateInfo)
m.Get("/label/templates", misc.ListLabelTemplates)
m.Get("/label/templates/{name}", misc.GetLabelTemplate)
m.Group("/settings", func() {
m.Get("/ui", settings.GetGeneralUISettings)
m.Get("/api", settings.GetGeneralAPISettings)

View file

@ -0,0 +1,60 @@
// Copyright 2023 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
package misc
import (
"net/http"
"code.gitea.io/gitea/modules/context"
repo_module "code.gitea.io/gitea/modules/repository"
"code.gitea.io/gitea/modules/util"
"code.gitea.io/gitea/services/convert"
)
// Shows a list of all Label templates
func ListLabelTemplates(ctx *context.APIContext) {
// swagger:operation GET /label/templates miscellaneous listLabelTemplates
// ---
// summary: Returns a list of all label templates
// produces:
// - application/json
// responses:
// "200":
// "$ref": "#/responses/LabelTemplateList"
result := make([]string, len(repo_module.LabelTemplateFiles))
for i := range repo_module.LabelTemplateFiles {
result[i] = repo_module.LabelTemplateFiles[i].DisplayName
}
ctx.JSON(http.StatusOK, result)
}
// Shows all labels in a template
func GetLabelTemplate(ctx *context.APIContext) {
// swagger:operation GET /label/templates/{name} miscellaneous getLabelTemplateInfo
// ---
// summary: Returns all labels in a template
// produces:
// - application/json
// parameters:
// - name: name
// in: path
// description: name of the template
// type: string
// required: true
// responses:
// "200":
// "$ref": "#/responses/LabelTemplateInfo"
// "404":
// "$ref": "#/responses/notFound"
name := util.PathJoinRelX(ctx.Params("name"))
labels, err := repo_module.LoadTemplateLabelsByDisplayName(name)
if err != nil {
ctx.NotFound()
return
}
ctx.JSON(http.StatusOK, convert.ToLabelTemplateList(labels))
}

View file

@ -48,3 +48,17 @@ type swaggerResponseStringSlice struct {
// in:body
Body []string `json:"body"`
}
// LabelTemplateList
// swagger:response LabelTemplateList
type swaggerResponseLabelTemplateList struct {
// in:body
Body []string `json:"body"`
}
// LabelTemplateInfo
// swagger:response LabelTemplateInfo
type swaggerResponseLabelTemplateInfo struct {
// in:body
Body []api.LabelTemplate `json:"body"`
}