api

Documentation

Overview

Package api provides commmon functionality for the OTF API

Index

• Constants
• type Client
  • func NewClient(config Config) (*Client, error)
  • func (c *Client) Do(ctx context.Context, req *retryablehttp.Request, v interface{}) error
  • func (c *Client) Hostname() string
  • func (c *Client) NewRequest(method, path string, v interface{}) (*retryablehttp.Request, error)
• type Config
• type Handlers
  • func (h *Handlers) AddHandlers(r *mux.Router)

Constants

const (
	DefaultBasePath = "/otfapi"
	PingEndpoint    = "ping"
	DefaultAddress  = "localhost:8080"
)

Types

type Client

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

func NewClient

func NewClient(config Config) (*Client, error)

func (*Client) Do

func (c *Client) Do(ctx context.Context, req *retryablehttp.Request, v interface{}) error

Do sends an API request and returns the API response. The API response is JSONAPI decoded and the document's primary data is stored in the value pointed to by v, or returned as an error if an API error has occurred.

If v implements the io.Writer interface, the raw response body will be written to v, without attempting to first decode it.

The provided ctx must be non-nil. If it is canceled or times out, ctx.Err() will be returned.

func (*Client) Hostname

func (c *Client) Hostname() string

Hostname returns the server host:port.

func (*Client) NewRequest

func (c *Client) NewRequest(method, path string, v interface{}) (*retryablehttp.Request, error)

NewRequest creates an API request with proper headers and serialization.

A relative URL path can be provided, in which case it is resolved relative to the baseURL of the Client. Relative URL paths should always be specified without a preceding slash. Adding a preceding slash allows for ignoring the configured baseURL for non-standard endpoints.

If v is supplied, the value will be JSONAPI encoded and included as the request body. If the method is GET, the value will be parsed and added as query parameters.

type Config

type Config struct {
	// The address of the otf API.
	Address string
	// The base path on which the API is served.
	BasePath string
	// API token used to access the otf API.
	Token string
	// Headers that will be added to every request.
	Headers http.Header
	// Toggle retrying requests upon encountering transient errors.
	RetryRequests bool
	// RetryLogHook is invoked each time a request is retried.
	RetryLogHook retryablehttp.RequestLogHook
	// Override default http transport
	Transport http.RoundTripper
}

Config provides configuration details to the API client.

type Handlers

type Handlers struct{}

func (*Handlers) AddHandlers

func (h *Handlers) AddHandlers(r *mux.Router)