make swagger

This commit is contained in:
Michael Panzlaff
2025-02-27 14:42:18 +01:00
parent f2428d3cb3
commit e376f97547
4 changed files with 218 additions and 63 deletions

View File

@@ -202,7 +202,7 @@
"200": {
"description": "Success message",
"schema": {
"$ref": "#/definitions/api.DeleteJobApiResponse"
"$ref": "#/definitions/api.DefaultJobApiResponse"
}
},
"400": {
@@ -272,7 +272,7 @@
"200": {
"description": "Success message",
"schema": {
"$ref": "#/definitions/api.DeleteJobApiResponse"
"$ref": "#/definitions/api.DefaultJobApiResponse"
}
},
"400": {
@@ -342,7 +342,7 @@
"200": {
"description": "Success message",
"schema": {
"$ref": "#/definitions/api.DeleteJobApiResponse"
"$ref": "#/definitions/api.DefaultJobApiResponse"
}
},
"400": {
@@ -487,7 +487,7 @@
"201": {
"description": "Job added successfully",
"schema": {
"$ref": "#/definitions/api.StartJobApiResponse"
"$ref": "#/definitions/api.DefaultJobApiResponse"
}
},
"400": {
@@ -581,7 +581,7 @@
}
},
"422": {
"description": "Unprocessable Entity: finding job failed: sql: no rows in result set",
"description": "Unprocessable Entity: job has already been stopped",
"schema": {
"$ref": "#/definitions/api.ErrorResponse"
}
@@ -827,6 +827,72 @@
}
}
},
"/notice/": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Modifies the content of notice.txt, shown as notice box on the homepage.\nIf more than one formValue is set then only the highest priority field is used.\nOnly accessible from IPs registered with apiAllowedIPs configuration option.",
"consumes": [
"multipart/form-data"
],
"produces": [
"text/plain"
],
"tags": [
"User"
],
"summary": "Updates or empties the notice box content",
"parameters": [
{
"type": "string",
"description": "Priority 1: New content to display",
"name": "new-content",
"in": "formData"
}
],
"responses": {
"200": {
"description": "Success Response Message",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "string"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"type": "string"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "string"
}
},
"422": {
"description": "Unprocessable Entity: The user could not be updated",
"schema": {
"type": "string"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "string"
}
}
}
}
},
"/user/{id}": {
"post": {
"security": [
@@ -1207,6 +1273,14 @@
}
}
},
"api.DefaultJobApiResponse": {
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
},
"api.DeleteJobApiRequest": {
"type": "object",
"required": [
@@ -1230,14 +1304,6 @@
}
}
},
"api.DeleteJobApiResponse": {
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
},
"api.EditMetaRequest": {
"type": "object",
"properties": {
@@ -1324,14 +1390,6 @@
}
}
},
"api.StartJobApiResponse": {
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
},
"api.StopJobApiRequest": {
"type": "object",
"required": [

View File

@@ -32,6 +32,11 @@ definitions:
example: Debug
type: string
type: object
api.DefaultJobApiResponse:
properties:
msg:
type: string
type: object
api.DeleteJobApiRequest:
properties:
cluster:
@@ -49,11 +54,6 @@ definitions:
required:
- jobId
type: object
api.DeleteJobApiResponse:
properties:
msg:
type: string
type: object
api.EditMetaRequest:
properties:
key:
@@ -112,11 +112,6 @@ definitions:
scope:
$ref: '#/definitions/schema.MetricScope'
type: object
api.StartJobApiResponse:
properties:
msg:
type: string
type: object
api.StopJobApiRequest:
properties:
cluster:
@@ -906,7 +901,7 @@ paths:
"200":
description: Success message
schema:
$ref: '#/definitions/api.DeleteJobApiResponse'
$ref: '#/definitions/api.DefaultJobApiResponse'
"400":
description: Bad Request
schema:
@@ -953,7 +948,7 @@ paths:
"200":
description: Success message
schema:
$ref: '#/definitions/api.DeleteJobApiResponse'
$ref: '#/definitions/api.DefaultJobApiResponse'
"400":
description: Bad Request
schema:
@@ -1000,7 +995,7 @@ paths:
"200":
description: Success message
schema:
$ref: '#/definitions/api.DeleteJobApiResponse'
$ref: '#/definitions/api.DefaultJobApiResponse'
"400":
description: Bad Request
schema:
@@ -1098,7 +1093,7 @@ paths:
"201":
description: Job added successfully
schema:
$ref: '#/definitions/api.StartJobApiResponse'
$ref: '#/definitions/api.DefaultJobApiResponse'
"400":
description: Bad Request
schema:
@@ -1161,8 +1156,7 @@ paths:
schema:
$ref: '#/definitions/api.ErrorResponse'
"422":
description: 'Unprocessable Entity: finding job failed: sql: no rows in
result set'
description: 'Unprocessable Entity: job has already been stopped'
schema:
$ref: '#/definitions/api.ErrorResponse'
"500":
@@ -1224,6 +1218,51 @@ paths:
summary: Adds one or more tags to a job
tags:
- Job add and modify
/notice/:
post:
consumes:
- multipart/form-data
description: |-
Modifies the content of notice.txt, shown as notice box on the homepage.
If more than one formValue is set then only the highest priority field is used.
Only accessible from IPs registered with apiAllowedIPs configuration option.
parameters:
- description: 'Priority 1: New content to display'
in: formData
name: new-content
type: string
produces:
- text/plain
responses:
"200":
description: Success Response Message
schema:
type: string
"400":
description: Bad Request
schema:
type: string
"401":
description: Unauthorized
schema:
type: string
"403":
description: Forbidden
schema:
type: string
"422":
description: 'Unprocessable Entity: The user could not be updated'
schema:
type: string
"500":
description: Internal Server Error
schema:
type: string
security:
- ApiKeyAuth: []
summary: Updates or empties the notice box content
tags:
- User
/user/{id}:
post:
consumes: