gateway

Documentation

Index

• type API
• type Gateway

Types

type API

type API struct {
	ID        string `json:"id,omitempty"`
	CreatedAt int    `json:"created_at,omitempty"`

	Name           string `json:"name,omitempty"`
	OrganizationID string `json:"organizationID,omitempty"`
	Function       string `json:"function,omitempty"`

	Hosts   []string `json:"hosts,omitempty"`
	URIs    []string `json:"uris,omitempty"`
	Methods []string `json:"methods,omitempty"`

	Authentication string `json:"authentication,omitempty"`

	Enabled bool `json:"enabled,omitempty"`

	// i.e. http https
	Protocols []string `json:"protocols,omitempty"`

	// reference to tls certificates (a dispatch secret name)
	// TODO: will be replaced by SNI objects
	TLS string `json:"tls,omitempty"`

	CORS bool `json:"cors,omitempty"`
}

API represents the metadata of an API

type Gateway

type Gateway interface {
	AddAPI(ctx context.Context, api *API) (*API, error)
	GetAPI(ctx context.Context, name string) (*API, error)
	UpdateAPI(ctx context.Context, name string, api *API) (*API, error)
	DeleteAPI(ctx context.Context, api *API) error
}

Gateway defines interfaces the underlying API Gateway provides