Skip to content

[docs] fix swag annotations #263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
capcom6 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[docs] fix swag annotations #263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions internal/sms-gateway/handlers/messages/3rdparty.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,11 +181,11 @@ func (h *ThirdPartyController) post(userID string, c *fiber.Ctx) error {
// @Security JWTAuth
// @Tags User, Messages
// @Produce json
// @Param from query string false "Start date in RFC3339 format" Format(date-time)
// @Param to query string false "End date in RFC3339 format" Format(date-time)
// @Param state query string false "Filter messages by processing state" Enum(Pending, Processed, Sent, Delivered, Failed)
// @Param deviceId query string false "Filter by device ID" min(21) max(21)
// @Param limit query int false "Pagination limit" default(50) min(1) max(100)
// @Param from query string false "Start date in RFC3339 format" Format(date-time)
// @Param to query string false "End date in RFC3339 format" Format(date-time)
// @Param state query smsgateway.ProcessingState false "Filter messages by processing state"
// @Param deviceId query string false "Filter by device ID" minLength(21) maxLength(21)
// @Param limit query int false "Pagination limit" default(50) minimum(1) maximum(100)
// @Param offset query int false "Pagination offset" default(0)
// @Param includeContent query bool false "Include textMessage/dataMessage content for each message. Default is false" default(false)
// @Param sort query string false "Sort order per JSON:API spec. Use created_at (ascending) or -created_at (descending)" Enums(created_at, -created_at) default(-created_at)
Expand Down
13 changes: 13 additions & 0 deletions internal/sms-gateway/openapi/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -642,18 +642,31 @@ const docTemplate = `{
"in": "query"
},
{
"enum": [
"Pending",
"Cancelling",
"Cancelled",
"Processed",
"Sent",
"Delivered",
"Failed"
],
"type": "string",
"description": "Filter messages by processing state",
"name": "state",
"in": "query"
},
{
"maxLength": 21,
"minLength": 21,
"type": "string",
"description": "Filter by device ID",
"name": "deviceId",
"in": "query"
},
{
"maximum": 100,
"minimum": 1,
"type": "integer",
"default": 50,
"description": "Pagination limit",
Expand Down
Loading