api

Documentation

Index

• func ErrorStatusCode(err error) (int, bool)
• type APIApp
• type APIDeployment
• type APIDomain
• type APIManifest
• type APISite
• type APIUser
• type Client
  • func NewClient(endpoint string) *Client
  • func NewClientWithTransport(endpoint string, transport http.RoundTripper) *Client
  • func (c *Client) AddUser(ctx context.Context, appID string, userID string) error
  • func (c *Client) AuthGitHubOIDC(ctx context.Context, oidcToken string) (string, error)
  • func (c *Client) ConfigureApp(ctx context.Context, appID string, conf *config.AppConfig) (*APIApp, error)
  • func (c *Client) CreateApp(ctx context.Context, appID string) (*APIApp, error)
  • func (c *Client) CreateDomain(ctx context.Context, appID string, domainName string, replaceApp string) (*APIDomain, error)
  • func (c *Client) CreateSite(ctx context.Context, appID string, siteName string) (*APISite, error)
  • func (c *Client) DeleteDomain(ctx context.Context, appID string, domainName string) (*APIDomain, error)
  • func (c *Client) DeleteUser(ctx context.Context, appID string, userID string) error
  • func (c *Client) Endpoint() string
  • func (c *Client) GetApp(ctx context.Context, id string) (*APIApp, error)
  • func (c *Client) GetDeployment(ctx context.Context, appID string, deploymentName string) (*APIDeployment, error)
  • func (c *Client) GetManifest(ctx context.Context) (*APIManifest, error)
  • func (c *Client) GetMe(ctx context.Context) (*APIUser, error)
  • func (c *Client) ListApps(ctx context.Context) ([]APIApp, error)
  • func (c *Client) ListDeployments(ctx context.Context, appID string) ([]APIDeployment, error)
  • func (c *Client) ListDomains(ctx context.Context, appID string) ([]APIDomain, error)
  • func (c *Client) ListSites(ctx context.Context, appID string) ([]APISite, error)
  • func (c *Client) ListUsers(ctx context.Context, appID string) ([]APIUser, error)
  • func (c *Client) OpenAuthGitHubSSH(ctx context.Context) (*websocket.Conn, error)
  • func (c *Client) SetupDeployment(ctx context.Context, appID string, name string, files []models.FileEntry, ...) (*models.Deployment, error)
  • func (c *Client) UpdateSite(ctx context.Context, appID string, siteName string, patch *SitePatchRequest) (*APISite, error)
  • func (c *Client) UploadDeploymentTarball(ctx context.Context, appID string, deploymentName string, tarball io.Reader, ...) (*models.Deployment, error)
• type HTTPStatusCodeError
  • func (e HTTPStatusCodeError) Error() string
  • func (e HTTPStatusCodeError) StatusCode() int
• type ServerError
  • func (e ServerError) Error() string
  • func (e ServerError) StatusCode() int
• type SitePatchRequest

Functions

func ErrorStatusCode

func ErrorStatusCode(err error) (int, bool)

Types

type APIApp

type APIApp struct {
	*models.App
	URL string `json:"url"`
}

type APIDeployment

type APIDeployment struct {
	*models.Deployment
	SiteName *string `json:"siteName"`
	URL      *string `json:"url"`
}

type APIDomain

type APIDomain struct {
	*models.Domain
}

type APIManifest

type APIManifest struct {
	Version             string `json:"version"`
	CustomDomainMessage string `json:"customDomainMessage,omitempty"`
}

type APISite

type APISite struct {
	*models.Site
	URL            string  `json:"url"`
	DeploymentName *string `json:"deploymentName"`
}

type APIUser

type APIUser struct {
	ID          string                `json:"id"`
	Name        string                `json:"name"`
	Credentials []models.CredentialID `json:"credentials"`
}

type Client

type Client struct {
	TokenFunc func(r *http.Request) (string, error)
	// contains filtered or unexported fields
}

func NewClient

func NewClient(endpoint string) *Client

func NewClientWithTransport

func NewClientWithTransport(endpoint string, transport http.RoundTripper) *Client

func (*Client) AddUser

func (c *Client) AddUser(ctx context.Context, appID string, userID string) error

func (*Client) AuthGitHubOIDC

func (c *Client) AuthGitHubOIDC(ctx context.Context, oidcToken string) (string, error)

func (*Client) ConfigureApp

func (c *Client) ConfigureApp(ctx context.Context, appID string, conf *config.AppConfig) (*APIApp, error)

func (*Client) CreateApp

func (c *Client) CreateApp(ctx context.Context, appID string) (*APIApp, error)

func (*Client) CreateDomain

func (c *Client) CreateDomain(ctx context.Context, appID string, domainName string, replaceApp string) (*APIDomain, error)

func (*Client) CreateSite

func (c *Client) CreateSite(ctx context.Context, appID string, siteName string) (*APISite, error)

func (*Client) DeleteDomain

func (c *Client) DeleteDomain(ctx context.Context, appID string, domainName string) (*APIDomain, error)

func (*Client) DeleteUser

func (c *Client) DeleteUser(ctx context.Context, appID string, userID string) error

func (*Client) Endpoint

func (c *Client) Endpoint() string

func (*Client) GetApp

func (c *Client) GetApp(ctx context.Context, id string) (*APIApp, error)

func (*Client) GetDeployment

func (c *Client) GetDeployment(ctx context.Context, appID string, deploymentName string) (*APIDeployment, error)

func (*Client) GetManifest

func (c *Client) GetManifest(ctx context.Context) (*APIManifest, error)

func (*Client) GetMe

func (c *Client) GetMe(ctx context.Context) (*APIUser, error)

func (*Client) ListApps

func (c *Client) ListApps(ctx context.Context) ([]APIApp, error)

func (*Client) ListDeployments

func (c *Client) ListDeployments(ctx context.Context, appID string) ([]APIDeployment, error)

func (*Client) ListDomains

func (c *Client) ListDomains(ctx context.Context, appID string) ([]APIDomain, error)

func (*Client) ListSites

func (c *Client) ListSites(ctx context.Context, appID string) ([]APISite, error)

func (*Client) ListUsers

func (c *Client) ListUsers(ctx context.Context, appID string) ([]APIUser, error)

func (*Client) OpenAuthGitHubSSH

func (c *Client) OpenAuthGitHubSSH(ctx context.Context) (*websocket.Conn, error)

func (*Client) SetupDeployment

func (c *Client) SetupDeployment(
	ctx context.Context,
	appID string,
	name string,
	files []models.FileEntry,
	siteConfig *config.SiteConfig,
) (*models.Deployment, error)

func (*Client) UpdateSite

func (c *Client) UpdateSite(
	ctx context.Context,
	appID string,
	siteName string,
	patch *SitePatchRequest,
) (*APISite, error)

func (*Client) UploadDeploymentTarball

func (c *Client) UploadDeploymentTarball(
	ctx context.Context,
	appID string,
	deploymentName string,
	tarball io.Reader,
	size int64,
) (*models.Deployment, error)

type HTTPStatusCodeError

type HTTPStatusCodeError struct {
	Status string
	Code   int
}

func (HTTPStatusCodeError) Error

func (e HTTPStatusCodeError) Error() string

func (HTTPStatusCodeError) StatusCode

func (e HTTPStatusCodeError) StatusCode() int

type ServerError

type ServerError struct {
	Message string
	Code    int
}

func (ServerError) Error

func (e ServerError) Error() string

func (ServerError) StatusCode

func (e ServerError) StatusCode() int

type SitePatchRequest

type SitePatchRequest struct {
	DeploymentName *string `json:"deploymentName,omitempty"`
}