1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2024-11-30 09:41:11 -05:00
forgejo/routers/api/v1/admin/cron.go
6543 2289580bb7
[API] generalize list header (#16551)
* Add info about list endpoints to CONTRIBUTING.md

* Let all list endpoints return X-Total-Count header 

* Add TODOs for GetCombinedCommitStatusByRef

* Fix models/issue_stopwatch.go

* Rrefactor models.ListDeployKeys

* Introduce helper func and use them for SetLinkHeader related func
2021-08-12 14:43:08 +02:00

87 lines
2.1 KiB
Go

// Copyright 2020 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.
package admin
import (
"net/http"
"code.gitea.io/gitea/modules/context"
"code.gitea.io/gitea/modules/cron"
"code.gitea.io/gitea/modules/log"
"code.gitea.io/gitea/modules/structs"
"code.gitea.io/gitea/modules/util"
"code.gitea.io/gitea/routers/api/v1/utils"
)
// ListCronTasks api for getting cron tasks
func ListCronTasks(ctx *context.APIContext) {
// swagger:operation GET /admin/cron admin adminCronList
// ---
// summary: List cron tasks
// produces:
// - application/json
// parameters:
// - name: page
// in: query
// description: page number of results to return (1-based)
// type: integer
// - name: limit
// in: query
// description: page size of results
// type: integer
// responses:
// "200":
// "$ref": "#/responses/CronList"
// "403":
// "$ref": "#/responses/forbidden"
tasks := cron.ListTasks()
count := len(tasks)
listOpts := utils.GetListOptions(ctx)
tasks = util.PaginateSlice(tasks, listOpts.Page, listOpts.PageSize).(cron.TaskTable)
res := make([]structs.Cron, len(tasks))
for i, task := range tasks {
res[i] = structs.Cron{
Name: task.Name,
Schedule: task.Spec,
Next: task.Next,
Prev: task.Prev,
ExecTimes: task.ExecTimes,
}
}
ctx.SetTotalCountHeader(int64(count))
ctx.JSON(http.StatusOK, res)
}
// PostCronTask api for getting cron tasks
func PostCronTask(ctx *context.APIContext) {
// swagger:operation POST /admin/cron/{task} admin adminCronRun
// ---
// summary: Run cron task
// produces:
// - application/json
// parameters:
// - name: task
// in: path
// description: task to run
// type: string
// required: true
// responses:
// "204":
// "$ref": "#/responses/empty"
// "404":
// "$ref": "#/responses/notFound"
task := cron.GetTask(ctx.Params(":task"))
if task == nil {
ctx.NotFound()
return
}
task.Run()
log.Trace("Cron Task %s started by admin(%s)", task.Name, ctx.User.Name)
ctx.Status(http.StatusNoContent)
}