statuspage

Documentation

Index

• Constants
• func ExampleMessage(cfg config.Configuration, data util.ExampleData, eventSlug string) (cc.Message, error)
• func NewHandler() handlers.Handler
• func Normalize(cfg config.Configuration, hReq handlers.HandlerRequest) (cc.Message, error)
• func NormalizeComponentUpdate(cfg config.Configuration, src StatuspageOutMessage) (cc.Message, error)
• func NormalizeIncidentUpdate(cfg config.Configuration, src StatuspageOutMessage) (cc.Message, error)
• func ToUpperFirstWorlds(input string, sep1 string, sep2 string) string
• type StatuspageOutComponent
• type StatuspageOutComponentUpdate
• type StatuspageOutIncident
• type StatuspageOutIncidentUpdate
• type StatuspageOutMessage
  • func StatuspageOutMessageFromBytes(bytes []byte) (StatuspageOutMessage, error)
  • func (msg *StatuspageOutMessage) IncidentURL() string
  • func (msg *StatuspageOutMessage) PageURL() (string, error)
• type StatuspageOutMeta
• type StatuspageOutPage

Constants

const (
	DisplayName        = "StatusPage"
	HandlerKey         = "statuspage"
	MessageDirection   = "out"
	ComponentURLFormat = "http://manage.statuspage.io/pages/%s/components"
	MessageBodyType    = models.JSON
)

Functions

func ExampleMessage

func ExampleMessage(cfg config.Configuration, data util.ExampleData, eventSlug string) (cc.Message, error)

func NewHandler

func NewHandler() handlers.Handler

func Normalize

func Normalize(cfg config.Configuration, hReq handlers.HandlerRequest) (cc.Message, error)

func NormalizeComponentUpdate

func NormalizeComponentUpdate(cfg config.Configuration, src StatuspageOutMessage) (cc.Message, error)

func NormalizeIncidentUpdate

func NormalizeIncidentUpdate(cfg config.Configuration, src StatuspageOutMessage) (cc.Message, error)

func ToUpperFirstWorlds

func ToUpperFirstWorlds(input string, sep1 string, sep2 string) string

Types

type StatuspageOutComponent

type StatuspageOutComponent struct {
	ID        string `json:"id,omitempty"`
	CreatedAt string `json:"created_at,omitempty"`
	Name      string `json:"name,omitempty"`
	Status    string `json:"status,omitempty"`
}

type StatuspageOutComponentUpdate

type StatuspageOutComponentUpdate struct {
	ID          string `json:"id,omitempty"`
	CreatedAt   string `json:"created_at,omitempty"`
	NewStatus   string `json:"new_status,omitempty"`
	OldStatus   string `json:"old_status,omitempty"`
	ComponentID string `json:"component_id,omitempty"`
}

type StatuspageOutIncident

type StatuspageOutIncident struct {
	ID                            string                        `json:"id,omitempty"`
	Backfilled                    bool                          `json:"backfilled,omitempty"`
	Impact                        string                        `json:"impact,omitempty"`
	ImpactOverride                any                           `json:"impact_override,omitempty"`
	MonitoringAt                  string                        `json:"monitoring_at,omitempty"`
	PostmortemBody                any                           `json:"postmortem_body,omitempty"`
	PostmortemBodyLastUpdatedAt   string                        `json:"postmortem_body_last_updated_at,omitempty"`
	PostmortemIgnored             bool                          `json:"postmortem_ignored,omitempty"`
	PostmortemNotifiedSubscribers bool                          `json:"postmortem_notified_subscribers,omitempty"`
	PostmortemNotifiedTwitter     bool                          `json:"postmortem_notified_twitter,omitempty"`
	PostmortemPublishedAt         string                        `json:"postmortem_published_at,omitempty"`
	ResovledAt                    string                        `json:"resolved_at,omitempty"`
	ScheduledAutoTransition       bool                          `json:"scheduled_auto_transition,omitempty"`
	ScheduledFor                  any                           `json:"scheduled_for,omitempty"`
	ScheduledRemindPrior          bool                          `json:"scheduled_remind_prior,omitempty"`
	ScheduledRemindedAt           any                           `json:"scheduled_reminded_at,omitempty"`
	ScheduledUntil                any                           `json:"scheduled_until,omitempty"`
	Shortlink                     string                        `json:"shortlink,omitempty"`
	Status                        string                        `json:"status,omitempty"`
	UpdatedAt                     string                        `json:"updated_at,omitempty"`
	OrganizationID                string                        `json:"organization_id,omitempty"`
	IncidentUpdates               []StatuspageOutIncidentUpdate `json:"incident_updates,omitempty"`
	Name                          string                        `json:"name,omitempty"`
}

type StatuspageOutIncidentUpdate

type StatuspageOutIncidentUpdate struct {
	ID                 string `json:"id,omitempty"`
	Body               string `json:"body,omitempty"`
	CreatedAt          string `json:"created_at,omitempty"`
	DisplayAt          string `json:"display_at,omitempty"`
	Status             string `json:"status,omitempty"`
	TwitterUpdatedAt   string `json:"twitter_updated_at,omitempty"`
	UpdatedAt          string `json:"updated_at,omitempty"`
	WantsTwitterUpdate bool   `json:"wants_twitter_update,omitempty"`
	IncidentID         string `json:"incident_id,omitempty"`
}

type StatuspageOutMessage

type StatuspageOutMessage struct {
	Meta            StatuspageOutMeta            `json:"meta,omitempty"`
	Page            StatuspageOutPage            `json:"page,omitempty"`
	ComponentUpdate StatuspageOutComponentUpdate `json:"component_update,omitempty"`
	Component       StatuspageOutComponent       `json:"component,omitempty"`
	Incident        StatuspageOutIncident        `json:"incident,omitempty"`
}

func StatuspageOutMessageFromBytes

func StatuspageOutMessageFromBytes(bytes []byte) (StatuspageOutMessage, error)

func (*StatuspageOutMessage) IncidentURL

func (msg *StatuspageOutMessage) IncidentURL() string

func (*StatuspageOutMessage) PageURL

func (msg *StatuspageOutMessage) PageURL() (string, error)

type StatuspageOutMeta

type StatuspageOutMeta struct {
	Unsubscribe   string `json:"unsubscribe,omitempty"`
	Documentation string `json:"documentation,omitempty"`
}

type StatuspageOutPage

type StatuspageOutPage struct {
	ID                string `json:"id,omitempty"`
	StatusIndicator   string `json:"status_indicator,omitempty"`
	StatusDescription string `json:"status_description,omitempty"`
}