api

Documentation

Index

• type AddComponentInput
• type AddComponentOutput
• type AddWorkspaceInput
• type AddWorkspaceOutput
• type ComponentDescription
• type DescribeComponentsInput
• type DescribeComponentsOutput
• type DescribeWorkspacesInput
• type DescribeWorkspacesOutput
• type PatchComponentInput
• type PatchComponentOutput
• type RemoveComponentInput
• type RemoveComponentOutput
• type RemoveWorkspaceInput
• type RemoveWorkspaceOutput
• type ResolveInput
• type ResolveOutput
• type ResolveWorkspaceInput
• type ResolveWorkspaceOutput
• type Store
• type WorkspaceDescription

Types

type AddComponentInput

type AddComponentInput struct {
	WorkspaceID string   `json:"workspaceId"`
	ID          string   `json:"id"`
	Name        string   `json:"name"`
	Type        string   `json:"type"`
	Spec        string   `json:"spec"`
	Created     string   `json:"created"`
	DependsOn   []string `json:"dependsOn"`
}

type AddComponentOutput

type AddComponentOutput struct {
}

type AddWorkspaceInput

type AddWorkspaceInput struct {
	ID   string `json:"id"`
	Root string `json:"root"`
}

type AddWorkspaceOutput

type AddWorkspaceOutput struct {
}

type ComponentDescription

type ComponentDescription struct {
	ID          string   `json:"id"`
	WorkspaceID string   `json:"workspaceId"`
	Name        string   `json:"name"`
	Type        string   `json:"type"`
	Spec        string   `json:"spec"`
	State       string   `json:"state"`
	Created     string   `json:"created"`
	DependsOn   []string `json:"dependsOn"`
}

type DescribeComponentsInput

type DescribeComponentsInput struct {
	WorkspaceID         string   `json:"workspaceId"`
	Refs                []string `json:"refs"`
	Types               []string `json:"types"`
	IncludeDependencies bool     `json:"includeDependencies"`
	IncludeDependents   bool     `json:"includeDependents"`
}

type DescribeComponentsOutput

type DescribeComponentsOutput struct {
	Components []ComponentDescription `json:"components"`
}

type DescribeWorkspacesInput

type DescribeWorkspacesInput struct {
	IDs []string `json:"ids"`
}

type DescribeWorkspacesOutput

type DescribeWorkspacesOutput struct {
	Workspaces []WorkspaceDescription `json:"workspaces"`
}

type PatchComponentInput

type PatchComponentInput struct {

	// ID of component to be patched.
	ID string `json:"id"`
	// If provided, renames component.
	Name string `json:"name"`
	// If provided, replaces component spec.
	Spec      string    `json:"spec"`
	State     string    `json:"state"`
	DependsOn *[]string `json:"dependsOn"`
}

type PatchComponentOutput

type PatchComponentOutput struct {
}

type RemoveComponentInput

type RemoveComponentInput struct {
	ID string `json:"id"`
}

type RemoveComponentOutput

type RemoveComponentOutput struct {
}

type RemoveWorkspaceInput

type RemoveWorkspaceInput struct {
	ID string `json:"id"`
}

type RemoveWorkspaceOutput

type RemoveWorkspaceOutput struct {
}

type ResolveInput

type ResolveInput struct {
	WorkspaceID string   `json:"workspaceId"`
	Refs        []string `json:"refs"`
}

type ResolveOutput

type ResolveOutput struct {
	IDs []*string `json:"ids"`
}

type ResolveWorkspaceInput

type ResolveWorkspaceInput struct {
	Ref string `json:"ref"`
}

type ResolveWorkspaceOutput

type ResolveWorkspaceOutput struct {
	ID *string `json:"id"`
}

type Store

type Store interface {
	// Returns workspace descriptions.
	DescribeWorkspaces(context.Context, *DescribeWorkspacesInput) (*DescribeWorkspacesOutput, error)
	AddWorkspace(context.Context, *AddWorkspaceInput) (*AddWorkspaceOutput, error)
	RemoveWorkspace(context.Context, *RemoveWorkspaceInput) (*RemoveWorkspaceOutput, error)
	ResolveWorkspace(context.Context, *ResolveWorkspaceInput) (*ResolveWorkspaceOutput, error)
	Resolve(context.Context, *ResolveInput) (*ResolveOutput, error)
	DescribeComponents(context.Context, *DescribeComponentsInput) (*DescribeComponentsOutput, error)
	AddComponent(context.Context, *AddComponentInput) (*AddComponentOutput, error)
	PatchComponent(context.Context, *PatchComponentInput) (*PatchComponentOutput, error)
	RemoveComponent(context.Context, *RemoveComponentInput) (*RemoveComponentOutput, error)
}

type WorkspaceDescription

type WorkspaceDescription struct {
	ID          string `json:"id"`
	Root        string `json:"root"`
	DisplayName string `json:"displayName"`
}