httpapi

type Config struct {
	// Addr is the listen address, such as ":8088".
	Addr string

	// Coordinator supplies the data and receives the commands.
	Coordinator *coordinator.Coordinator

	Logger *slog.Logger

	// AllowedOrigins lists the browser origins permitted to open a WebSocket.
	// Empty means same-origin only, which is what a normal deployment wants;
	// the frontend dev server needs its own origin added.
	AllowedOrigins []string

	// ReadOnly refuses every mutating request. Useful when exposing a live
	// run to an audience who should not be able to stop it.
	ReadOnly bool

	// OnShutdown ends the whole process, if the deployment allows it.
	//
	// Separate from stopping a run on purpose. Stopping a run has to leave
	// the coordinator up — the operator still wants the results, the report,
	// and usually another run — so shutting down needs its own deliberate
	// action rather than being a side effect of the last run ending.
	//
	// Nil disables the endpoint.
	OnShutdown func(reason string)

	// Registry holds the scenarios compiled into this binary.
	//
	// Needed so that validation can tell a configuration referring to a Go
	// scenario this binary does not have from one that is merely misspelled —
	// a distinction the scenario builder has no other way to make.
	Registry *loadwave.Registry
}

type Server struct {
	// contains filtered or unexported fields
}

type ValidateResult struct {
	Valid bool `json:"valid"`

	// Error is the parser's own message, verbatim, when the configuration is
	// rejected. It carries the offending line and field, which is far more
	// use to somebody editing a form than a reworded summary would be.
	Error string `json:"error,omitempty"`

	Summary *ValidateSummary `json:"summary,omitempty"`
}

type ValidateScenario struct {
	Name        string `json:"name"`
	Weight      int    `json:"weight"`
	Description string `json:"description,omitempty"`
	// Steps is zero for a scenario compiled into the binary.
	Steps int `json:"steps"`
	// Source is "yaml" for a scenario defined by steps here, "go" for one
	// compiled in.
	Source string `json:"source"`
}

type ValidateSummary struct {
	Name            string             `json:"name"`
	BaseURL         string             `json:"baseURL,omitempty"`
	Profile         string             `json:"profile"`
	PeakVUs         int                `json:"peakVUs"`
	DurationSeconds float64            `json:"durationSeconds"`
	Iterations      uint64             `json:"iterations,omitempty"`
	IterationRate   int                `json:"iterationRate,omitempty"`
	WorkersPerAgent int                `json:"workersPerAgent,omitempty"`
	BetweenRequests string             `json:"betweenRequests"`
	PacingDefaulted bool               `json:"pacingDefaulted"`
	Scenarios       []ValidateScenario `json:"scenarios"`
	Thresholds      []string           `json:"thresholds,omitempty"`
}