client

Documentation

Index

• type Endpoint
  • func (e *Endpoint) Validate() error
• type Endpoints
• type Expect
  • func NewExpect(headers http.Headers) *Expect
  • func (e *Expect) Validate(status http.Status, headers http.Headers) error
  • func (e *Expect) ValidateHeader(headers http.Headers) error
  • func (e *Expect) ValidateStatus(status http.Status) error

Types

type Endpoint

type Endpoint struct {
	validation.Validatable `json:"-"`
	Name                   string           `json:"name"          yaml:"Name"`
	Method                 http.Method      `json:"method"        yaml:"Method"`
	Path                   string           `json:"path"          yaml:"Path"`
	Description            string           `json:"description"   yaml:"Description"`
	Documentation          string           `json:"documentation" yaml:"Documentation"`
	Deprecated             string           `json:"deprecated"    yaml:"Deprecated"`
	Labels                 data.Map[string] `json:"labels"        yaml:"Labels"`
	Headers                http.Headers     `json:"headers"       yaml:"Headers"`
	Payload                any              `json:"payload"       yaml:"Payload"`
	Expect                 *Expect          `json:"expect"        yaml:"Expect"`
}

Endpoint is an HTTP client endpoint.

func (*Endpoint) Validate

func (e *Endpoint) Validate() error

Validate makes Endpoint validatable by implementing validation.Validatable interface.

type Endpoints

type Endpoints []*Endpoint

Endpoints represents the http client endpoints.

type Expect

type Expect struct {
	Status  http.Status  `json:"status"  yaml:"Status"`
	Headers http.Headers `json:"headers" yaml:"Headers"`
}

Expect is an HTTP response expectation.

func NewExpect

func NewExpect(headers http.Headers) *Expect

NewExpect creates a new Expect.

func (*Expect) Validate

func (e *Expect) Validate(status http.Status, headers http.Headers) error

Validate validates the given response.

func (*Expect) ValidateHeader

func (e *Expect) ValidateHeader(headers http.Headers) error

ValidateHeader validates the headers of the given response.

func (*Expect) ValidateStatus

func (e *Expect) ValidateStatus(status http.Status) error

ValidateStatus validates the status code of the given response.