api

Documentation

Index

• func WithClient(ctx context.Context, client *Depot) context.Context
• type BuildReponse
• type BuilderHealthResponse
• type BuilderResponse
• type CLIAuthenticationResponse
• type Depot
  • func GetContextClient(ctx context.Context) *Depot
  • func NewDepot(baseURL string, token string) *Depot
  • func NewDepotFromEnv(token string) (*Depot, error)
  • func (d *Depot) AuthorizeDevice() (*TokenResponse, error)
  • func (d *Depot) CreateBuild(projectID string) (*BuildReponse, error)
  • func (d *Depot) FinishBuild(buildID string, buildErr error) error
  • func (d *Depot) GetBuilder(buildID string, platform string) (*BuilderResponse, error)
  • func (d *Depot) GetProjects() (*GetProjectsResponse, error)
  • func (d *Depot) LatestRelease() (*ReleaseResponse, error)
  • func (d *Depot) ReportBuilderHealth(buildID string, platform string, status string) (*BuilderHealthResponse, error)
• type ErrorResponse
• type FinishResponse
• type GetProjectsResponse
• type Project
• type ReleaseResponse
• type TokenRequest
• type TokenResponse

Functions

func WithClient

func WithClient(ctx context.Context, client *Depot) context.Context

Types

type BuildReponse

type BuildReponse struct {
	OK bool   `json:"ok"`
	ID string `json:"id"`
}

type BuilderHealthResponse

type BuilderHealthResponse struct {
	OK bool `json:"ok"`
}

type BuilderResponse

type BuilderResponse struct {
	OK           bool   `json:"ok"`
	Endpoint     string `json:"endpoint"`
	AccessToken  string `json:"accessToken"`
	BuilderState string `json:"builderState"`
	PollSeconds  int    `json:"pollSeconds"`
	Platform     string `json:"platform"`

	// Version 2 uses mTLS for authentication
	Version string `json:"version"`
	CACert  string `json:"caCert"`
	Cert    string `json:"cert"`
	Key     string `json:"key"`
}

type CLIAuthenticationResponse

type CLIAuthenticationResponse struct {
	RequestID  string `json:"requestID"`
	ExpiresIn  int    `json:"expiresIn"`
	Interval   int    `json:"interval"`
	ApproveURL string `json:"approveURL"`
	TokenURL   string `json:"tokenURL"`
}

type Depot

type Depot struct {
	BaseURL string
	// contains filtered or unexported fields
}

func GetContextClient

func GetContextClient(ctx context.Context) *Depot

func NewDepot

func NewDepot(baseURL string, token string) *Depot

func NewDepotFromEnv

func NewDepotFromEnv(token string) (*Depot, error)

func (*Depot) AuthorizeDevice

func (d *Depot) AuthorizeDevice() (*TokenResponse, error)

func (*Depot) CreateBuild

func (d *Depot) CreateBuild(projectID string) (*BuildReponse, error)

func (*Depot) FinishBuild

func (d *Depot) FinishBuild(buildID string, buildErr error) error

func (*Depot) GetBuilder

func (d *Depot) GetBuilder(buildID string, platform string) (*BuilderResponse, error)

func (*Depot) GetProjects

func (d *Depot) GetProjects() (*GetProjectsResponse, error)

func (*Depot) LatestRelease

func (d *Depot) LatestRelease() (*ReleaseResponse, error)

func (*Depot) ReportBuilderHealth

func (d *Depot) ReportBuilderHealth(buildID string, platform string, status string) (*BuilderHealthResponse, error)

type ErrorResponse

type ErrorResponse struct {
	OK    bool   `json:"ok"`
	Error string `json:"error"`
}

type FinishResponse

type FinishResponse struct {
	OK bool `json:"ok"`
}

type GetProjectsResponse

type GetProjectsResponse struct {
	OK       bool       `json:"ok"`
	Projects []*Project `json:"projects"`
}

type Project

type Project struct {
	ID      string `json:"id"`
	Name    string `json:"name"`
	OrgID   string `json:"orgID"`
	OrgName string `json:"orgName"`
}

type ReleaseResponse

type ReleaseResponse struct {
	OK          bool      `json:"ok"`
	Version     string    `json:"version"`
	URL         string    `json:"url"`
	PublishedAt time.Time `json:"publishedAt"`
}

type TokenRequest

type TokenRequest struct {
	RequestID string `json:"requestID"`
}

type TokenResponse

type TokenResponse struct {
	Token string `json:"token"`
}