[docs] update API docs

Author: capcom6

internal/sms-gateway/handlers/settings/3rdparty.go

@@ -52,8 +52,8 @@ func (h *ThirdPartyController) get(user models.User, c *fiber.Ctx) error {
 	return c.JSON(settings)
 }
 
-//	@Summary		Update settings
-//	@Description	Updates settings for a specific user
+//	@Summary		Replace settings
+//	@Description	Replaces settings
 //	@Security		ApiAuth
 //	@Tags			User, Settings
 //	@Accept			json

internal/sms-gateway/handlers/settings/mobile.go

@@ -29,15 +29,15 @@ type MobileController struct {
 	settingsSvc *settings.Service
 }
 
-// @Summary		Get settings
-// @Description	Returns settings for a device
-// @Security	MobileToken
-// @Tags		Device, Settings
-// @Produce		json
-// @Success		200	{object}	smsgateway.DeviceSettings	"Settings"
-// @Failure		401	{object}	smsgateway.ErrorResponse	"Unauthorized"
-// @Failure		500	{object}	smsgateway.ErrorResponse	"Internal server error"
-// @Router		/mobile/v1/settings [get]
+//	@Summary		Get settings
+//	@Description	Returns settings for a device
+//	@Security		MobileToken
+//	@Tags			Device, Settings
+//	@Produce		json
+//	@Success		200	{object}	smsgateway.DeviceSettings	"Settings"
+//	@Failure		401	{object}	smsgateway.ErrorResponse	"Unauthorized"
+//	@Failure		500	{object}	smsgateway.ErrorResponse	"Internal server error"
+//	@Router			/mobile/v1/settings [get]
 //
 // Get settings
 func (h *MobileController) get(device models.Device, c *fiber.Ctx) error {

pkg/swagger/docs/swagger.json

@@ -436,7 +436,7 @@
                         "ApiAuth": []
                     }
                 ],
-                "description": "Updates settings for a specific user",
+                "description": "Replaces settings",
                 "consumes": [
                     "application/json"
                 ],
@@ -447,7 +447,7 @@
                     "User",
                     "Settings"
                 ],
-                "summary": "Update settings",
+                "summary": "Replace settings",
                 "parameters": [
                     {
                         "description": "Settings",
@@ -1184,14 +1184,6 @@
                         }
                     ]
                 },
-                "gateway": {
-                    "description": "Gateway contains settings related to the Cloud/Private server configuration.",
-                    "allOf": [
-                        {
-                            "$ref": "#/definitions/smsgateway.SettingsGateway"
-                        }
-                    ]
-                },
                 "logs": {
                     "description": "Logs contains settings related to logging.",
                     "allOf": [
@@ -1848,19 +1840,6 @@
                 }
             }
         },
-        "smsgateway.SettingsGateway": {
-            "type": "object",
-            "properties": {
-                "cloud_url": {
-                    "description": "CloudURL is the URL of the server. If nil, the Cloud Public server is used.\nMust be a valid HTTPs URL when provided.",
-                    "type": "string"
-                },
-                "private_token": {
-                    "description": "PrivateToken is the private token for authenticating with the Private Server.",
-                    "type": "string"
-                }
-            }
-        },
         "smsgateway.SettingsLogs": {
             "type": "object",
             "properties": {

pkg/swagger/docs/swagger.yaml

@@ -32,11 +32,6 @@ definitions:
         allOf:
         - $ref: '#/definitions/smsgateway.SettingsEncryption'
         description: Encryption contains settings related to message encryption.
-      gateway:
-        allOf:
-        - $ref: '#/definitions/smsgateway.SettingsGateway'
-        description: Gateway contains settings related to the Cloud/Private server
-          configuration.
       logs:
         allOf:
         - $ref: '#/definitions/smsgateway.SettingsLogs'
@@ -520,18 +515,6 @@ definitions:
           is disabled.
         type: string
     type: object
-  smsgateway.SettingsGateway:
-    properties:
-      cloud_url:
-        description: |-
-          CloudURL is the URL of the server. If nil, the Cloud Public server is used.
-          Must be a valid HTTPs URL when provided.
-        type: string
-      private_token:
-        description: PrivateToken is the private token for authenticating with the
-          Private Server.
-        type: string
-    type: object
   smsgateway.SettingsLogs:
     properties:
       lifetime_days:
@@ -987,7 +970,7 @@ paths:
     put:
       consumes:
       - application/json
-      description: Updates settings for a specific user
+      description: Replaces settings
       parameters:
       - description: Settings
         in: body
@@ -1016,7 +999,7 @@ paths:
             $ref: '#/definitions/smsgateway.ErrorResponse'
       security:
       - ApiAuth: []
-      summary: Update settings
+      summary: Replace settings
       tags:
       - User
       - Settings