From 93713edcac8261fa86aaf8ccea74b3d9cb9bb23f Mon Sep 17 00:00:00 2001 From: Christoph Kluge Date: Wed, 21 Sep 2022 17:13:55 +0200 Subject: [PATCH] Add '401 unauthorized' to api docs --- api/swagger.json | 30 ++++++++++++++++++++++++++++++ api/swagger.yaml | 20 ++++++++++++++++++++ internal/api/docs.go | 32 +++++++++++++++++++++++++++++++- internal/api/rest.go | 5 +++++ 4 files changed, 86 insertions(+), 1 deletion(-) diff --git a/api/swagger.json b/api/swagger.json index 2aaad29..2f81cca 100644 --- a/api/swagger.json +++ b/api/swagger.json @@ -95,6 +95,12 @@ "$ref": "#/definitions/api.ErrorResponse" } }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/api.ErrorResponse" + } + }, "500": { "description": "Internal Server Error", "schema": { @@ -143,6 +149,12 @@ "$ref": "#/definitions/api.ErrorResponse" } }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/api.ErrorResponse" + } + }, "403": { "description": "Forbidden", "schema": { @@ -200,6 +212,12 @@ "$ref": "#/definitions/api.ErrorResponse" } }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/api.ErrorResponse" + } + }, "403": { "description": "Forbidden", "schema": { @@ -273,6 +291,12 @@ "$ref": "#/definitions/api.ErrorResponse" } }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/api.ErrorResponse" + } + }, "403": { "description": "Forbidden", "schema": { @@ -349,6 +373,12 @@ "$ref": "#/definitions/api.ErrorResponse" } }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/api.ErrorResponse" + } + }, "404": { "description": "Job or tag does not exist", "schema": { diff --git a/api/swagger.yaml b/api/swagger.yaml index 1e46b28..7146a74 100644 --- a/api/swagger.yaml +++ b/api/swagger.yaml @@ -408,6 +408,10 @@ paths: description: Bad Request schema: $ref: '#/definitions/api.ErrorResponse' + "401": + description: Unauthorized + schema: + $ref: '#/definitions/api.ErrorResponse' "500": description: Internal Server Error schema: @@ -440,6 +444,10 @@ paths: description: Bad Request schema: $ref: '#/definitions/api.ErrorResponse' + "401": + description: Unauthorized + schema: + $ref: '#/definitions/api.ErrorResponse' "403": description: Forbidden schema: @@ -479,6 +487,10 @@ paths: description: Bad Request schema: $ref: '#/definitions/api.ErrorResponse' + "401": + description: Unauthorized + schema: + $ref: '#/definitions/api.ErrorResponse' "403": description: Forbidden schema: @@ -529,6 +541,10 @@ paths: description: Bad Request schema: $ref: '#/definitions/api.ErrorResponse' + "401": + description: Unauthorized + schema: + $ref: '#/definitions/api.ErrorResponse' "403": description: Forbidden schema: @@ -581,6 +597,10 @@ paths: description: Bad Request schema: $ref: '#/definitions/api.ErrorResponse' + "401": + description: Unauthorized + schema: + $ref: '#/definitions/api.ErrorResponse' "404": description: Job or tag does not exist schema: diff --git a/internal/api/docs.go b/internal/api/docs.go index eb4db11..e08b9d5 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 16:59:20.417950914 +0200 CEST m=+0.112710428 +// 2022-09-21 17:13:02.799543712 +0200 CEST m=+0.123569150 package api import "github.com/swaggo/swag" @@ -103,6 +103,12 @@ const docTemplate = `{ "$ref": "#/definitions/api.ErrorResponse" } }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/api.ErrorResponse" + } + }, "500": { "description": "Internal Server Error", "schema": { @@ -151,6 +157,12 @@ const docTemplate = `{ "$ref": "#/definitions/api.ErrorResponse" } }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/api.ErrorResponse" + } + }, "403": { "description": "Forbidden", "schema": { @@ -208,6 +220,12 @@ const docTemplate = `{ "$ref": "#/definitions/api.ErrorResponse" } }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/api.ErrorResponse" + } + }, "403": { "description": "Forbidden", "schema": { @@ -281,6 +299,12 @@ const docTemplate = `{ "$ref": "#/definitions/api.ErrorResponse" } }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/api.ErrorResponse" + } + }, "403": { "description": "Forbidden", "schema": { @@ -357,6 +381,12 @@ const docTemplate = `{ "$ref": "#/definitions/api.ErrorResponse" } }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/api.ErrorResponse" + } + }, "404": { "description": "Job or tag does not exist", "schema": { diff --git a/internal/api/rest.go b/internal/api/rest.go index 95fca07..4ba711f 100644 --- a/internal/api/rest.go +++ b/internal/api/rest.go @@ -154,6 +154,7 @@ func decode(r io.Reader, val interface{}) error { // @Param with-metadata query bool false "Include metadata in response" // @Success 200 {array} schema.Job "Array of jobs" // @Failure 400 {object} api.ErrorResponse "Bad Request" +// @Failure 401 {object} api.ErrorResponse "Unauthorized" // @Failure 500 {object} api.ErrorResponse "Internal Server Error" // @Security ApiKeyAuth // @Router /jobs/ [get] @@ -276,6 +277,7 @@ func (api *RestApi) getJobs(rw http.ResponseWriter, r *http.Request) { // @Param request body api.TagJobApiRequest true "Array of tag-objects to add" // @Success 200 {object} schema.Job "Job resource" // @Failure 400 {object} api.ErrorResponse "Bad Request" +// @Failure 401 {object} api.ErrorResponse "Unauthorized" // @Failure 404 {object} api.ErrorResponse "Job or tag does not exist" // @Failure 500 {object} api.ErrorResponse "Internal Server Error" // @Security ApiKeyAuth @@ -333,6 +335,7 @@ func (api *RestApi) tagJob(rw http.ResponseWriter, r *http.Request) { // @Param request body schema.JobMeta true "Job to add" // @Success 201 {object} api.StartJobApiResponse "Job added successfully" // @Failure 400 {object} api.ErrorResponse "Bad Request" +// @Failure 401 {object} api.ErrorResponse "Unauthorized" // @Failure 403 {object} api.ErrorResponse "Forbidden" // @Failure 422 {object} api.ErrorResponse "Unprocessable Entity: The combination of jobId, clusterId and startTime does already exist" // @Failure 500 {object} api.ErrorResponse "Internal Server Error" @@ -402,6 +405,7 @@ func (api *RestApi) startJob(rw http.ResponseWriter, r *http.Request) { // @Param request body api.StopJobApiRequest true "stopTime and final state in request body" // @Success 200 {object} schema.JobMeta "Job resource" // @Failure 400 {object} api.ErrorResponse "Bad Request" +// @Failure 401 {object} api.ErrorResponse "Unauthorized" // @Failure 403 {object} api.ErrorResponse "Forbidden" // @Failure 404 {object} api.ErrorResponse "Resource not found" // @Failure 422 {object} api.ErrorResponse "Unprocessable Entity: finding job failed: sql: no rows in result set" @@ -514,6 +518,7 @@ func (api *RestApi) stopJobById(rw http.ResponseWriter, r *http.Request) { // @Param request body api.StopJobApiRequest true "All fields required" // @Success 200 {object} schema.JobMeta "Job resource" // @Failure 400 {object} api.ErrorResponse "Bad Request" +// @Failure 401 {object} api.ErrorResponse "Unauthorized" // @Failure 403 {object} api.ErrorResponse "Forbidden" // @Failure 404 {object} api.ErrorResponse "Resource not found" // @Failure 422 {object} api.ErrorResponse "Unprocessable Entity: finding job failed: sql: no rows in result set"