devauth

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(config Config) (Client, error)
• type Config
  • func (conf Config) Validate() error
• type Device

Constants

const (
	URIInternal        = "/api/internal/v1/devauth"
	URIInternalDevices = URIInternal + "/tenants/:tenant/devices"
	URIInternalAlive   = URIInternal + "/alive"
)

const DefaultTimeout = time.Second * 10

Variables

var (
	ErrInvalidURL = errors.New("invalid URL format")
)

Types

type Client

type Client interface {
	Ping(ctx context.Context) error
	GetDevices(context.Context, []string) ([]Device, error)
}

Client interface exposing a portion of the internal deviceauth API.

func NewClient

func NewClient(config Config) (Client, error)

NewClient initializes a new client from the given configuration options.

type Config

type Config struct {
	// Client provides an option to override the http.Client used for
	// performing the requests.
	Client *http.Client
	// DevauthAddress is the base URI to the deviceauth service (requires
	// a minimal of an addressable hostname, to a full blown URL).
	DevauthAddress string
}

Config provides initialization options for creating a new client.

func (Config) Validate

func (conf Config) Validate() error

type Device

type Device struct {
	ID     string       `json:"id"`
	Status model.Status `json:"status"`
}

Device definition containing subset of the deviceauth model