apiclient

Documentation

Index

• type ErrorResponse
• type InfoSuccessResponse
  • func GetLatestAvailableVersion() (*InfoSuccessResponse, error)
• type RegistrationSuccessResponse
  • func RegisterSite(publicKey ssh.PublicKey, requestedSiteID string) (*RegistrationSuccessResponse, error)
• type RequestError
  • func (err RequestError) Error() string

Types

type ErrorResponse

type ErrorResponse struct {
	StatusCode int32  `json:"statusCode"`
	Message    string `json:"message"`
	Error      string `json:"error"`
}

ErrorResponse defines the json format in which the error response is returned

type InfoSuccessResponse

type InfoSuccessResponse struct {
	Version string `json:"version"`
}

InfoSuccessResponse defines the json format in which the info success response is returned

func GetLatestAvailableVersion

func GetLatestAvailableVersion() (*InfoSuccessResponse, error)

type RegistrationSuccessResponse

type RegistrationSuccessResponse struct {
	SiteID string `json:"siteId"`
	Domain string `json:"domain"`
}

RegistrationSuccessResponse defines the json format in which the registration success response is returned

func RegisterSite

func RegisterSite(publicKey ssh.PublicKey, requestedSiteID string) (*RegistrationSuccessResponse, error)

RegisterSite is a funtion used to obtain site id and register keys in the gateway

type RequestError

type RequestError struct {
	Message    string
	Details    string
	StatusCode int
}

RequestError is an error returned when the request finished with failure

func (RequestError) Error

func (err RequestError) Error() string