3pp-mirror/pushbits
1
0
Fork 0
mirror of https://github.com/pushbits/server.git synced 2025-06-24 05:17:22 +02:00
Code Issues Projects Releases Packages Wiki Activity

add openapi docu

Browse source
This commit is contained in:
Cubicroot 2021-10-01 18:19:50 +02:00
parent afa4a9f866
commit 54d3cef46a
6 changed files with 109 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

25
internal/api/notification.go
View file

@ -29,7 +29,19 @@ type NotificationHandler struct {
DP NotificationDispatcher
}
// CreateNotification is used to create a new notification for a user.
// CreateNotification godoc
// @Summary Create a Notification
// @Description Creates a new notification for the given channel
// @Accept json,mpfd
// @Produce json
// @Param message query string true "The message to send"
// @Param title query string false "The title to send"
// @Param priority query integer false "The notifications priority"
// @Param extras query model.NotificationExtras false "JSON object with additional information"
// @Param token query string true "Channels token, can also be provieded in the header"
// @Success 200 {object} model.Notification
// @Failure 500,404,403 ""
// @Router /message [post]
func (h *NotificationHandler) CreateNotification(ctx *gin.Context) {
var notification model.Notification
@ -58,7 +70,16 @@ func (h *NotificationHandler) CreateNotification(ctx *gin.Context) {
ctx.JSON(http.StatusOK, &notification)
}
// DeleteNotification is used to delete (or mark as deleted) a notification for a user
// DeleteNotification godoc
// @Summary Delete a Notification
// @Description Informs the channel that the notification is deleted
// @Accept json,mpfd
// @Produce json
// @Param message_id path string true "ID of the message to delete"
// @Param token query string true "Channels token, can also be provieded in the header"
// @Success 200 ""
// @Failure 500,404,403 ""
// @Router /message/{message_id} [DELETE]
func (h *NotificationHandler) DeleteNotification(ctx *gin.Context) {
application := authentication.GetApplication(ctx)
id, err := getMessageID(ctx)