ClusterCockpit/cc-backend
1
0
Fork 0
mirror of https://github.com/ClusterCockpit/cc-backend synced 2024-11-14 02:37:25 +01:00
Code Issues Packages Releases Activity
4652f1dae1
cc-backend/internal/api/docs.go

775 lines
28 KiB
Go
Raw Normal View History

Reconfigure Swagger integration. Regenerate API docs
2022-09-16 06:09:55 +02:00
// Package api GENERATED BY SWAG; DO NOT EDIT
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
// This file was generated by swaggo/swag at
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
// 2022-09-21 14:20:28.235814518 +0200 CEST m=+0.133704544
Reconfigure Swagger integration. Regenerate API docs
2022-09-16 06:09:55 +02:00
package api
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
import "github.com/swaggo/swag"
const docTemplate = `{
"schemes": {{ marshal .Schemes }},
"swagger": "2.0",
"info": {
"description": "{{escape .Description}}",
"title": "{{.Title}}",
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"termsOfService": "https://monitoring.nhr.fau.de/imprint",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"contact": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"name": "ClusterCockpit Project",
"url": "https://github.com/ClusterCockpit",
Reconfigure Swagger integration. Regenerate API docs
2022-09-16 06:09:55 +02:00
"email": "support@clustercockpit.org"
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"license": {
"name": "MIT License",
"url": "https://opensource.org/licenses/MIT"
},
"version": "{{.Version}}"
},
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
"/jobs/": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Get a list of all jobs. Filters can be applied using query parameters.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"summary": "Lists all jobs",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"parameters": [
{
"enum": [
"running",
"completed",
"failed",
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"cancelled",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"stopped",
"timeout"
],
"type": "string",
"description": "Job State",
"name": "state",
"in": "query"
},
{
"type": "string",
"description": "Job Cluster",
"name": "cluster",
"in": "query"
},
{
"type": "string",
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Syntax: '$from-$to', as unix epoch timestamps in seconds",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"name": "start-time",
"in": "query"
},
{
"type": "integer",
"description": "Page Number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "Items per page",
"name": "items-per-page",
"in": "query"
},
{
"type": "boolean",
"description": "Include metadata in response",
"name": "with-metadata",
"in": "query"
}
],
"responses": {
"200": {
"description": "Array of jobs",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.Job"
}
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.ErrorResponse"
}
}
}
}
},
"/jobs/start_job/": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Job specified in request body will be saved to database as \"running\" with new DB ID.\nJob specifications follow the 'JobMeta' scheme, API will fail to execute if requirements are not met.",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"summary": "Adds a new job as \"running\"",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"parameters": [
{
"description": "Job to add",
"name": "request",
"in": "body",
"required": true,
"schema": {
Fix API data types, use unsecured router for /docs - Note: Use /docs swagger playground without login - Otherwise: Session User will be used which leads to role mismatch
2022-09-15 17:38:11 +02:00
"$ref": "#/definitions/schema.JobMeta"
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
}
}
],
"responses": {
"201": {
"description": "Job added successfully",
"schema": {
"$ref": "#/definitions/api.StartJobApiResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.ErrorResponse"
}
},
"422": {
"description": "The combination of jobId, clusterId and startTime does already exist",
"schema": {
"$ref": "#/definitions/api.ErrorResponse"
}
}
}
}
},
"/jobs/stop_job/": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Job to stop is specified by request body. All fields are required in this case.\nReturns full job resource information according to 'JobMeta' scheme.",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"produces": [
"application/json"
],
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"summary": "Marks job as completed and triggers archiving",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"parameters": [
{
"description": "All fields required",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.StopJobApiRequest"
}
}
],
"responses": {
"201": {
"description": "Job resource",
"schema": {
Fix API tag data type
2022-09-16 11:21:27 +02:00
"$ref": "#/definitions/schema.JobMeta"
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.ErrorResponse"
}
},
"404": {
"description": "Resource not found",
"schema": {
"$ref": "#/definitions/api.ErrorResponse"
}
}
}
}
},
"/jobs/stop_job/{id}": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Job to stop is specified by database ID. Only stopTime and final state are required in request body.\nReturns full job resource information according to 'JobMeta' scheme.",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"summary": "Marks job as completed and triggers archiving",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"parameters": [
{
"type": "integer",
"description": "Database ID of Job",
"name": "id",
"in": "path",
"required": true
},
{
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "stopTime and final state in request body",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.StopJobApiRequest"
}
}
],
"responses": {
"201": {
"description": "Job resource",
"schema": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"$ref": "#/definitions/schema.JobMeta"
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.ErrorResponse"
}
},
"404": {
"description": "Resource not found",
"schema": {
"$ref": "#/definitions/api.ErrorResponse"
}
}
}
}
},
"/jobs/tag_job/{id}": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Adds tag(s) to a job specified by DB ID. Name and Type of Tag(s) can be chosen freely.\nIf tagged job is already finished: Tag will be written directly to respective archive files.",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"summary": "Adds one or more tags to a job",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"parameters": [
{
"type": "integer",
"description": "Job Database ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Array of tag-objects to add",
"name": "request",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
Fix API tag data type
2022-09-16 11:21:27 +02:00
"$ref": "#/definitions/api.Tag"
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
}
}
}
],
"responses": {
"200": {
"description": "Job resource",
"schema": {
"$ref": "#/definitions/schema.Job"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.ErrorResponse"
}
},
"404": {
"description": "Job or tag does not exist",
"schema": {
"$ref": "#/definitions/api.ErrorResponse"
}
}
}
}
}
},
"definitions": {
"api.ErrorResponse": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Error message as returned from backend.",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"type": "object",
"properties": {
"error": {
"description": "Error Message",
"type": "string"
},
"status": {
"description": "Statustext of Errorcode",
"type": "string"
}
}
},
"api.StartJobApiResponse": {
"description": "Successful job start response with database id of new job.",
"type": "object",
"properties": {
"id": {
"description": "Database ID of new job",
"type": "integer"
}
}
},
"api.StopJobApiRequest": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Request to stop running job using stoptime and final state. They are only required if no database id was provided with endpoint.",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"type": "object",
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"required": [
"jobState",
"stopTime"
],
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"properties": {
"cluster": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Cluster of job",
"type": "string",
"example": "fritz"
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"jobId": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Cluster Job ID of job",
"type": "integer",
"example": 123000
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"jobState": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Final state of job",
"type": "string",
"enum": [
"completed",
"failed",
"cancelled",
"stopped",
"timeout"
],
"example": "completed"
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"startTime": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Start Time of job as epoch",
"type": "integer",
"example": 1649723812
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"stopTime": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Stop Time of job as epoch",
"type": "integer",
"example": 1649763839
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
}
}
},
Fix API tag data type
2022-09-16 11:21:27 +02:00
"api.Tag": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Defines a tag using name and type.",
Fix API tag data type
2022-09-16 11:21:27 +02:00
"type": "object",
"properties": {
"name": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Tag Name",
"type": "string",
"example": "Testjob"
Fix API tag data type
2022-09-16 11:21:27 +02:00
},
"type": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Tag Type",
"type": "string",
"example": "Debug"
Remove GitHub merge comment lines
2022-09-16 10:12:37 +02:00
}
}
Fix API tag data type
2022-09-16 11:21:27 +02:00
},
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"schema.Job": {
Small additions to swagger docs
2022-09-21 14:12:24 +02:00
"description": "Information of a HPC job.",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"type": "object",
"properties": {
"arrayJobId": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "The unique identifier of an array job",
"type": "integer",
"example": 123000
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"cluster": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "The unique identifier of a cluster",
"type": "string",
"example": "fritz"
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"duration": {
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
"description": "Duration of job in seconds (Min \u003e 0)",
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"type": "integer",
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
"minimum": 1,
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"example": 43200
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"exclusive": {
Small additions to swagger docs
2022-09-21 14:12:24 +02:00
"description": "Specifies how nodes are shared: 0 - Shared among multiple jobs of multiple users, 1 - Job exclusive (Default), 2 - Shared among multiple jobs of same user",
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"type": "integer",
"maximum": 2,
"minimum": 0,
Small additions to swagger docs
2022-09-21 14:12:24 +02:00
"example": 1
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"id": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "The unique identifier of a job in the database",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"type": "integer"
},
"jobId": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "The unique identifier of a job",
"type": "integer",
"example": 123000
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"jobState": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Final state of job",
"type": "string",
"enum": [
"completed",
"failed",
"cancelled",
"stopped",
"timeout",
"out_of_memory"
],
"example": "completed"
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"metaData": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Additional information about the job",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"monitoringStatus": {
Small additions to swagger docs
2022-09-21 14:12:24 +02:00
"description": "State of monitoring system during job run: 0 - Disabled, 1 - Running or Archiving (Default), 2 - Archiving Failed, 3 - Archiving Successfull",
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"type": "integer",
Small additions to swagger docs
2022-09-21 14:12:24 +02:00
"maximum": 3,
"minimum": 0,
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"example": 1
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"numAcc": {
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
"description": "Number of accelerators used (Min \u003e 0)",
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"type": "integer",
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
"minimum": 1,
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"example": 2
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"numHwthreads": {
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
"description": "Number of HWThreads used (Min \u003e 0)",
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"type": "integer",
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
"minimum": 1,
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"example": 20
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"numNodes": {
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
"description": "Number of nodes used (Min \u003e 0)",
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"type": "integer",
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
"minimum": 1,
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"example": 2
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"partition": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "The Slurm partition to which the job was submitted",
"type": "string",
"example": "main"
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"project": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "The unique identifier of a project",
"type": "string",
"example": "abcd200"
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"resources": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Resources used by job",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"type": "array",
"items": {
"$ref": "#/definitions/schema.Resource"
}
},
"smt": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "SMT threads used by job",
"type": "integer",
"example": 4
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"startTime": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Start time as 'time.Time' data type",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"type": "string"
},
"subCluster": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "The unique identifier of a sub cluster",
"type": "string",
"example": "main"
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"tags": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "List of tags",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"type": "array",
"items": {
"$ref": "#/definitions/schema.Tag"
}
},
"user": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "The unique identifier of a user",
"type": "string",
"example": "abcd100h"
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"walltime": {
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
"description": "Requested walltime of job in seconds (Min \u003e 0)",
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"type": "integer",
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
"minimum": 1,
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"example": 86400
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
}
}
},
Fix API data types, use unsecured router for /docs - Note: Use /docs swagger playground without login - Otherwise: Session User will be used which leads to role mismatch
2022-09-15 17:38:11 +02:00
"schema.JobMeta": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Meta data information of a HPC job.",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"type": "object",
"properties": {
"arrayJobId": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "The unique identifier of an array job",
"type": "integer",
"example": 123000
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"cluster": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "The unique identifier of a cluster",
"type": "string",
"example": "fritz"
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"duration": {
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
"description": "Duration of job in seconds (Min \u003e 0)",
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"type": "integer",
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
"minimum": 1,
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"example": 43200
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"exclusive": {
Small additions to swagger docs
2022-09-21 14:12:24 +02:00
"description": "Specifies how nodes are shared: 0 - Shared among multiple jobs of multiple users, 1 - Job exclusive (Default), 2 - Shared among multiple jobs of same user",
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"type": "integer",
"maximum": 2,
"minimum": 0,
Small additions to swagger docs
2022-09-21 14:12:24 +02:00
"example": 1
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"id": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "The unique identifier of a job in the database",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"type": "integer"
},
"jobId": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "The unique identifier of a job",
"type": "integer",
"example": 123000
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"jobState": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Final state of job",
"type": "string",
"enum": [
"completed",
"failed",
"cancelled",
"stopped",
"timeout",
"out_of_memory"
],
"example": "completed"
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"metaData": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Additional information about the job",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"monitoringStatus": {
Small additions to swagger docs
2022-09-21 14:12:24 +02:00
"description": "State of monitoring system during job run: 0 - Disabled, 1 - Running or Archiving (Default), 2 - Archiving Failed, 3 - Archiving Successfull",
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"type": "integer",
Small additions to swagger docs
2022-09-21 14:12:24 +02:00
"maximum": 3,
"minimum": 0,
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"example": 1
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"numAcc": {
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
"description": "Number of accelerators used (Min \u003e 0)",
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"type": "integer",
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
"minimum": 1,
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"example": 2
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"numHwthreads": {
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
"description": "Number of HWThreads used (Min \u003e 0)",
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"type": "integer",
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
"minimum": 1,
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"example": 20
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"numNodes": {
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
"description": "Number of nodes used (Min \u003e 0)",
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"type": "integer",
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
"minimum": 1,
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"example": 2
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"partition": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "The Slurm partition to which the job was submitted",
"type": "string",
"example": "main"
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"project": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "The unique identifier of a project",
"type": "string",
"example": "abcd200"
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"resources": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Resources used by job",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"type": "array",
"items": {
"$ref": "#/definitions/schema.Resource"
}
},
"smt": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "SMT threads used by job",
"type": "integer",
"example": 4
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"startTime": {
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
"description": "Start epoch time stamp in seconds (Min \u003e 0)",
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"type": "integer",
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
"minimum": 1,
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"example": 1649723812
Fix API data types, use unsecured router for /docs - Note: Use /docs swagger playground without login - Otherwise: Session User will be used which leads to role mismatch
2022-09-15 17:38:11 +02:00
},
"statistics": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Metric statistics of job",
Fix API data types, use unsecured router for /docs - Note: Use /docs swagger playground without login - Otherwise: Session User will be used which leads to role mismatch
2022-09-15 17:38:11 +02:00
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/schema.JobStatistics"
}
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"subCluster": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "The unique identifier of a sub cluster",
"type": "string",
"example": "main"
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"tags": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "List of tags",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"type": "array",
"items": {
"$ref": "#/definitions/schema.Tag"
}
},
"user": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "The unique identifier of a user",
"type": "string",
"example": "abcd100h"
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"walltime": {
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
"description": "Requested walltime of job in seconds (Min \u003e 0)",
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"type": "integer",
Better represent 'exclusiveMinimum' from JSON schemata
2022-09-21 14:21:13 +02:00
"minimum": 1,
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"example": 86400
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
}
}
},
Fix API data types, use unsecured router for /docs - Note: Use /docs swagger playground without login - Otherwise: Session User will be used which leads to role mismatch
2022-09-15 17:38:11 +02:00
"schema.JobStatistics": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Specification for job metric statistics.",
Fix API data types, use unsecured router for /docs - Note: Use /docs swagger playground without login - Otherwise: Session User will be used which leads to role mismatch
2022-09-15 17:38:11 +02:00
"type": "object",
"properties": {
"avg": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Job metric average",
"type": "number",
"minimum": 0,
"example": 2500
Fix API data types, use unsecured router for /docs - Note: Use /docs swagger playground without login - Otherwise: Session User will be used which leads to role mismatch
2022-09-15 17:38:11 +02:00
},
"max": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Job metric maximum",
"type": "number",
"minimum": 0,
"example": 3000
Fix API data types, use unsecured router for /docs - Note: Use /docs swagger playground without login - Otherwise: Session User will be used which leads to role mismatch
2022-09-15 17:38:11 +02:00
},
"min": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Job metric minimum",
"type": "number",
"minimum": 0,
"example": 2000
Fix API data types, use unsecured router for /docs - Note: Use /docs swagger playground without login - Otherwise: Session User will be used which leads to role mismatch
2022-09-15 17:38:11 +02:00
},
"unit": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Metric unit (see schema/unit.schema.json)",
"type": "string",
"example": "GHz"
Fix API data types, use unsecured router for /docs - Note: Use /docs swagger playground without login - Otherwise: Session User will be used which leads to role mismatch
2022-09-15 17:38:11 +02:00
}
}
},
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"schema.Resource": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "A resource used by a job",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"type": "object",
"properties": {
"accelerators": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "List of of accelerator device ids",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"type": "array",
"items": {
"type": "string"
}
},
"configuration": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "The configuration options of the node",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"type": "string"
},
"hostname": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Name of the host (= node)",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"type": "string"
},
"hwthreads": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "List of OS processor ids",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"schema.Tag": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Defines a tag using name and type.",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"type": "object",
"properties": {
"id": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "The unique DB identifier of a tag",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
"type": "integer"
},
"name": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Tag Name",
"type": "string",
"example": "Testjob"
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
},
"type": {
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
"description": "Tag Type",
"type": "string",
"example": "Debug"
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
}
}
}
},
"securityDefinitions": {
"ApiKeyAuth": {
"description": "JWT based authentification for general API endpoint use.",
"type": "apiKey",
"name": "X-Auth-Token",
"in": "header"
}
}
}`
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = &swag.Spec{
Version: "0.1.0",
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
Host: "clustercockpit.localhost:8082",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
BasePath: "/api",
Schemes: []string{},
Title: "ClusterCockpit REST API",
Extend parsed swagger documentation by adding comments
2022-09-21 11:54:19 +02:00
Description: "Defines a tag using name and type.",
First commit for swagger api documentation, not yet fully functional - Problems with JWT auth (eg startJob fails with missing role) - Manually fixed auto-parsing errors (missing api.TagJobApiRequest, wrong API @Description)
2022-09-15 12:37:44 +02:00
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
}
func init() {
swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
}
Reference in New Issue Copy Permalink