From f69d56f527b8ee4e682061df9b55af4f788ef581 Mon Sep 17 00:00:00 2001 From: phoenix Date: Thu, 13 Nov 2025 21:45:17 +0000 Subject: [PATCH] tsk-35: Add API documentation (#39) Closes #35 Reviewed-on: https://git.kundeng.us/phoenix/textsender-api/pulls/39 Co-authored-by: phoenix Co-committed-by: phoenix --- Dockerfile | 1 + README.md | 11 + cmd/api/main.go | 17 + docs/docs.go | 906 ++++++++++++++++++++ docs/swagger.json | 882 +++++++++++++++++++ docs/swagger.yaml | 568 ++++++++++++ go.mod | 27 +- go.sum | 60 +- internal/handler/contact.go | 26 + internal/handler/draftMessage.go | 1 + internal/handler/message.go | 34 +- internal/handler/schedule_message_status.go | 13 + internal/handler/scheduled_message.go | 37 +- internal/handler/scheduled_message_event.go | 37 + 14 files changed, 2597 insertions(+), 23 deletions(-) create mode 100644 docs/docs.go create mode 100644 docs/swagger.json create mode 100644 docs/swagger.yaml diff --git a/Dockerfile b/Dockerfile index fb66b34..cbedb04 100644 --- a/Dockerfile +++ b/Dockerfile @@ -29,6 +29,7 @@ COPY ./internal ./internal COPY ./Makefile . COPY ./.env . COPY ./migrations ./migrations +COPY ./docs ./docs # Build the application RUN CGO_ENABLED=0 GOOS=linux make build diff --git a/README.md b/README.md index 0ccc778..c79b9b8 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,14 @@ A software system to process Text messaging queueing ```BASH make build ``` + + +Generate API documentation +``` +go install github.com/swaggo/swag/cmd/swag@latest +go get -u github.com/swaggo/http-swagger/v2 + +swag init --generalInfo main.go --dir ./cmd/api,./internal/handler --output docs/ --parseDependency --parseInternal +``` + +The API documentation can be viewed from `http://localhost:8080/swagger/index.html`. diff --git a/cmd/api/main.go b/cmd/api/main.go index 611dfe0..7faf4cc 100644 --- a/cmd/api/main.go +++ b/cmd/api/main.go @@ -12,7 +12,9 @@ import ( "github.com/go-chi/chi/v5" "github.com/go-chi/chi/v5/middleware" + "github.com/swaggo/http-swagger/v2" + _ "git.kundeng.us/phoenix/textsender-api/docs" "git.kundeng.us/phoenix/textsender-api/internal/config" database "git.kundeng.us/phoenix/textsender-api/internal/db" "git.kundeng.us/phoenix/textsender-api/internal/handler" @@ -22,6 +24,17 @@ import ( "git.kundeng.us/phoenix/textsender-api/internal/store" ) +// @title textsender-api +// @version 1.0 +// @description Core API to send text messages + +// @host localhost:8080 +// @BasePath /api/v1 + +// @securityDefinitions.apikey BearerAuth +// @in header +// @name Authorization +// @description JWT Bearer Token func main() { cfg := config.Load() if cfg == nil { @@ -91,6 +104,10 @@ func main() { router.Method("GET", endpoint.GetScheduledMessageEndpoint, mdlware.AuthMiddleware(jwtService)(http.HandlerFunc(scheduledMessageHandler.GetScheduledMessage))) router.Method("GET", endpoint.FetchNextScheduledMessageEndpoint, mdlware.AuthMiddleware(jwtService)(http.HandlerFunc(scheduledMessageHandler.FetchNextMessage))) + router.Method("GET", "/swagger/*", httpSwagger.Handler( + httpSwagger.URL(fmt.Sprintf("http://localhost:%s/swagger/doc.json", config.PORT)), + )) + // Start server server := &http.Server{ Addr: ":" + cfg.ServerPort, diff --git a/docs/docs.go b/docs/docs.go new file mode 100644 index 0000000..5814417 --- /dev/null +++ b/docs/docs.go @@ -0,0 +1,906 @@ +// Package docs Code generated by swaggo/swag. DO NOT EDIT +package docs + +import "github.com/swaggo/swag" + +const docTemplate = `{ + "schemes": {{ marshal .Schemes }}, + "swagger": "2.0", + "info": { + "description": "{{escape .Description}}", + "title": "{{.Title}}", + "contact": {}, + "version": "{{.Version}}" + }, + "host": "{{.Host}}", + "basePath": "{{.BasePath}}", + "paths": { + "/contact": { + "get": { + "security": [ + { + "BearerAuth": [] + } + ], + "description": "Get a contact record to have a recipient to send a text to (requires JWT)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "contacts" + ], + "summary": "Get contact", + "parameters": [ + { + "type": "string", + "description": "Contact Id", + "name": "id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "User Id", + "name": "user_id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/handler.GetContactResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/handler.GetContactResponse" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/handler.GetContactResponse" + } + } + } + } + }, + "/contact/new": { + "post": { + "security": [ + { + "BearerAuth": [] + } + ], + "description": "Add a contact record to have a recipient to send a text to (requires JWT)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "contacts" + ], + "summary": "Add contact", + "parameters": [ + { + "description": "Data to add contact", + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/handler.RequestAddContact" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/handler.AddContactResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/handler.AddContactResponse" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/handler.AddContactResponse" + } + } + } + } + }, + "/message": { + "get": { + "security": [ + { + "BearerAuth": [] + } + ], + "description": "Get a message record to have a recipient to send a text to (requires JWT)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "messages" + ], + "summary": "Get message", + "parameters": [ + { + "type": "string", + "description": "Message Id", + "name": "id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "User Id", + "name": "user_id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/handler.GetMessageResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/handler.GetMessageResponse" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/handler.GetMessageResponse" + } + } + } + } + }, + "/message/new": { + "post": { + "security": [ + { + "BearerAuth": [] + } + ], + "description": "Add a message record to send a text to (requires JWT)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "messages" + ], + "summary": "Add message", + "parameters": [ + { + "description": "Data to add message", + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/handler.RequestAddMessage" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/handler.AddMessageResponse" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/handler.AddMessageResponse" + } + } + } + } + }, + "/schedule/message": { + "get": { + "security": [ + { + "BearerAuth": [] + } + ], + "description": "Get a scheduled message (requires JWT)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "scheduled messages" + ], + "summary": "Get scheduled message", + "parameters": [ + { + "type": "string", + "description": "Contact Id", + "name": "id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "User Id", + "name": "user_id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/handler.GetScheduledMessageResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/handler.GetScheduledMessageResponse" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/handler.GetScheduledMessageResponse" + } + } + } + }, + "post": { + "security": [ + { + "BearerAuth": [] + } + ], + "description": "Adds a scheduled message (requires JWT)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "scheduled messages" + ], + "summary": "Add scheduled message", + "parameters": [ + { + "description": "Data to add scheduled message", + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/handler.RequestAddScheduledMessage" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/handler.AddScheduledMessageResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/handler.AddScheduledMessageResponse" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/handler.AddScheduledMessageResponse" + } + } + } + } + }, + "/schedule/message/event": { + "get": { + "security": [ + { + "BearerAuth": [] + } + ], + "description": "Gets a scheduled message event (requires JWT)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "scheduled message events" + ], + "summary": "Get scheduled message event", + "parameters": [ + { + "type": "string", + "description": "Contact Id", + "name": "id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Scheduled Message Id", + "name": "scheduled_message_id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/handler.GetScheduledMessageEventResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/handler.GetScheduledMessageEventResponse" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/handler.GetScheduledMessageEventResponse" + } + } + } + }, + "post": { + "security": [ + { + "BearerAuth": [] + } + ], + "description": "Add a scheduled message event (requires JWT)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "scheduled message events" + ], + "summary": "Add scheduled message event", + "parameters": [ + { + "description": "Data to add scheduled message event", + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/handler.RequestAddScheduledMessageEvent" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/handler.AddScheduledMessageEventResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/handler.AddScheduledMessageEventResponse" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/handler.AddScheduledMessageEventResponse" + } + } + } + } + }, + "/schedule/message/event/{id}": { + "delete": { + "security": [ + { + "BearerAuth": [] + } + ], + "description": "Deletes a scheduled message event (requires JWT)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "scheduled message events" + ], + "summary": "Delete scheduled message event", + "parameters": [ + { + "type": "string", + "format": "uuid", + "description": "scheduled message event Id", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/handler.DeleteScheduledMessageEventResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/handler.DeleteScheduledMessageEventResponse" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/handler.DeleteScheduledMessageEventResponse" + } + } + } + } + }, + "/schedule/message/fetch": { + "get": { + "security": [ + { + "BearerAuth": [] + } + ], + "description": "Fetches a scheduled message that is available to be processed (requires JWT)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "scheduled messages" + ], + "summary": "Fetch scheduled message", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/handler.FetchNextMessageResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/handler.FetchNextMessageResponse" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/handler.FetchNextMessageResponse" + } + } + } + } + }, + "/schedule/message/status/update": { + "patch": { + "security": [ + { + "BearerAuth": [] + } + ], + "description": "Update the status of a scheduled message (requires JWT)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "status" + ], + "summary": "Update status", + "parameters": [ + { + "description": "Used to update scheduled message status", + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/handler.RequestScheduledMessageStatus" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/handler.ScheduledMessageStatusResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/handler.ScheduledMessageStatusResponse" + } + }, + "404": { + "description": "Not Found", + "schema": { + "$ref": "#/definitions/handler.ScheduledMessageStatusResponse" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/handler.ScheduledMessageStatusResponse" + } + } + } + } + } + }, + "definitions": { + "contact.Contact": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "phone_number": { + "type": "string" + }, + "user_id": { + "type": "string" + } + } + }, + "handler.AddContactResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/contact.Contact" + } + }, + "message": { + "type": "string" + } + } + }, + "handler.AddMessageResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/message.Message" + } + }, + "message": { + "type": "string" + } + } + }, + "handler.AddScheduledMessageEventResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/scheduling.ScheduledMessageEvent" + } + }, + "message": { + "type": "string" + } + } + }, + "handler.AddScheduledMessageResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/scheduling.ScheduledMessage" + } + }, + "message": { + "type": "string" + } + } + }, + "handler.DeleteScheduledMessageEventResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/scheduling.ScheduledMessageEvent" + } + }, + "message": { + "type": "string" + } + } + }, + "handler.FetchNextMessageResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/scheduling.ScheduledMessage" + } + }, + "message": { + "type": "string" + } + } + }, + "handler.GetContactResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/contact.Contact" + } + }, + "message": { + "type": "string" + } + } + }, + "handler.GetMessageResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/message.Message" + } + }, + "message": { + "type": "string" + } + } + }, + "handler.GetScheduledMessageEventResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/scheduling.ScheduledMessageEvent" + } + }, + "message": { + "type": "string" + } + } + }, + "handler.GetScheduledMessageResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/scheduling.ScheduledMessage" + } + }, + "message": { + "type": "string" + } + } + }, + "handler.RequestAddContact": { + "type": "object", + "properties": { + "phone_number": { + "type": "string" + }, + "user_id": { + "type": "string" + } + } + }, + "handler.RequestAddMessage": { + "type": "object", + "properties": { + "content": { + "type": "string" + }, + "user_id": { + "type": "string" + } + } + }, + "handler.RequestAddScheduledMessage": { + "type": "object", + "properties": { + "scheduled": { + "type": "string" + }, + "status": { + "type": "string" + }, + "user_id": { + "type": "string" + } + } + }, + "handler.RequestAddScheduledMessageEvent": { + "type": "object", + "properties": { + "message_id": { + "type": "string" + }, + "recipient_id": { + "type": "string" + }, + "scheduled_message_id": { + "type": "string" + } + } + }, + "handler.RequestScheduledMessageStatus": { + "type": "object", + "properties": { + "scheduled_message_id": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "handler.ScheduledMessageChange": { + "type": "object", + "properties": { + "old_status": { + "type": "string" + }, + "scheduled_message": { + "$ref": "#/definitions/scheduling.ScheduledMessage" + } + } + }, + "handler.ScheduledMessageStatusResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/handler.ScheduledMessageChange" + } + }, + "message": { + "type": "string" + } + } + }, + "message.Message": { + "type": "object", + "properties": { + "content": { + "type": "string" + }, + "id": { + "type": "string" + }, + "user_id": { + "type": "string" + } + } + }, + "scheduling.ScheduledMessage": { + "type": "object", + "properties": { + "created": { + "type": "string" + }, + "id": { + "type": "string" + }, + "scheduled": { + "type": "string" + }, + "status": { + "type": "string" + }, + "user_id": { + "type": "string" + } + } + }, + "scheduling.ScheduledMessageEvent": { + "type": "object", + "properties": { + "created": { + "type": "string" + }, + "id": { + "type": "string" + }, + "message_id": { + "type": "string" + }, + "recipient_id": { + "type": "string" + }, + "scheduled_message_id": { + "type": "string" + } + } + } + }, + "securityDefinitions": { + "BearerAuth": { + "description": "JWT Bearer Token", + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + } +}` + +// SwaggerInfo holds exported Swagger Info so clients can modify it +var SwaggerInfo = &swag.Spec{ + Version: "1.0", + Host: "localhost:8080", + BasePath: "/api/v1", + Schemes: []string{}, + Title: "textsender-api", + Description: "Core API to send text messages", + InfoInstanceName: "swagger", + SwaggerTemplate: docTemplate, + LeftDelim: "{{", + RightDelim: "}}", +} + +func init() { + swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo) +} diff --git a/docs/swagger.json b/docs/swagger.json new file mode 100644 index 0000000..ca5406d --- /dev/null +++ b/docs/swagger.json @@ -0,0 +1,882 @@ +{ + "swagger": "2.0", + "info": { + "description": "Core API to send text messages", + "title": "textsender-api", + "contact": {}, + "version": "1.0" + }, + "host": "localhost:8080", + "basePath": "/api/v1", + "paths": { + "/contact": { + "get": { + "security": [ + { + "BearerAuth": [] + } + ], + "description": "Get a contact record to have a recipient to send a text to (requires JWT)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "contacts" + ], + "summary": "Get contact", + "parameters": [ + { + "type": "string", + "description": "Contact Id", + "name": "id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "User Id", + "name": "user_id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/handler.GetContactResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/handler.GetContactResponse" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/handler.GetContactResponse" + } + } + } + } + }, + "/contact/new": { + "post": { + "security": [ + { + "BearerAuth": [] + } + ], + "description": "Add a contact record to have a recipient to send a text to (requires JWT)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "contacts" + ], + "summary": "Add contact", + "parameters": [ + { + "description": "Data to add contact", + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/handler.RequestAddContact" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/handler.AddContactResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/handler.AddContactResponse" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/handler.AddContactResponse" + } + } + } + } + }, + "/message": { + "get": { + "security": [ + { + "BearerAuth": [] + } + ], + "description": "Get a message record to have a recipient to send a text to (requires JWT)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "messages" + ], + "summary": "Get message", + "parameters": [ + { + "type": "string", + "description": "Message Id", + "name": "id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "User Id", + "name": "user_id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/handler.GetMessageResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/handler.GetMessageResponse" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/handler.GetMessageResponse" + } + } + } + } + }, + "/message/new": { + "post": { + "security": [ + { + "BearerAuth": [] + } + ], + "description": "Add a message record to send a text to (requires JWT)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "messages" + ], + "summary": "Add message", + "parameters": [ + { + "description": "Data to add message", + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/handler.RequestAddMessage" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/handler.AddMessageResponse" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/handler.AddMessageResponse" + } + } + } + } + }, + "/schedule/message": { + "get": { + "security": [ + { + "BearerAuth": [] + } + ], + "description": "Get a scheduled message (requires JWT)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "scheduled messages" + ], + "summary": "Get scheduled message", + "parameters": [ + { + "type": "string", + "description": "Contact Id", + "name": "id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "User Id", + "name": "user_id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/handler.GetScheduledMessageResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/handler.GetScheduledMessageResponse" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/handler.GetScheduledMessageResponse" + } + } + } + }, + "post": { + "security": [ + { + "BearerAuth": [] + } + ], + "description": "Adds a scheduled message (requires JWT)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "scheduled messages" + ], + "summary": "Add scheduled message", + "parameters": [ + { + "description": "Data to add scheduled message", + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/handler.RequestAddScheduledMessage" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/handler.AddScheduledMessageResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/handler.AddScheduledMessageResponse" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/handler.AddScheduledMessageResponse" + } + } + } + } + }, + "/schedule/message/event": { + "get": { + "security": [ + { + "BearerAuth": [] + } + ], + "description": "Gets a scheduled message event (requires JWT)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "scheduled message events" + ], + "summary": "Get scheduled message event", + "parameters": [ + { + "type": "string", + "description": "Contact Id", + "name": "id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Scheduled Message Id", + "name": "scheduled_message_id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/handler.GetScheduledMessageEventResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/handler.GetScheduledMessageEventResponse" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/handler.GetScheduledMessageEventResponse" + } + } + } + }, + "post": { + "security": [ + { + "BearerAuth": [] + } + ], + "description": "Add a scheduled message event (requires JWT)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "scheduled message events" + ], + "summary": "Add scheduled message event", + "parameters": [ + { + "description": "Data to add scheduled message event", + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/handler.RequestAddScheduledMessageEvent" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/handler.AddScheduledMessageEventResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/handler.AddScheduledMessageEventResponse" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/handler.AddScheduledMessageEventResponse" + } + } + } + } + }, + "/schedule/message/event/{id}": { + "delete": { + "security": [ + { + "BearerAuth": [] + } + ], + "description": "Deletes a scheduled message event (requires JWT)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "scheduled message events" + ], + "summary": "Delete scheduled message event", + "parameters": [ + { + "type": "string", + "format": "uuid", + "description": "scheduled message event Id", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/handler.DeleteScheduledMessageEventResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/handler.DeleteScheduledMessageEventResponse" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/handler.DeleteScheduledMessageEventResponse" + } + } + } + } + }, + "/schedule/message/fetch": { + "get": { + "security": [ + { + "BearerAuth": [] + } + ], + "description": "Fetches a scheduled message that is available to be processed (requires JWT)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "scheduled messages" + ], + "summary": "Fetch scheduled message", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/handler.FetchNextMessageResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/handler.FetchNextMessageResponse" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/handler.FetchNextMessageResponse" + } + } + } + } + }, + "/schedule/message/status/update": { + "patch": { + "security": [ + { + "BearerAuth": [] + } + ], + "description": "Update the status of a scheduled message (requires JWT)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "status" + ], + "summary": "Update status", + "parameters": [ + { + "description": "Used to update scheduled message status", + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/handler.RequestScheduledMessageStatus" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/handler.ScheduledMessageStatusResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/handler.ScheduledMessageStatusResponse" + } + }, + "404": { + "description": "Not Found", + "schema": { + "$ref": "#/definitions/handler.ScheduledMessageStatusResponse" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/handler.ScheduledMessageStatusResponse" + } + } + } + } + } + }, + "definitions": { + "contact.Contact": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "phone_number": { + "type": "string" + }, + "user_id": { + "type": "string" + } + } + }, + "handler.AddContactResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/contact.Contact" + } + }, + "message": { + "type": "string" + } + } + }, + "handler.AddMessageResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/message.Message" + } + }, + "message": { + "type": "string" + } + } + }, + "handler.AddScheduledMessageEventResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/scheduling.ScheduledMessageEvent" + } + }, + "message": { + "type": "string" + } + } + }, + "handler.AddScheduledMessageResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/scheduling.ScheduledMessage" + } + }, + "message": { + "type": "string" + } + } + }, + "handler.DeleteScheduledMessageEventResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/scheduling.ScheduledMessageEvent" + } + }, + "message": { + "type": "string" + } + } + }, + "handler.FetchNextMessageResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/scheduling.ScheduledMessage" + } + }, + "message": { + "type": "string" + } + } + }, + "handler.GetContactResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/contact.Contact" + } + }, + "message": { + "type": "string" + } + } + }, + "handler.GetMessageResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/message.Message" + } + }, + "message": { + "type": "string" + } + } + }, + "handler.GetScheduledMessageEventResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/scheduling.ScheduledMessageEvent" + } + }, + "message": { + "type": "string" + } + } + }, + "handler.GetScheduledMessageResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/scheduling.ScheduledMessage" + } + }, + "message": { + "type": "string" + } + } + }, + "handler.RequestAddContact": { + "type": "object", + "properties": { + "phone_number": { + "type": "string" + }, + "user_id": { + "type": "string" + } + } + }, + "handler.RequestAddMessage": { + "type": "object", + "properties": { + "content": { + "type": "string" + }, + "user_id": { + "type": "string" + } + } + }, + "handler.RequestAddScheduledMessage": { + "type": "object", + "properties": { + "scheduled": { + "type": "string" + }, + "status": { + "type": "string" + }, + "user_id": { + "type": "string" + } + } + }, + "handler.RequestAddScheduledMessageEvent": { + "type": "object", + "properties": { + "message_id": { + "type": "string" + }, + "recipient_id": { + "type": "string" + }, + "scheduled_message_id": { + "type": "string" + } + } + }, + "handler.RequestScheduledMessageStatus": { + "type": "object", + "properties": { + "scheduled_message_id": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "handler.ScheduledMessageChange": { + "type": "object", + "properties": { + "old_status": { + "type": "string" + }, + "scheduled_message": { + "$ref": "#/definitions/scheduling.ScheduledMessage" + } + } + }, + "handler.ScheduledMessageStatusResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/handler.ScheduledMessageChange" + } + }, + "message": { + "type": "string" + } + } + }, + "message.Message": { + "type": "object", + "properties": { + "content": { + "type": "string" + }, + "id": { + "type": "string" + }, + "user_id": { + "type": "string" + } + } + }, + "scheduling.ScheduledMessage": { + "type": "object", + "properties": { + "created": { + "type": "string" + }, + "id": { + "type": "string" + }, + "scheduled": { + "type": "string" + }, + "status": { + "type": "string" + }, + "user_id": { + "type": "string" + } + } + }, + "scheduling.ScheduledMessageEvent": { + "type": "object", + "properties": { + "created": { + "type": "string" + }, + "id": { + "type": "string" + }, + "message_id": { + "type": "string" + }, + "recipient_id": { + "type": "string" + }, + "scheduled_message_id": { + "type": "string" + } + } + } + }, + "securityDefinitions": { + "BearerAuth": { + "description": "JWT Bearer Token", + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + } +} \ No newline at end of file diff --git a/docs/swagger.yaml b/docs/swagger.yaml new file mode 100644 index 0000000..4af2dbd --- /dev/null +++ b/docs/swagger.yaml @@ -0,0 +1,568 @@ +basePath: /api/v1 +definitions: + contact.Contact: + properties: + id: + type: string + phone_number: + type: string + user_id: + type: string + type: object + handler.AddContactResponse: + properties: + data: + items: + $ref: '#/definitions/contact.Contact' + type: array + message: + type: string + type: object + handler.AddMessageResponse: + properties: + data: + items: + $ref: '#/definitions/message.Message' + type: array + message: + type: string + type: object + handler.AddScheduledMessageEventResponse: + properties: + data: + items: + $ref: '#/definitions/scheduling.ScheduledMessageEvent' + type: array + message: + type: string + type: object + handler.AddScheduledMessageResponse: + properties: + data: + items: + $ref: '#/definitions/scheduling.ScheduledMessage' + type: array + message: + type: string + type: object + handler.DeleteScheduledMessageEventResponse: + properties: + data: + items: + $ref: '#/definitions/scheduling.ScheduledMessageEvent' + type: array + message: + type: string + type: object + handler.FetchNextMessageResponse: + properties: + data: + items: + $ref: '#/definitions/scheduling.ScheduledMessage' + type: array + message: + type: string + type: object + handler.GetContactResponse: + properties: + data: + items: + $ref: '#/definitions/contact.Contact' + type: array + message: + type: string + type: object + handler.GetMessageResponse: + properties: + data: + items: + $ref: '#/definitions/message.Message' + type: array + message: + type: string + type: object + handler.GetScheduledMessageEventResponse: + properties: + data: + items: + $ref: '#/definitions/scheduling.ScheduledMessageEvent' + type: array + message: + type: string + type: object + handler.GetScheduledMessageResponse: + properties: + data: + items: + $ref: '#/definitions/scheduling.ScheduledMessage' + type: array + message: + type: string + type: object + handler.RequestAddContact: + properties: + phone_number: + type: string + user_id: + type: string + type: object + handler.RequestAddMessage: + properties: + content: + type: string + user_id: + type: string + type: object + handler.RequestAddScheduledMessage: + properties: + scheduled: + type: string + status: + type: string + user_id: + type: string + type: object + handler.RequestAddScheduledMessageEvent: + properties: + message_id: + type: string + recipient_id: + type: string + scheduled_message_id: + type: string + type: object + handler.RequestScheduledMessageStatus: + properties: + scheduled_message_id: + type: string + status: + type: string + type: object + handler.ScheduledMessageChange: + properties: + old_status: + type: string + scheduled_message: + $ref: '#/definitions/scheduling.ScheduledMessage' + type: object + handler.ScheduledMessageStatusResponse: + properties: + data: + items: + $ref: '#/definitions/handler.ScheduledMessageChange' + type: array + message: + type: string + type: object + message.Message: + properties: + content: + type: string + id: + type: string + user_id: + type: string + type: object + scheduling.ScheduledMessage: + properties: + created: + type: string + id: + type: string + scheduled: + type: string + status: + type: string + user_id: + type: string + type: object + scheduling.ScheduledMessageEvent: + properties: + created: + type: string + id: + type: string + message_id: + type: string + recipient_id: + type: string + scheduled_message_id: + type: string + type: object +host: localhost:8080 +info: + contact: {} + description: Core API to send text messages + title: textsender-api + version: "1.0" +paths: + /contact: + get: + consumes: + - application/json + description: Get a contact record to have a recipient to send a text to (requires + JWT) + parameters: + - description: Contact Id + in: path + name: id + required: true + type: string + - description: User Id + in: path + name: user_id + required: true + type: string + produces: + - application/json + responses: + "200": + description: OK + schema: + $ref: '#/definitions/handler.GetContactResponse' + "400": + description: Bad Request + schema: + $ref: '#/definitions/handler.GetContactResponse' + "500": + description: Internal Server Error + schema: + $ref: '#/definitions/handler.GetContactResponse' + security: + - BearerAuth: [] + summary: Get contact + tags: + - contacts + /contact/new: + post: + consumes: + - application/json + description: Add a contact record to have a recipient to send a text to (requires + JWT) + parameters: + - description: Data to add contact + in: body + name: request + required: true + schema: + $ref: '#/definitions/handler.RequestAddContact' + produces: + - application/json + responses: + "201": + description: Created + schema: + $ref: '#/definitions/handler.AddContactResponse' + "400": + description: Bad Request + schema: + $ref: '#/definitions/handler.AddContactResponse' + "500": + description: Internal Server Error + schema: + $ref: '#/definitions/handler.AddContactResponse' + security: + - BearerAuth: [] + summary: Add contact + tags: + - contacts + /message: + get: + consumes: + - application/json + description: Get a message record to have a recipient to send a text to (requires + JWT) + parameters: + - description: Message Id + in: path + name: id + required: true + type: string + - description: User Id + in: path + name: user_id + required: true + type: string + produces: + - application/json + responses: + "200": + description: OK + schema: + $ref: '#/definitions/handler.GetMessageResponse' + "400": + description: Bad Request + schema: + $ref: '#/definitions/handler.GetMessageResponse' + "500": + description: Internal Server Error + schema: + $ref: '#/definitions/handler.GetMessageResponse' + security: + - BearerAuth: [] + summary: Get message + tags: + - messages + /message/new: + post: + consumes: + - application/json + description: Add a message record to send a text to (requires JWT) + parameters: + - description: Data to add message + in: body + name: request + required: true + schema: + $ref: '#/definitions/handler.RequestAddMessage' + produces: + - application/json + responses: + "201": + description: Created + schema: + $ref: '#/definitions/handler.AddMessageResponse' + "500": + description: Internal Server Error + schema: + $ref: '#/definitions/handler.AddMessageResponse' + security: + - BearerAuth: [] + summary: Add message + tags: + - messages + /schedule/message: + get: + consumes: + - application/json + description: Get a scheduled message (requires JWT) + parameters: + - description: Contact Id + in: path + name: id + required: true + type: string + - description: User Id + in: path + name: user_id + required: true + type: string + produces: + - application/json + responses: + "200": + description: OK + schema: + $ref: '#/definitions/handler.GetScheduledMessageResponse' + "400": + description: Bad Request + schema: + $ref: '#/definitions/handler.GetScheduledMessageResponse' + "500": + description: Internal Server Error + schema: + $ref: '#/definitions/handler.GetScheduledMessageResponse' + security: + - BearerAuth: [] + summary: Get scheduled message + tags: + - scheduled messages + post: + consumes: + - application/json + description: Adds a scheduled message (requires JWT) + parameters: + - description: Data to add scheduled message + in: body + name: request + required: true + schema: + $ref: '#/definitions/handler.RequestAddScheduledMessage' + produces: + - application/json + responses: + "201": + description: Created + schema: + $ref: '#/definitions/handler.AddScheduledMessageResponse' + "400": + description: Bad Request + schema: + $ref: '#/definitions/handler.AddScheduledMessageResponse' + "500": + description: Internal Server Error + schema: + $ref: '#/definitions/handler.AddScheduledMessageResponse' + security: + - BearerAuth: [] + summary: Add scheduled message + tags: + - scheduled messages + /schedule/message/event: + get: + consumes: + - application/json + description: Gets a scheduled message event (requires JWT) + parameters: + - description: Contact Id + in: path + name: id + required: true + type: string + - description: Scheduled Message Id + in: path + name: scheduled_message_id + required: true + type: string + produces: + - application/json + responses: + "200": + description: OK + schema: + $ref: '#/definitions/handler.GetScheduledMessageEventResponse' + "400": + description: Bad Request + schema: + $ref: '#/definitions/handler.GetScheduledMessageEventResponse' + "500": + description: Internal Server Error + schema: + $ref: '#/definitions/handler.GetScheduledMessageEventResponse' + security: + - BearerAuth: [] + summary: Get scheduled message event + tags: + - scheduled message events + post: + consumes: + - application/json + description: Add a scheduled message event (requires JWT) + parameters: + - description: Data to add scheduled message event + in: body + name: request + required: true + schema: + $ref: '#/definitions/handler.RequestAddScheduledMessageEvent' + produces: + - application/json + responses: + "201": + description: Created + schema: + $ref: '#/definitions/handler.AddScheduledMessageEventResponse' + "400": + description: Bad Request + schema: + $ref: '#/definitions/handler.AddScheduledMessageEventResponse' + "500": + description: Internal Server Error + schema: + $ref: '#/definitions/handler.AddScheduledMessageEventResponse' + security: + - BearerAuth: [] + summary: Add scheduled message event + tags: + - scheduled message events + /schedule/message/event/{id}: + delete: + consumes: + - application/json + description: Deletes a scheduled message event (requires JWT) + parameters: + - description: scheduled message event Id + format: uuid + in: path + name: id + required: true + type: string + produces: + - application/json + responses: + "201": + description: Created + schema: + $ref: '#/definitions/handler.DeleteScheduledMessageEventResponse' + "400": + description: Bad Request + schema: + $ref: '#/definitions/handler.DeleteScheduledMessageEventResponse' + "500": + description: Internal Server Error + schema: + $ref: '#/definitions/handler.DeleteScheduledMessageEventResponse' + security: + - BearerAuth: [] + summary: Delete scheduled message event + tags: + - scheduled message events + /schedule/message/fetch: + get: + consumes: + - application/json + description: Fetches a scheduled message that is available to be processed (requires + JWT) + produces: + - application/json + responses: + "200": + description: OK + schema: + $ref: '#/definitions/handler.FetchNextMessageResponse' + "400": + description: Bad Request + schema: + $ref: '#/definitions/handler.FetchNextMessageResponse' + "500": + description: Internal Server Error + schema: + $ref: '#/definitions/handler.FetchNextMessageResponse' + security: + - BearerAuth: [] + summary: Fetch scheduled message + tags: + - scheduled messages + /schedule/message/status/update: + patch: + consumes: + - application/json + description: Update the status of a scheduled message (requires JWT) + parameters: + - description: Used to update scheduled message status + in: body + name: request + required: true + schema: + $ref: '#/definitions/handler.RequestScheduledMessageStatus' + produces: + - application/json + responses: + "201": + description: Created + schema: + $ref: '#/definitions/handler.ScheduledMessageStatusResponse' + "400": + description: Bad Request + schema: + $ref: '#/definitions/handler.ScheduledMessageStatusResponse' + "404": + description: Not Found + schema: + $ref: '#/definitions/handler.ScheduledMessageStatusResponse' + "500": + description: Internal Server Error + schema: + $ref: '#/definitions/handler.ScheduledMessageStatusResponse' + security: + - BearerAuth: [] + summary: Update status + tags: + - status +securityDefinitions: + BearerAuth: + description: JWT Bearer Token + in: header + name: Authorization + type: apiKey +swagger: "2.0" diff --git a/go.mod b/go.mod index 768b311..205c74b 100644 --- a/go.mod +++ b/go.mod @@ -7,22 +7,37 @@ require ( github.com/go-chi/chi/v5 v5.2.3 github.com/golang-jwt/jwt/v5 v5.3.0 github.com/google/uuid v1.6.0 - github.com/gorilla/mux v1.8.1 github.com/jackc/pgx/v5 v5.7.6 github.com/joho/godotenv v1.5.1 github.com/stretchr/testify v1.11.1 + github.com/swaggo/http-swagger/v2 v2.0.2 + github.com/swaggo/swag v1.16.6 ) require ( + github.com/KyleBanks/depth v1.2.1 // indirect github.com/davecgh/go-spew v1.1.1 // indirect + github.com/go-openapi/jsonpointer v0.22.1 // indirect + github.com/go-openapi/jsonreference v0.21.3 // indirect + github.com/go-openapi/spec v0.22.1 // indirect + github.com/go-openapi/swag/conv v0.25.1 // indirect + github.com/go-openapi/swag/jsonname v0.25.1 // indirect + github.com/go-openapi/swag/jsonutils v0.25.1 // indirect + github.com/go-openapi/swag/loading v0.25.1 // indirect + github.com/go-openapi/swag/stringutils v0.25.1 // indirect + github.com/go-openapi/swag/typeutils v0.25.1 // indirect + github.com/go-openapi/swag/yamlutils v0.25.1 // indirect + github.com/google/go-cmp v0.7.0 // indirect github.com/jackc/pgpassfile v1.0.0 // indirect github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect github.com/jackc/puddle/v2 v2.2.2 // indirect - github.com/kr/text v0.2.0 // indirect github.com/pmezard/go-difflib v1.0.0 // indirect - github.com/rogpeppe/go-internal v1.14.1 // indirect - golang.org/x/crypto v0.42.0 // indirect - golang.org/x/sync v0.17.0 // indirect - golang.org/x/text v0.29.0 // indirect + github.com/swaggo/files/v2 v2.0.2 // indirect + go.yaml.in/yaml/v3 v3.0.4 // indirect + golang.org/x/crypto v0.44.0 // indirect + golang.org/x/mod v0.30.0 // indirect + golang.org/x/sync v0.18.0 // indirect + golang.org/x/text v0.31.0 // indirect + golang.org/x/tools v0.39.0 // indirect gopkg.in/yaml.v3 v3.0.1 // indirect ) diff --git a/go.sum b/go.sum index c20e94a..0bd8f08 100644 --- a/go.sum +++ b/go.sum @@ -1,17 +1,43 @@ git.kundeng.us/phoenix/textsender-models v0.0.6-4-e124bcfda8-556 h1:2shgOKmglCODswpCJeCuyPiUAph3wfc0Ep1z6b/ifis= git.kundeng.us/phoenix/textsender-models v0.0.6-4-e124bcfda8-556/go.mod h1:lx5MCnOgGgsdpwzrfi9uph5xmkeb6H8AuexUNGss2no= -github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= +github.com/KyleBanks/depth v1.2.1 h1:5h8fQADFrWtarTdtDudMmGsC7GPbOAu6RVB3ffsVFHc= +github.com/KyleBanks/depth v1.2.1/go.mod h1:jzSb9d0L43HxTQfT+oSA1EEp2q+ne2uh6XgeJcm8brE= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/go-chi/chi/v5 v5.2.3 h1:WQIt9uxdsAbgIYgid+BpYc+liqQZGMHRaUwp0JUcvdE= github.com/go-chi/chi/v5 v5.2.3/go.mod h1:L2yAIGWB3H+phAw1NxKwWM+7eUH/lU8pOMm5hHcoops= +github.com/go-openapi/jsonpointer v0.22.1 h1:sHYI1He3b9NqJ4wXLoJDKmUmHkWy/L7rtEo92JUxBNk= +github.com/go-openapi/jsonpointer v0.22.1/go.mod h1:pQT9OsLkfz1yWoMgYFy4x3U5GY5nUlsOn1qSBH5MkCM= +github.com/go-openapi/jsonreference v0.21.3 h1:96Dn+MRPa0nYAR8DR1E03SblB5FJvh7W6krPI0Z7qMc= +github.com/go-openapi/jsonreference v0.21.3/go.mod h1:RqkUP0MrLf37HqxZxrIAtTWW4ZJIK1VzduhXYBEeGc4= +github.com/go-openapi/spec v0.22.1 h1:beZMa5AVQzRspNjvhe5aG1/XyBSMeX1eEOs7dMoXh/k= +github.com/go-openapi/spec v0.22.1/go.mod h1:c7aeIQT175dVowfp7FeCvXXnjN/MrpaONStibD2WtDA= +github.com/go-openapi/swag v0.19.15 h1:D2NRCBzS9/pEY3gP9Nl8aDqGUcPFrwG2p+CNFrLyrCM= +github.com/go-openapi/swag/conv v0.25.1 h1:+9o8YUg6QuqqBM5X6rYL/p1dpWeZRhoIt9x7CCP+he0= +github.com/go-openapi/swag/conv v0.25.1/go.mod h1:Z1mFEGPfyIKPu0806khI3zF+/EUXde+fdeksUl2NiDs= +github.com/go-openapi/swag/jsonname v0.25.1 h1:Sgx+qbwa4ej6AomWC6pEfXrA6uP2RkaNjA9BR8a1RJU= +github.com/go-openapi/swag/jsonname v0.25.1/go.mod h1:71Tekow6UOLBD3wS7XhdT98g5J5GR13NOTQ9/6Q11Zo= +github.com/go-openapi/swag/jsonutils v0.25.1 h1:AihLHaD0brrkJoMqEZOBNzTLnk81Kg9cWr+SPtxtgl8= +github.com/go-openapi/swag/jsonutils v0.25.1/go.mod h1:JpEkAjxQXpiaHmRO04N1zE4qbUEg3b7Udll7AMGTNOo= +github.com/go-openapi/swag/jsonutils/fixtures_test v0.25.1 h1:DSQGcdB6G0N9c/KhtpYc71PzzGEIc/fZ1no35x4/XBY= +github.com/go-openapi/swag/jsonutils/fixtures_test v0.25.1/go.mod h1:kjmweouyPwRUEYMSrbAidoLMGeJ5p6zdHi9BgZiqmsg= +github.com/go-openapi/swag/loading v0.25.1 h1:6OruqzjWoJyanZOim58iG2vj934TysYVptyaoXS24kw= +github.com/go-openapi/swag/loading v0.25.1/go.mod h1:xoIe2EG32NOYYbqxvXgPzne989bWvSNoWoyQVWEZicc= +github.com/go-openapi/swag/stringutils v0.25.1 h1:Xasqgjvk30eUe8VKdmyzKtjkVjeiXx1Iz0zDfMNpPbw= +github.com/go-openapi/swag/stringutils v0.25.1/go.mod h1:JLdSAq5169HaiDUbTvArA2yQxmgn4D6h4A+4HqVvAYg= +github.com/go-openapi/swag/typeutils v0.25.1 h1:rD/9HsEQieewNt6/k+JBwkxuAHktFtH3I3ysiFZqukA= +github.com/go-openapi/swag/typeutils v0.25.1/go.mod h1:9McMC/oCdS4BKwk2shEB7x17P6HmMmA6dQRtAkSnNb8= +github.com/go-openapi/swag/yamlutils v0.25.1 h1:mry5ez8joJwzvMbaTGLhw8pXUnhDK91oSJLDPF1bmGk= +github.com/go-openapi/swag/yamlutils v0.25.1/go.mod h1:cm9ywbzncy3y6uPm/97ysW8+wZ09qsks+9RS8fLWKqg= +github.com/go-openapi/testify/v2 v2.0.2 h1:X999g3jeLcoY8qctY/c/Z8iBHTbwLz7R2WXd6Ub6wls= +github.com/go-openapi/testify/v2 v2.0.2/go.mod h1:HCPmvFFnheKK2BuwSA0TbbdxJ3I16pjwMkYkP4Ywn54= github.com/golang-jwt/jwt/v5 v5.3.0 h1:pv4AsKCKKZuqlgs5sUmn4x8UlGa0kEVt/puTpKx9vvo= github.com/golang-jwt/jwt/v5 v5.3.0/go.mod h1:fxCRLWMO43lRc8nhHWY6LGqRcf+1gQWArsqaEUEa5bE= +github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= +github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= -github.com/gorilla/mux v1.8.1 h1:TuBL49tXwgrFYWhqrNgrUNEY92u81SPhu7sTdzQEiWY= -github.com/gorilla/mux v1.8.1/go.mod h1:AKf9I4AEqPTmMytcMc0KkNouC66V3BtZ4qD5fmWSiMQ= github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM= github.com/jackc/pgpassfile v1.0.0/go.mod h1:CEx0iS5ambNFdcRtxPj5JhEz+xB6uRky5eyVu/W2HEg= github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 h1:iCEnooe7UlwOQYpKFhBabPMi4aNAfoODPEFNiAnClxo= @@ -22,8 +48,8 @@ github.com/jackc/puddle/v2 v2.2.2 h1:PR8nw+E/1w0GLuRFSmiioY6UooMp6KJv0/61nB7icHo github.com/jackc/puddle/v2 v2.2.2/go.mod h1:vriiEXHvEE654aYKXXjOvZM39qJ0q+azkZFrfEOc3H4= github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0= github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4= -github.com/kr/pretty v0.3.0 h1:WgNl7dwNpEZ6jJ9k1snq4pZsg7DOEN8hP9Xw0Tsjwk0= -github.com/kr/pretty v0.3.0/go.mod h1:640gp4NfQd8pI5XOwp5fnNeVWj67G7CFk/SaSQn7NBk= +github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= +github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= @@ -35,12 +61,24 @@ github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UV github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= -golang.org/x/crypto v0.42.0 h1:chiH31gIWm57EkTXpwnqf8qeuMUi0yekh6mT2AvFlqI= -golang.org/x/crypto v0.42.0/go.mod h1:4+rDnOTJhQCx2q7/j6rAN5XDw8kPjeaXEUR2eL94ix8= -golang.org/x/sync v0.17.0 h1:l60nONMj9l5drqw6jlhIELNv9I0A4OFgRsG9k2oT9Ug= -golang.org/x/sync v0.17.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI= -golang.org/x/text v0.29.0 h1:1neNs90w9YzJ9BocxfsQNHKuAT4pkghyXc4nhZ6sJvk= -golang.org/x/text v0.29.0/go.mod h1:7MhJOA9CD2qZyOKYazxdYMF85OwPdEr9jTtBpO7ydH4= +github.com/swaggo/files/v2 v2.0.2 h1:Bq4tgS/yxLB/3nwOMcul5oLEUKa877Ykgz3CJMVbQKU= +github.com/swaggo/files/v2 v2.0.2/go.mod h1:TVqetIzZsO9OhHX1Am9sRf9LdrFZqoK49N37KON/jr0= +github.com/swaggo/http-swagger/v2 v2.0.2 h1:FKCdLsl+sFCx60KFsyM0rDarwiUSZ8DqbfSyIKC9OBg= +github.com/swaggo/http-swagger/v2 v2.0.2/go.mod h1:r7/GBkAWIfK6E/OLnE8fXnviHiDeAHmgIyooa4xm3AQ= +github.com/swaggo/swag v1.16.6 h1:qBNcx53ZaX+M5dxVyTrgQ0PJ/ACK+NzhwcbieTt+9yI= +github.com/swaggo/swag v1.16.6/go.mod h1:ngP2etMK5a0P3QBizic5MEwpRmluJZPHjXcMoj4Xesg= +go.yaml.in/yaml/v3 v3.0.4 h1:tfq32ie2Jv2UxXFdLJdh3jXuOzWiL1fo0bu/FbuKpbc= +go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg= +golang.org/x/crypto v0.44.0 h1:A97SsFvM3AIwEEmTBiaxPPTYpDC47w720rdiiUvgoAU= +golang.org/x/crypto v0.44.0/go.mod h1:013i+Nw79BMiQiMsOPcVCB5ZIJbYkerPrGnOa00tvmc= +golang.org/x/mod v0.30.0 h1:fDEXFVZ/fmCKProc/yAXXUijritrDzahmwwefnjoPFk= +golang.org/x/mod v0.30.0/go.mod h1:lAsf5O2EvJeSFMiBxXDki7sCgAxEUcZHXoXMKT4GJKc= +golang.org/x/sync v0.18.0 h1:kr88TuHDroi+UVf+0hZnirlk8o8T+4MrK6mr60WkH/I= +golang.org/x/sync v0.18.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI= +golang.org/x/text v0.31.0 h1:aC8ghyu4JhP8VojJ2lEHBnochRno1sgL6nEi9WGFGMM= +golang.org/x/text v0.31.0/go.mod h1:tKRAlv61yKIjGGHX/4tP1LTbc13YSec1pxVEWXzfoeM= +golang.org/x/tools v0.39.0 h1:ik4ho21kwuQln40uelmciQPp9SipgNDdrafrYA4TmQQ= +golang.org/x/tools v0.39.0/go.mod h1:JnefbkDPyD8UU2kI5fuf8ZX4/yUeh9W877ZeBONxUqQ= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= diff --git a/internal/handler/contact.go b/internal/handler/contact.go index d023f44..e07b8a8 100644 --- a/internal/handler/contact.go +++ b/internal/handler/contact.go @@ -33,6 +33,18 @@ func NewContactHandler(str store.ContactStore) *ContactHandler { return &ContactHandler{ContactStore: str} } +// AddContact godoc +// @Summary Add contact +// @Description Add a contact record to have a recipient to send a text to (requires JWT) +// @Tags contacts +// @Accept json +// @Produce json +// @Security BearerAuth +// @Param request body RequestAddContact true "Data to add contact" +// @Success 201 {object} AddContactResponse +// @Failure 400 {object} AddContactResponse +// @Failure 500 {object} AddContactResponse +// @Router /contact/new [post] func (c *ContactHandler) AddContact(w http.ResponseWriter, r *http.Request) { if r.Method != http.MethodPost { http.Error(w, "Method not allowed", http.StatusMethodNotAllowed) @@ -76,6 +88,19 @@ func (c *ContactHandler) AddContact(w http.ResponseWriter, r *http.Request) { RespondWithJSON(w, statusCode, &resp) } +// GetContact godoc +// @Summary Get contact +// @Description Get a contact record to have a recipient to send a text to (requires JWT) +// @Tags contacts +// @Accept json +// @Produce json +// @Param id path string true "Contact Id" +// @Param user_id path string true "User Id" +// @Security BearerAuth +// @Success 200 {object} GetContactResponse +// @Failure 400 {object} GetContactResponse +// @Failure 500 {object} GetContactResponse +// @Router /contact [get] func (c *ContactHandler) GetContact(w http.ResponseWriter, r *http.Request) { if r.Method != http.MethodGet { fmt.Println("Method:", r.Method) @@ -83,6 +108,7 @@ func (c *ContactHandler) GetContact(w http.ResponseWriter, r *http.Request) { return } + // One or the other var id, userId uuid.UUID queryParams := r.URL.Query() diff --git a/internal/handler/draftMessage.go b/internal/handler/draftMessage.go index c662df0..9d76e83 100644 --- a/internal/handler/draftMessage.go +++ b/internal/handler/draftMessage.go @@ -4,6 +4,7 @@ import "net/http" import "git.kundeng.us/phoenix/textsender-api/internal/model" +// TODO: Remove file func DraftMessageHandler(w http.ResponseWriter, r *http.Request) { da := model.MessageItem{ Id: 1, diff --git a/internal/handler/message.go b/internal/handler/message.go index a880309..28c55dc 100644 --- a/internal/handler/message.go +++ b/internal/handler/message.go @@ -33,6 +33,17 @@ func NewMessageHandler(str store.MessageStore) *MessageHandler { return &MessageHandler{MessageStore: str} } +// AddMessage godoc +// @Summary Add message +// @Description Add a message record to send a text to (requires JWT) +// @Tags messages +// @Accept json +// @Produce json +// @Security BearerAuth +// @Param request body RequestAddMessage true "Data to add message" +// @Success 201 {object} AddMessageResponse +// @Failure 500 {object} AddMessageResponse +// @Router /message/new [post] func (m *MessageHandler) AddMessage(w http.ResponseWriter, r *http.Request) { if r.Method != http.MethodPost { http.Error(w, "Method not allowed", http.StatusMethodNotAllowed) @@ -64,6 +75,19 @@ func (m *MessageHandler) AddMessage(w http.ResponseWriter, r *http.Request) { RespondWithJSON(w, statusCode, &resp) } +// GetMessage godoc +// @Summary Get message +// @Description Get a message record to have a recipient to send a text to (requires JWT) +// @Tags messages +// @Accept json +// @Produce json +// @Param id path string true "Message Id" +// @Param user_id path string true "User Id" +// @Security BearerAuth +// @Success 200 {object} GetMessageResponse +// @Failure 400 {object} GetMessageResponse +// @Failure 500 {object} GetMessageResponse +// @Router /message [get] func (c *MessageHandler) GetMessage(w http.ResponseWriter, r *http.Request) { if r.Method != http.MethodGet { http.Error(w, "Method not allowed", http.StatusMethodNotAllowed) @@ -114,10 +138,10 @@ func (c *MessageHandler) GetMessage(w http.ResponseWriter, r *http.Request) { } } else if userId != uuid.Nil { fmt.Println("Checking with User Id") - if contacts, err := c.MessageStore.GetAllMessages(ctx); err == nil { - for _, con := range contacts { - if con.UserId == userId { - resp.Data = append(resp.Data, *con) + if messages, err := c.MessageStore.GetAllMessages(ctx); err == nil { + for _, msg := range messages { + if msg.UserId == userId { + resp.Data = append(resp.Data, *msg) } } @@ -126,7 +150,7 @@ func (c *MessageHandler) GetMessage(w http.ResponseWriter, r *http.Request) { resp.Message = "Successful" } else { statusCode = http.StatusNotFound - resp.Message = "Contact not found" + resp.Message = "Message not found" } } else { statusCode = http.StatusInternalServerError diff --git a/internal/handler/schedule_message_status.go b/internal/handler/schedule_message_status.go index 7e04d00..616afd4 100644 --- a/internal/handler/schedule_message_status.go +++ b/internal/handler/schedule_message_status.go @@ -33,6 +33,19 @@ func NewScheduledMessageStatusHandler(str store.ScheduledMessageEventStore, schS return &ScheduledMessageStatusHandler{ScheduledMessageEventStore: str, ScheduledMessageStore: schStore} } +// UpdateStatus godoc +// @Summary Update status +// @Description Update the status of a scheduled message (requires JWT) +// @Tags status +// @Accept json +// @Produce json +// @Security BearerAuth +// @Param request body RequestScheduledMessageStatus true "Used to update scheduled message status" +// @Success 201 {object} ScheduledMessageStatusResponse +// @Failure 400 {object} ScheduledMessageStatusResponse +// @Failure 404 {object} ScheduledMessageStatusResponse +// @Failure 500 {object} ScheduledMessageStatusResponse +// @Router /schedule/message/status/update [patch] func (s *ScheduledMessageStatusHandler) UpdateStatus(w http.ResponseWriter, r *http.Request) { if r.Method != http.MethodPatch { http.Error(w, "Method not allowed", http.StatusMethodNotAllowed) diff --git a/internal/handler/scheduled_message.go b/internal/handler/scheduled_message.go index 73c1e98..d2499df 100644 --- a/internal/handler/scheduled_message.go +++ b/internal/handler/scheduled_message.go @@ -14,7 +14,6 @@ import ( type RequestAddScheduledMessage struct { Scheduled time.Time `json:"scheduled"` - Created time.Time `json:"created"` Status string `json:"status"` UserId uuid.UUID `json:"user_id"` } @@ -42,6 +41,18 @@ func NewScheduledMessageHandler(str store.ScheduledMessageStore) *ScheduledMessa return &ScheduledMessageHandler{ScheduledMessageStore: str} } +// AddScheduledMessage godoc +// @Summary Add scheduled message +// @Description Adds a scheduled message (requires JWT) +// @Tags scheduled messages +// @Accept json +// @Produce json +// @Security BearerAuth +// @Param request body RequestAddScheduledMessage true "Data to add scheduled message" +// @Success 201 {object} AddScheduledMessageResponse +// @Failure 400 {object} AddScheduledMessageResponse +// @Failure 500 {object} AddScheduledMessageResponse +// @Router /schedule/message [post] func (s *ScheduledMessageHandler) AddScheduledMessage(w http.ResponseWriter, r *http.Request) { if r.Method != http.MethodPost { http.Error(w, "Method not allowed", http.StatusMethodNotAllowed) @@ -93,6 +104,19 @@ func (s *ScheduledMessageHandler) AddScheduledMessage(w http.ResponseWriter, r * RespondWithJSON(w, statusCode, &resp) } +// GetScheduledMessage godoc +// @Summary Get scheduled message +// @Description Get a scheduled message (requires JWT) +// @Tags scheduled messages +// @Accept json +// @Produce json +// @Security BearerAuth +// @Param id path string true "Contact Id" +// @Param user_id path string true "User Id" +// @Success 200 {object} GetScheduledMessageResponse +// @Failure 400 {object} GetScheduledMessageResponse +// @Failure 500 {object} GetScheduledMessageResponse +// @Router /schedule/message [get] func (s *ScheduledMessageHandler) GetScheduledMessage(w http.ResponseWriter, r *http.Request) { var id, userId uuid.UUID @@ -157,6 +181,17 @@ func (s *ScheduledMessageHandler) GetScheduledMessage(w http.ResponseWriter, r * RespondWithJSON(w, statusCode, &resp) } +// FetchNextMessage godoc +// @Summary Fetch scheduled message +// @Description Fetches a scheduled message that is available to be processed (requires JWT) +// @Tags scheduled messages +// @Accept json +// @Produce json +// @Security BearerAuth +// @Success 200 {object} FetchNextMessageResponse +// @Failure 400 {object} FetchNextMessageResponse +// @Failure 500 {object} FetchNextMessageResponse +// @Router /schedule/message/fetch [get] func (s *ScheduledMessageHandler) FetchNextMessage(w http.ResponseWriter, r *http.Request) { ctx := r.Context() var resp FetchNextMessageResponse diff --git a/internal/handler/scheduled_message_event.go b/internal/handler/scheduled_message_event.go index 15f47de..ebee917 100644 --- a/internal/handler/scheduled_message_event.go +++ b/internal/handler/scheduled_message_event.go @@ -41,6 +41,18 @@ func NewScheduledMessageEventHandler(str store.ScheduledMessageEventStore, schSt return &ScheduledMessageEventHandler{ScheduledMessageEventStore: str, ScheduledMessageStore: schStore} } +// AddContact godoc +// @Summary Add scheduled message event +// @Description Add a scheduled message event (requires JWT) +// @Tags scheduled message events +// @Accept json +// @Produce json +// @Security BearerAuth +// @Param request body RequestAddScheduledMessageEvent true "Data to add scheduled message event" +// @Success 201 {object} AddScheduledMessageEventResponse +// @Failure 400 {object} AddScheduledMessageEventResponse +// @Failure 500 {object} AddScheduledMessageEventResponse +// @Router /schedule/message/event [post] func (s *ScheduledMessageEventHandler) AddScheduledMessageEvent(w http.ResponseWriter, r *http.Request) { if r.Method != http.MethodPost { http.Error(w, "Method not allowed", http.StatusMethodNotAllowed) @@ -103,6 +115,19 @@ func (s *ScheduledMessageEventHandler) AddScheduledMessageEvent(w http.ResponseW RespondWithJSON(w, statusCode, &resp) } +// GetScheduledMessageEvent godoc +// @Summary Get scheduled message event +// @Description Gets a scheduled message event (requires JWT) +// @Tags scheduled message events +// @Accept json +// @Produce json +// @Param id path string true "Contact Id" +// @Param scheduled_message_id path string true "Scheduled Message Id" +// @Security BearerAuth +// @Success 200 {object} GetScheduledMessageEventResponse +// @Failure 400 {object} GetScheduledMessageEventResponse +// @Failure 500 {object} GetScheduledMessageEventResponse +// @Router /schedule/message/event [get] func (s *ScheduledMessageEventHandler) GetScheduledMessageEvent(w http.ResponseWriter, r *http.Request) { if r.Method != http.MethodGet { http.Error(w, "Metnot allowed", http.StatusMethodNotAllowed) @@ -154,6 +179,18 @@ func (s *ScheduledMessageEventHandler) GetScheduledMessageEvent(w http.ResponseW RespondWithJSON(w, statusCode, &resp) } +// DeleteScheduledMessageEvent godoc +// @Summary Delete scheduled message event +// @Description Deletes a scheduled message event (requires JWT) +// @Tags scheduled message events +// @Accept json +// @Produce json +// @Security BearerAuth +// @Param id path string true "scheduled message event Id" Format(uuid) +// @Success 201 {object} DeleteScheduledMessageEventResponse +// @Failure 400 {object} DeleteScheduledMessageEventResponse +// @Failure 500 {object} DeleteScheduledMessageEventResponse +// @Router /schedule/message/event/{id} [delete] func (s *ScheduledMessageEventHandler) DeleteScheduledMessageEvent(w http.ResponseWriter, r *http.Request) { if r.Method != http.MethodDelete { http.Error(w, "Metnot allowed", http.StatusMethodNotAllowed)