Improve documentation

This commit is contained in:
TwinProduction
2020-09-26 15:15:50 -04:00
parent ac5ad9d173
commit b4b9f5c1be
6 changed files with 19 additions and 0 deletions

View File

@ -8,6 +8,7 @@ import (
"net/url"
)
// AlertProvider is the configuration necessary for sending an alert using Twilio
type AlertProvider struct {
SID string `yaml:"sid"`
Token string `yaml:"token"`
@ -15,10 +16,12 @@ type AlertProvider struct {
To string `yaml:"to"`
}
// IsValid returns whether the provider's configuration is valid
func (provider *AlertProvider) IsValid() bool {
return len(provider.Token) > 0 && len(provider.SID) > 0 && len(provider.From) > 0 && len(provider.To) > 0
}
// ToCustomAlertProvider converts the provider into a custom.AlertProvider
func (provider *AlertProvider) ToCustomAlertProvider(service *core.Service, alert *core.Alert, result *core.Result, resolved bool) *custom.AlertProvider {
var message string
if resolved {