echo

Documentation

Overview

Package echo contains API functionality for issuing echo requests to the API.

Index

• Constants
• Variables
• func TestMock(t *testing.T) http.Handler
• type API
  • func NewAPI(c client.Client) API

Constants

const (
	// EchoPath can be used to test connectivity with the API.
	EchoPath = "/api/v1/test/echo.json"
)

Variables

var ErrInvalidEchoResponse = errors.New("invalid echo value received")

ErrInvalidEchoResponse indicates that an error request returned an invalid value.

Functions

func TestMock

func TestMock(t *testing.T) http.Handler

TestMock creates a new http.Handler that emulated the echo API endpoint.

Types

type API

type API interface {
	Echo(ctx context.Context) error
}

API contains methods for echo calls.

func NewAPI

func NewAPI(c client.Client) API

NewAPI creates a new echo API instance with the given client.