Small additions to 'getJobs' API docs

This commit is contained in:
Christoph Kluge
2022-09-22 13:32:40 +02:00
parent 93713edcac
commit b96c515c2c
4 changed files with 40 additions and 37 deletions

View File

@@ -1,6 +1,6 @@
// Package api GENERATED BY SWAG; DO NOT EDIT
// This file was generated by swaggo/swag at
// 2022-09-21 17:13:02.799543712 +0200 CEST m=+0.123569150
// 2022-09-22 13:31:53.353204065 +0200 CEST m=+0.139444562
package api
import "github.com/swaggo/swag"
@@ -33,7 +33,7 @@ const docTemplate = `{
"ApiKeyAuth": []
}
],
"description": "Get a list of all jobs. Filters can be applied using query parameters.",
"description": "Get a list of all jobs. Filters can be applied using query parameters.\nNumber of results can be limited by page. Results are sorted by descending startTime.",
"consumes": [
"application/json"
],
@@ -70,26 +70,26 @@ const docTemplate = `{
},
{
"type": "integer",
"description": "Page Number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "Items per page",
"description": "Items per page (If empty: No Limit)",
"name": "items-per-page",
"in": "query"
},
{
"type": "integer",
"description": "Page Number (If empty: No Paging)",
"name": "page",
"in": "query"
},
{
"type": "boolean",
"description": "Include metadata in response",
"description": "Include metadata (e.g. jobScript) in response",
"name": "with-metadata",
"in": "query"
}
],
"responses": {
"200": {
"description": "Array of jobs",
"description": "Array of matching jobs",
"schema": {
"type": "array",
"items": {
@@ -370,7 +370,7 @@ const docTemplate = `{
],
"responses": {
"200": {
"description": "Job resource",
"description": "Updated job resource",
"schema": {
"$ref": "#/definitions/schema.Job"
}