api

Documentation

Overview

Package api provides the daemon API.

Index

• type Client
  • func NewClient(cfg *config.Config) *Client
  • func (c *Client) Do(ctx context.Context, r *http.Request, v interface{}) (*http.Response, error)
  • func (c *Client) NewRequest(method, path string, query *url.Values, body interface{}) (*http.Request, error)
• type SessionClient
  • func (s *SessionClient) Get(ctx context.Context) (*apitypes.SessionStatus, error)
  • func (s *SessionClient) Login(ctx context.Context, email, passphrase string) error
• type VersionClient
  • func (v *VersionClient) Get(ctx context.Context) (*apitypes.Version, error)

Types

type Client

type Client struct {
	Session *SessionClient
	Version *VersionClient
	// contains filtered or unexported fields
}

Client exposes the daemon API.

func NewClient

func NewClient(cfg *config.Config) *Client

NewClient returns a new Client.

func (*Client) Do

func (c *Client) Do(ctx context.Context, r *http.Request, v interface{}) (*http.Response, error)

Do executes an http.Request, populating v with the JSON response on success.

If the request errors with a JSON formatted response body, it will be unmarshaled into the returned error.

func (*Client) NewRequest

func (c *Client) NewRequest(method, path string, query *url.Values,
	body interface{}) (*http.Request, error)

NewRequest constructs a new http.Request, with a body containing the json representation of body, if provided.

type SessionClient

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

SessionClient provides access to the daemon's user session related endpoints, for logging in/out, and checking your session status.

func (*SessionClient) Get

func (s *SessionClient) Get(ctx context.Context) (*apitypes.SessionStatus, error)

Get returns the status of the user's session.

func (*SessionClient) Login

func (s *SessionClient) Login(ctx context.Context, email, passphrase string) error

Login logs the user in using the provided email and passphrase

type VersionClient

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

VersionClient provides access to the daemon's /v1/version endpoint, for inspecting the daemon's release version.

func (*VersionClient) Get

func (v *VersionClient) Get(ctx context.Context) (*apitypes.Version, error)

Get returns the daemon's release version.