The highest tagged major version is
Documentation
¶
Overview ¶
Package api provides controllers for each api endpoint. Controllers are "dumb wiring"; there is little to no application logic in this package. Controllers call and coordinate other packages to satisfy the api endpoint.
Index ¶
Constants ¶
View Source
const (
API_ROOT = "/api/v1/"
)
Variables ¶
View Source
var ( // Errors related to getting and setting traversers in the traverser repo. ErrDuplicateTraverser = errors.New("traverser already exists") ErrTraverserNotFound = errors.New("traverser not found") ErrInvalidTraverser = errors.New("traverser found, but type is invalid") // Error when Job Runner is shutting down and not starting new job chains ErrShuttingDown = errors.New("Job Runner is shutting down - no new job chains are being started") )
Functions ¶
This section is empty.
Types ¶
type API ¶
type API struct {
// contains filtered or unexported fields
}
api provides controllers for endpoints it registers with a router.
func NewAPI ¶
func NewAPI(appCtx app.Context, traverserFactory chain.TraverserFactory, traverserRepo cmap.ConcurrentMap, stat status.Manager, shutdownChan chan struct{}) *API
NewAPI creates a new API struct. It initializes an echo web server within the struct, and registers all of the API's routes with it.
Source Files
Click to show internal directories.
Click to hide internal directories.