jirarest

Aug 25, 2025

Changes in this version

+ type GetQueryOptions struct

+ ExpandChangelog bool

+ XIncludeParents bool

+ XMultiSkipNotFound bool

+ func (opts GetQueryOptions) Build() *jira.GetQueryOptions

type IssueMore

+ func (im *IssueMore) Keys() (keys []string, hasChangelog bool)

Apr 30, 2025

Changes in this version

type Client

+ func NewClientGoauthCredentialsSetFile(filename, accountkey string, addCustomFieldSet, inclAccountsOnError bool) (*Client, error)

type Issues

+ func (ii Issues) KeysSplitVenn(keys []string) slicesutil.SplitVennResultOrdered[string]

type IssuesSet

+ func (set *IssuesSet) HistogramSet(fieldSlug1, fieldSlug2 string) *histogram.HistogramSet

Feb 3, 2025

Changes in this version

type IssueService

+ func (svc *IssueService) WebURL() string

Feb 2, 2025

Changes in this version

type IssueService

+ func (svc *IssueService) JQLResultsTotalCount(jql string) (int, error)

+ func (svc *IssueService) JQLsAddMetadata(jqls gojira.JQLs) (gojira.JQLs, error)

+ func (svc *IssueService) JQLsReportMarkdownLines(headerPrefix string, jqls gojira.JQLs, opts gojira.JQLsReportMarkdownOpts) ([]string, error)

Nov 23, 2024

Changes in this version

+ type IssueMores []IssueMore

+ func (ii IssueMores) Keys(sortAsc, dedupe bool) []string

+ func (ii IssueMores) ProjectKeys(sortAsc, dedupe bool) []string

type IssuesSet

+ func (set *IssuesSet) Issue(key string) (jira.Issue, error)

+ func (set *IssuesSet) IssueMores(keys ...string) IssueMores

Nov 20, 2024

Changes in this version

+ var ErrKeyNotFound = errors.New("key not found")

+ var ErrNotFound = errors.New(...)

+ var ErrSimpleClientCannotBeNil = errors.New("simple client cannot be nil")

type Client

+ func NewClientGoauthCredentials(c *goauth.Credentials, addCustomFieldSet bool) (*Client, error)

type CustomFieldService

+ func (svc *CustomFieldService) GetCustomFieldSet() (*CustomFieldSet, error)

type CustomFieldSet

+ func (set *CustomFieldSet) CreateFuncIssueToMap(fieldsWithDefaults map[string]string, useCustomFieldDisplayNames bool) FuncIssueToMap

+ func (set *CustomFieldSet) IDToName(id string) (string, error)

+ type FuncIssueToMap func(iss *jira.Issue) (map[string]string, error)

Sep 9, 2024

Changes in this version

+ var ErrFunctionCannotBeNil = errors.New("function cannot be nil")

+ var ErrIssueCannotBeNil = errors.New("issue cannot be nil")

+ func IssueMapProjectStatusType(iss *jira.Issue) (map[string]string, error)

+ func IssueProjectkeyType(iss *jira.Issue) (string, string)

+ func IssueProjectkeyTypeStatus(iss *jira.Issue) (string, string, string)

type IssueMore

+ func (im *IssueMore) ValueOrDefault(fieldSlug, def string) string

type IssuesSet

+ func (set *IssuesSet) ExportWorkstreamFilter(wsFuncMake WorkstreamFuncMake, wsFuncIncl WorkstreamFuncIncl, ...) (*IssuesSet, error)

+ func (set *IssuesSet) FilterByType(inclTypes ...string) (*IssuesSet, error)

+ func (set *IssuesSet) HistogramMapFunc(fn func(iss *jira.Issue) (map[string]string, error)) (*histogram.Histogram, error)

+ func (set *IssuesSet) HistogramSetFunc(fn func(iss *jira.Issue) (cat1 string, cat2 string)) *histogram.HistogramSet

+ func (set *IssuesSet) HistogramSetsFunc(fn func(iss *jira.Issue) (cat1 string, cat2 string, cat3 string)) *histogram.HistogramSets

+ type IssuesSets struct

+ Data map[string]IssuesSet

+ Order []string

+ func NewIssuesSets() *IssuesSets

+ func (sets *IssuesSets) OrderOrDefault() []string

+ func (sets *IssuesSets) TableSet(tblColsMapKeys []string, contColumnName string, ...) (*table.TableSet, error)

+ func (sets *IssuesSets) Upsert(setName string, set *IssuesSet)

+ func (sets *IssuesSets) UpsertIssueKeys(jrClient *Client, setName string, issueKeys []string) error

Sep 9, 2024

Changes in this version

+ const OperationAdd

+ const OperationRemove

+ var ErrCustomFieldLabelRequired = errors.New("custom field label is required")

+ var ErrIssueOrIssueKeyOrIssueIDRequired = errors.New("issue, issue id, or issue key required")

type Client

+ BacklogAPI *BacklogService

+ CustomFieldAPI *CustomFieldService

+ LoggerZ *zerolog.Logger

+ func (c *Client) LogOrNotAny(ctx context.Context, level slog.Level, msg string, attrs ...any)

+ type CustomFieldService struct

+ JRClient *Client

+ func NewCustomFieldService(client *Client) *CustomFieldService

+ func (svc *CustomFieldService) GetCustomField(customFieldName string) (CustomField, error)

+ func (svc *CustomFieldService) GetCustomFieldEpicLink() (CustomField, error)

+ func (svc *CustomFieldService) GetCustomFields() (CustomFields, error)

type IssueMore

+ func (im *IssueMore) KeyLinkWebMarkdown(baseURL string) string

+ func (im *IssueMore) KeyURLWeb(baseURL string) string

type IssuePatchRequestBody

+ Update *IssuePatchRequestBodyUpdate

+ func NewIssuePatchRequestBodyCustomField(customFieldLabel, customFieldValue string) IssuePatchRequestBody

+ func NewIssuePatchRequestBodyLabelAddRemove(label string, remove bool) IssuePatchRequestBody

+ func (body IssuePatchRequestBody) Validate() error

+ type IssuePatchRequestBodyField struct

+ Child *IssuePatchRequestBodyField

+ Value string

+ type IssuePatchRequestBodyUpdate struct

+ Labels []IssuePatchRequestBodyUpdateLabel

+ type IssuePatchRequestBodyUpdateLabel struct

+ Add *string

+ Remove *string

+ type IssueService struct

+ Client *Client

+ func NewIssueService(client *Client) *IssueService

+ func (svc *IssueService) GetIssuesSetForKeys(keys []string) (*IssuesSet, error)

+ func (svc *IssueService) Issue(key string) (*jira.Issue, error)

+ func (svc *IssueService) IssuePatch(issueKeyOrID string, issueUpdateRequestBody IssuePatchRequestBody) (*http.Response, error)

+ func (svc *IssueService) IssuePatchCustomFieldRecursive(ctx context.Context, issueKeyOrID string, iss *jira.Issue, ...) (int, error)

+ func (svc *IssueService) IssuePatchLabelRecursive(ctx context.Context, issueKeyOrID string, iss *jira.Issue, label string, ...) (int, error)

+ func (svc *IssueService) Issues(keys ...string) (Issues, error)

+ func (svc *IssueService) IssuesSetAddParents(is *IssuesSet) error

+ func (svc *IssueService) SearchChildrenIssues(parentKeys []string) (Issues, error)

+ func (svc *IssueService) SearchChildrenIssuesSet(recursive bool, parentKeys ...string) (*IssuesSet, error)

+ func (svc *IssueService) SearchIssues(jql string) (Issues, error)

+ func (svc *IssueService) SearchIssuesByMonth(jql gojira.JQL, createdGTE, createdLT time.Time, ...) error

+ func (svc *IssueService) SearchIssuesMulti(jqls ...string) (Issues, error)

+ func (svc *IssueService) SearchIssuesPages(jql string, limit, offset, maxPages uint) (Issues, error)

+ func (svc *IssueService) SearchIssuesSet(jql string) (*IssuesSet, error)

+ func (svc *IssueService) SearchIssuesSetParents(is *IssuesSet) (*IssuesSet, error)

type IssuesSet

+ func (set *IssuesSet) KeysByField(fieldLabel string) map[string]SliceMore

+ type SliceMore struct

+ Count int

+ Values []string

+ func (sm *SliceMore) Inflate()

Sep 8, 2024

Changes in this version

+ const APIV2URLListCustomFields

+ const APIV3URLIssue

type Client

+ CustomFieldSet *CustomFieldSet

+ CustomFieldsAPI *CustomFieldsService

+ IssueAPI *IssueAPI

+ func (c *Client) Inflate(addCustomFieldSet bool) error

+ func (c *Client) LoadCustomFields() error

+ type CustomFieldSet struct

+ Data map[string]CustomField

+ func NewCustomFieldSet() *CustomFieldSet

+ func (set *CustomFieldSet) Add(fields ...CustomField) error

+ func (set *CustomFieldSet) Init()

+ type FieldPatchRequestObject struct

+ Child *FieldPatchRequestObject

+ Value string

+ type IssueAPI struct

+ Client *Client

+ func NewIssueAPI(client *Client) *IssueAPI

+ func (c *IssueAPI) GetIssuesSetForKeys(keys []string) (*IssuesSet, error)

+ func (c *IssueAPI) Issue(key string) (*jira.Issue, error)

+ func (c *IssueAPI) IssuePatch(issueKeyOrID string, issueUpdateRequestBody IssuePatchRequestBody) (*http.Response, error)

+ func (c *IssueAPI) Issues(keys ...string) (Issues, error)

+ func (c *IssueAPI) IssuesSetAddParents(is *IssuesSet) error

+ func (c *IssueAPI) SearchChildrenIssues(parentKeys ...string) (Issues, error)

+ func (c *IssueAPI) SearchChildrenIssuesSet(recursive bool, parentKeys ...string) (*IssuesSet, error)

+ func (c *IssueAPI) SearchIssues(jql string) (Issues, error)

+ func (c *IssueAPI) SearchIssuesByMonth(jql gojira.JQL, createdGTE, createdLT time.Time, ...) error

+ func (c *IssueAPI) SearchIssuesMulti(jqls ...string) (Issues, error)

+ func (c *IssueAPI) SearchIssuesPages(jql string, limit, offset, maxPages uint) (Issues, error)

+ func (c *IssueAPI) SearchIssuesSet(jql string) (*IssuesSet, error)

+ func (c *IssueAPI) SearchIssuesSetParents(is *IssuesSet) (*IssuesSet, error)

type IssueMeta

+ AdditionalFields map[string]*string

type IssueMore

+ func (im *IssueMore) AdditionalFields(additionalFieldNames []string) map[string]*string

+ func (im *IssueMore) WriteFileJSON(filename string, perm os.FileMode, prefix, indent string) error

+ type IssuePatchRequestBody struct

+ Fields map[string]FieldPatchRequestObject

Aug 18, 2024

Changes in this version

type Client

+ func (c *Client) SearchIssuesByMonth(jql gojira.JQL, createdGTE, createdLT time.Time, ...) error

type CustomCol

+ Slug string

+ func (c CustomCol) NameOrSlug() string

type CustomTableCols

+ func CustomTableColsFromStrings(cols []string) CustomTableCols

+ func (cols CustomTableCols) Names(defaultToSlug bool) []string

type IssueMore

+ func NewIssueMore(iss *jira.Issue) IssueMore

+ func (im *IssueMore) AssigneeName() string

+ func (im *IssueMore) CustomFieldString(customFieldLabel string) (string, error)

+ func (im *IssueMore) CustomFieldStringOrDefault(customFieldLabel, def string) string

+ func (im *IssueMore) Value(fieldSlug string) (string, bool)

type IssuesSet

+ func IssuesSetReadDirIssuesFiles(filepaths []string) (*IssuesSet, error)

+ func (is *IssuesSet) TableDefault(customCols *CustomTableCols, inclEpic bool, initiativeType string) (*table.Table, error)

+ func (is *IssuesSet) TableSimple(cols []string) (*table.Table, error)

+ func (is *IssuesSet) TimeSeriesSetCreatedMonthByCustomField(cumulative, inflate, popLast bool, monthsFilter []time.Month, ...) (*timeseries.TimeSeriesSet, error)

+ func (is *IssuesSet) TimeSeriesSetCreatedMonthByKey(cumulative, inflate, popLast bool, monthsFilter []time.Month, ...) (*timeseries.TimeSeriesSet, error)

+ func (is *IssuesSet) TimeSeriesSetCreatedMonthByProject(cumulative, inflate, popLast bool, monthsFilter []time.Month) (*timeseries.TimeSeriesSet, error)

+ func (is *IssuesSet) TimeSeriesSetCreatedMonthByResolution(cumulative, inflate, popLast bool, monthsFilter []time.Month) (*timeseries.TimeSeriesSet, error)

+ func (is *IssuesSet) TimeSeriesSetCreatedMonthByStatus(cumulative, inflate, popLast bool, monthsFilter []time.Month) (*timeseries.TimeSeriesSet, error)

May 27, 2024

Changes in this version

type IssuesSet

+ func (is *IssuesSet) CountsByProjectAndMetaStage(inclTypeFilter []string) *histogram.HistogramSet

May 11, 2024

Changes in this version

+ const APIURLMyself

+ var ErrJiraClientCannotBeNil = errors.New("jira client cannot be nil")

+ func JiraClientBasicAuthGoauth(creds *goauth.CredentialsBasicAuth) (*jira.Client, error)

+ func UserJiraToOIDC(u *jira.User, serverURL string) *oidc.UserInfo

type Client

+ func NewClientBasicAuth(serverURL, username, password string) (*Client, error)

+ func (c *Client) Issues(keys ...string) (Issues, error)

+ func (c *Client) Myself() (*jira.User, *http.Response, error)

+ func (c *Client) MyselfUserInfo(ctx context.Context) (*oidc.UserInfo, *jira.User, *jira.Response, error)

+ func (c *Client) SearchChildrenIssuesSet(recursive bool, parentKeys ...string) (*IssuesSet, error)

type IssuesSet

+ func (is *IssuesSet) TimeSeriesCreatedMonth() *timeseries.TimeSeries

Feb 5, 2024

Changes in this version

+ var ErrIssueKeyCannotBeEmpty = errors.New("issue key cannot be empty")

+ var ErrIssuesSetCannotBeNil = errors.New("issuesSet cannot be nil")

type IssuesSet

+ func (is *IssuesSet) CountWithTypeFilter(inclTypeFilter []string) uint

+ func (is *IssuesSet) CountsByMetaStage(inclTypeFilter []string) map[string]uint

+ func (is *IssuesSet) CountsByWorkstream(wsFuncMake WorkstreamFuncMake, inclTypeFilter []string) (map[string]uint, error)

+ func (is *IssuesSet) ExportWorkstremaFilter(wsFuncMake WorkstreamFuncMake, wsFuncIncl WorkstreamFuncIncl) (*IssuesSet, error)

Feb 2, 2024

Changes in this version

type IssuesSet

+ func (is *IssuesSet) StatusesOrder() []string

Jan 21, 2024

Changes in this version

+ const FieldSlugProjectkey

+ const FieldSlugType

+ var ErrClientCannotBeNil = errors.New("client cannot be nil")

type Client

+ func (c *Client) SearchChildrenIssues(parentKeys ...string) (Issues, error)

type Issues

+ func (ii Issues) Keys() []string

type IssuesSet

+ func (is *IssuesSet) ExportWorkstreamProjectkeyStatusTablePivot(wsFuncMake WorkstreamFuncMake, wsFuncIncl WorkstreamFuncIncl, ...) (*table.Table, error)

+ func (is *IssuesSet) ExportWorkstreamTypeStatusTablePivot(wsFuncMake WorkstreamFuncMake, wsFuncIncl WorkstreamFuncIncl, ...) (*table.Table, error)

+ func (is *IssuesSet) ExportWorkstreamXfieldStatusHistogramSets(wsFuncMake WorkstreamFuncMake, wsFuncIncl WorkstreamFuncIncl, ...) (*histogram.HistogramSets, error)

+ func (is *IssuesSet) ExportWorkstreamXfieldStatusTablePivot(wsFuncMake WorkstreamFuncMake, wsFuncIncl WorkstreamFuncIncl, ...) (*table.Table, error)

+ func (is *IssuesSet) IssueFirst() (jira.Issue, error)

+ func (is *IssuesSet) KeyExists(key string, inclParents bool) bool

+ func (is *IssuesSet) KeysForTypes(types []string, inclBase, inclParents bool) []string

+ func (is *IssuesSet) RetrieveChildrenOfType(client *Client, parentTypes, baseTypes []string) error

+ func (is *IssuesSet) Types(inclBase, inclParents bool) []string

+ type WorkstreamFuncIncl func(ws string) bool

+ type WorkstreamFuncMake func(issueKey string) (string, error)

Dec 24, 2023

Changes in this version

+ func DefaultHistogramMapTableConfig(projectKeys []string) *histogram.HistogramMapTableSetConfig

+ type CustomJiraProcessor struct

+ type IssueCalcField struct

+ Key string

+ ValFunc func(iss *jira.Issue) (string, error)

type IssueMore

+ func (im *IssueMore) LabelExists(label string) bool

type IssuesSet

+ func (is *IssuesSet) CountsByCustomFieldValues(customField string) (map[string]uint, error)

+ func (is *IssuesSet) HistogramMap(stdKeys []string, calcFields []IssueCalcField) (*histogram.Histogram, error)

+ func (is *IssuesSet) HistogramMapProjectTypeStatus() *histogram.Histogram

+ func (is *IssuesSet) HistogramSetsProjectTypeStatus() *histogram.HistogramSets

+ func (is *IssuesSet) TableSetProjectTypeStatus(tsConfig *histogram.HistogramMapTableSetConfig) (*table.TableSet, error)

Dec 17, 2023

Changes in this version

+ var ErrLineageNotFound = errors.New("lineage not found")

type Client

+ Logger *zerolog.Logger

+ func (c *Client) SearchIssuesPages(jql string, limit, offset, maxPages uint) (Issues, error)

type IssuesSet

+ func (is *IssuesSet) AddIssuesFile(filename string) error

+ func (is *IssuesSet) IssueOrParent(key string) (*jira.Issue, bool)

+ func (is *IssuesSet) KeysParents() []string

+ func (is *IssuesSet) KeysParentsPopulated() []string

+ func (is *IssuesSet) KeysParentsUnpopulated() []string

+ func (is *IssuesSet) Len() uint

+ func (is *IssuesSet) LenLineageTopKeysPopulated() uint

+ func (is *IssuesSet) LenLineageTopKeysUnpopulated() uint

+ func (is *IssuesSet) LenMap() map[string]uint

+ func (is *IssuesSet) LenParents() uint

+ func (is *IssuesSet) LenParentsPopulated() uint

+ func (is *IssuesSet) LenParentsUnpopulated() uint

+ func (is *IssuesSet) LineageTopKeysPopulated() ([]string, error)

+ func (is *IssuesSet) LineageTopKeysUnpopulated() ([]string, error)

+ func (is *IssuesSet) LineageValidateKey(key string) ([]string, error)

+ func (is *IssuesSet) LineageValidateSet() (popLineage []string, unpopLineage []string, allValid bool)

Dec 17, 2023

Changes in this version

+ func NewClientHTTPBasicAuthFile(filename, credsKey string) (hclient *http.Client, serverURL string, err error)

+ func NewClientJiraBasicAuthFile(filename, credsKey string) (*jira.Client, error)

+ func NewCredentialsBasicAuthGoauthFile(filename, credsKey string) (*goauth.CredentialsBasicAuth, error)

type Client

+ func NewClientGoauthBasicAuthFile(filename, credsKey string) (*Client, error)

+ func (c *Client) IssuesSetAddParents(is *IssuesSet) error

+ func (c *Client) SearchIssuesSet(jql string) (*IssuesSet, error)

+ func (c *Client) SearchIssuesSetParents(is *IssuesSet) (*IssuesSet, error)

type IssueMeta

+ Labels []string

+ func (im *IssueMeta) BuildKeyURL(baseURL string)

+ func (im *IssueMeta) KeyLinkMarkdown() string

type IssueMetas

+ func (ims IssueMetas) HighestAboveEpic() *IssueMeta

+ func (ims IssueMetas) HighestEpic() *IssueMeta

+ func (ims IssueMetas) HighestType(issueType string) *IssueMeta

type IssueMore

+ func (im *IssueMore) Labels(sortAsc bool) []string

type Issues

+ func (ii Issues) Metas(baseURL string) IssueMetas

type IssuesSet

+ func IssuesSetReadFileJSON(filename string) (*IssuesSet, error)

+ func (is *IssuesSet) Get(key string) (jira.Issue, error)

+ func (is *IssuesSet) HistogramSetProjectType() *histogram.HistogramSet

+ func (is *IssuesSet) IssueMetas() IssueMetas

+ func (is *IssuesSet) IssuesSetHighestType(issueType string) (*IssuesSet, error)

+ func (is *IssuesSet) TableSet(customCols *CustomTableCols, inclEpic bool, initiativeType string) (*table.TableSet, error)

Oct 30, 2023

Changes in this version

type IssueMore

+ func (im *IssueMore) EpicKey() string

+ func (im *IssueMore) EpicNameOrSummary() string

Oct 30, 2023

Changes in this version

+ type API struct

+ Backlog *BacklogService

+ Client *Client

+ CustomFields *CustomFieldsService

+ func NewAPI(client *Client) API

type BacklogService

+ Client *Client

type Client

+ Config gojira.Config

+ type CustomFieldsService struct

+ JRClient *Client

+ func NewCustomFieldsService(client *Client) *CustomFieldsService

+ func (svc *CustomFieldsService) GetCustomField(customFieldName string) (CustomField, error)

+ func (svc *CustomFieldsService) GetCustomFieldEpicLink() (CustomField, error)

+ func (svc *CustomFieldsService) GetCustomFields() (CustomFields, error)

type IssueMore

+ func (im *IssueMore) CustomField(customFieldLabel string) (IssueCustomField, error)

Oct 28, 2023

Changes in this version

+ var ErrJiraRESTClientCannotBeNil = errors.New("jirarest.Client cannot be nil")

+ type Client struct

+ HTTPClient *http.Client

+ JiraClient *jira.Client

+ ServerURL string

+ func (c *Client) GetIssuesSetForKeys(keys []string) (*IssuesSet, error)

+ func (c *Client) Issue(key string) (*jira.Issue, error)

+ func (c *Client) SearchIssues(jql string) (Issues, error)

+ func (c *Client) SearchIssuesMulti(jqls ...string) (Issues, error)

+ func (c *Client) SearchIssuesSetForJQL(jql string, cfg *gojira.Config) (*IssuesSet, error)

+ type IssueMeta struct

+ AssigneeName string

+ CreateTime *time.Time

+ CreatorName string

+ EpicName string

+ Key string

+ KeyURL string

+ ParentKey string

+ Project string

+ ProjectKey string

+ Resolution string

+ Status string

+ Summary string

+ Type string

+ UpdateTime *time.Time

+ func (im IssueMeta) String() string

+ type IssueMetas []IssueMeta

+ type IssueMore struct

+ Issue *jira.Issue

+ func (im *IssueMore) AsigneeName() string

+ func (im *IssueMore) CreateTime() time.Time

+ func (im *IssueMore) CreatorName() string

+ func (im *IssueMore) EpicName() string

+ func (im *IssueMore) Key() string

+ func (im *IssueMore) KeyURL(baseURL string) string

+ func (im *IssueMore) Meta(baseURL string) IssueMeta

+ func (im *IssueMore) ParentKey() string

+ func (im *IssueMore) Project() string

+ func (im *IssueMore) ProjectKey() string

+ func (im *IssueMore) Resolution() string

+ func (im *IssueMore) Status() string

+ func (im *IssueMore) Summary() string

+ func (im *IssueMore) Type() string

+ func (im *IssueMore) UpdateTime() time.Time

type Issues

+ func IssuesReadFileJSON(filename string) (Issues, error)

+ func (ii Issues) WriteFileJSON(filename, prefix, indent string) error

type IssuesSet

+ Parents *IssuesSet

+ func (is *IssuesSet) CountsByProject() map[string]uint

+ func (is *IssuesSet) CountsByProjectKey() map[string]uint

+ func (is *IssuesSet) FilterStatus(inclStatuses ...string) (*IssuesSet, error)

+ func (is *IssuesSet) FilterType(inclTypes ...string) (*IssuesSet, error)

+ func (is *IssuesSet) Keys() []string

+ func (is *IssuesSet) Lineage(key string) (IssueMetas, error)

+ func (is *IssuesSet) RetrieveIssues(client *Client, ids []string) error

+ func (is *IssuesSet) RetrieveParents(client *Client) error

+ func (is *IssuesSet) RetrieveParentsIssuesSet(client *Client) (*IssuesSet, error)

+ func (is *IssuesSet) UnknownParents() []string

+ func (is *IssuesSet) WriteFileJSON(name, prefix, indent string) error

Aug 27, 2023

Changes in this version

+ const MaxResults

+ const MetaParamRank

+ const ParamFields

+ const ParamJQL

+ const ParamMaxResults

+ const ParamStartAt

+ const ParamValidateQuery

+ const TimeAggregateTimeEstimate

+ const TimeAggregateTimeOriginalEstimate

+ const TimeAggregateTimeSpent

+ const TimeTimeEstimate

+ const TimeTimeOriginalEstimate

+ const TimeTimeRemaining

+ const TimeTimeRemainingOriginal

+ const TimeTimeSpent

+ type BacklogService struct

+ func NewBacklogService(client *http.Client, cfg *gojira.Config) *BacklogService

+ func (s *BacklogService) GetBacklogIssuesAll(boardID uint, jql string) (*IssuesResponse, [][]byte, error)

+ func (s *BacklogService) GetBacklogIssuesResponse(boardID uint, qry *BoardBacklogParams) (*IssuesResponse, []byte, error)

+ func (s *BacklogService) GetBacklogIssuesSetAll(boardID uint, jql string) (*IssuesSet, [][]byte, error)

+ type BoardBacklogParams struct

+ Expand string

+ Fields string

+ JQL string

+ MaxResults uint

+ StartAt uint

+ ValidateQuery bool

+ func (p BoardBacklogParams) URLValues() url.Values

type CustomField

+ func GetCustomField(client *http.Client, serverURL, customFieldName string) (CustomField, error)

type Issues

+ func (ii Issues) AddRank() Issues

+ func (ii Issues) IssuesSet(cfg *gojira.Config) (*IssuesSet, error)

type IssuesSet

+ func SearchIssuesSetForJQL(client *jira.Client, jql string, cfg *gojira.Config) (*IssuesSet, error)

+ func (is *IssuesSet) Counts() map[string]map[string]uint

+ func (is *IssuesSet) CountsByStatus() map[string]uint

+ func (is *IssuesSet) CountsByTime() map[string]uint

+ func (is *IssuesSet) CountsByType() map[string]uint

+ func (is *IssuesSet) CountsbByProject() map[string]uint

+ func (is *IssuesSet) FilterByStatus(inclStatuses, exclStatuses []string) (*IssuesSet, error)

Aug 21, 2023

Changes in this version

+ const APIURL2ListCustomFields

+ const CustomFieldNameEpicLink

+ const StatusCustomClosed

+ const StatusDone

+ const StatusOpen

+ const WorkingDaysPerWeekDefault

+ const WorkingHoursPerDayDefault

+ func BacklogAPIURL(baseURL string, boardID, startAt, maxResults uint) string

+ func BuildJiraIssueURL(baseURL, issueKey string) string

+ func ClientsBasicAuthFile(filename, credsKey string) (*http.Client, *jira.Client, string, error)

+ func DefaultIssuesSetTableColumns() *table.ColumnDefinitions

+ func GetCustomValueString(iss jira.Issue, customFieldKey string) (string, error)

+ func GetUnmarshalCustomValue(iss jira.Issue, customFieldKey string, v any) error

+ func HTTPClientBasicAuthFile(filename, credsKey string) (hclient *http.Client, serverURL string, err error)

+ func IssueFieldsCustomFieldString(fields *jira.IssueFields, id string) string

+ func IssueToEpic(iss jira.Issue) (*jira.Epic, error)

+ func JiraClientBasicAuth(creds *goauth.CredentialsBasicAuth) (*jira.Client, error)

+ func JiraClientBasicAuthFile(filename, credsKey string) (*jira.Client, error)

+ func KeysJQL(keys []string) string

+ func Shift(s S) (E, S)

+ func TimeRemaining(status string, timeOriginalEstimate, timeEstimate, timeSpent int) (timeRemainingOriginal, timeRemaining int)

+ func UnmarshalAny(data, v any) error

+ func UserPassCredsBasic(filename, credsKey string) (*goauth.CredentialsBasicAuth, error)

+ type Config struct

+ WorkingDaysPerWeek float32

+ WorkingHoursPerDay float32

+ func NewConfigDefault() *Config

+ func (c *Config) SecondsToDays(sec int) float32

+ func (c *Config) SecondsToDaysString(sec int) string

+ type CustomCol struct

+ Func func(iss jira.Issue) (string, error)

+ Name string

+ RenderSkip bool

+ Type string

+ type CustomField struct

+ ClauseNames []string

+ Custom bool

+ ID string

+ Key string

+ Name string

+ Navigable bool

+ Orderable bool

+ Schema CustomFieldSchema

+ Searchable bool

+ UntranslatedName string

+ func GetCustomFieldEpicLink(client *http.Client, serverURL string) (CustomField, error)

+ type CustomFieldSchema struct

+ Custom string

+ CustomID int

+ Type string

+ type CustomFields []CustomField

+ func GetCustomFields(client *http.Client, serverURL string) (CustomFields, error)

+ func (cfs CustomFields) FilterByIDs(ids ...string) CustomFields

+ func (cfs CustomFields) FilterByNames(names ...string) CustomFields

+ func (cfs CustomFields) SortByName(asc bool) CustomFields

+ func (cfs CustomFields) Table(name string) table.Table

+ func (cfs CustomFields) WriteTable(w io.Writer)

+ type CustomTableCols struct

+ Cols []CustomCol

+ type EpicsSet struct

+ EpicsMap map[string]jira.Epic

+ func NewEpicsSet() EpicsSet

+ func (es *EpicsSet) AddIssues(issues []jira.Issue) error

+ func (es *EpicsSet) GetKeys(jclient *jira.Client, epicKeys []string) error

+ type IssueCustomField struct

+ ID string

+ Self string

+ Value string

+ func GetIssueCustomValueStruct(iss jira.Issue) (*IssueCustomField, error)

+ type IssueFieldsSimple struct

+ Fields *jira.IssueFields

+ func (ifs IssueFieldsSimple) EpicKey() string

+ func (ifs IssueFieldsSimple) EpicName() string

+ func (ifs IssueFieldsSimple) ResolutionName() string

+ func (ifs IssueFieldsSimple) StatusName() string

+ type Issues []jira.Issue

+ func SearchIssues(client *jira.Client, jql string) (Issues, error)

+ func (ii Issues) CountsByProjectTypeStatus() *histogram.HistogramSets

+ func (ii Issues) CountsByType() map[string]int

+ type IssuesResponse struct

+ Expand string

+ Issues Issues

+ MaxResults int

+ StartAt int

+ Total int

+ func GetBacklogIssuesAll(client *http.Client, baseURL string, boardID uint) (*IssuesResponse, [][]byte, error)

+ func GetBacklogIssuesResponse(client *http.Client, baseURL string, boardID, startAt, maxResults uint) (*IssuesResponse, []byte, error)

+ func IssuesResponseReadFile(filename string) (*IssuesResponse, error)

+ func ParseIssuesResponseBytes(b []byte) (*IssuesResponse, error)

+ func ParseIssuesResponseReader(r io.Reader) (*IssuesResponse, error)

+ type IssuesSet struct

+ Config *Config

+ IssuesMap map[string]jira.Issue

+ func GetIssuesSetForKeys(client *jira.Client, keys []string) (IssuesSet, error)

+ func NewIssuesSet(cfg *Config) IssuesSet

+ func (is *IssuesSet) Add(issues ...jira.Issue) error

+ func (is *IssuesSet) EpicKeys(customFieldID string) []string

+ func (is *IssuesSet) HistogramSets(baseURL string) *histogram.HistogramSets

+ func (is *IssuesSet) InflateEpicKeys(customFieldEpicLinkID string)

+ func (is *IssuesSet) InflateEpics(jclient *jira.Client, customFieldIDEpicLink string) error

+ func (is *IssuesSet) Issues() Issues

+ func (is *IssuesSet) Table(baseURL string, customCols *CustomTableCols) (table.Table, error)

+ func (is *IssuesSet) TimeStats() TimeStats

+ func (is *IssuesSet) WriteJSONFile(filename string) error

+ type Status struct

+ Description string

+ Name string

+ func IssueStatuses() []Status

+ type TimeStats struct

+ AggregateTimeEstimate int

+ AggregateTimeOriginalEstimate int

+ AggregateTimeSpent int

+ ItemCount int

+ TimeEstimate int

+ TimeOriginalEstimate int

+ TimeRemaining int

+ TimeRemainingOriginal int

+ TimeSpent int

+ WorkingDaysPerWeek float32

+ WorkingHoursPerDay float32

+ type TimeStatsSet struct

+ Map map[string]TimeStats

+ type TimeStatsSets struct

+ Map map[string]TimeStatsSet

+ func (tss TimeStatsSets) AddIssue(iss jira.Issue)