docs

Documentation

Index

• func ClientFieldSpec(forOutput bool, extraChildren ...docs.FieldSpec) docs.FieldSpec
• func ServerCORSFieldSpec() docs.FieldSpec
• type ServerCORS
  • func NewServerCORS() ServerCORS
  • func (conf ServerCORS) WrapHandler(handler http.Handler) (http.Handler, error)

Functions

func ClientFieldSpec

func ClientFieldSpec(forOutput bool, extraChildren ...docs.FieldSpec) docs.FieldSpec

ClientFieldSpec returns a field spec for an http client component.

func ServerCORSFieldSpec

func ServerCORSFieldSpec() docs.FieldSpec

ServerCORSFieldSpec returns a field spec for an http server CORS component.

Types

type ServerCORS

type ServerCORS struct {
	Enabled        bool     `json:"enabled" yaml:"enabled"`
	AllowedOrigins []string `json:"allowed_origins" yaml:"allowed_origins"`
}

ServerCORS contains configuration for allowing CORS headers.

func NewServerCORS

func NewServerCORS() ServerCORS

NewServerCORS returns a new server CORS config with default fields.

func (ServerCORS) WrapHandler

func (conf ServerCORS) WrapHandler(handler http.Handler) (http.Handler, error)

WrapHandler wraps a provided HTTP handler with middleware that enables CORS requests (when configured).