client

Documentation

Index

• Variables
• type AuthorizedRoundTripper
  • func (a *AuthorizedRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)
• type Client
  • func New() (Client, error)
  • func NewGuest() Client
• type CodeInfo
• type ErrorResponse
• type FileInfo
• type GeneratedRunbook
• type GuestRoundTripper
  • func (g *GuestRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)
• type QuestionInfo
• type RecordedCommand
• type Runbook
  • func (rb *Runbook) Commands() []string
• type RunbookInfo
• type Step
• type StepContent
  • func (sc *StepContent) UnmarshalJSON(data []byte) error
• type StepTypeEnum

Variables

var ErrCannotUseGuest = errors.New("cannot use guest client for this operation")

var ErrInvalidClient = errors.New("invalid client")

Types

type AuthorizedRoundTripper

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

func (*AuthorizedRoundTripper) RoundTrip

func (a *AuthorizedRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)

type Client

type Client interface {
	WhoAmI(ctx context.Context) (string, error)
	GenerateRunbookV2(ctx context.Context, commands []RecordedCommand) (*GeneratedRunbook, error)
	// Deprecated. Use GenerateRunbookV2 instead
	GenerateRunbook(ctx context.Context, commands []string) (*GeneratedRunbook, error)
	RunbookByID(ctx context.Context, id string) (*Runbook, error)
	Runbooks(ctx context.Context) ([]RunbookInfo, error)
	Ask(ctx context.Context, question QuestionInfo) (*Runbook, error)
	SaveRunbook(ctx context.Context, runbook *Runbook) (*GeneratedRunbook, error)
	Explain(ctx context.Context, code CodeInfo) (<-chan string, error)
	StepContentByStepID(ctx context.Context, stepID string) (*StepContent, error)
}

func New

func New() (Client, error)

func NewGuest

func NewGuest() Client

type CodeInfo

type CodeInfo struct {
	Code     string            `json:"code"`
	Tags     map[string]string `json:"tags,omitempty"`
	FileData []byte            `json:"file_data,omitempty"`
	FileName string            `json:"file_name,omitempty"`
}

type ErrorResponse

type ErrorResponse struct {
	Message string `json:"message"`
}

type FileInfo

type FileInfo struct {
	Mode    fs.FileMode `json:"mode,omitempty"`
	Content []byte      `json:"content,omitempty"`
	Path    string      `json:"path,omitempty"`
}

type GeneratedRunbook

type GeneratedRunbook struct {
	Runbook Runbook `json:"runbook"`
	URL     string  `json:"url"`
}

type GuestRoundTripper

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

func (*GuestRoundTripper) RoundTrip

func (g *GuestRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)

type QuestionInfo

type QuestionInfo struct {
	Question          string            `json:"question"`
	Tags              map[string]string `json:"tags,omitempty"`
	FileData          []byte            `json:"file_data,omitempty"`
	FileName          string            `json:"file_name,omitempty"`
	PreviousQuestions []string          `json:"previous_questions,omitempty"`
}

type RecordedCommand

type RecordedCommand struct {
	Command  string    `json:"command"`
	Prompt   string    `json:"prompt,omitempty"`
	FileInfo *FileInfo `json:"file_info,omitempty"`
}

type Runbook

type Runbook struct {
	RunbookID string `json:"runbook_id"`
	Title     string `json:"title"`
	Steps     []Step `json:"steps"`
}

func (*Runbook) Commands

func (rb *Runbook) Commands() []string

type RunbookInfo

type RunbookInfo struct {
	RunbookID string `json:"runbook_id"`
	Title     string `json:"title"`
}

type Step

type Step struct {
	Type        StepTypeEnum `json:"type"`
	Description string       `json:"description"`
	Command     string       `json:"command"`
}

type StepContent

type StepContent struct {
	Content []byte      `json:"content"`
	Mode    fs.FileMode `json:"mode"`
	Name    string      `json:"name"`
	DirPath string      `json:"dir_path"`
}

func (*StepContent) UnmarshalJSON

func (sc *StepContent) UnmarshalJSON(data []byte) error

UnmarshalJSON is a custom unmarshaler for StepContent that handles the mode as a float64.

type StepTypeEnum

type StepTypeEnum string

const (
	StepTypeCode StepTypeEnum = "code"
	StepTypeFile StepTypeEnum = "file"
)