api

package

Go to main page

Versions in this module

v0

v0.1.2

May 15, 2026

Changes in this version

type APIHandler

+ func (ah *APIHandler) GetPlaybookLibrary(w http.ResponseWriter, r *http.Request)

+ func (ah *APIHandler) GetPlaybookLibraryCheck(w http.ResponseWriter, r *http.Request)

+ type GetPlaybookLibraryCheckResponse struct

+ LocalName string

+ LocalTestID string

+ LocalYaml string

+ RemoteID string

+ RemoteName string

+ RemoteURL string

+ RemoteYaml string

+ State string

type GetTestResponse

+ Description string

+ Tags []string

+ Version string

type GetTestsResponse

+ Description string

+ Tags []string

+ Version string

v0.1.1

Apr 22, 2026

Changes in this version

type APIHandler

+ func (ah *APIHandler) GetVersion(w http.ResponseWriter, r *http.Request)

+ type GetVersionResponse struct

+ Release string

+ Version string

v0.1.0

Apr 14, 2026

Changes in this version

+ const TaskResultFailure

+ const TaskResultNone

+ const TaskResultSuccess

+ const TaskStatusComplete

+ const TaskStatusPending

+ const TaskStatusRunning

+ type AIChatRequest struct

+ CurrentYaml string

+ Messages []ai.ChatMessage

+ Model string

+ TestName string

+ type AIChatStartResponse struct

+ SessionID string

+ type AIConfigResponse struct

+ AllowedModels []string

+ DefaultModel string

+ Enabled bool

+ ServerKeyConfigured bool

+ type AIHandler struct

+ func NewAIHandler(config *types.AIConfig, database *db.Database, logger logrus.FieldLogger, ...) *AIHandler

+ func (h *AIHandler) Chat(w http.ResponseWriter, r *http.Request)

+ func (h *AIHandler) GetChatSession(w http.ResponseWriter, r *http.Request)

+ func (h *AIHandler) GetConfig(w http.ResponseWriter, _ *http.Request)

+ func (h *AIHandler) GetSystemPrompt(w http.ResponseWriter, _ *http.Request)

+ func (h *AIHandler) GetUsage(w http.ResponseWriter, r *http.Request)

+ func (h *AIHandler) StreamChatSession(w http.ResponseWriter, r *http.Request)

+ func (h *AIHandler) ValidateYaml(w http.ResponseWriter, r *http.Request)

+ type AIUsageResponse struct

+ LastDay *db.AIUsageStats

+ LastMonth *db.AIUsageStats

+ type APIHandler struct

+ func NewAPIHandler(logger logrus.FieldLogger, coordinator types.Coordinator, ...) *APIHandler

+ func (ah *APIHandler) GetClients(w http.ResponseWriter, r *http.Request)

+ func (ah *APIHandler) GetGlobalVariables(w http.ResponseWriter, r *http.Request)

+ func (ah *APIHandler) GetLogs(w http.ResponseWriter, r *http.Request)

+ func (ah *APIHandler) GetTaskDescriptor(w http.ResponseWriter, r *http.Request)

+ func (ah *APIHandler) GetTaskDescriptors(w http.ResponseWriter, r *http.Request)

+ func (ah *APIHandler) GetTaskResult(w http.ResponseWriter, r *http.Request)

+ func (ah *APIHandler) GetTest(w http.ResponseWriter, r *http.Request)

+ func (ah *APIHandler) GetTestRun(w http.ResponseWriter, r *http.Request)

+ func (ah *APIHandler) GetTestRunDetails(w http.ResponseWriter, r *http.Request)

+ func (ah *APIHandler) GetTestRunStatus(w http.ResponseWriter, r *http.Request)

+ func (ah *APIHandler) GetTestRunTaskDetails(w http.ResponseWriter, r *http.Request)

+ func (ah *APIHandler) GetTestRuns(w http.ResponseWriter, r *http.Request)

+ func (ah *APIHandler) GetTestYaml(w http.ResponseWriter, r *http.Request)

+ func (ah *APIHandler) GetTests(w http.ResponseWriter, r *http.Request)

+ func (ah *APIHandler) PostTestRunCancel(w http.ResponseWriter, r *http.Request)

+ func (ah *APIHandler) PostTestRunsDelete(w http.ResponseWriter, r *http.Request)

+ func (ah *APIHandler) PostTestRunsSchedule(w http.ResponseWriter, r *http.Request)

+ func (ah *APIHandler) PostTestsDelete(w http.ResponseWriter, r *http.Request)

+ func (ah *APIHandler) PostTestsRegister(w http.ResponseWriter, r *http.Request)

+ func (ah *APIHandler) PostTestsRegisterExternal(w http.ResponseWriter, r *http.Request)

+ type ClientResponse struct

+ CLHeadRoot string

+ CLHeadSlot uint64

+ CLIsReady bool

+ CLLastError string

+ CLLastRefresh string

+ CLStatus string

+ CLType int64

+ CLVersion string

+ ELHeadHash string

+ ELHeadNumber uint64

+ ELIsReady bool

+ ELLastError string

+ ELLastRefresh string

+ ELStatus string

+ ELType int64

+ ELVersion string

+ Index int

+ Name string

+ type GetClientsResponse struct

+ ClientCount int

+ Clients []*ClientResponse

+ type GetGlobalVariablesResponse struct

+ Names []string

+ type GetLogsResponse struct

+ Log []*LogEntry

+ type GetTestResponse struct

+ BasePath string

+ Config map[string]any

+ ConfigVars map[string]string

+ ID string

+ Name string

+ Schedule *types.TestSchedule

+ Source string

+ Timeout uint64

+ Vars map[string]any

+ type GetTestRunDetailedTask struct

+ Completed bool

+ ConfigYaml string

+ Index uint64

+ Log []*GetTestRunDetailedTaskLog

+ Name string

+ ParentIndex uint64

+ Progress float64

+ ProgressMessage string

+ Result string

+ ResultError string

+ ResultYaml string

+ RunConcurrent bool

+ RunTime uint64

+ StartTime int64

+ Started bool

+ Status string

+ StopTime int64

+ Timeout uint64

+ Title string

+ type GetTestRunDetailedTaskLog struct

+ Data map[string]string

+ DataLen uint64

+ Level string

+ Message string

+ Time time.Time

+ type GetTestRunDetailsResponse struct

+ Name string

+ RunID uint64

+ StartTime int64

+ Status types.TestStatus

+ StopTime int64

+ Tasks []*GetTestRunDetailedTask

+ TestID string

+ type GetTestRunResponse struct

+ Name string

+ RunID uint64

+ StartTime int64

+ Status types.TestStatus

+ StopTime int64

+ Tasks []*GetTestRunTask

+ TestID string

+ type GetTestRunTask struct

+ Completed bool

+ Index uint64

+ Name string

+ ParentIndex uint64

+ Result string

+ ResultError string

+ ResultFiles []GetTestRunTaskResult

+ RunConcurrent bool

+ RunTime uint64

+ StartTime int64

+ Started bool

+ Status string

+ StopTime int64

+ Timeout uint64

+ Title string

+ type GetTestRunTaskResult struct

+ Index uint64

+ Name string

+ Size uint64

+ Type string

+ URL string

+ type GetTestRunsResponse struct

+ Name string

+ RunID uint64

+ StartTime int64

+ Status types.TestStatus

+ StopTime int64

+ TestID string

+ type GetTestYamlResponse struct

+ Source string

+ Yaml string

+ type GetTestsResponse struct

+ BasePath string

+ ID string

+ Name string

+ Source string

+ type LogEntry struct

+ Data map[string]string

+ DataLen uint64

+ Level uint64

+ LogIndex uint64

+ Message string

+ Time time.Time

+ type PostTestRunCancelRequest struct

+ SkipCleanup bool

+ TestID string

+ type PostTestRunCancelResponse struct

+ Name string

+ RunID uint64

+ Status string

+ TestID string

+ type PostTestRunsDeleteRequest struct

+ TestRuns []uint64

+ type PostTestRunsDeleteResponse struct

+ Deleted []uint64

+ Errors []string

+ type PostTestRunsScheduleRequest struct

+ AllowDuplicate bool

+ Config map[string]any

+ SkipQueue bool

+ TestID string

+ type PostTestRunsScheduleResponse struct

+ Config map[string]any

+ Name string

+ RunID uint64

+ TestID string

+ type PostTestsDeleteRequest struct

+ Tests []string

+ type PostTestsDeleteResponse struct

+ Deleted []string

+ Errors []string

+ type PostTestsRegisterExternalRequest struct

+ Config map[string]interface{}

+ ConfigVars map[string]string

+ File string

+ Name string

+ Schedule *types.TestSchedule

+ Timeout uint64

+ type PostTestsRegisterExternalResponse struct

+ Config map[string]any

+ Name string

+ TestID string

+ type PostTestsRegisterRequest struct

+ CleanupTasks []helper.RawMessage

+ Config map[string]interface{}

+ ConfigVars map[string]string

+ ID string

+ Name string

+ Schedule *types.TestSchedule

+ Tasks []helper.RawMessage

+ Timeout string

+ type PostTestsRegisterResponse struct

+ Config map[string]any

+ Name string

+ TestID string

+ type Response struct

+ Data any

+ Status string

+ type SystemPromptResponse struct

+ Prompt string

+ type ValidateYamlRequest struct

+ Yaml string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL