enhance batch data restoring, updat docs

Author: krustowski

.env.example

@@ -4,15 +4,15 @@
 
 APP_NAME=swis-api
 APP_ROOT=/opt/${APP_NAME}
-APP_VERSION=5.17.9
+APP_VERSION=5.18.0
 
 
 #
 # build constants
 #
 
-ALPINE_VERSION=3.19
-GOLANG_VERSION=1.22
+ALPINE_VERSION=3.20
+GOLANG_VERSION=1.23
 
 # note: prod image needs 'tzdata' package present
 TZ=Europe/Vienna

README.md

@@ -1,4 +1,4 @@
-# swis-api (swapi) v5.17
+# swis-api (swapi) v5.18
 
 [![Go Reference](https://pkg.go.dev/badge/go.vxn.dev/swis/v5.svg)](https://pkg.go.dev/go.vxn.dev/swis/v5)
 [![Go Report Card](https://goreportcard.com/badge/go.vxn.dev/swis/v5)](https://goreportcard.com/report/go.vxn.dev/swis/v5)

api/swagger.json

@@ -13,7 +13,7 @@
             "name": "MIT",
             "url": "https://github.com/vxn-dev/swis-api/blob/master/LICENSE"
         },
-        "version": "5.17.9"
+        "version": "5.18.0"
     },
     "host": "swis-api-run-prod:8050",
     "basePath": "/",
@@ -32,10 +32,7 @@
                     "200": {
                         "description": "OK",
                         "schema": {
-                            "type": "array",
-                            "items": {
-                                "$ref": "#/definitions/pkg_alvax.ConfigRoot"
-                            }
+                            "$ref": "#/definitions/pkg_alvax.ConfigRootMap"
                         }
                     }
                 }
@@ -3973,6 +3970,17 @@
                 }
             }
         },
+        "pkg_alvax.ConfigRootMap": {
+            "type": "object",
+            "properties": {
+                "items": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "$ref": "#/definitions/pkg_alvax.ConfigRoot"
+                    }
+                }
+            }
+        },
         "pkg_alvax.Docker": {
             "type": "object",
             "properties": {

cmd/swis-api/main.go

@@ -1,5 +1,5 @@
 // @title swis-api (swapi) v5
-// @version 5.17.9
+// @version 5.18.0
 // @description sakalWeb Information System v5 RESTful API documentation
 // @termsOfService http://swagger.io/terms/
 
@@ -80,6 +80,7 @@ func main() {
 	// @Success 200
 	// @Router /ping [get]
 	// @Router /ping [head]
+	// @Success 200 {string} "pong"
 	// Very simple LE support --- https://github.com/gin-gonic/gin#support-lets-encrypt.
 	router.GET("/ping", func(c *gin.Context) {
 		c.String(http.StatusOK, "pong")

pkg/alvax/controllers.go

@@ -35,7 +35,7 @@ var restorePackage = &core.RestorePackage{
 // @Description get alvax config list
 // @Tags alvax
 // @Produce json
-// @Success 200 {object} []alvax.ConfigRoot
+// @Success 200 {object} alvax.ConfigRootMap
 // @Router /alvax [get]
 func GetConfigs(ctx *gin.Context) {
 	core.PrintAllRootItems(ctx, Cache, pkgName)

pkg/alvax/models.go

@@ -1,5 +1,9 @@
 package alvax
 
+type ConfigRootMap struct {
+	Items map[string]ConfigRoot `json:"items"`
+}
+
 type ConfigRoot struct {
 	ID       string             `json:"id" required:"true" readonly:"true"`
 	Key      string             `json:"key" required:"true"`