aboutsummaryrefslogtreecommitdiffstats
path: root/templates
diff options
context:
space:
mode:
authorzeripath <art27@cantab.net>2020-08-24 16:48:15 +0100
committerGitHub <noreply@github.com>2020-08-24 11:48:15 -0400
commit2ae8c7ab1cc1311a493fa4efa205412664f54f96 (patch)
treef2259efafea334ef4ff3cae6de952a1d0946623f /templates
parentee047312a1a3238a8504200f7ded8536ebc838e3 (diff)
downloadgitea-2ae8c7ab1cc1311a493fa4efa205412664f54f96.tar.gz
gitea-2ae8c7ab1cc1311a493fa4efa205412664f54f96.zip
Add cron running API (#12421)
* Add cron running API Signed-off-by: Andrew Thornton <art27@cantab.net> * Apply suggestions from code review * placate-swagger Signed-off-by: Andrew Thornton <art27@cantab.net> * return not found Signed-off-by: Andrew Thornton <art27@cantab.net> * Apply suggestions from code review Co-authored-by: techknowlogick <techknowlogick@gitea.io>
Diffstat (limited to 'templates')
-rw-r--r--templates/swagger/v1_json.tmpl102
1 files changed, 102 insertions, 0 deletions
diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl
index ec4570b488..d9c8aeb87d 100644
--- a/templates/swagger/v1_json.tmpl
+++ b/templates/swagger/v1_json.tmpl
@@ -23,6 +23,69 @@
},
"basePath": "{{AppSubUrl}}/api/v1",
"paths": {
+ "/admin/cron": {
+ "get": {
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "admin"
+ ],
+ "summary": "List cron tasks",
+ "operationId": "adminCronList",
+ "parameters": [
+ {
+ "type": "integer",
+ "description": "page number of results to return (1-based)",
+ "name": "page",
+ "in": "query"
+ },
+ {
+ "type": "integer",
+ "description": "page size of results",
+ "name": "limit",
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "200": {
+ "$ref": "#/responses/CronList"
+ },
+ "403": {
+ "$ref": "#/responses/forbidden"
+ }
+ }
+ }
+ },
+ "/admin/cron/{task}": {
+ "post": {
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "admin"
+ ],
+ "summary": "Run cron task",
+ "operationId": "adminCronRun",
+ "parameters": [
+ {
+ "type": "string",
+ "description": "task to run",
+ "name": "task",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "204": {
+ "$ref": "#/responses/empty"
+ },
+ "404": {
+ "$ref": "#/responses/notFound"
+ }
+ }
+ }
+ },
"/admin/orgs": {
"get": {
"produces": [
@@ -11931,6 +11994,36 @@
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
+ "Cron": {
+ "description": "Cron represents a Cron task",
+ "type": "object",
+ "properties": {
+ "exec_times": {
+ "type": "integer",
+ "format": "int64",
+ "x-go-name": "ExecTimes"
+ },
+ "name": {
+ "type": "string",
+ "x-go-name": "Name"
+ },
+ "next": {
+ "type": "string",
+ "format": "date-time",
+ "x-go-name": "Next"
+ },
+ "prev": {
+ "type": "string",
+ "format": "date-time",
+ "x-go-name": "Prev"
+ },
+ "schedule": {
+ "type": "string",
+ "x-go-name": "Schedule"
+ }
+ },
+ "x-go-package": "code.gitea.io/gitea/modules/structs"
+ },
"DeleteEmailOption": {
"description": "DeleteEmailOption options when deleting email addresses",
"type": "object",
@@ -15027,6 +15120,15 @@
"$ref": "#/definitions/ContentsResponse"
}
},
+ "CronList": {
+ "description": "CronList",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Cron"
+ }
+ }
+ },
"DeployKey": {
"description": "DeployKey",
"schema": {