rest

Documentation

Index

• type Client
  • func NewClient(options ...Options) *Client
  • func (c *Client) Auth(ctx context.Context, clientid string, clientsecret *config.Plaintext)
  • func (c *Client) Delete(ctx context.Context, endpoint string, request any) (resp *http.Response, err error)
  • func (c *Client) Get(ctx context.Context, endpoint string, request any, response any) (resp *http.Response, err error)
  • func (c *Client) Post(ctx context.Context, endpoint string, request any, response any) (resp *http.Response, err error)
  • func (c *Client) Put(ctx context.Context, endpoint string, request any, response any) (resp *http.Response, err error)
  • func (c *Client) SetAuth(header, value string)
• type Options
  • func BaseURL(baseurl string) Options
  • func HTTPClient(client *http.Client) Options
  • func SetupRequestFunc(f func(req *http.Request, c *Client, endpoint string, body []byte)) Options

Types

type Client

type Client struct {
	BaseURL    string
	HTTPClient *http.Client
	// if not nil, call SetUpRequest() just before the Do() call
	SetupRequest func(req *http.Request, c *Client, endpoint string, body []byte)
	// contains filtered or unexported fields
}

func NewClient

func NewClient(options ...Options) *Client

NewClient returns a *Client struct, ready to use. Unless options are supplied the base URL defaults to `https://localhost:443`.

func (*Client) Auth

func (c *Client) Auth(ctx context.Context, clientid string, clientsecret *config.Plaintext)

Auth with client ID and Secret. If clientid is empty just return, allowing callers to call with config values even when not set.

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, endpoint string, request any) (resp *http.Response, err error)

Delete Method

func (*Client) Get

func (c *Client) Get(ctx context.Context, endpoint string, request any, response any) (resp *http.Response, err error)

GET method. On successful return the response body will be closed.

func (*Client) Post

func (c *Client) Post(ctx context.Context, endpoint string, request any, response any) (resp *http.Response, err error)

POST method

func (*Client) Put

func (c *Client) Put(ctx context.Context, endpoint string, request any, response any) (resp *http.Response, err error)

PUT method

func (*Client) SetAuth

func (c *Client) SetAuth(header, value string)

SetAuth sets an explicit auth head and value for clients that do not use OAUTH etc.

type Options

type Options func(*restOptions)

Options are used to control behaviour of ICP functions

func BaseURL

func BaseURL(baseurl string) Options

BaseURL sets the root of the REST API URL. The default is "https://localhost:443"

func HTTPClient

func HTTPClient(client *http.Client) Options

HTTPClient sets the http.Client to use for requests. The default is the default http package client.

func SetupRequestFunc

func SetupRequestFunc(f func(req *http.Request, c *Client, endpoint string, body []byte)) Options