Skip to content

Commit d819cb7

Browse files
committed
[docs] add tags to API docs
1 parent e6e073c commit d819cb7

File tree

3 files changed

+8
-4
lines changed

3 files changed

+8
-4
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ type ThirdPartyController struct {
3131
// @Summary List devices
3232
// @Description Returns list of registered devices
3333
// @Security ApiAuth
34-
// @Tags User
34+
// @Tags User, Devices
3535
// @Produce json
3636
// @Success 200 {object} []smsgateway.Device "Device list"
3737
// @Failure 400 {object} smsgateway.ErrorResponse "Invalid request"
@@ -54,7 +54,7 @@ func (h *ThirdPartyController) get(user models.User, c *fiber.Ctx) error {
5454
// @Summary Remove device
5555
// @Description Removes device
5656
// @Security ApiAuth
57-
// @Tags User
57+
// @Tags User, Devices
5858
// @Produce json
5959
// @Param id path string true "Device ID"
6060
// @Success 204 "Successfully removed"

pkg/swagger/docs/swagger.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@
2626
"application/json"
2727
],
2828
"tags": [
29-
"User"
29+
"User",
30+
"Devices"
3031
],
3132
"summary": "List devices",
3233
"responses": {
@@ -72,7 +73,8 @@
7273
"application/json"
7374
],
7475
"tags": [
75-
"User"
76+
"User",
77+
"Devices"
7678
],
7779
"summary": "Remove device",
7880
"parameters": [

pkg/swagger/docs/swagger.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -450,6 +450,7 @@ paths:
450450
summary: List devices
451451
tags:
452452
- User
453+
- Devices
453454
/3rdparty/v1/devices/{id}:
454455
delete:
455456
description: Removes device
@@ -485,6 +486,7 @@ paths:
485486
summary: Remove device
486487
tags:
487488
- User
489+
- Devices
488490
/3rdparty/v1/health:
489491
get:
490492
description: Checks if service is healthy

0 commit comments

Comments
 (0)