From 2d4759114e31dc193da0be6df3e7775e022944a0 Mon Sep 17 00:00:00 2001 From: Jan Eitzinger Date: Thu, 7 Sep 2023 14:33:22 +0200 Subject: [PATCH] Add Release Notes link to release page --- .goreleaser.yaml | 1 + Makefile | 2 +- ReleaseNotes.md | 2 +- api/swagger.json | 8 ++++---- api/swagger.yaml | 10 ++++++++-- internal/api/docs.go | 13 ++++++++----- 6 files changed, 23 insertions(+), 13 deletions(-) diff --git a/.goreleaser.yaml b/.goreleaser.yaml index a17ce5c..19d29cf 100644 --- a/.goreleaser.yaml +++ b/.goreleaser.yaml @@ -101,5 +101,6 @@ release: draft: false footer: | Supports job archive version 1 and database version 6. + Please check out the [Release Notes](https://github.com/ClusterCockpit/cc-backend/blob/master/ReleaseNotes.md) for further details on breaking changes. # vim: set ts=2 sw=2 tw=0 fo=cnqoj diff --git a/Makefile b/Makefile index 3d44172..374d936 100644 --- a/Makefile +++ b/Makefile @@ -2,7 +2,7 @@ TARGET = ./cc-backend VAR = ./var CFG = config.json .env FRONTEND = ./web/frontend -VERSION = 1.2.0 +VERSION = 1.2.1 GIT_HASH := $(shell git rev-parse --short HEAD || echo 'development') CURRENT_TIME = $(shell date +"%Y-%m-%d:T%H:%M:%S") LD_FLAGS = '-s -X main.date=${CURRENT_TIME} -X main.version=${VERSION} -X main.commit=${GIT_HASH}' diff --git a/ReleaseNotes.md b/ReleaseNotes.md index c10ecd5..5ff796e 100644 --- a/ReleaseNotes.md +++ b/ReleaseNotes.md @@ -1,4 +1,4 @@ -# `cc-backend` version 1.2.0 +# `cc-backend` version 1.2.1 Supports job archive version 1 and database version 6. diff --git a/api/swagger.json b/api/swagger.json index dfc2f75..69d80ba 100644 --- a/api/swagger.json +++ b/api/swagger.json @@ -715,7 +715,7 @@ "ApiKeyAuth": [] } ], - "description": "Modifies user defined by username (id) in one of four possible ways.\nIf more than one formValue is set then only the highest priority field is used.", + "description": "Modifies user defined by username (id) in one of four possible ways.\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" ], @@ -820,7 +820,7 @@ "ApiKeyAuth": [] } ], - "description": "Returns a JSON-encoded list of users.\nRequired query-parameter defines if all users or only users with additional special roles are returned.", + "description": "Returns a JSON-encoded list of users.\nRequired query-parameter defines if all users or only users with additional special roles are returned.\nOnly accessible from IPs registered with apiAllowedIPs configuration option.", "produces": [ "application/json" ], @@ -879,7 +879,7 @@ "ApiKeyAuth": [] } ], - "description": "User specified in form data will be saved to database.", + "description": "User specified in form data will be saved to database.\nOnly accessible from IPs registered with apiAllowedIPs configuration option.", "consumes": [ "multipart/form-data" ], @@ -983,7 +983,7 @@ "ApiKeyAuth": [] } ], - "description": "User defined by username in form data will be deleted from database.", + "description": "User defined by username in form data will be deleted from database.\nOnly accessible from IPs registered with apiAllowedIPs configuration option.", "consumes": [ "multipart/form-data" ], diff --git a/api/swagger.yaml b/api/swagger.yaml index 2ba47a0..532d5d0 100644 --- a/api/swagger.yaml +++ b/api/swagger.yaml @@ -1018,6 +1018,7 @@ paths: description: |- Modifies user defined by username (id) in one of four possible ways. 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: Database ID of User in: path @@ -1088,7 +1089,9 @@ paths: delete: consumes: - multipart/form-data - description: User defined by username in form data will be deleted from database. + description: |- + User defined by username in form data will be deleted from database. + Only accessible from IPs registered with apiAllowedIPs configuration option. parameters: - description: User ID to delete in: formData @@ -1129,6 +1132,7 @@ paths: description: |- Returns a JSON-encoded list of users. Required query-parameter defines if all users or only users with additional special roles are returned. + Only accessible from IPs registered with apiAllowedIPs configuration option. parameters: - description: If returned list should contain all users or only users with additional special roles @@ -1169,7 +1173,9 @@ paths: post: consumes: - multipart/form-data - description: User specified in form data will be saved to database. + description: |- + User specified in form data will be saved to database. + Only accessible from IPs registered with apiAllowedIPs configuration option. parameters: - description: Unique user ID in: formData diff --git a/internal/api/docs.go b/internal/api/docs.go index f3bcf5e..009b64a 100644 --- a/internal/api/docs.go +++ b/internal/api/docs.go @@ -1,4 +1,5 @@ -// Code generated by swaggo/swag. DO NOT EDIT +// Code generated by swaggo/swag. DO NOT EDIT. + package api import "github.com/swaggo/swag" @@ -721,7 +722,7 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "Modifies user defined by username (id) in one of four possible ways.\nIf more than one formValue is set then only the highest priority field is used.", + "description": "Modifies user defined by username (id) in one of four possible ways.\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" ], @@ -826,7 +827,7 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "Returns a JSON-encoded list of users.\nRequired query-parameter defines if all users or only users with additional special roles are returned.", + "description": "Returns a JSON-encoded list of users.\nRequired query-parameter defines if all users or only users with additional special roles are returned.\nOnly accessible from IPs registered with apiAllowedIPs configuration option.", "produces": [ "application/json" ], @@ -885,7 +886,7 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "User specified in form data will be saved to database.", + "description": "User specified in form data will be saved to database.\nOnly accessible from IPs registered with apiAllowedIPs configuration option.", "consumes": [ "multipart/form-data" ], @@ -989,7 +990,7 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "User defined by username in form data will be deleted from database.", + "description": "User defined by username in form data will be deleted from database.\nOnly accessible from IPs registered with apiAllowedIPs configuration option.", "consumes": [ "multipart/form-data" ], @@ -1781,6 +1782,8 @@ var SwaggerInfo = &swag.Spec{ Description: "API for batch job control.", InfoInstanceName: "swagger", SwaggerTemplate: docTemplate, + LeftDelim: "{{", + RightDelim: "}}", } func init() {