makayabou/asg-server
1
0
Fork 0
mirror of https://github.com/makayabou/asg-server.git synced 2026-05-02 17:43:36 +02:00
Code Issues Packages Projects Releases Wiki Activity

[docs] update API docs

Browse Source
This commit is contained in:
Aleksandr Soloshenko 2025-07-22 14:42:43 +07:00 committed by Aleksandr
parent cefb6fa7bb
commit 63b93fbe01
5 changed files with 177 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
internal/sms-gateway/handlers/events/mobile.go
View File

@ -26,6 +26,22 @@ func NewMobileController(sseService *sse.Service, validator *validator.Validate,
}
}
// @Summary Get events
// @Description Returns events stream for a device
// @Security MobileToken
// @Tags Device, Events
// @x-sse true
// @Produce text/event-stream
// @Header 200 {string} Content-Type "text/event-stream"
// @Header 200 {string} Transfer-Encoding "chunked"
// @Header 200 {string} Connection "keep-alive"
// @Header 200 {string} Cache-Control "no-cache"
// @Success 200 {string} string "Event"
// @Failure 401 {object} smsgateway.ErrorResponse "Unauthorized"
// @Failure 500 {object} smsgateway.ErrorResponse "Internal server error"
// @Router /mobile/v1/events [get]
//
// Get events
func (h *MobileController) get(device models.Device, c *fiber.Ctx) error {
return h.sseSvc.Handler(device.ID, c)
}

44
internal/sms-gateway/handlers/messages/3rdparty.go
View File

@ -45,16 +45,16 @@ type ThirdPartyController struct {
// @Tags User, Messages
// @Accept json
// @Produce json
// @Param skipPhoneValidation query bool false "Skip phone validation"
// @Param deviceActiveWithin query int false "Filter devices active within the specified number of hours" default(0) minimum(0)
// @Param request body smsgateway.Message true "Send message request"
// @Success 202 {object} smsgateway.GetMessageResponse "Message enqueued"
// @Failure 400 {object} smsgateway.ErrorResponse "Invalid request"
// @Failure 401 {object} smsgateway.ErrorResponse "Unauthorized"
// @Failure 409 {object} smsgateway.ErrorResponse "Message with such ID already exists"
// @Failure 500 {object} smsgateway.ErrorResponse "Internal server error"
// @Header 202 {string} Location "Get message state URL"
// @Router /3rdparty/v1/messages [post]
// @Param skipPhoneValidation query bool false "Skip phone validation"
// @Param deviceActiveWithin query int false "Filter devices active within the specified number of hours" default(0) minimum(0)
// @Param request body smsgateway.Message true "Send message request"
// @Success 202 {object} smsgateway.GetMessageResponse "Message enqueued"
// @Failure 400 {object} smsgateway.ErrorResponse "Invalid request"
// @Failure 401 {object} smsgateway.ErrorResponse "Unauthorized"
// @Failure 409 {object} smsgateway.ErrorResponse "Message with such ID already exists"
// @Failure 500 {object} smsgateway.ErrorResponse "Internal server error"
// @Header 202 {string} Location "Get message state URL"
// @Router /3rdparty/v1/messages [post]
//
// Enqueue message
func (h *ThirdPartyController) post(user models.User, c *fiber.Ctx) error {
@ -174,12 +174,12 @@ func (h *ThirdPartyController) post(user models.User, c *fiber.Ctx) error {
// @Security ApiAuth
// @Tags User, Messages
// @Produce json
// @Param id path string true "Message ID"
// @Success 200 {object} smsgateway.GetMessageResponse "Message state"
// @Failure 400 {object} smsgateway.ErrorResponse "Invalid request"
// @Failure 401 {object} smsgateway.ErrorResponse "Unauthorized"
// @Failure 500 {object} smsgateway.ErrorResponse "Internal server error"
// @Router /3rdparty/v1/messages/{id} [get]
// @Param id path string true "Message ID"
// @Success 200 {object} smsgateway.GetMessageResponse "Message state"
// @Failure 400 {object} smsgateway.ErrorResponse "Invalid request"
// @Failure 401 {object} smsgateway.ErrorResponse "Unauthorized"
// @Failure 500 {object} smsgateway.ErrorResponse "Internal server error"
// @Router /3rdparty/v1/messages/{id} [get]
//
// Get message state
func (h *ThirdPartyController) get(user models.User, c *fiber.Ctx) error {
@ -211,12 +211,12 @@ func (h *ThirdPartyController) get(user models.User, c *fiber.Ctx) error {
// @Tags User, Messages
// @Accept json
// @Produce json
// @Param request body smsgateway.MessagesExportRequest true "Export inbox request"
// @Success 202 {object} object "Inbox export request accepted"
// @Failure 400 {object} smsgateway.ErrorResponse "Invalid request"
// @Failure 401 {object} smsgateway.ErrorResponse "Unauthorized"
// @Failure 500 {object} smsgateway.ErrorResponse "Internal server error"
// @Router /3rdparty/v1/inbox/export [post]
// @Param request body smsgateway.MessagesExportRequest true "Export inbox request"
// @Success 202 {object} object "Inbox export request accepted"
// @Failure 400 {object} smsgateway.ErrorResponse "Invalid request"
// @Failure 401 {object} smsgateway.ErrorResponse "Unauthorized"
// @Failure 500 {object} smsgateway.ErrorResponse "Internal server error"
// @Router /3rdparty/v1/inbox/export [post]
//
// Export inbox
func (h *ThirdPartyController) postInboxExport(user models.User, c *fiber.Ctx) error {

2
internal/sms-gateway/handlers/mobile.go
View File

@ -184,7 +184,7 @@ func (h *mobileHandler) getMessage(device models.Device, c *fiber.Ctx) error {
// @Tags Device, Messages
// @Accept json
// @Produce json
// @Param request body smsgateway.MobilePatchMessageRequest true "New message state"
// @Param request body smsgateway.MobilePatchMessageRequest true "List of message state updates"
// @Success 204 {object} nil "Successfully updated"
// @Failure 400 {object} smsgateway.ErrorResponse "Invalid request"
// @Failure 500 {object} smsgateway.ErrorResponse "Internal server error"

120
pkg/swagger/docs/swagger.json
View File

@ -837,6 +837,45 @@
}
}
},
"/mobile/v1/events": {
"get": {
"security": [
{
"MobileToken": []
}
],
"description": "Returns events stream for a device",
"produces": [
"text/event-stream"
],
"tags": [
"Device",
"Events"
],
"summary": "Get events",
"responses": {
"200": {
"description": "Event",
"schema": {
"type": "string"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/smsgateway.ErrorResponse"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/smsgateway.ErrorResponse"
}
}
},
"x-sse": true
}
},
"/mobile/v1/message": {
"get": {
"security": [
@ -894,50 +933,14 @@
"summary": "Update message state",
"parameters": [
{
"description": "New message state",
"description": "List of message state updates",
"name": "request",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "object",
"required": [
"recipients",
"state"
],
"properties": {
"id": {
"description": "Message ID",
"type": "string",
"maxLength": 36,
"example": "PyDmBQZZXYmyxMwED8Fzy"
},
"recipients": {
"description": "Recipients states",
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/definitions/smsgateway.RecipientState"
}
},
"state": {
"description": "State",
"allOf": [
{
"$ref": "#/definitions/smsgateway.ProcessingState"
}
],
"example": "Pending"
},
"states": {
"description": "History of states",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
"$ref": "#/definitions/smsgateway.MobilePatchMessageItem"
}
}
}
@ -1307,6 +1310,7 @@
"type": "object",
"required": [
"deviceId",
"id",
"recipients",
"state"
],
@ -1770,6 +1774,46 @@
}
}
},
"smsgateway.MobilePatchMessageItem": {
"type": "object",
"required": [
"id",
"recipients",
"state"
],
"properties": {
"id": {
"description": "Message ID",
"type": "string",
"maxLength": 36,
"example": "PyDmBQZZXYmyxMwED8Fzy"
},
"recipients": {
"description": "Recipients states",
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/definitions/smsgateway.RecipientState"
}
},
"state": {
"description": "State",
"allOf": [
{
"$ref": "#/definitions/smsgateway.ProcessingState"
}
],
"example": "Pending"
},
"states": {
"description": "History of states",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"smsgateway.MobileRegisterRequest": {
"type": "object",
"properties": {

83
pkg/swagger/docs/swagger.yaml
View File

@ -118,6 +118,7 @@ definitions:
type: object
required:
- deviceId
- id
- recipients
- state
type: object
@ -428,6 +429,34 @@ definitions:
required:
- phoneNumbers
type: object
smsgateway.MobilePatchMessageItem:
properties:
id:
description: Message ID
example: PyDmBQZZXYmyxMwED8Fzy
maxLength: 36
type: string
recipients:
description: Recipients states
items:
$ref: '#/definitions/smsgateway.RecipientState'
minItems: 1
type: array
state:
allOf:
- $ref: '#/definitions/smsgateway.ProcessingState'
description: State
example: Pending
states:
additionalProperties:
type: string
description: History of states
type: object
required:
- id
- recipients
- state
type: object
smsgateway.MobileRegisterRequest:
properties:
name:
@ -1258,6 +1287,31 @@ paths:
summary: Register device
tags:
- Device
/mobile/v1/events:
get:
description: Returns events stream for a device
produces:
- text/event-stream
responses:
"200":
description: Event
schema:
type: string
"401":
description: Unauthorized
schema:
$ref: '#/definitions/smsgateway.ErrorResponse'
"500":
description: Internal server error
schema:
$ref: '#/definitions/smsgateway.ErrorResponse'
security:
- MobileToken: []
summary: Get events
tags:
- Device
- Events
x-sse: true
/mobile/v1/message:
get:
consumes:
@ -1287,38 +1341,13 @@ paths:
- application/json
description: Updates message state
parameters:
- description: New message state
- description: List of message state updates
in: body
name: request
required: true
schema:
items:
properties:
id:
description: Message ID
example: PyDmBQZZXYmyxMwED8Fzy
maxLength: 36
type: string
recipients:
description: Recipients states
items:
$ref: '#/definitions/smsgateway.RecipientState'
minItems: 1
type: array
state:
allOf:
- $ref: '#/definitions/smsgateway.ProcessingState'
description: State
example: Pending
states:
additionalProperties:
type: string
description: History of states
type: object
required:
- recipients
- state
type: object
$ref: '#/definitions/smsgateway.MobilePatchMessageItem'
type: array
produces:
- application/json