shared

Documentation

Index

• Constants
• func MarshalError(err *WiretapError) []byte
• type WiretapConfiguration
• type WiretapError
  • func GenerateError(title string, status int, detail string, instance string) *WiretapError

Constants

const ConfigKey = "config"

const IndexFile = "index.html"

const UIAssetsLocation = "ui/dist/assets"

const UILocation = "ui/dist"

const WiretapPortPlaceholder = "%WIRETAP_PORT%"

Functions

func MarshalError

func MarshalError(err *WiretapError) []byte

Types

type WiretapConfiguration

type WiretapConfiguration struct {
	Contract         string   `json:"-"`
	RedirectHost     string   `json:"redirectHost,omitempty"`
	RedirectPort     string   `json:"redirectPort,omitempty"`
	RedirectBasePath string   `json:"redirectBasePath,omitempty"`
	RedirectProtocol string   `json:"redirectProtocol,omitempty"`
	RedirectURL      string   `json:"redirectURL,omitempty"`
	Port             string   `json:"port,omitempty"`
	MonitorPort      string   `json:"monitorPort,omitempty"`
	WebSocketPort    string   `json:"webSocketPort,omitempty"`
	GlobalAPIDelay   int      `json:"globalAPIDelay,omitempty"`
	FS               embed.FS `json:"-"`
}

type WiretapError

type WiretapError struct {
	Type     string `json:"type,omitempty"`   // URI reference to the type of problem
	Title    string `json:"title"`            // A short description of the issue
	Status   int    `json:"status,omitempty"` // HTTP status code.
	Detail   string `json:"detail"`           // explanation of the issue in detail.
	Instance string `json:"instance"`         // URI to the specific problem.
}

WiretapError is an rfc7807 compliant error struct

func GenerateError

func GenerateError(title string,
	status int,
	detail string,
	instance string) *WiretapError