client

Documentation

Index

• type Manager
  • func NewManager(api WorkspacesClient, cli WorkspaceClient) *Manager
  • func (m *Manager) CreateWorkspace(ctx context.Context) (*model.Workspace, error)
  • func (m *Manager) DeleteWorkspace(ctx context.Context, id int64) (*model.APIResponse, error)
  • func (m *Manager) GetWorkspaces(ctx context.Context) (*model.Workspaces, error)
  • func (m *Manager) PushWorkspace(ctx context.Context, id int64, key string, secret string, passphrase string, ...) error
• type WorkspaceClient
• type WorkspacesClient

Types

type Manager

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

Manager is managing the required clients to interact with Structurizr. Use NewManager to get started

func NewManager

func NewManager(api WorkspacesClient, cli WorkspaceClient) *Manager

NewManager creates a new Manager with the required clients to interact with Structurizr

func (*Manager) CreateWorkspace

func (m *Manager) CreateWorkspace(ctx context.Context) (*model.Workspace, error)

CreateWorkspace creates a new workspace

func (*Manager) DeleteWorkspace

func (m *Manager) DeleteWorkspace(ctx context.Context, id int64) (*model.APIResponse, error)

DeleteWorkspace deletes a workspace

func (*Manager) GetWorkspaces

func (m *Manager) GetWorkspaces(ctx context.Context) (*model.Workspaces, error)

GetWorkspaces lists all workspaces

func (*Manager) PushWorkspace

func (m *Manager) PushWorkspace(
	ctx context.Context,
	id int64,
	key string,
	secret string,
	passphrase string,
	source string,
) error

PushWorkspace push a new version of a workspace from an existing file

type WorkspaceClient

type WorkspaceClient interface {
	// PushWorkspace push a new version of a workspace from an existing file
	PushWorkspace(ctx context.Context, id int64, key string, secret string, passphrase string, source string) error
}

type WorkspacesClient

type WorkspacesClient interface {
	GetWorkspaces(ctx context.Context) (*model.Workspaces, error)
	CreateWorkspace(ctx context.Context) (*model.Workspace, error)
	DeleteWorkspace(ctx context.Context, id int64) (*model.APIResponse, error)
}