v1

package

v0.0.0-...-202a999 Latest Latest Go to latest Published: Jun 11, 2020 License: BSD-3-Clause Imports: 31 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/facette/facette

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type API
- func NewAPI(router *httprouter.Router, storage *storage.Storage, ...) *API
type Message
type Options
type Version

Constants ¶

View Source

const Prefix = "/api/v1"

Prefix represents the versioned API prefix.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type API ¶

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

API represents an API instance.

func NewAPI ¶

func NewAPI(
	router *httprouter.Router,
	storage *storage.Storage,
	searcher *catalog.Searcher,
	poller *poller.Poller,
	config *config.Config,
	logger *logger.Logger,
) *API

NewAPI creates a new API instance.

type Message ¶

type Message struct {
	Message string `json:"message"`
}

Message represents an API message instance.

type Options ¶

type Options struct {
	Connectors []string               `json:"connectors"`
	Defaults   *config.DefaultsConfig `json:"defaults"`
	ReadOnly   bool                   `json:"read_only"`
}

Options represents an API options instance.

type Version ¶

type Version struct {
	Version   jsonutil.NullString `json:"version"`
	Branch    jsonutil.NullString `json:"branch"`
	Revision  jsonutil.NullString `json:"revision"`
	Compiler  string              `json:"compiler"`
	BuildDate jsonutil.NullString `json:"build_date"`
}

Version represents an API version information instance.

Source Files ¶

View all Source files

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