omit unused models, update swagger docs

thevxn · Aug 11, 2023 · 4cbfcb2 · 4cbfcb2
1 parent a544d42
commit 4cbfcb2
Show file tree

Hide file tree

Showing 19 changed files with 294 additions and 274 deletions.
diff --git a/.env.example b/.env.example
@@ -4,7 +4,7 @@
 
 APP_NAME=swis-api
 APP_ROOT=/opt/${APP_NAME}
-APP_VERSION=5.5.12
+APP_VERSION=5.5.13
 
 
 #

diff --git a/auth/helpers.go b/auth/helpers.go
@@ -29,9 +29,10 @@ func checkMethodUsagePermission(pp AuthParams, ctx *gin.Context) bool {
 	return true
 }
 
-func respondWithError(c *gin.Context, code int, message interface{}) {
-	c.AbortWithStatusJSON(code, gin.H{
-		"message": message,
+func respondWithError(ctx *gin.Context, code int, message interface{}) {
+	ctx.AbortWithStatusJSON(code, gin.H{
 		"code":    code,
+		"message": message,
 	})
+	return
 }
diff --git a/backups/models.go b/backups/models.go
@@ -1,11 +1,5 @@
 package backups
 
-type Backups struct {
-	// Array of to be backuped services.
-	//Backups []Backup `json:"backups"`
-	Backups map[string]Backup `json:"backups"`
-}
-
 type Backup struct {
 	// Backuped service name -- unique identifier.
 	ServiceName string `json:"service_name" binding:"required" validation:"required"`

diff --git a/business/controllers.go b/business/controllers.go
@@ -15,7 +15,7 @@ var (
 // @Description get business entities list
 // @Tags business
 // @Produce  json
-// @Success 200 {object} business.Entities
+// @Success 200 {object} []business.Business
 // @Router /business [get]
 func GetBusinessEntities(ctx *gin.Context) {
 	config.PrintAllRootItems(ctx, Cache, pkgName)

diff --git a/business/models.go b/business/models.go
@@ -1,10 +1,5 @@
 package business
 
-type Entities struct {
-	// Array of business records.
-	Entities map[string]Business `json:"business"`
-}
-
 // Business structure
 type Business struct {
 	// Business' unique identifier.

diff --git a/depots/controllers.go b/depots/controllers.go
@@ -20,7 +20,7 @@ var (
 // @Description get depot complete list
 // @Tags depots
 // @Produce json
-// @Success 200 {object} depots.Depot
+// @Success 200 {object} []depots.DepotItem
 // @Router /depots [get]
 func GetDepotItems(ctx *gin.Context) {
 	config.PrintAllRootItems(ctx, Cache, pkgName)
@@ -31,7 +31,7 @@ func GetDepotItems(ctx *gin.Context) {
 // @Description add new depot item
 // @Tags depots
 // @Produce json
-// @Param request body depots.Depot true "query params"
+// @Param request body depots.DepotItem true "query params"
 // @Success 200 {object} depots.DepotItem
 // @Router /depots/{key} [post]
 func PostNewDepotItemByKey(ctx *gin.Context) {
@@ -78,7 +78,7 @@ func PostDumpRestore(ctx *gin.Context) {
 // @Description get depot item list by :owner param
 // @Tags depots
 // @Produce json
-// @Success 200 {object} depots.Depot
+// @Success 200 {object} []depots.DepotItem
 // @Router /depots/{owner} [get]
 func GetDepotItemsByOwner(ctx *gin.Context) {
 	var owner string = ctx.Param("owner")

diff --git a/depots/models.go b/depots/models.go
@@ -1,17 +1,5 @@
 package depots
 
-type Depots struct {
-	Depots map[string]Depot `json:"depots"`
-}
-
-type Depot struct {
-	// Depot owner's name, unique ID.
-	//Owner string `json:"owner_name"`
-
-	// Generic array of depot Items.
-	DepotItems []DepotItem `json:"depot_items"`
-}
-
 type DepotItem struct {
 	// Numeric unique ID of such Item.
 	ID int `json:"id"`