botcheckapi

type Config struct {
	Checks botcheck.Store
	// KeyAvailable is whether the deployment can sign a proof-of-work
	// challenge (auth.browser_session.signing_key).
	KeyAvailable bool
	// Secret reads the stored secret a provider's key is in, refusing one
	// the bot check may not use (botcheck.SecretUse).
	Secret func(ctx context.Context, name string) (string, error)
	// Author resolves the acting admin.
	Author func(*http.Request) string
}

type List struct {
	Checks []View `json:"checks"`
	// KeyAvailable is whether a proof-of-work challenge can be signed: a
	// deployment with no browser-session signing key cannot.
	KeyAvailable bool `json:"key_available"`
}

type View struct {
	botcheck.Check
	// UsedBy is the endpoints that name the check; a check any endpoint names
	// cannot be deleted.
	UsedBy []string `json:"used_by"`
	// Usable is false for a proof of work on a deployment that cannot sign
	// one, which no endpoint can be bound to.
	Usable bool `json:"usable"`
}