tag

Documentation

Index

• Variables
• type Controller
  • func NewController() Controller
• type Option
• type Tag

Variables

var (
	// Ctl is a global tag controller instance
	Ctl = NewController()
)

Types

type Controller

type Controller interface {
	// Ensure
	Ensure(ctx context.Context, repositoryID, artifactID int64, name string) (int64, error)
	// Count returns the total count of tags according to the query.
	Count(ctx context.Context, query *q.Query) (total int64, err error)
	// List tags according to the query
	List(ctx context.Context, query *q.Query, option *Option) (tags []*Tag, err error)
	// Get the tag specified by ID
	Get(ctx context.Context, id int64, option *Option) (tag *Tag, err error)
	// Create the tag and returns the ID
	Create(ctx context.Context, tag *Tag) (id int64, err error)
	// Update the tag. Only the properties specified by "props" will be updated if it is set
	Update(ctx context.Context, tag *Tag, props ...string) (err error)
	// Delete the tag specified by ID with limitation check
	Delete(ctx context.Context, id int64) (err error)
	// DeleteTags deletes all tags
	DeleteTags(ctx context.Context, ids []int64) (err error)
}

Controller manages the tags

func NewController

func NewController() Controller

NewController creates an instance of the default repository controller

type Option

type Option struct {
	WithImmutableStatus bool
}

Option is used to specify the properties returned when listing/getting tags

type Tag

type Tag struct {
	tag.Tag
	Immutable bool `json:"immutable"`
}

Tag is the overall view of tag