api

Documentation

Index

• func GetUser(ctx context.Context, log *logger.Logger) string
• func WithUser(ctx context.Context, username string) context.Context
• type ErrorPayload
  • func NewErrAPIPayloadFromError(err error, code, detail string) ErrorPayload
  • func NewErrAPIPayloadFromMessage(code, title, detail string) ErrorPayload
• type ErrorPayloadItem
• type ExecuteInput
• type Links
• type Meta
  • func NewMeta(count int) *Meta
• type SuccessPayload
  • func NewSuccessPayload(data interface{}) SuccessPayload

Functions

func GetUser

func GetUser(ctx context.Context, log *logger.Logger) string

GetUser returns a username from a given context.

func WithUser

func WithUser(ctx context.Context, username string) context.Context

WithUser returns a copy of a given context that contains a given username.

Types

type ErrorPayload

type ErrorPayload struct {
	Errors []ErrorPayloadItem `json:"errors"`
}

ErrorPayload represents a uniform format for all error API responses.

func NewErrAPIPayloadFromError

func NewErrAPIPayloadFromError(err error, code, detail string) ErrorPayload

func NewErrAPIPayloadFromMessage

func NewErrAPIPayloadFromMessage(code, title, detail string) ErrorPayload

type ErrorPayloadItem

type ErrorPayloadItem struct {
	Code   string `json:"code"`
	Title  string `json:"title"`
	Detail string `json:"detail"`
}

ErrorPayloadItem represents a uniform format for a single error used in API responses.

type ExecuteInput

type ExecuteInput struct {
	Command     string `json:"command"`
	Script      string `json:"script"`
	Interpreter string `json:"interpreter"`
	Cwd         string `json:"cwd"`
	IsSudo      bool   `json:"is_sudo"`
	TimeoutSec  int    `json:"timeout_sec"`
	ClientID    string
	IsScript    bool
}

type Links

type Links interface{}

type Meta

type Meta struct {
	Count int `json:"count"`
}

func NewMeta

func NewMeta(count int) *Meta

type SuccessPayload

type SuccessPayload struct {
	Data  interface{} `json:"data"`
	Meta  *Meta       `json:"meta,omitempty"`
	Links Links       `json:"links,omitempty"`
}

SuccessPayload represents a uniform format for all successful API responses.

func NewSuccessPayload

func NewSuccessPayload(data interface{}) SuccessPayload