client

Documentation

Index

• Variables
• func DynamicClientFromContext(ctx context.Context) client.Client
• func NewContextWithDynamicClient(ctx context.Context, client client.Client) context.Context
• func NewContextWithStaticClient(ctx context.Context, client client.Client) context.Context
• func RequestMutator(ctx context.Context, req *http.Request) error
• func StaticClientFromContext(ctx context.Context) client.Client
• type Client
  • func New(client client.Client, options *Options, ...) *Client
  • func (c *Client) Client(ctx context.Context) (*openapi.ClientWithResponses, error)
  • func (c *Client) HTTPClient(ctx context.Context) (*http.Client, error)
• type Options
  • func NewOptions() *Options
• type TokenIssuer
  • func NewTokenIssuer(client client.Client, identityOptions *Options, ...) *TokenIssuer
  • func (i *TokenIssuer) Context(ctx context.Context, traceName string) (context.Context, error)

Variables

var (
	ErrResponse = errors.New("unexpected http response")
)

Functions

func DynamicClientFromContext

func DynamicClientFromContext(ctx context.Context) client.Client

func NewContextWithDynamicClient

func NewContextWithDynamicClient(ctx context.Context, client client.Client) context.Context

func NewContextWithStaticClient

func NewContextWithStaticClient(ctx context.Context, client client.Client) context.Context

func RequestMutator

func RequestMutator(ctx context.Context, req *http.Request) error

requestMutator implements OAuth2 bearer token authorization.

func StaticClientFromContext

func StaticClientFromContext(ctx context.Context) client.Client

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client wraps up the raw OpenAPI client with things to make it useable e.g. authorization and TLS.

func New

func New(client client.Client, options *Options, clientOptions *coreclient.HTTPClientOptions) *Client

New creates a new client.

func (*Client) Client

func (c *Client) Client(ctx context.Context) (*openapi.ClientWithResponses, error)

Client returns a new OpenAPI client that can be used to access the API.

func (*Client) HTTPClient

func (c *Client) HTTPClient(ctx context.Context) (*http.Client, error)

HTTPClient returns a new http client that will transparently do oauth2 header injection and refresh token updates.

type Options

type Options = coreclient.HTTPOptions

func NewOptions

func NewOptions() *Options

NewOptions must be used to create options for consistency.

type TokenIssuer

type TokenIssuer struct {
	// contains filtered or unexported fields
}

func NewTokenIssuer

func NewTokenIssuer(client client.Client, identityOptions *Options, clientOptions *coreclient.HTTPClientOptions, serviceName, serviceVersion string) *TokenIssuer

func (*TokenIssuer) Context

func (i *TokenIssuer) Context(ctx context.Context, traceName string) (context.Context, error)

Context issues an access token for the non-user client/service and injects it into the context.