v1

package

v0.2.1 Latest Latest Go to latest Published: Aug 30, 2021 License: Apache-2.0 Imports: 12 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/SamsungSLAV/boruta

Links

Open Source Insights

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 ¶

View Source

const State = util.Devel

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

View Source

const Version = "v1"

Version contains version string of the API.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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.

Source Files ¶

View all Source files

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