v2

type API interface {
	// CheckEndpoint verifies we can talk to the backend.
	CheckEndpoint(ctx context.Context) (api.Metadata, error)

	// ListApplications gets a list of existing applications for an authorized request.
	ListApplications(ctx context.Context, q ApplicationListQuery) (ApplicationList, error)
	// ListApplicationsByPage returns single page of applications identified by the supplied URL.
	ListApplicationsByPage(ctx context.Context, u string) (ApplicationList, error)
	// CreateApplication creates a new application.
	CreateApplication(ctx context.Context, app Application) (api.Metadata, error)
	// CreateApplicationByName creates a new application.
	CreateApplicationByName(ctx context.Context, n ApplicationName, app Application) (api.Metadata, error)
	// GetApplication retrieves an application.
	GetApplication(ctx context.Context, u string) (Application, error)
	// GetApplicationByName retrieves an application.
	GetApplicationByName(ctx context.Context, n ApplicationName) (Application, error)
	// UpdateApplication updates an application.
	UpdateApplication(ctx context.Context, u string, app Application) (api.Metadata, error)
	// UpdateApplicationByName updates or creates an application.
	UpdateApplicationByName(ctx context.Context, n ApplicationName, app Application) (api.Metadata, error)
	// DeleteApplication deletes an application.
	DeleteApplication(ctx context.Context, u string) error

	// ListScenarios lists configured scenarios for an application.
	// Deprecated: scenarios should no longer be used.
	ListScenarios(ctx context.Context, u string, q ScenarioListQuery) (ScenarioList, error)
	// CreateScenario creates a scenario.
	// Deprecated: scenarios should no longer be used.
	CreateScenario(ctx context.Context, u string, scn Scenario) (api.Metadata, error)
	// CreateScenarioByName creates a scenario.
	// Deprecated: scenarios should no longer be used.
	CreateScenarioByName(ctx context.Context, u string, n ScenarioName, scn Scenario) (Scenario, error)
	// GetScenario retrieves a scenario.
	// Deprecated: scenarios should no longer be used.
	GetScenario(ctx context.Context, u string) (Scenario, error)
	// GetScenarioByName retrieves a scenario by name.
	// Deprecated: scenarios should no longer be used.
	GetScenarioByName(ctx context.Context, u string, n ScenarioName) (Scenario, error)
	// UpdateScenario updates or creates a scenario.
	// Deprecated: scenarios should no longer be used.
	UpdateScenario(ctx context.Context, u string, scn Scenario) (Scenario, error)
	// UpdateScenarioByName updates or creates a scenario.
	// Deprecated: scenarios should no longer be used.
	UpdateScenarioByName(ctx context.Context, u string, n ScenarioName, scn Scenario) (Scenario, error)
	// DeleteScenario deletes a scenario.
	// Deprecated: scenarios should no longer be used.
	DeleteScenario(ctx context.Context, u string) error
	// PatchScenario updates attributes on a scenario.
	// Deprecated: scenarios should no longer be used.
	PatchScenario(ctx context.Context, u string, scn Scenario) error

	// GetTemplate gets the application scenario template.
	GetTemplate(ctx context.Context, u string) (Template, error)
	// UpdateTemplate records or updates scenario template.
	UpdateTemplate(ctx context.Context, u string, s Template) error
	// PatchTemplate updates a partial scenario template.
	PatchTemplate(ctx context.Context, u string, s Template) error

	// ListActivity gets activity feed for an application.
	ListActivity(ctx context.Context, u string, q ActivityFeedQuery) (ActivityFeed, error)
	// CreateActivity creates application activity.
	CreateActivity(ctx context.Context, u string, a Activity) error
	// DeleteActivity resolves application activity.
	DeleteActivity(ctx context.Context, u string) error
	// PatchApplicationActivity updates application activity.
	PatchApplicationActivity(ctx context.Context, u string, a ActivityPatchRequest) error

	// SubscribeActivity returns a subscriber for the activity feed.
	SubscribeActivity(ctx context.Context, q ActivityFeedQuery) (Subscriber, error)

	// CreateRecommendation creates an application recommendation using the most recently published values.
	CreateRecommendation(ctx context.Context, u string) (api.Metadata, error)
	// GetRecommendation retrieves a recommendation.
	GetRecommendation(ctx context.Context, u string) (Recommendation, error)
	// ListRecommendations lists recommendations and recommendation configuration for an application.
	ListRecommendations(ctx context.Context, u string) (RecommendationList, error)
	// PatchRecommendations updates recommendation configuration.
	PatchRecommendations(ctx context.Context, u string, details RecommendationList) error

	// GetCluster retrieves a cluster.
	GetCluster(ctx context.Context, u string) (Cluster, error)
	// GetClusterByName retrieves a cluster.
	GetClusterByName(ctx context.Context, n ClusterName) (Cluster, error)
	// ListClusters lists clusters.
	ListClusters(ctx context.Context, q ClusterListQuery) (ClusterList, error)
	// PatchCluster updates a cluster title.
	PatchCluster(ctx context.Context, u string, c ClusterTitle) error
	// DeleteCluster deletes a cluster.
	DeleteCluster(ctx context.Context, u string) error
}

type Activity struct {
	api.Metadata `json:"-"`
	Run          *RunActivity     `json:"run,omitempty"`
	Scan         *ScanActivity    `json:"scan,omitempty"`
	Approve      *ApproveActivity `json:"approve,omitempty"`
	Refresh      *RefreshActivity `json:"refresh,omitempty"`
}

type ActivityExtension struct {
	ActivityFailure
}

type ActivityFailure struct {
	FailureReason  string `json:"failure_reason,omitempty"`
	FailureMessage string `json:"failure_message,omitempty"`
}

type ActivityFeed struct {
	HomePageURL string         `json:"home_page_url,omitempty"`
	FeedURL     string         `json:"feed_url,omitempty"`
	NextURL     string         `json:"next_url,omitempty"`
	Hubs        []ActivityHub  `json:"hubs,omitempty"`
	Items       []ActivityItem `json:"items"`
}

type ActivityFeedQuery struct {
	Query map[string][]string
}

type ActivityHub struct {
	Type string `json:"type"`
	URL  string `json:"url"`
}

type ActivityItem struct {
	ID            string             `json:"id"`
	URL           string             `json:"url,omitempty"`
	ExternalURL   string             `json:"external_url,omitempty"`
	Title         string             `json:"title,omitempty"`
	DatePublished time.Time          `json:"date_published,omitempty"`
	DateModified  time.Time          `json:"date_modified,omitempty"`
	Tags          []string           `json:"tags,omitempty"`
	StormForge    *ActivityExtension `json:"_stormforge,omitempty"`
}

type ActivityPatchRequest struct {
	Title string `json:"title"`
	// Data is a JSON-serializable value for internal metadata about the Activity
	Data any `json:"_stormforge,omitempty"`
}

type Application struct {
	api.Metadata `json:"-"`
	Name         ApplicationName `json:"name,omitempty"`
	DisplayName  string          `json:"title,omitempty"` // TODO This doesn't seem to get set
	Resources    []Resource      `json:"resources,omitempty"`
	CreatedAt    *time.Time      `json:"createdAt,omitempty"`
}

type ApplicationItem struct {
	Application
	// The number of scenarios associated with this application.
	ScenarioCount   int                 `json:"scenarioCount,omitempty"`
	LastDeployedAt  *time.Time          `json:"lastDeployedAt,omitempty"`
	Recommendations RecommendationsMode `json:"recommendations,omitempty"`
}

type ApplicationList struct {
	// The application list metadata.
	api.Metadata `json:"-"`
	// The total number of items in the collection.
	TotalCount int `json:"totalCount,omitempty"`
	// The list of applications.
	Applications []ApplicationItem `json:"applications"`
}

type ApplicationListQuery struct{ api.IndexQuery }

type ApplicationName string

type ApproveActivity struct {
	Recommendation string `json:"recommendation"`
	ActivityFailure
}

type BackfillProgress struct {
	Timestamp time.Time `json:"timestamp"`
}

type Bounds struct {
	Limits            *BoundsRange `json:"limits,omitempty"`
	Requests          *BoundsRange `json:"requests,omitempty"`
	TargetUtilization *BoundsRange `json:"targetUtilization,omitempty"`
}

type BoundsRange struct {
	Max *ResourceList `json:"max,omitempty"`
	Min *ResourceList `json:"min,omitempty"`
}

type Cluster struct {
	api.Metadata           `json:"-"`
	Name                   ClusterName `json:"name,omitempty"`
	CreatedAt              *time.Time  `json:"created,omitempty"`
	OptimizeProVersion     string      `json:"optimizeProVersion,omitempty"`
	OptimizeLiveVersion    string      `json:"optimizeLiveVersion,omitempty"`
	PerformanceTestVersion string      `json:"performanceTestVersion,omitempty"`
	KubernetesVersion      string      `json:"kubernetesVersion,omitempty"`
	LastSeen               *time.Time  `json:"lastSeen,omitempty"`
}

type ClusterItem struct {
	Cluster
}

type ClusterList struct {
	// The cluster list metadata.
	api.Metadata `json:"-"`
	// The total number of items in the collection.
	TotalCount int `json:"totalCount,omitempty"`
	// The list of clusters.
	Items []ClusterItem `json:"items"`
}

type ClusterListQuery struct{ api.IndexQuery }

type ClusterModule string

type ClusterName string

type ClusterTitle struct {
	Title string `json:"title"`
}

type Configuration struct {
	ContainerResources *ContainerResources `json:"containerResources,omitempty"`
}

type ContainerResources struct {
	Selector          string        `json:"selector,omitempty"`
	Interval          api.Duration  `json:"interval,omitempty"`
	TargetUtilization *ResourceList `json:"targetUtilization,omitempty"`
	Tolerance         *ResourceList `json:"tolerance,omitempty"`
	Bounds            *Bounds       `json:"bounds,omitempty"`
	LimitRequestRatio *ResourceList `json:"limitRequestRatio,omitempty"`
}

type DeployConfiguration struct {
	Mode                   RecommendationsMode `json:"mode,omitempty"`
	Interval               api.Duration        `json:"interval,omitempty"`
	Limits                 []LimitRangeItem    `json:"limits,omitempty"`
	MaxRecommendationRatio *ResourceList       `json:"maxRecommendationRatio,omitempty"`
	Clusters               []string            `json:"clusters,omitempty"`
}

type LimitRangeItem struct {
	Type string        `json:"type,omitempty"`
	Max  *ResourceList `json:"max,omitempty"`
	Min  *ResourceList `json:"min,omitempty"`
}

type Lister struct {
	// API is the Application API used to fetch objects.
	API API
	// BatchSize overrides the default batch size for fetching lists.
	BatchSize int
}

type Parameter struct {
	Target             TargetRef     `json:"target"`
	ContainerResources []interface{} `json:"containerResources"`
	HPAResources       []interface{} `json:"hpaResources"`
}

type PollingSubscriber struct {
	// The API instance used to fetch the feed.
	API API
	// The URL to poll.
	FeedURL string
	// Time between polling requests. Defaults to 30 seconds.
	PollInterval time.Duration
	// Adjust the poll duration by a random amount. Defaults to 1.0, effectively
	// a random amount up to the full poll interval.
	JitterFactor float64
	// Flag indicating that failed activities should still be reported.
	ReportFailedActivities bool // TODO Should this be part of the ActivityFeedQuery?
	// contains filtered or unexported fields
}

type Recommendation struct {
	api.Metadata `json:"-"`
	Name         string      `json:"name"`
	DeployedAt   *time.Time  `json:"deployedAt,omitempty"`
	Parameters   []Parameter `json:"parameters,omitempty"`
}

type RecommendationItem struct {
	Recommendation
}

type RecommendationList struct {
	api.Metadata        `json:"-"`
	DeployConfiguration *DeployConfiguration `json:"deploy,omitempty"`
	Configuration       []Configuration      `json:"configuration,omitempty"`
	BackfillProgress    *BackfillProgress    `json:"backfillProgress,omitempty"`
	Recommendations     []RecommendationItem `json:"recommendations,omitempty"`
}

type RecommendationsMode string

type RefreshActivity struct {
	Application string `json:"application"`
	ActivityFailure
}

type Resource struct {
	Kubernetes struct {
		Namespace         string   `json:"namespace,omitempty" yaml:"namespace,omitempty"`
		Namespaces        []string `json:"namespaces,omitempty" yaml:"namespaces,omitempty"`
		NamespaceSelector string   `json:"namespaceSelector,omitempty" yaml:"namespaceSelector,omitempty"`
		Types             []string `json:"types,omitempty" yaml:"types,omitempty"`
		Selector          string   `json:"selector,omitempty" yaml:"selector,omitempty"`
	} `json:"kubernetes" yaml:"kubernetes"`
}

type ResourceList struct {
	CPU    *api.NumberOrString `json:"cpu,omitempty"`
	Memory *api.NumberOrString `json:"memory,omitempty"`
}

type RunActivity struct {
	Scenario string `json:"scenario"`
	ActivityFailure
}

type ScanActivity struct {
	Scenario string `json:"scenario"`
	ActivityFailure
}

type Scenario struct {
	api.Metadata  `json:"-"`
	Name          ScenarioName  `json:"name,omitempty"`
	DisplayName   string        `json:"title,omitempty"`
	Configuration []interface{} `json:"configuration,omitempty"`
	Objective     []interface{} `json:"objective,omitempty"`
	Clusters      []string      `json:"clusters,omitempty"`

	StormForgePerformance interface{} `json:"stormforgePerf,omitempty"`
	Locust                interface{} `json:"locust,omitempty"`
	Custom                interface{} `json:"custom,omitempty"`
}

type ScenarioItem struct {
	Scenario
}

type ScenarioList struct {
	// The scenario list metadata.
	api.Metadata `json:"-"`
	// The total number of items in the collection.
	TotalCount int `json:"totalCount,omitempty"`
	// The list of scenarios.
	Scenarios []ScenarioItem `json:"scenarios,omitempty"`
}

type ScenarioListQuery struct{ api.IndexQuery }

type ScenarioName string

type Subscriber interface {
	// Subscribe initiates a subscription that continues for the lifetime of the context.
	Subscribe(ctx context.Context, ch chan<- ActivityItem) error
}

type TargetRef struct {
	Kind      string `json:"kind,omitempty"`
	Namespace string `json:"namespace,omitempty"`
	Workload  string `json:"workload,omitempty"`
}

type Template struct {
	// The list of parameters for this template.
	Parameters []TemplateParameter `json:"parameters,omitempty"`
	// The list of metrics for this template.
	Metrics []TemplateMetric `json:"metrics,omitempty"`
}

type TemplateMetric struct {
	// The name of the metric.
	Name string `json:"name"`
	// The flag indicating this metric should be minimized.
	Minimize bool `json:"minimize,omitempty"`
	// The flag indicating this metric is optimized (nil defaults to true).
	Optimize *bool `json:"optimize,omitempty"`
	// The domain of the metric
	Bounds *TemplateMetricBounds `json:"bounds,omitempty"`
}

type TemplateMetricBounds struct {
	// The minimum value for a metric.
	Min float64 `json:"min,omitempty"`
	// The maximum value for a metric.
	Max float64 `json:"max,omitempty"`
}

type TemplateParameter struct {
	// The name of the parameter.
	Name string `json:"name"`
	// The type of the parameter.
	Type string `json:"type"`
	// The optional baseline value of the parameter, either numeric or categorical.
	Baseline *api.NumberOrString `json:"baseline,omitempty"`
	// The domain of the parameter.
	Bounds *TemplateParameterBounds `json:"bounds,omitempty"`
	// The list of allowed categorical values for the parameter.
	Values []string `json:"values,omitempty"`
}

type TemplateParameterBounds struct {
	// The minimum value for a numeric parameter.
	Min json.Number `json:"min,omitempty"`
	// The maximum value for a numeric parameter.
	Max json.Number `json:"max,omitempty"`
}

type Tolerance api.NumberOrString