From 94c77d8a677f4e6fb9d0444df19be67e3d275936 Mon Sep 17 00:00:00 2001 From: Christoph Kluge Date: Wed, 21 Sep 2022 14:12:24 +0200 Subject: [PATCH] Small additions to swagger docs --- api/swagger.json | 18 +++++++++++------- api/swagger.yaml | 28 +++++++++++++++++----------- internal/api/docs.go | 20 ++++++++++++-------- pkg/schema/job.go | 4 ++-- 4 files changed, 42 insertions(+), 28 deletions(-) diff --git a/api/swagger.json b/api/swagger.json index 13502b8..17277d8 100644 --- a/api/swagger.json +++ b/api/swagger.json @@ -389,7 +389,7 @@ } }, "schema.Job": { - "description": "Meta data information of a HPC job.", + "description": "Information of a HPC job.", "type": "object", "properties": { "arrayJobId": { @@ -409,11 +409,11 @@ "example": 43200 }, "exclusive": { - "description": "Specifies how nodes are shared. 0 - Shared among multiple jobs of multiple users, 1 - Job exclusive, 2 - Shared among multiple jobs of same user", + "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", "type": "integer", "maximum": 2, "minimum": 0, - "example": 2 + "example": 1 }, "id": { "description": "The unique identifier of a job in the database", @@ -445,8 +445,10 @@ } }, "monitoringStatus": { - "description": "State of monitoring system during job run", + "description": "State of monitoring system during job run: 0 - Disabled, 1 - Running or Archiving (Default), 2 - Archiving Failed, 3 - Archiving Successfull", "type": "integer", + "maximum": 3, + "minimum": 0, "example": 1 }, "numAcc": { @@ -538,11 +540,11 @@ "example": 43200 }, "exclusive": { - "description": "Specifies how nodes are shared. 0 - Shared among multiple jobs of multiple users, 1 - Job exclusive, 2 - Shared among multiple jobs of same user", + "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", "type": "integer", "maximum": 2, "minimum": 0, - "example": 2 + "example": 1 }, "id": { "description": "The unique identifier of a job in the database", @@ -574,8 +576,10 @@ } }, "monitoringStatus": { - "description": "State of monitoring system during job run", + "description": "State of monitoring system during job run: 0 - Disabled, 1 - Running or Archiving (Default), 2 - Archiving Failed, 3 - Archiving Successfull", "type": "integer", + "maximum": 3, + "minimum": 0, "example": 1 }, "numAcc": { diff --git a/api/swagger.yaml b/api/swagger.yaml index cd1d0ff..32372cd 100644 --- a/api/swagger.yaml +++ b/api/swagger.yaml @@ -64,7 +64,7 @@ definitions: type: string type: object schema.Job: - description: Meta data information of a HPC job. + description: Information of a HPC job. properties: arrayJobId: description: The unique identifier of an array job @@ -80,10 +80,10 @@ definitions: minimum: 0 type: integer exclusive: - description: Specifies how nodes are shared. 0 - Shared among multiple jobs - of multiple users, 1 - Job exclusive, 2 - Shared among multiple jobs of - same user - example: 2 + 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' + example: 1 maximum: 2 minimum: 0 type: integer @@ -111,8 +111,11 @@ definitions: description: Additional information about the job type: object monitoringStatus: - description: State of monitoring system during job run + description: 'State of monitoring system during job run: 0 - Disabled, 1 - + Running or Archiving (Default), 2 - Archiving Failed, 3 - Archiving Successfull' example: 1 + maximum: 3 + minimum: 0 type: integer numAcc: description: Number of accelerators used @@ -184,10 +187,10 @@ definitions: minimum: 0 type: integer exclusive: - description: Specifies how nodes are shared. 0 - Shared among multiple jobs - of multiple users, 1 - Job exclusive, 2 - Shared among multiple jobs of - same user - example: 2 + 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' + example: 1 maximum: 2 minimum: 0 type: integer @@ -215,8 +218,11 @@ definitions: description: Additional information about the job type: object monitoringStatus: - description: State of monitoring system during job run + description: 'State of monitoring system during job run: 0 - Disabled, 1 - + Running or Archiving (Default), 2 - Archiving Failed, 3 - Archiving Successfull' example: 1 + maximum: 3 + minimum: 0 type: integer numAcc: description: Number of accelerators used diff --git a/internal/api/docs.go b/internal/api/docs.go index 6922599..f430a50 100644 --- a/internal/api/docs.go +++ b/internal/api/docs.go @@ -1,6 +1,6 @@ // Package api GENERATED BY SWAG; DO NOT EDIT // This file was generated by swaggo/swag at -// 2022-09-21 11:45:40.164979895 +0200 CEST m=+0.117799537 +// 2022-09-21 14:11:26.478228557 +0200 CEST m=+0.132083534 package api import "github.com/swaggo/swag" @@ -397,7 +397,7 @@ const docTemplate = `{ } }, "schema.Job": { - "description": "Meta data information of a HPC job.", + "description": "Information of a HPC job.", "type": "object", "properties": { "arrayJobId": { @@ -417,11 +417,11 @@ const docTemplate = `{ "example": 43200 }, "exclusive": { - "description": "Specifies how nodes are shared. 0 - Shared among multiple jobs of multiple users, 1 - Job exclusive, 2 - Shared among multiple jobs of same user", + "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", "type": "integer", "maximum": 2, "minimum": 0, - "example": 2 + "example": 1 }, "id": { "description": "The unique identifier of a job in the database", @@ -453,8 +453,10 @@ const docTemplate = `{ } }, "monitoringStatus": { - "description": "State of monitoring system during job run", + "description": "State of monitoring system during job run: 0 - Disabled, 1 - Running or Archiving (Default), 2 - Archiving Failed, 3 - Archiving Successfull", "type": "integer", + "maximum": 3, + "minimum": 0, "example": 1 }, "numAcc": { @@ -546,11 +548,11 @@ const docTemplate = `{ "example": 43200 }, "exclusive": { - "description": "Specifies how nodes are shared. 0 - Shared among multiple jobs of multiple users, 1 - Job exclusive, 2 - Shared among multiple jobs of same user", + "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", "type": "integer", "maximum": 2, "minimum": 0, - "example": 2 + "example": 1 }, "id": { "description": "The unique identifier of a job in the database", @@ -582,8 +584,10 @@ const docTemplate = `{ } }, "monitoringStatus": { - "description": "State of monitoring system during job run", + "description": "State of monitoring system during job run: 0 - Disabled, 1 - Running or Archiving (Default), 2 - Archiving Failed, 3 - Archiving Successfull", "type": "integer", + "maximum": 3, + "minimum": 0, "example": 1 }, "numAcc": { diff --git a/pkg/schema/job.go b/pkg/schema/job.go index e4e2c6b..299966b 100644 --- a/pkg/schema/job.go +++ b/pkg/schema/job.go @@ -26,8 +26,8 @@ type BaseJob struct { NumNodes int32 `json:"numNodes" db:"num_nodes" example:"2" minimum:"0"` // Number of nodes used NumHWThreads int32 `json:"numHwthreads" db:"num_hwthreads" example:"20" minimum:"0"` // Number of HWThreads used NumAcc int32 `json:"numAcc" db:"num_acc" example:"2" minimum:"0"` // Number of accelerators used - Exclusive int32 `json:"exclusive" db:"exclusive" example:"2" minimum:"0" maximum:"2"` // Specifies how nodes are shared. 0 - Shared among multiple jobs of multiple users, 1 - Job exclusive, 2 - Shared among multiple jobs of same user - MonitoringStatus int32 `json:"monitoringStatus" db:"monitoring_status" example:"1"` // State of monitoring system during job run + Exclusive int32 `json:"exclusive" db:"exclusive" example:"1" minimum:"0" maximum:"2"` // 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 + MonitoringStatus int32 `json:"monitoringStatus" db:"monitoring_status" example:"1" minimum:"0" maximum:"3"` // State of monitoring system during job run: 0 - Disabled, 1 - Running or Archiving (Default), 2 - Archiving Failed, 3 - Archiving Successfull SMT int32 `json:"smt" db:"smt" example:"4"` // SMT threads used by job State JobState `json:"jobState" db:"job_state" example:"completed" enums:"completed,failed,cancelled,stopped,timeout,out_of_memory"` // Final state of job Duration int32 `json:"duration" db:"duration" example:"43200" minimum:"0"` // Duration of job in seconds