Documentation
¶
Index ¶
- Constants
- func Ambiguousf(format string, args ...any) error
- func Authf(format string, args ...any) error
- func NotFoundf(format string, args ...any) error
- func Runtimef(format string, args ...any) error
- func Validationf(format string, args ...any) error
- type AddWorkItemRequest
- type BoardStore
- type CommentStore
- type CreateIssueRequest
- type EditRequest
- type EditWorkItemRequest
- type Error
- type ErrorKind
- type FieldAssignment
- type FieldInput
- type FieldResolver
- func (r *FieldResolver) Definitions(ctx context.Context, projectID string) ([]domain.FieldDefinition, error)
- func (r *FieldResolver) Resolve(ctx context.Context, issue domain.Issue, ref domain.FieldRef, values []string, ...) (FieldAssignment, error)
- func (r *FieldResolver) ResolveForProject(ctx context.Context, project domain.Project, ref domain.FieldRef, ...) (FieldAssignment, error)
- type GroupStore
- type IssueCreate
- type IssueCreator
- type IssueIdentityStore
- type IssuePatch
- type IssueSearchStore
- type IssueStore
- type LinkRelationReference
- type LinkStore
- type Page
- type PageRequest
- type ProjectFieldStore
- type ProjectStore
- type ProjectTimeTrackingStore
- type RawAPI
- type RawResponse
- type SavedSearchStore
- type SavedSearchView
- type Service
- func (s *Service) AddComment(ctx context.Context, issue domain.IssueRef, text string) (domain.Comment, error)
- func (s *Service) AddIssueLink(ctx context.Context, source, target domain.IssueRef, ...) (domain.IssueLinkChange, error)
- func (s *Service) AddTag(ctx context.Context, ref domain.IssueRef, name string) error
- func (s *Service) AddWorkItem(ctx context.Context, ref domain.IssueRef, request AddWorkItemRequest) (domain.WorkItem, error)
- func (s *Service) ClearField(ctx context.Context, ref domain.IssueRef, field domain.FieldRef) (domain.Issue, error)
- func (s *Service) CreateIssue(ctx context.Context, req CreateIssueRequest) (domain.Issue, error)
- func (s *Service) EditComment(ctx context.Context, issue domain.IssueRef, commentID, text string) (domain.Comment, error)
- func (s *Service) EditIssue(ctx context.Context, ref domain.IssueRef, req EditRequest) (domain.Issue, error)
- func (s *Service) EditWorkItem(ctx context.Context, ref domain.IssueRef, itemID string, ...) (domain.WorkItem, error)
- func (s *Service) GetField(ctx context.Context, ref domain.IssueRef, field domain.FieldRef) (domain.IssueField, error)
- func (s *Service) GetIssue(ctx context.Context, ref domain.IssueRef) (domain.Issue, error)
- func (s *Service) GetWorkItem(ctx context.Context, ref domain.IssueRef, itemID string) (domain.WorkItem, error)
- func (s *Service) ListComments(ctx context.Context, issue domain.IssueRef, request PageRequest) ([]domain.Comment, error)
- func (s *Service) ListFields(ctx context.Context, ref domain.IssueRef) ([]domain.IssueField, error)
- func (s *Service) ListIssueLinks(ctx context.Context, source domain.IssueRef, reference LinkRelationReference, ...) (domain.IssueLinkList, error)
- func (s *Service) ListLinkTypes(ctx context.Context, request PageRequest) ([]domain.LinkType, error)
- func (s *Service) ListTags(ctx context.Context, ref domain.IssueRef) ([]domain.Tag, error)
- func (s *Service) ListWorkItemTypes(ctx context.Context, ref domain.IssueRef, request PageRequest) ([]domain.WorkItemType, error)
- func (s *Service) ListWorkItems(ctx context.Context, ref domain.IssueRef, request PageRequest) ([]domain.WorkItem, error)
- func (s *Service) MoveIssue(ctx context.Context, ref domain.IssueRef, projectRef domain.ProjectRef) (domain.Issue, error)
- func (s *Service) RemoveComment(ctx context.Context, issue domain.IssueRef, commentID string) error
- func (s *Service) RemoveIssueLink(ctx context.Context, source, target domain.IssueRef, ...) (domain.IssueLinkChange, error)
- func (s *Service) RemoveTag(ctx context.Context, ref domain.IssueRef, name string) error
- func (s *Service) RemoveWorkItem(ctx context.Context, ref domain.IssueRef, itemID string) (string, error)
- func (s *Service) ResolveIssueIdentity(ctx context.Context, ref domain.IssueRef) (domain.IssueIdentity, error)
- func (s *Service) ResolveSavedSearch(ctx context.Context, ref string) (domain.SavedSearch, error)
- func (s *Service) SearchIssues(ctx context.Context, query string, request PageRequest) ([]domain.IssueSummary, error)
- func (s *Service) SetField(ctx context.Context, ref domain.IssueRef, field domain.FieldRef, ...) (domain.Issue, error)
- func (s *Service) ViewSavedSearch(ctx context.Context, ref string, request PageRequest) (SavedSearchView, error)
- type TagStore
- type UserDirectoryStore
- type UserStore
- type WorkItemCreate
- type WorkItemPatch
- type WorkItemStore
- type WorkItemTypePatch
Constants ¶
View Source
const DefaultPageLimit = 50
Variables ¶
This section is empty.
Functions ¶
func Ambiguousf ¶
func Validationf ¶
Types ¶
type AddWorkItemRequest ¶ added in v0.4.0
type BoardStore ¶ added in v0.2.0
type CommentStore ¶ added in v0.3.0
type CommentStore interface {
ListComments(context.Context, domain.IssueRef, Page) ([]domain.Comment, error)
CreateComment(context.Context, domain.IssueRef, string) (domain.Comment, error)
EditComment(context.Context, domain.IssueRef, string, string) (domain.Comment, error)
SoftRemoveComment(context.Context, domain.IssueRef, string) error
}
type CreateIssueRequest ¶ added in v0.3.0
type CreateIssueRequest struct {
Project domain.ProjectRef
Summary string
Description *string
Fields []FieldInput
Tags []string
}
type EditRequest ¶
type EditRequest struct {
Summary *string
Description *string
Fields []FieldInput
AddTags []string
RemoveTags []string
}
type EditWorkItemRequest ¶ added in v0.4.0
type FieldAssignment ¶
type FieldAssignment struct {
Field domain.FieldDefinition
Value domain.FieldValue
}
type FieldInput ¶
type FieldResolver ¶
type FieldResolver struct {
// contains filtered or unexported fields
}
func NewFieldResolver ¶
func NewFieldResolver(fields ProjectFieldStore, users UserStore, groups GroupStore) *FieldResolver
func (*FieldResolver) Definitions ¶
func (r *FieldResolver) Definitions(ctx context.Context, projectID string) ([]domain.FieldDefinition, error)
func (*FieldResolver) ResolveForProject ¶ added in v0.3.0
func (r *FieldResolver) ResolveForProject(ctx context.Context, project domain.Project, ref domain.FieldRef, values []string) (FieldAssignment, error)
type GroupStore ¶
type IssueCreate ¶ added in v0.3.0
type IssueCreator ¶ added in v0.3.0
type IssueIdentityStore ¶ added in v0.4.0
type IssuePatch ¶
type IssuePatch struct {
Summary *string
Description *string
Fields []FieldAssignment
Tags *[]domain.Tag
}
func (IssuePatch) Empty ¶ added in v0.2.0
func (p IssuePatch) Empty() bool
type IssueSearchStore ¶ added in v0.3.0
type IssueStore ¶
type IssueStore interface {
GetIssue(context.Context, domain.IssueRef) (domain.Issue, error)
UpdateIssue(context.Context, domain.IssueRef, IssuePatch) error
MoveIssue(context.Context, domain.IssueRef, string) (domain.Issue, error)
AddIssueTag(context.Context, domain.IssueRef, domain.Tag) error
RemoveIssueTag(context.Context, domain.IssueRef, domain.Tag) error
}
type LinkRelationReference ¶ added in v0.4.0
type LinkStore ¶ added in v0.4.0
type LinkStore interface {
ListLinkTypes(context.Context, Page) ([]domain.LinkType, error)
ListLinkedIssues(context.Context, domain.IssueRef, domain.LinkRelation, Page) ([]domain.IssueSummary, error)
AddIssueLink(context.Context, domain.IssueRef, domain.LinkRelation, domain.IssueRef) error
RemoveIssueLink(context.Context, domain.IssueRef, domain.LinkRelation, domain.IssueRef) error
}
type PageRequest ¶ added in v0.3.0
func (PageRequest) Validate ¶ added in v0.3.0
func (r PageRequest) Validate() error
type ProjectFieldStore ¶
type ProjectStore ¶
type ProjectTimeTrackingStore ¶ added in v0.4.0
type SavedSearchStore ¶ added in v0.3.0
type SavedSearchView ¶ added in v0.3.0
type SavedSearchView struct {
Search domain.SavedSearch
Issues []domain.IssueSummary
}
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
func NewService ¶
func NewService(issues IssueStore, creator IssueCreator, issueSearch IssueSearchStore, savedSearches SavedSearchStore, fields ProjectFieldStore, projects ProjectStore, tags TagStore, users UserStore, groups GroupStore, boards BoardStore, comments CommentStore, workItems WorkItemStore, timeTracking ProjectTimeTrackingStore, userDirectory UserDirectoryStore, issueIdentity IssueIdentityStore, links LinkStore) *Service
func (*Service) AddComment ¶ added in v0.3.0
func (*Service) AddIssueLink ¶ added in v0.4.0
func (s *Service) AddIssueLink(ctx context.Context, source, target domain.IssueRef, reference LinkRelationReference) (domain.IssueLinkChange, error)
func (*Service) AddWorkItem ¶ added in v0.4.0
func (*Service) ClearField ¶
func (*Service) CreateIssue ¶ added in v0.3.0
func (*Service) EditComment ¶ added in v0.3.0
func (*Service) EditWorkItem ¶ added in v0.4.0
func (*Service) GetWorkItem ¶ added in v0.4.0
func (*Service) ListComments ¶ added in v0.3.0
func (*Service) ListFields ¶
func (*Service) ListIssueLinks ¶ added in v0.4.0
func (s *Service) ListIssueLinks(ctx context.Context, source domain.IssueRef, reference LinkRelationReference, request PageRequest) (domain.IssueLinkList, error)
func (*Service) ListLinkTypes ¶ added in v0.4.0
func (*Service) ListWorkItemTypes ¶ added in v0.4.0
func (s *Service) ListWorkItemTypes(ctx context.Context, ref domain.IssueRef, request PageRequest) ([]domain.WorkItemType, error)
func (*Service) ListWorkItems ¶ added in v0.4.0
func (*Service) RemoveComment ¶ added in v0.3.0
func (*Service) RemoveIssueLink ¶ added in v0.4.0
func (s *Service) RemoveIssueLink(ctx context.Context, source, target domain.IssueRef, reference LinkRelationReference) (domain.IssueLinkChange, error)
func (*Service) RemoveWorkItem ¶ added in v0.4.0
func (*Service) ResolveIssueIdentity ¶ added in v0.4.0
func (s *Service) ResolveIssueIdentity(ctx context.Context, ref domain.IssueRef) (domain.IssueIdentity, error)
ResolveIssueIdentity resolves canonical issue identity without loading issue details.
func (*Service) ResolveSavedSearch ¶ added in v0.4.0
ResolveSavedSearch resolves saved-search metadata without executing its query.
func (*Service) SearchIssues ¶ added in v0.3.0
func (s *Service) SearchIssues(ctx context.Context, query string, request PageRequest) ([]domain.IssueSummary, error)
func (*Service) ViewSavedSearch ¶ added in v0.3.0
func (s *Service) ViewSavedSearch(ctx context.Context, ref string, request PageRequest) (SavedSearchView, error)
ViewSavedSearch resolves a visible saved search then executes its stored query.
type UserDirectoryStore ¶ added in v0.4.0
type WorkItemCreate ¶ added in v0.4.0
type WorkItemPatch ¶ added in v0.4.0
type WorkItemStore ¶ added in v0.4.0
type WorkItemStore interface {
ListWorkItems(context.Context, domain.IssueRef, Page) ([]domain.WorkItem, error)
GetWorkItem(context.Context, domain.IssueRef, string) (domain.WorkItem, error)
CreateWorkItem(context.Context, domain.IssueRef, WorkItemCreate) (domain.WorkItem, error)
UpdateWorkItem(context.Context, domain.IssueRef, string, WorkItemPatch) (domain.WorkItem, error)
DeleteWorkItem(context.Context, domain.IssueRef, string) error
}
type WorkItemTypePatch ¶ added in v0.4.0
type WorkItemTypePatch struct {
Set bool
Value *domain.WorkItemType
}
Click to show internal directories.
Click to hide internal directories.