Implement /deliveries route

This commit is contained in:
2025-12-05 16:59:56 +01:00
parent 8e7a540c97
commit c554479604
4 changed files with 179 additions and 1 deletions

View File

@@ -271,6 +271,65 @@ func (h APIHandler) GetMessage(pctx ginext.PreContext) ginext.HTTPResponse {
})
}
// ListMessageDeliveries swaggerdoc
//
// @Summary List deliveries for a message
// @Description The user must own the channel and request the resource with the ADMIN Key
// @ID api-messages-deliveries
// @Tags API-v2
//
// @Param mid path string true "MessageID"
//
// @Success 200 {object} handler.ListMessageDeliveries.response
// @Failure 400 {object} ginresp.apiError "supplied values/parameters cannot be parsed / are invalid"
// @Failure 401 {object} ginresp.apiError "user is not authorized / has missing permissions"
// @Failure 404 {object} ginresp.apiError "message not found"
// @Failure 500 {object} ginresp.apiError "internal server error"
//
// @Router /api/v2/messages/{mid}/deliveries [GET]
func (h APIHandler) ListMessageDeliveries(pctx ginext.PreContext) ginext.HTTPResponse {
type uri struct {
MessageID models.MessageID `uri:"mid" binding:"entityid"`
}
type response struct {
Deliveries []models.Delivery `json:"deliveries"`
}
var u uri
ctx, g, errResp := pctx.URI(&u).Start()
if errResp != nil {
return *errResp
}
defer ctx.Cancel()
return h.app.DoRequest(ctx, g, models.TLockRead, func(ctx *logic.AppContext, finishSuccess func(r ginext.HTTPResponse) ginext.HTTPResponse) ginext.HTTPResponse {
if permResp := ctx.CheckPermissionAny(); permResp != nil {
return *permResp
}
msg, err := h.database.GetMessage(ctx, u.MessageID, false)
if errors.Is(err, sql.ErrNoRows) {
return ginresp.APIError(g, 404, apierr.MESSAGE_NOT_FOUND, "message not found", err)
}
if err != nil {
return ginresp.APIError(g, 500, apierr.DATABASE_ERROR, "Failed to query message", err)
}
// User must own the channel and have admin key
if permResp := ctx.CheckPermissionUserAdmin(msg.ChannelOwnerUserID); permResp != nil {
return *permResp
}
deliveries, err := h.database.ListDeliveriesOfMessage(ctx, msg.MessageID)
if err != nil {
return ginresp.APIError(g, 500, apierr.DATABASE_ERROR, "Failed to query deliveries", err)
}
return finishSuccess(ginext.JSON(http.StatusOK, response{Deliveries: deliveries}))
})
}
// DeleteMessage swaggerdoc
//
// @Summary Delete a single message

View File

@@ -164,6 +164,7 @@ func (r *Router) Init(e *ginext.GinWrapper) error {
apiv2.GET("/messages").Handle(r.apiHandler.ListMessages)
apiv2.GET("/messages/:mid").Handle(r.apiHandler.GetMessage)
apiv2.DELETE("/messages/:mid").Handle(r.apiHandler.DeleteMessage)
apiv2.GET("/messages/:mid/deliveries").Handle(r.apiHandler.ListMessageDeliveries)
apiv2.GET("/sender-names").Handle(r.apiHandler.ListSenderNames)