api

Documentation

Index

• type API
  • func New(baseURI string, keyStore *cluster.KeyStore) *API
  • func (a *API) ClusterURI(c *cluster.Cluster) string
  • func (a *API) MachineURI(c *cluster.Cluster, m *cluster.Machine) string
  • func (a *API) Router() *mux.Router
• type CreatedResponse
• type ErrorResponse

Types

type API

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

API represents the footloose REST API.

func New

func New(baseURI string, keyStore *cluster.KeyStore) *API

New creates a new object able to answer footloose REST API.

func (*API) ClusterURI

func (a *API) ClusterURI(c *cluster.Cluster) string

ClusterURI returns the URI identifying a cluster in the REST API.

func (*API) MachineURI

func (a *API) MachineURI(c *cluster.Cluster, m *cluster.Machine) string

MachineURI returns the URI identifying a machine in the REST API.

func (*API) Router

func (a *API) Router() *mux.Router

Router returns the API request router.

type CreatedResponse

type CreatedResponse struct {
	URI string `json:"uri"`
}

CreatedResponse is the response POST entry points return when a resource has been successfully created.

type ErrorResponse

type ErrorResponse struct {
	Error string `json:"error"`
}

ErrorResponse is the response API entry points return when they encountered an error.