git-sync/crawlab
1
0
Fork 0
mirror of https://github.com/crawlab-team/crawlab.git synced 2026-01-23 17:31:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

add swagger docs for 'tasks'

Browse Source
This commit is contained in:
hantmac
2020-05-03 19:50:35 +08:00
parent fee7eff911
commit a14e166320
4 changed files with 1533 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

533
backend/docs/swagger.json
View File

@@ -2151,6 +2151,505 @@
}
}
},
"/task/{id}": {
"delete": {
"description": "Delete task",
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Delete task",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "string",
"description": "task id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "json"
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "json"
}
}
}
}
},
"/tasks": {
"get": {
"description": "Get task list",
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Get task list",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "req data",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/routes.TaskListRequestData"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "json"
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "json"
}
}
}
},
"put": {
"description": "Put task",
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Put task",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "json"
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "json"
}
}
}
},
"delete": {
"description": "Delete tasks",
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Delete tasks",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "json"
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "json"
}
}
}
}
},
"/tasks/{id}": {
"get": {
"description": "Get task",
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Get task",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "string",
"description": "task id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "json"
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "json"
}
}
}
}
},
"/tasks/{id}/cancel": {
"post": {
"description": "Cancel task",
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Cancel task",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "string",
"description": "task id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "json"
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "json"
}
}
}
}
},
"/tasks/{id}/error-log": {
"delete": {
"description": "Get task error log",
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Get task error log",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "string",
"description": "task id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "json"
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "json"
}
}
}
}
},
"/tasks/{id}/log": {
"delete": {
"description": "Get task log",
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Get task log",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "string",
"description": "task id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "json"
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "json"
}
}
}
}
},
"/tasks/{id}/restart": {
"post": {
"description": "Restart task",
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Restart task",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "string",
"description": "task id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "json"
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "json"
}
}
}
}
},
"/tasks/{id}/results": {
"get": {
"description": "Get task list",
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Get task list",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "req data",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/routes.TaskResultsRequestData"
}
},
{
"type": "string",
"description": "task id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "json"
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "json"
}
}
}
}
},
"/tasks/{id}/results/download": {
"get": {
"description": "Get task results",
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Get task results",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "string",
"description": "task id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "json"
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "json"
}
}
}
}
},
"/tasks_by_status": {
"delete": {
"description": "Delete task",
"produces": [
"application/json"
],
"tags": [
"task"
],
"summary": "Delete task",
"parameters": [
{
"type": "string",
"description": "Authorization token",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "string",
"description": "task status",
"name": "status",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "json"
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "json"
}
}
}
}
},
"/version": {
"get": {
"description": "Get version",
@@ -2743,6 +3242,40 @@
"type": "string"
}
}
},
"routes.TaskListRequestData": {
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"pageNum": {
"type": "integer"
},
"pageSize": {
"type": "integer"
},
"scheduleId": {
"type": "string"
},
"spiderId": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"routes.TaskResultsRequestData": {
"type": "object",
"properties": {
"pageNum": {
"type": "integer"
},
"pageSize": {
"type": "integer"
}
}
}
}
}