tag

Documentation

Index

• Variables
• type Core
  • func NewCore(log *zap.SugaredLogger, sqlxDB *sqlx.DB) Core
  • func (c Core) Create(ctx context.Context, nt NewTag, now time.Time) (Tag, error)
  • func (c Core) Delete(ctx context.Context, tagID string) error
  • func (c Core) QueryByID(ctx context.Context, tagID string) (Tag, error)
  • func (c Core) QueryWorkspaceTags(ctx context.Context, workspaceID string, pageNumber, rowsPerPage int) ([]Tag, error)
  • func (c Core) Update(ctx context.Context, tagID string, ut UpdateTag, now time.Time) error
• type NewTag
• type Tag
• type UpdateTag

Variables

var (
	ErrNotFound  = errors.New("tag not found")
	ErrInvalidID = errors.New("ID is not in its proper form")
)

Set of error variables for CRUD operations.

Types

type Core

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

Core manages the set of APIs for user access.

func NewCore

func NewCore(log *zap.SugaredLogger, sqlxDB *sqlx.DB) Core

NewCore constructs a core for user api access.

func (Core) Create

func (c Core) Create(ctx context.Context, nt NewTag, now time.Time) (Tag, error)

Create inserts a new tag into the database.

func (Core) Delete

func (c Core) Delete(ctx context.Context, tagID string) error

Delete removes a tag from the database.

func (Core) QueryByID

func (c Core) QueryByID(ctx context.Context, tagID string) (Tag, error)

QueryByID gets the specified tag from the database.

func (Core) QueryWorkspaceTags

func (c Core) QueryWorkspaceTags(ctx context.Context, workspaceID string, pageNumber, rowsPerPage int) ([]Tag, error)

QueryWorkspaceTags retrieves a list of existing workspace from the database.

func (Core) Update

func (c Core) Update(ctx context.Context, tagID string, ut UpdateTag, now time.Time) error

Update replaces a tag document in the database.

type NewTag

type NewTag struct {
	Name string `json:"name" validate:"required"`
	Wid  string `json:"wid"`
}

NewTag contains information needed to create a new tag.

type Tag

type Tag struct {
	ID          string    `json:"id"`
	Name        string    `json:"name"`
	Wid         string    `json:"wid"`
	DateCreated time.Time `json:"date_created"`
	DateUpdated time.Time `json:"date_updated"`
}

Tag represents an individual tag.

type UpdateTag

type UpdateTag struct {
	Name *string `json:"name"`
}

UpdateTag defines what information may be provided to modify an existing tag. All fields are optional so tag can send just the fields they want changed. It uses pointer fields ,so we can differentiate between a field that was not provided and a field that was provided as explicitly blank. Normally we do not want to use pointers to basic types ,but we make exceptions around marshalling/unmarshalling.