projects

Documentation

Overview

Package projects provides the project related business logic.

Index

• func CreateProject(ctx context.Context, be *backend.Backend, owner types.ID, name string) (*types.Project, error)
• func From(ctx context.Context) *types.Project
• func GetProject(ctx context.Context, be *backend.Backend, owner types.ID, name string) (*types.Project, error)
• func GetProjectFromAPIKey(ctx context.Context, be *backend.Backend, apiKey string) (*types.Project, error)
• func GetProjectFromSecretKey(ctx context.Context, be *backend.Backend, secretKey string) (*types.Project, error)
• func ListProjects(ctx context.Context, be *backend.Backend, owner types.ID) ([]*types.Project, error)
• func UpdateProject(ctx context.Context, be *backend.Backend, owner types.ID, id types.ID, ...) (*types.Project, error)
• func With(ctx context.Context, project *types.Project) context.Context

Functions

func CreateProject

func CreateProject(
	ctx context.Context,
	be *backend.Backend,
	owner types.ID,
	name string,
) (*types.Project, error)

CreateProject creates a project.

func From

func From(ctx context.Context) *types.Project

From returns the project from the context.

func GetProject

func GetProject(
	ctx context.Context,
	be *backend.Backend,
	owner types.ID,
	name string,
) (*types.Project, error)

GetProject returns a project by the given name.

func GetProjectFromAPIKey

func GetProjectFromAPIKey(ctx context.Context, be *backend.Backend, apiKey string) (*types.Project, error)

GetProjectFromAPIKey returns a project from an API key.

func GetProjectFromSecretKey

func GetProjectFromSecretKey(ctx context.Context, be *backend.Backend, secretKey string) (*types.Project, error)

GetProjectFromSecretKey returns a project from a secret key.

func ListProjects

func ListProjects(
	ctx context.Context,
	be *backend.Backend,
	owner types.ID,
) ([]*types.Project, error)

ListProjects lists all projects.

func UpdateProject

func UpdateProject(
	ctx context.Context,
	be *backend.Backend,
	owner types.ID,
	id types.ID,
	fields *types.UpdatableProjectFields,
) (*types.Project, error)

UpdateProject updates a project.

func With

func With(ctx context.Context, project *types.Project) context.Context

With creates a new context with the given Project.