Documentation
¶
Index ¶
- type CheckMailServerController
- type MailController
- func (mc *MailController) CheckMailServer(c *gin.Context)
- func (mc *MailController) CreateMailChannel(c *gin.Context)
- func (mc *MailController) DeleteMailChannel(c *gin.Context)
- func (mc *MailController) ListMailChannelsByType(c *gin.Context)
- func (mc *MailController) UpdateMailChannel(c *gin.Context)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CheckMailServerController ¶
type CheckMailServerController struct {
// contains filtered or unexported fields
}
func AddCheckMailServerController ¶
func AddCheckMailServerController( router gin.IRouter, notificationChannelServicer notificationchannelservice.MailChannelService, auth gin.HandlerFunc, registry errmap.ErrorRegistry, ) *CheckMailServerController
func (*CheckMailServerController) CheckMailServer ¶
func (mc *CheckMailServerController) CheckMailServer(c *gin.Context)
CheckMailServer
@Summary Check mail server
@Description Check if a mail server is reachable
@Tags mail-channel
@Accept json
@Produce json
@Security KeycloakAuth
@Param MailServerConfig body maildto.CheckMailServerRequest true "Mail server to check"
@Success 204 "Mail server reachable"
@Failure 400 {object} map[string]string
@Failure 422 "Mail server error"
@Router /notification-channel/mail/check [post]
type MailController ¶
type MailController struct {
Service notificationchannelservice.NotificationChannelService
MailChannelService notificationchannelservice.MailChannelService
}
func NewMailController ¶
func NewMailController( router gin.IRouter, service notificationchannelservice.NotificationChannelService, mailChannelService notificationchannelservice.MailChannelService, auth gin.HandlerFunc, registry errmap.ErrorRegistry, ) *MailController
func (*MailController) CheckMailServer ¶
func (mc *MailController) CheckMailServer(c *gin.Context)
CheckMailServer
@Summary Check mail server
@Description Check if a mail server is reachable
@Tags mail-channel
@Accept json
@Produce json
@Security KeycloakAuth
@Param MailServerConfig body maildto.CheckMailServerEntityRequest true "Mail server to check"
@Success 204 "Mail server reachable"
@Failure 400 {object} map[string]string
@Failure 422 "Mail server error"
@Router /notification-channel/mail/{id}/check [post]
func (*MailController) CreateMailChannel ¶
func (mc *MailController) CreateMailChannel(c *gin.Context)
CreateMailChannel
@Summary Create Mail Channel
@Description Create a new mail notification channel
@Tags mail-channel
@Accept json
@Produce json
@Security KeycloakAuth
@Param MailChannel body maildto.MailNotificationChannelRequest true "Mail channel to add"
@Success 201 {object} maildto.MailNotificationChannelRequest
@Failure 400 {object} map[string]string
@Failure 500 {object} map[string]string
@Router /notification-channel/mail [post]
func (*MailController) DeleteMailChannel ¶
func (mc *MailController) DeleteMailChannel(c *gin.Context)
DeleteMailChannel
@Summary Delete Mail Channel
@Description Delete a mail notification channel
@Tags mail-channel
@Security KeycloakAuth
@Param id path string true "Mail channel ID"
@Success 204 "Deleted successfully"
@Failure 500 {object} map[string]string
@Router /notification-channel/mail/{id} [delete]
func (*MailController) ListMailChannelsByType ¶
func (mc *MailController) ListMailChannelsByType(c *gin.Context)
ListMailChannelsByType
@Summary List Mail Channels
@Description List mail notification channels by type
@Tags mail-channel
@Produce json
@Security KeycloakAuth
@Param type query string false "Channel type"
@Success 200 {array} maildto.MailNotificationChannelRequest
@Failure 500 {object} map[string]string
@Router /notification-channel/mail [get]
func (*MailController) UpdateMailChannel ¶
func (mc *MailController) UpdateMailChannel(c *gin.Context)
UpdateMailChannel
@Summary Update Mail Channel
@Description Update an existing mail notification channel
@Tags mail-channel
@Accept json
@Produce json
@Security KeycloakAuth
@Param id path string true "Mail channel ID"
@Param MailChannel body maildto.MailNotificationChannelRequest true "Mail channel to update"
@Success 200 {object} maildto.MailNotificationChannelRequest
@Failure 400 {object} map[string]string
@Failure 500 {object} map[string]string
@Router /notification-channel/mail/{id} [put]
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.