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

@ -5,7 +5,11 @@ import (
"github.com/TwinProduction/gatus/core"
)
// AlertProvider is the interface that each providers should implement
type AlertProvider interface {
// IsValid returns whether the provider's configuration is valid
IsValid() bool
// ToCustomAlertProvider converts the provider into a custom.AlertProvider
ToCustomAlertProvider(service *core.Service, alert *core.Alert, result *core.Result, resolved bool) *custom.AlertProvider
}