api

Documentation

Index

• type ClientTLS
• type Config
• type HTTPClientTimeoutType
• type HTTPSnapRequest
• type SchemaConfig

Types

type ClientTLS

type ClientTLS struct {
	// CA
	Ca string

	// Public Crt
	Crt string
}

ClientTLS defines client crt and key

type Config

type Config interface {
	GetConfigPath(path string) string
	GetClientCert() (string, error)
	GetNamedClientOverride() (map[string]*ClientTLS, error)
	GetSchemaConfig(contentType string) (*SchemaConfig, error)
	GetCaCerts() ([]string, error)
	GetPeerClientKey() (string, error)
	IsSystemCertPoolEnabled() bool
	TimeoutOrDefault(timeoutType HTTPClientTimeoutType) time.Duration
	IsPeerTLSConfigEnabled() bool
	IsHeaderAllowed(name string) (bool, error)
}

Config configuration interface

type HTTPClientTimeoutType

type HTTPClientTimeoutType int

HTTPClientTimeoutType enumerates the different types of timeouts used by http client

const (
	Global HTTPClientTimeoutType = iota
	TransportTLSHandshake
	TransportResponseHeader
	TransportExpectContinue
	TransportIdleConn
	DialerTimeout
	DialerKeepAlive
)

Timeouts used by HTTP client

type HTTPSnapRequest

type HTTPSnapRequest struct {
	URL         string            // required
	Headers     map[string]string // required
	Body        string            // required
	NamedClient string            // optional
	PinSet      []string          // optional
}

HTTPSnapRequest is used to invoke http snap

type SchemaConfig

type SchemaConfig struct {
	// Content type
	Type string

	// Request schema
	Request string

	// Response schema
	Response string
}

SchemaConfig defines request and response schemas for content type