houston

Documentation

Index

• Variables
• type AuthConfig
• type AuthUser
• type Client
  • func NewHoustonClient(c *httputil.HTTPClient) *Client
  • func (c *Client) Do(doOpts httputil.DoOptions) (*Response, error)
• type Decoded
• type Deployment
• type DeploymentInfo
• type Email
• type Error
• type GraphQLQuery
• type Request
  • func (r *Request) Do() (*Response, error)
• type Response
• type ServiceAccount
• type Status
• type Token
• type TokenPayload
• type User
• type Workspace

Variables

var (
	AuthConfigGetRequest = `` /* 169-byte string literal not displayed */

	DeploymentCreateRequest = `` /* 322-byte string literal not displayed */

	DeploymentDeleteRequest = `` /* 227-byte string literal not displayed */

	DeploymentsGetRequest = `` /* 357-byte string literal not displayed */

	DeploymentUpdateRequest = `` /* 263-byte string literal not displayed */

	ServiceAccountCreateRequest = `` /* 389-byte string literal not displayed */

	ServiceAccountDeleteRequest = `` /* 265-byte string literal not displayed */

	ServiceAccountsGetRequest = `` /* 342-byte string literal not displayed */

	TokenBasicCreateRequest = `` /* 246-byte string literal not displayed */

	UserCreateRequest = `` /* 328-byte string literal not displayed */

	WorkspacesGetRequest = `` /* 236-byte string literal not displayed */

	WorkspaceCreateRequest = `` /* 210-byte string literal not displayed */

	WorkspaceDeleteRequest = `` /* 171-byte string literal not displayed */

	WorkspaceUpdateRequest = `` /* 226-byte string literal not displayed */

	WorkspaceUserAddRequest = `` /* 241-byte string literal not displayed */

	WorkspaceUserRemoveRequest = `` /* 311-byte string literal not displayed */

)

var PermissionsError = errors.New("You do not have the appropriate permissions for that")

Types

type AuthConfig

type AuthConfig struct {
	LocalEnabled  bool `json:"localEnabled"`
	GoogleEnabled bool `json:"googleEnabled"`
	GithubEnabled bool `json:"githubEnabled"`
	Auth0Enabled  bool `json:"auth0Enabled"`
}

AuthConfig holds data related to oAuth and basic authentication

type AuthUser

type AuthUser struct {
	User  User  `json:"user"`
	Token Token `json:"token"`
}

type Client

type Client struct {
	HTTPClient *httputil.HTTPClient
}

Client containers the logger and HTTPClient used to communicate with the HoustonAPI

func NewHoustonClient

func NewHoustonClient(c *httputil.HTTPClient) *Client

NewHoustonClient returns a new Client with the logger and HTTP client setup.

func (*Client) Do

func (c *Client) Do(doOpts httputil.DoOptions) (*Response, error)

Do executes a query against the Houston API, logging out any errors contained in the response object

type Decoded

type Decoded struct {
	ID  string `json:"id"`
	SU  bool   `json:"sU"`
	Iat int    `json:"iat"`
	Exp int    `json:"exp"`
}

Decoded defines structure of a houston response Decoded object

type Deployment

type Deployment struct {
	Id             string         `json:"id"`
	Type           string         `json:"type"`
	Label          string         `json:"label"`
	ReleaseName    string         `json:"releaseName"`
	Version        string         `json:"version"`
	DeploymentInfo DeploymentInfo `json:"deployInfo"`
	Workspace      Workspace      `json:"workspace"`
	CreatedAt      string         `json:"createdAt"`
	UpdatedAt      string         `json:"updatedAt"`
}

Deployment defines structure of a houston response Deployment object

type DeploymentInfo

type DeploymentInfo struct {
	Latest string `json:"latest"`
	Next   string `json:"next"`
}

DeploymentInfo contains registry related information for a deployment

type Email

type Email struct {
	Address  string `json:"address"`
	Verified bool   `json:"verified"`
	Primary  bool   `json:"primary"`
}

Email contains various pieces of a users email

type Error

type Error struct {
	Message string `json:"message"`
	Name    string `json:"name"`
}

Error defines struct of a houston response Error object

type GraphQLQuery

type GraphQLQuery struct {
	Query string `json:"query"`
}

GraphQLQuery wraps a graphql query string

type Request

type Request struct {
	Query     string                 `json:"query"`
	Variables map[string]interface{} `json:"variables"`
}

func (*Request) Do

func (r *Request) Do() (*Response, error)

Do (request) is a wrapper to more easily pass variables to a client.Do request

type Response

type Response struct {
	Data struct {
		AddWorkspaceUser     *Workspace       `json:"workspaceAddUser,omitempty"`
		RemoveWorkspaceUser  *Workspace       `json:"workspaceRemoveUser,omitempty"`
		CreateDeployment     *Deployment      `json:"createDeployment,omitempty"`
		CreateToken          *AuthUser        `json:"createToken,omitempty"`
		CreateServiceAccount *ServiceAccount  `json:"createServiceAccount,omitempty"`
		CreateUser           *AuthUser        `json:"createUser,omitempty"`
		CreateWorkspace      *Workspace       `json:"createWorkspace,omitempty"`
		DeleteDeployment     *Deployment      `json:"deleteDeployment,omitempty"`
		DeleteServiceAccount *ServiceAccount  `json:"deleteServiceAccount,omitempty"`
		DeleteWorkspace      *Workspace       `json:"deleteWorkspace,omitempty"`
		GetDeployments       []Deployment     `json:"deployments,omitempty"`
		GetAuthConfig        *AuthConfig      `json:"authConfig,omitempty"`
		GetServiceAccounts   []ServiceAccount `json:"serviceAccounts,omitempty"`
		GetUsers             []User           `json:"users,omitempty"`
		GetWorkspaces        []Workspace      `json:"workspaces,omitempty"`
		UpdateDeployment     *Deployment      `json:"updateDeployment,omitempty"`
		UpdateWorkspace      *Workspace       `json:"updateWorkspace,omitempty"`
	} `json:"data"`
	Errors []Error `json:"errors,omitempty"`
}

Response wraps all houston response structs used for json marashalling

type ServiceAccount

type ServiceAccount struct {
	Id         string `json:"id"`
	ApiKey     string `json:"apiKey"`
	Label      string `json:"label"`
	Category   string `json:"category"`
	EntityType string `json:"entityType"`
	EntityId   string `json:"entityId"`
	LastUsedAt string `json:"lastUsedAt"`
	Active     bool   `json:"active"`
}

ServiceACcount defines a structure of a ServiceAccountResponse object

type Status

type Status struct {
	Success bool   `json:"success"`
	Message string `json:"message"`
	Code    string `json:"code"`
	Id      string `json:"id"`
}

Status defines structure of a houston response StatusResponse object

type Token

type Token struct {
	Value   string       `json:"value"`
	Payload TokenPayload `json:"payload"`
}

Token contains a houston auth token as well as it's payload of components

type TokenPayload

type TokenPayload struct {
	Id  string `json:"id"`
	Iat int    `json:"iat"`
	Exp int    `json:"exp"`
}

TokenPayload contains components of a houston auth token

type User

type User struct {
	Id       string  `json:"id"`
	Emails   []Email `json:"emails"`
	Username string  `json:"username"`
	Status   string  `json:"status"`
}

User contains all components of an Astronomer user

type Workspace

type Workspace struct {
	Id          string `json:"id"`
	Label       string `json:"label"`
	Description string `json:"description"`
	Active      bool   `json:"active"`
	Users       []User `json:"users"`
	// groups
	CreatedAt string `json:"createdAt"`
	UpdatedAt string `json:"updatedAt"`
}

Workspace contains all components of an Astronomer Workspace