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

make swagger

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

100
internal/api/docs.go
View File

@@ -208,7 +208,7 @@ const docTemplate = `{
"200": {
"description": "Success message",
"schema": {
"$ref": "#/definitions/api.DeleteJobApiResponse"
"$ref": "#/definitions/api.DefaultJobApiResponse"
}
},
"400": {
@@ -278,7 +278,7 @@ const docTemplate = `{
"200": {
"description": "Success message",
"schema": {
"$ref": "#/definitions/api.DeleteJobApiResponse"
"$ref": "#/definitions/api.DefaultJobApiResponse"
}
},
"400": {
@@ -348,7 +348,7 @@ const docTemplate = `{
"200": {
"description": "Success message",
"schema": {
"$ref": "#/definitions/api.DeleteJobApiResponse"
"$ref": "#/definitions/api.DefaultJobApiResponse"
}
},
"400": {
@@ -493,7 +493,7 @@ const docTemplate = `{
"201": {
"description": "Job added successfully",
"schema": {
"$ref": "#/definitions/api.StartJobApiResponse"
"$ref": "#/definitions/api.DefaultJobApiResponse"
}
},
"400": {
@@ -587,7 +587,7 @@ const docTemplate = `{
}
},
"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"
}
@@ -833,6 +833,72 @@ const docTemplate = `{
}
}
},
"/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": [
@@ -1213,6 +1279,14 @@ const docTemplate = `{
}
}
},
"api.DefaultJobApiResponse": {
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
},
"api.DeleteJobApiRequest": {
"type": "object",
"required": [
@@ -1236,14 +1310,6 @@ const docTemplate = `{
}
}
},
"api.DeleteJobApiResponse": {
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
},
"api.EditMetaRequest": {
"type": "object",
"properties": {
@@ -1330,14 +1396,6 @@ const docTemplate = `{
}
}
},
"api.StartJobApiResponse": {
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
},
"api.StopJobApiRequest": {
"type": "object",
"required": [