v1

Documentation

Overview

Package v1 provides HTTP API version 1 of Boruta. Through this API clients may: * list, create, manage and get details of requests; * list, acquire, prolong access to and get details of workers.

Index

• Constants
• type API
  • func NewAPI(router *httptreemux.Group, requestsAPI boruta.Requests, ...) (api *API)

Constants

const State = util.Devel

State contains information about state of the API (devel, stable or obsolete).

const Version = "v1"

Version contains version string of the API.

Types

type API

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

API provides HTTP API handlers.

func NewAPI

func NewAPI(router *httptreemux.Group, requestsAPI boruta.Requests,
	workersAPI boruta.Workers) (api *API)

NewAPI takes router and registers HTTP API in it. htttreemux.PanicHandler function is set. Also other setting of the router may be modified.