tfeapi

Documentation

Overview

Package tfeapi provides common functionality useful for implementation of the Hashicorp TFE/TFC API, which uses the json:api encoding

Index

• Constants
• func Error(w http.ResponseWriter, err error)
• func IsTerraformCLI(r *http.Request) bool
• func Unmarshal(r io.Reader, v any) error
• type Handlers
  • func (h *Handlers) AddHandlers(r *mux.Router)
• type IncludeFunc
• type IncludeName
• type Responder
  • func NewResponder() *Responder
  • func (i Responder) Register(name IncludeName, f IncludeFunc)
  • func (res *Responder) Respond(w http.ResponseWriter, r *http.Request, payload any, status int, ...)
  • func (res *Responder) RespondWithPage(w http.ResponseWriter, r *http.Request, items any, ...)

Constants

const (
	// APIPrefixV2 is the URL path prefix for TFE API endpoints
	APIPrefixV2 = "/api/v2/"
	// ModuleV1Prefix is the URL path prefix for module registry endpoints
	ModuleV1Prefix = "/v1/modules/"
)

Functions

func Error

func Error(w http.ResponseWriter, err error)

Error writes an HTTP response with a JSON-API encoded error.

func IsTerraformCLI

func IsTerraformCLI(r *http.Request) bool

func Unmarshal

func Unmarshal(r io.Reader, v any) error

Types

type Handlers

type Handlers struct{}

func (*Handlers) AddHandlers

func (h *Handlers) AddHandlers(r *mux.Router)

type IncludeFunc

type IncludeFunc func(context.Context, any) ([]any, error)

IncludeFunc retrieves the resource for inclusion

type IncludeName

type IncludeName string

IncludeName is the name used in the query parameter to request a resource be included, i.e. /?include=<IncludeName>

const (
	IncludeOrganization IncludeName = "organization"
	IncludeWorkspace    IncludeName = "workspace"
	IncludeWorkspaces   IncludeName = "workspaces"
	IncludeCurrentRun   IncludeName = "current_run"
	IncludeConfig       IncludeName = "configuration_version"
	IncludeIngress      IncludeName = "ingress_attributes"
	IncludeUsers        IncludeName = "users"
	IncludeCreatedBy    IncludeName = "created_by"
	IncludeOutputs      IncludeName = "outputs"
)

type Responder

type Responder struct {
	// contains filtered or unexported fields
}

Responder handles responding to API requests.

func NewResponder

func NewResponder() *Responder

func (Responder) Register

func (i Responder) Register(name IncludeName, f IncludeFunc)

Register registers an IncludeFunc to be called whenever IncludeName is specified in an API query.

func (*Responder) Respond

func (res *Responder) Respond(w http.ResponseWriter, r *http.Request, payload any, status int, opts ...jsonapi.MarshalOption)

func (*Responder) RespondWithPage

func (res *Responder) RespondWithPage(w http.ResponseWriter, r *http.Request, items any, pagination *resource.Pagination)