ClusterCockpit/cc-backend
1
0
Fork 0
mirror of https://github.com/ClusterCockpit/cc-backend synced 2025-07-22 20:41:40 +02:00
Code Issues Packages Releases Activity

Small additions to 'getJobs' API docs

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

22
api/swagger.json
View File

@@ -25,7 +25,7 @@
"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"
],
@@ -62,26 +62,26 @@
},
{
"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": {
@@ -362,7 +362,7 @@
],
"responses": {
"200": {
"description": "Job resource",
"description": "Updated job resource",
"schema": {
"$ref": "#/definitions/schema.Job"
}

20
api/swagger.yaml
View File

@@ -362,7 +362,9 @@ paths:
get:
consumes:
- application/json
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.
Number of results can be limited by page. Results are sorted by descending startTime.
parameters:
- description: Job State
enum:
@@ -383,15 +385,15 @@ paths:
in: query
name: start-time
type: string
- description: Page Number
in: query
name: page
type: integer
- description: Items per page
- description: 'Items per page (If empty: No Limit)'
in: query
name: items-per-page
type: integer
- description: Include metadata in response
- description: 'Page Number (If empty: No Paging)'
in: query
name: page
type: integer
- description: Include metadata (e.g. jobScript) in response
in: query
name: with-metadata
type: boolean
@@ -399,7 +401,7 @@ paths:
- application/json
responses:
"200":
description: Array of jobs
description: Array of matching jobs
schema:
items:
$ref: '#/definitions/schema.Job'
@@ -590,7 +592,7 @@ paths:
- application/json
responses:
"200":
description: Job resource
description: Updated job resource
schema:
$ref: '#/definitions/schema.Job'
"400":