api

Documentation

Index

• func SetupAPIRouter() *mux.Router
• type API
• type Response

Functions

func SetupAPIRouter

func SetupAPIRouter() *mux.Router

SetupAPIRouter creates a router to handle load test API requests.

Types

type API

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

API contains information about all load tests.

type Response

type Response struct {
	Id      string           `json:"id,omitempty"`      // The load-test agent unique identifier.
	Message string           `json:"message,omitempty"` // Message contains information about the response.
	Status  *loadtest.Status `json:"status,omitempty"`  // Status contains the current status of the load test.
	Error   string           `json:"error,omitempty"`   // Error is set if there was an error during the operation.
}

Response contains the data returned by the HTTP server.