configuration

type Component struct {
	// Unique but user-readable component name
	Name        string `validate:"required"`
	Description string
	// If the component should be hidden to users while operational
	OnlyShowIfDegraded bool
	// If uptime data should be hidden and go unrecorded
	HideUptime bool
	// Date the component existed from, in the form YYYY-MM-DD
	StartDate string `validate:"required"`
}

type ComponentGroup struct {
	// Unique but user-readable group name
	Name        string `validate:"required"`
	Description string
	// Exact names of components to include in the group (components should never exist in more than one group)
	ComponentNames []string `validate:"required,unique"`
}

type Config struct {
	// Whether to be more verbose with console output
	// NOTE: May be set via --verbose / -v command line flags
	Verbose bool

	Client struct {
		// Number of 300-series redirects to follow
		Redirects int // default: 3
		// Number of exponential-backoff retries to make
		Retries int // default: 3
	}

	Statuspage struct {
		// API key to communicate with Statuspage.io
		// NOTE: May be set via REVERE_STATUSPAGE_APIKEY in environment
		ApiKey string `validate:"required"`
		// ID of the particular page to interact with
		PageID     string           `validate:"required"`
		ApiRoot    string           // default: "https://api.statuspage.io/v1"
		Components []Component      `validate:"unique=Name,dive"`
		Groups     []ComponentGroup `validate:"unique=Name,dive"`
	}

	Pubsub struct {
		// Non-numeric ID of the GCP project containing the subscription
		ProjectID string `validate:"required"`
		// ID of the Cloud Pub/Sub subscription to use to pull messages
		SubscriptionID string `validate:"required"`
	}

	Api struct {
		// Port to host Revere's web server on
		// NOTE: May be set via REVERE_API_PORT in environment
		Port int // default: 8080
		// Print debugging information from the server library
		Debug bool
		// Forcibly silence the request log
		Silent bool
	}

	// Correlate developed services to user-facing components
	ServiceToComponentMapping []ServiceToComponentMapping `validate:"dive"`
}

type ServiceToComponentMapping struct {
	ServiceName            string   `validate:"required"`
	ServiceEnvironment     string   `validate:"required"`
	AffectsComponentsNamed []string `validate:"unique"`
}