2018-06-02 00:37:01 +00:00
package jira
import (
"bytes"
"encoding/json"
"fmt"
"io"
"io/ioutil"
"mime/multipart"
2020-09-14 18:31:56 +00:00
"net/http"
2018-06-02 00:37:01 +00:00
"net/url"
"reflect"
"strings"
"time"
"github.com/fatih/structs"
"github.com/google/go-querystring/query"
"github.com/trivago/tgo/tcontainer"
)
const (
// AssigneeAutomatic represents the value of the "Assignee: Automatic" of JIRA
AssigneeAutomatic = "-1"
)
// IssueService handles Issues for the JIRA instance / API.
//
// JIRA API docs: https://docs.atlassian.com/jira/REST/latest/#api/2/issue
type IssueService struct {
client * Client
}
2020-09-14 18:31:56 +00:00
// UpdateQueryOptions specifies the optional parameters to the Edit issue
type UpdateQueryOptions struct {
NotifyUsers bool ` url:"notifyUsers,omitempty" `
OverrideScreenSecurity bool ` url:"overrideScreenSecurity,omitempty" `
OverrideEditableFlag bool ` url:"overrideEditableFlag,omitempty" `
}
2018-06-02 00:37:01 +00:00
// Issue represents a JIRA issue.
type Issue struct {
2020-09-14 18:31:56 +00:00
Expand string ` json:"expand,omitempty" structs:"expand,omitempty" `
ID string ` json:"id,omitempty" structs:"id,omitempty" `
Self string ` json:"self,omitempty" structs:"self,omitempty" `
Key string ` json:"key,omitempty" structs:"key,omitempty" `
Fields * IssueFields ` json:"fields,omitempty" structs:"fields,omitempty" `
RenderedFields * IssueRenderedFields ` json:"renderedFields,omitempty" structs:"renderedFields,omitempty" `
Changelog * Changelog ` json:"changelog,omitempty" structs:"changelog,omitempty" `
Transitions [ ] Transition ` json:"transitions,omitempty" structs:"transitions,omitempty" `
2018-06-02 00:37:01 +00:00
}
// ChangelogItems reflects one single changelog item of a history item
type ChangelogItems struct {
Field string ` json:"field" structs:"field" `
FieldType string ` json:"fieldtype" structs:"fieldtype" `
From interface { } ` json:"from" structs:"from" `
FromString string ` json:"fromString" structs:"fromString" `
To interface { } ` json:"to" structs:"to" `
ToString string ` json:"toString" structs:"toString" `
}
// ChangelogHistory reflects one single changelog history entry
type ChangelogHistory struct {
Id string ` json:"id" structs:"id" `
Author User ` json:"author" structs:"author" `
Created string ` json:"created" structs:"created" `
Items [ ] ChangelogItems ` json:"items" structs:"items" `
}
// Changelog reflects the change log of an issue
type Changelog struct {
Histories [ ] ChangelogHistory ` json:"histories,omitempty" `
}
// Attachment represents a JIRA attachment
type Attachment struct {
Self string ` json:"self,omitempty" structs:"self,omitempty" `
ID string ` json:"id,omitempty" structs:"id,omitempty" `
Filename string ` json:"filename,omitempty" structs:"filename,omitempty" `
Author * User ` json:"author,omitempty" structs:"author,omitempty" `
Created string ` json:"created,omitempty" structs:"created,omitempty" `
Size int ` json:"size,omitempty" structs:"size,omitempty" `
MimeType string ` json:"mimeType,omitempty" structs:"mimeType,omitempty" `
Content string ` json:"content,omitempty" structs:"content,omitempty" `
Thumbnail string ` json:"thumbnail,omitempty" structs:"thumbnail,omitempty" `
}
// Epic represents the epic to which an issue is associated
// Not that this struct does not process the returned "color" value
type Epic struct {
ID int ` json:"id" structs:"id" `
Key string ` json:"key" structs:"key" `
Self string ` json:"self" structs:"self" `
Name string ` json:"name" structs:"name" `
Summary string ` json:"summary" structs:"summary" `
Done bool ` json:"done" structs:"done" `
}
// IssueFields represents single fields of a JIRA issue.
// Every JIRA issue has several fields attached.
type IssueFields struct {
// TODO Missing fields
// * "workratio": -1,
// * "lastViewed": null,
// * "environment": null,
2020-09-14 18:31:56 +00:00
Expand string ` json:"expand,omitempty" structs:"expand,omitempty" `
Type IssueType ` json:"issuetype,omitempty" structs:"issuetype,omitempty" `
Project Project ` json:"project,omitempty" structs:"project,omitempty" `
Resolution * Resolution ` json:"resolution,omitempty" structs:"resolution,omitempty" `
Priority * Priority ` json:"priority,omitempty" structs:"priority,omitempty" `
Resolutiondate Time ` json:"resolutiondate,omitempty" structs:"resolutiondate,omitempty" `
Created Time ` json:"created,omitempty" structs:"created,omitempty" `
Duedate Date ` json:"duedate,omitempty" structs:"duedate,omitempty" `
Watches * Watches ` json:"watches,omitempty" structs:"watches,omitempty" `
Assignee * User ` json:"assignee,omitempty" structs:"assignee,omitempty" `
Updated Time ` json:"updated,omitempty" structs:"updated,omitempty" `
Description string ` json:"description,omitempty" structs:"description,omitempty" `
Summary string ` json:"summary,omitempty" structs:"summary,omitempty" `
Creator * User ` json:"Creator,omitempty" structs:"Creator,omitempty" `
Reporter * User ` json:"reporter,omitempty" structs:"reporter,omitempty" `
Components [ ] * Component ` json:"components,omitempty" structs:"components,omitempty" `
Status * Status ` json:"status,omitempty" structs:"status,omitempty" `
Progress * Progress ` json:"progress,omitempty" structs:"progress,omitempty" `
AggregateProgress * Progress ` json:"aggregateprogress,omitempty" structs:"aggregateprogress,omitempty" `
TimeTracking * TimeTracking ` json:"timetracking,omitempty" structs:"timetracking,omitempty" `
TimeSpent int ` json:"timespent,omitempty" structs:"timespent,omitempty" `
TimeEstimate int ` json:"timeestimate,omitempty" structs:"timeestimate,omitempty" `
TimeOriginalEstimate int ` json:"timeoriginalestimate,omitempty" structs:"timeoriginalestimate,omitempty" `
Worklog * Worklog ` json:"worklog,omitempty" structs:"worklog,omitempty" `
IssueLinks [ ] * IssueLink ` json:"issuelinks,omitempty" structs:"issuelinks,omitempty" `
Comments * Comments ` json:"comment,omitempty" structs:"comment,omitempty" `
FixVersions [ ] * FixVersion ` json:"fixVersions,omitempty" structs:"fixVersions,omitempty" `
AffectsVersions [ ] * AffectsVersion ` json:"versions,omitempty" structs:"versions,omitempty" `
Labels [ ] string ` json:"labels,omitempty" structs:"labels,omitempty" `
Subtasks [ ] * Subtasks ` json:"subtasks,omitempty" structs:"subtasks,omitempty" `
Attachments [ ] * Attachment ` json:"attachment,omitempty" structs:"attachment,omitempty" `
Epic * Epic ` json:"epic,omitempty" structs:"epic,omitempty" `
Sprint * Sprint ` json:"sprint,omitempty" structs:"sprint,omitempty" `
Parent * Parent ` json:"parent,omitempty" structs:"parent,omitempty" `
AggregateTimeOriginalEstimate int ` json:"aggregatetimeoriginalestimate,omitempty" structs:"aggregatetimeoriginalestimate,omitempty" `
AggregateTimeSpent int ` json:"aggregatetimespent,omitempty" structs:"aggregatetimespent,omitempty" `
AggregateTimeEstimate int ` json:"aggregatetimeestimate,omitempty" structs:"aggregatetimeestimate,omitempty" `
Unknowns tcontainer . MarshalMap
2018-06-02 00:37:01 +00:00
}
// MarshalJSON is a custom JSON marshal function for the IssueFields structs.
// It handles JIRA custom fields and maps those from / to "Unknowns" key.
func ( i * IssueFields ) MarshalJSON ( ) ( [ ] byte , error ) {
m := structs . Map ( i )
unknowns , okay := m [ "Unknowns" ]
if okay {
// if unknowns present, shift all key value from unknown to a level up
for key , value := range unknowns . ( tcontainer . MarshalMap ) {
m [ key ] = value
}
delete ( m , "Unknowns" )
}
return json . Marshal ( m )
}
// UnmarshalJSON is a custom JSON marshal function for the IssueFields structs.
// It handles JIRA custom fields and maps those from / to "Unknowns" key.
func ( i * IssueFields ) UnmarshalJSON ( data [ ] byte ) error {
// Do the normal unmarshalling first
// Details for this way: http://choly.ca/post/go-json-marshalling/
type Alias IssueFields
aux := & struct {
* Alias
} {
Alias : ( * Alias ) ( i ) ,
}
if err := json . Unmarshal ( data , & aux ) ; err != nil {
return err
}
totalMap := tcontainer . NewMarshalMap ( )
err := json . Unmarshal ( data , & totalMap )
if err != nil {
return err
}
t := reflect . TypeOf ( * i )
for i := 0 ; i < t . NumField ( ) ; i ++ {
field := t . Field ( i )
tagDetail := field . Tag . Get ( "json" )
if tagDetail == "" {
// ignore if there are no tags
continue
}
options := strings . Split ( tagDetail , "," )
if len ( options ) == 0 {
return fmt . Errorf ( "No tags options found for %s" , field . Name )
}
// the first one is the json tag
key := options [ 0 ]
if _ , okay := totalMap . Value ( key ) ; okay {
delete ( totalMap , key )
}
}
i = ( * IssueFields ) ( aux . Alias )
// all the tags found in the struct were removed. Whatever is left are unknowns to struct
i . Unknowns = totalMap
return nil
}
2020-09-14 18:31:56 +00:00
// IssueRenderedFields represents rendered fields of a JIRA issue.
// Not all IssueFields are rendered.
type IssueRenderedFields struct {
// TODO Missing fields
// * "aggregatetimespent": null,
// * "workratio": -1,
// * "lastViewed": null,
// * "aggregatetimeoriginalestimate": null,
// * "aggregatetimeestimate": null,
// * "environment": null,
Resolutiondate string ` json:"resolutiondate,omitempty" structs:"resolutiondate,omitempty" `
Created string ` json:"created,omitempty" structs:"created,omitempty" `
Duedate string ` json:"duedate,omitempty" structs:"duedate,omitempty" `
Updated string ` json:"updated,omitempty" structs:"updated,omitempty" `
Comments * Comments ` json:"comment,omitempty" structs:"comment,omitempty" `
Description string ` json:"description,omitempty" structs:"description,omitempty" `
}
2018-06-02 00:37:01 +00:00
// IssueType represents a type of a JIRA issue.
// Typical types are "Request", "Bug", "Story", ...
type IssueType struct {
Self string ` json:"self,omitempty" structs:"self,omitempty" `
ID string ` json:"id,omitempty" structs:"id,omitempty" `
Description string ` json:"description,omitempty" structs:"description,omitempty" `
IconURL string ` json:"iconUrl,omitempty" structs:"iconUrl,omitempty" `
Name string ` json:"name,omitempty" structs:"name,omitempty" `
Subtask bool ` json:"subtask,omitempty" structs:"subtask,omitempty" `
AvatarID int ` json:"avatarId,omitempty" structs:"avatarId,omitempty" `
}
// Watches represents a type of how many and which user are "observing" a JIRA issue to track the status / updates.
type Watches struct {
Self string ` json:"self,omitempty" structs:"self,omitempty" `
WatchCount int ` json:"watchCount,omitempty" structs:"watchCount,omitempty" `
IsWatching bool ` json:"isWatching,omitempty" structs:"isWatching,omitempty" `
Watchers [ ] * Watcher ` json:"watchers,omitempty" structs:"watchers,omitempty" `
}
// Watcher represents a simplified user that "observes" the issue
type Watcher struct {
Self string ` json:"self,omitempty" structs:"self,omitempty" `
Name string ` json:"name,omitempty" structs:"name,omitempty" `
DisplayName string ` json:"displayName,omitempty" structs:"displayName,omitempty" `
Active bool ` json:"active,omitempty" structs:"active,omitempty" `
}
// AvatarUrls represents different dimensions of avatars / images
type AvatarUrls struct {
Four8X48 string ` json:"48x48,omitempty" structs:"48x48,omitempty" `
Two4X24 string ` json:"24x24,omitempty" structs:"24x24,omitempty" `
One6X16 string ` json:"16x16,omitempty" structs:"16x16,omitempty" `
Three2X32 string ` json:"32x32,omitempty" structs:"32x32,omitempty" `
}
// Component represents a "component" of a JIRA issue.
// Components can be user defined in every JIRA instance.
type Component struct {
Self string ` json:"self,omitempty" structs:"self,omitempty" `
ID string ` json:"id,omitempty" structs:"id,omitempty" `
Name string ` json:"name,omitempty" structs:"name,omitempty" `
}
// Progress represents the progress of a JIRA issue.
type Progress struct {
Progress int ` json:"progress" structs:"progress" `
Total int ` json:"total" structs:"total" `
2020-09-14 18:31:56 +00:00
Percent int ` json:"percent" structs:"percent" `
2018-06-02 00:37:01 +00:00
}
// Parent represents the parent of a JIRA issue, to be used with subtask issue types.
type Parent struct {
ID string ` json:"id,omitempty" structs:"id" `
Key string ` json:"key,omitempty" structs:"key" `
}
// Time represents the Time definition of JIRA as a time.Time of go
type Time time . Time
2020-09-14 18:31:56 +00:00
func ( t Time ) Equal ( u Time ) bool {
return time . Time ( t ) . Equal ( time . Time ( u ) )
}
2018-06-02 00:37:01 +00:00
// Date represents the Date definition of JIRA as a time.Time of go
type Date time . Time
// Wrapper struct for search result
type transitionResult struct {
Transitions [ ] Transition ` json:"transitions" structs:"transitions" `
}
// Transition represents an issue transition in JIRA
type Transition struct {
ID string ` json:"id" structs:"id" `
Name string ` json:"name" structs:"name" `
To Status ` json:"to" structs:"status" `
Fields map [ string ] TransitionField ` json:"fields" structs:"fields" `
}
// TransitionField represents the value of one Transition
type TransitionField struct {
Required bool ` json:"required" structs:"required" `
}
// CreateTransitionPayload is used for creating new issue transitions
type CreateTransitionPayload struct {
Transition TransitionPayload ` json:"transition" structs:"transition" `
Fields TransitionPayloadFields ` json:"fields" structs:"fields" `
}
// TransitionPayload represents the request payload of Transition calls like DoTransition
type TransitionPayload struct {
ID string ` json:"id" structs:"id" `
}
// TransitionPayloadFields represents the fields that can be set when executing a transition
type TransitionPayloadFields struct {
Resolution * Resolution ` json:"resolution,omitempty" structs:"resolution,omitempty" `
}
// Option represents an option value in a SelectList or MultiSelect
// custom issue field
type Option struct {
Value string ` json:"value" structs:"value" `
}
// UnmarshalJSON will transform the JIRA time into a time.Time
// during the transformation of the JIRA JSON response
func ( t * Time ) UnmarshalJSON ( b [ ] byte ) error {
// Ignore null, like in the main JSON package.
if string ( b ) == "null" {
return nil
}
ti , err := time . Parse ( "\"2006-01-02T15:04:05.999-0700\"" , string ( b ) )
if err != nil {
return err
}
* t = Time ( ti )
return nil
}
2020-09-14 18:31:56 +00:00
// MarshalJSON will transform the time.Time into a JIRA time
// during the creation of a JIRA request
func ( t Time ) MarshalJSON ( ) ( [ ] byte , error ) {
return [ ] byte ( time . Time ( t ) . Format ( "\"2006-01-02T15:04:05.999-0700\"" ) ) , nil
}
2018-06-02 00:37:01 +00:00
// UnmarshalJSON will transform the JIRA date into a time.Time
// during the transformation of the JIRA JSON response
func ( t * Date ) UnmarshalJSON ( b [ ] byte ) error {
// Ignore null, like in the main JSON package.
if string ( b ) == "null" {
return nil
}
ti , err := time . Parse ( "\"2006-01-02\"" , string ( b ) )
if err != nil {
return err
}
* t = Date ( ti )
return nil
}
// MarshalJSON will transform the Date object into a short
// date string as JIRA expects during the creation of a
// JIRA request
func ( t Date ) MarshalJSON ( ) ( [ ] byte , error ) {
time := time . Time ( t )
return [ ] byte ( time . Format ( "\"2006-01-02\"" ) ) , nil
}
// Worklog represents the work log of a JIRA issue.
// One Worklog contains zero or n WorklogRecords
// JIRA Wiki: https://confluence.atlassian.com/jira/logging-work-on-an-issue-185729605.html
type Worklog struct {
StartAt int ` json:"startAt" structs:"startAt" `
MaxResults int ` json:"maxResults" structs:"maxResults" `
Total int ` json:"total" structs:"total" `
Worklogs [ ] WorklogRecord ` json:"worklogs" structs:"worklogs" `
}
// WorklogRecord represents one entry of a Worklog
type WorklogRecord struct {
2020-09-14 18:31:56 +00:00
Self string ` json:"self,omitempty" structs:"self,omitempty" `
Author * User ` json:"author,omitempty" structs:"author,omitempty" `
UpdateAuthor * User ` json:"updateAuthor,omitempty" structs:"updateAuthor,omitempty" `
Comment string ` json:"comment,omitempty" structs:"comment,omitempty" `
Created * Time ` json:"created,omitempty" structs:"created,omitempty" `
Updated * Time ` json:"updated,omitempty" structs:"updated,omitempty" `
Started * Time ` json:"started,omitempty" structs:"started,omitempty" `
TimeSpent string ` json:"timeSpent,omitempty" structs:"timeSpent,omitempty" `
TimeSpentSeconds int ` json:"timeSpentSeconds,omitempty" structs:"timeSpentSeconds,omitempty" `
ID string ` json:"id,omitempty" structs:"id,omitempty" `
IssueID string ` json:"issueId,omitempty" structs:"issueId,omitempty" `
Properties [ ] EntityProperty ` json:"properties,omitempty" `
}
type EntityProperty struct {
Key string ` json:"key" `
Value interface { } ` json:"value" `
2018-06-02 00:37:01 +00:00
}
// TimeTracking represents the timetracking fields of a JIRA issue.
type TimeTracking struct {
OriginalEstimate string ` json:"originalEstimate,omitempty" structs:"originalEstimate,omitempty" `
RemainingEstimate string ` json:"remainingEstimate,omitempty" structs:"remainingEstimate,omitempty" `
TimeSpent string ` json:"timeSpent,omitempty" structs:"timeSpent,omitempty" `
OriginalEstimateSeconds int ` json:"originalEstimateSeconds,omitempty" structs:"originalEstimateSeconds,omitempty" `
RemainingEstimateSeconds int ` json:"remainingEstimateSeconds,omitempty" structs:"remainingEstimateSeconds,omitempty" `
TimeSpentSeconds int ` json:"timeSpentSeconds,omitempty" structs:"timeSpentSeconds,omitempty" `
}
// Subtasks represents all issues of a parent issue.
type Subtasks struct {
ID string ` json:"id" structs:"id" `
Key string ` json:"key" structs:"key" `
Self string ` json:"self" structs:"self" `
Fields IssueFields ` json:"fields" structs:"fields" `
}
// IssueLink represents a link between two issues in JIRA.
type IssueLink struct {
ID string ` json:"id,omitempty" structs:"id,omitempty" `
Self string ` json:"self,omitempty" structs:"self,omitempty" `
Type IssueLinkType ` json:"type" structs:"type" `
OutwardIssue * Issue ` json:"outwardIssue" structs:"outwardIssue" `
InwardIssue * Issue ` json:"inwardIssue" structs:"inwardIssue" `
Comment * Comment ` json:"comment,omitempty" structs:"comment,omitempty" `
}
// IssueLinkType represents a type of a link between to issues in JIRA.
// Typical issue link types are "Related to", "Duplicate", "Is blocked by", etc.
type IssueLinkType struct {
ID string ` json:"id,omitempty" structs:"id,omitempty" `
Self string ` json:"self,omitempty" structs:"self,omitempty" `
Name string ` json:"name" structs:"name" `
Inward string ` json:"inward" structs:"inward" `
Outward string ` json:"outward" structs:"outward" `
}
// Comments represents a list of Comment.
type Comments struct {
Comments [ ] * Comment ` json:"comments,omitempty" structs:"comments,omitempty" `
}
// Comment represents a comment by a person to an issue in JIRA.
type Comment struct {
ID string ` json:"id,omitempty" structs:"id,omitempty" `
Self string ` json:"self,omitempty" structs:"self,omitempty" `
Name string ` json:"name,omitempty" structs:"name,omitempty" `
Author User ` json:"author,omitempty" structs:"author,omitempty" `
Body string ` json:"body,omitempty" structs:"body,omitempty" `
UpdateAuthor User ` json:"updateAuthor,omitempty" structs:"updateAuthor,omitempty" `
Updated string ` json:"updated,omitempty" structs:"updated,omitempty" `
Created string ` json:"created,omitempty" structs:"created,omitempty" `
Visibility CommentVisibility ` json:"visibility,omitempty" structs:"visibility,omitempty" `
}
// FixVersion represents a software release in which an issue is fixed.
type FixVersion struct {
2020-09-14 18:31:56 +00:00
Self string ` json:"self,omitempty" structs:"self,omitempty" `
2018-06-02 00:37:01 +00:00
ID string ` json:"id,omitempty" structs:"id,omitempty" `
Name string ` json:"name,omitempty" structs:"name,omitempty" `
2020-09-14 18:31:56 +00:00
Description string ` json:"description,omitempty" structs:"description,omitempty" `
Archived * bool ` json:"archived,omitempty" structs:"archived,omitempty" `
2018-06-02 00:37:01 +00:00
Released * bool ` json:"released,omitempty" structs:"released,omitempty" `
2020-09-14 18:31:56 +00:00
ReleaseDate string ` json:"releaseDate,omitempty" structs:"releaseDate,omitempty" `
2018-06-02 00:37:01 +00:00
UserReleaseDate string ` json:"userReleaseDate,omitempty" structs:"userReleaseDate,omitempty" `
2020-09-14 18:31:56 +00:00
ProjectID int ` json:"projectId,omitempty" structs:"projectId,omitempty" ` // Unlike other IDs, this is returned as a number
StartDate string ` json:"startDate,omitempty" structs:"startDate,omitempty" `
2018-06-02 00:37:01 +00:00
}
2020-09-14 18:31:56 +00:00
// AffectsVersion represents a software release which is affected by an issue.
type AffectsVersion Version
2018-06-02 00:37:01 +00:00
// CommentVisibility represents he visibility of a comment.
// E.g. Type could be "role" and Value "Administrators"
type CommentVisibility struct {
Type string ` json:"type,omitempty" structs:"type,omitempty" `
Value string ` json:"value,omitempty" structs:"value,omitempty" `
}
// SearchOptions specifies the optional parameters to various List methods that
// support pagination.
// Pagination is used for the JIRA REST APIs to conserve server resources and limit
// response size for resources that return potentially large collection of items.
// A request to a pages API will result in a values array wrapped in a JSON object with some paging metadata
// Default Pagination options
type SearchOptions struct {
// StartAt: The starting index of the returned projects. Base index: 0.
StartAt int ` url:"startAt,omitempty" `
// MaxResults: The maximum number of projects to return per page. Default: 50.
MaxResults int ` url:"maxResults,omitempty" `
// Expand: Expand specific sections in the returned issues
Expand string ` url:"expand,omitempty" `
Fields [ ] string
// ValidateQuery: The validateQuery param offers control over whether to validate and how strictly to treat the validation. Default: strict.
ValidateQuery string ` url:"validateQuery,omitempty" `
}
// searchResult is only a small wrapper around the Search (with JQL) method
// to be able to parse the results
type searchResult struct {
Issues [ ] Issue ` json:"issues" structs:"issues" `
StartAt int ` json:"startAt" structs:"startAt" `
MaxResults int ` json:"maxResults" structs:"maxResults" `
Total int ` json:"total" structs:"total" `
}
// GetQueryOptions specifies the optional parameters for the Get Issue methods
type GetQueryOptions struct {
// Fields is the list of fields to return for the issue. By default, all fields are returned.
Fields string ` url:"fields,omitempty" `
Expand string ` url:"expand,omitempty" `
// Properties is the list of properties to return for the issue. By default no properties are returned.
Properties string ` url:"properties,omitempty" `
// FieldsByKeys if true then fields in issues will be referenced by keys instead of ids
FieldsByKeys bool ` url:"fieldsByKeys,omitempty" `
UpdateHistory bool ` url:"updateHistory,omitempty" `
ProjectKeys string ` url:"projectKeys,omitempty" `
}
2020-09-14 18:31:56 +00:00
// GetWorklogsQueryOptions specifies the optional parameters for the Get Worklogs method
type GetWorklogsQueryOptions struct {
StartAt int64 ` url:"startAt,omitempty" `
MaxResults int32 ` url:"maxResults,omitempty" `
Expand string ` url:"expand,omitempty" `
}
type AddWorklogQueryOptions struct {
NotifyUsers bool ` url:"notifyUsers,omitempty" `
AdjustEstimate string ` url:"adjustEstimate,omitempty" `
NewEstimate string ` url:"newEstimate,omitempty" `
ReduceBy string ` url:"reduceBy,omitempty" `
Expand string ` url:"expand,omitempty" `
OverrideEditableFlag bool ` url:"overrideEditableFlag,omitempty" `
}
2018-06-02 00:37:01 +00:00
// CustomFields represents custom fields of JIRA
// This can heavily differ between JIRA instances
type CustomFields map [ string ] string
2020-09-14 18:31:56 +00:00
// RemoteLink represents remote links which linked to issues
type RemoteLink struct {
ID int ` json:"id,omitempty" structs:"id,omitempty" `
Self string ` json:"self,omitempty" structs:"self,omitempty" `
GlobalID string ` json:"globalId,omitempty" structs:"globalId,omitempty" `
Application * RemoteLinkApplication ` json:"application,omitempty" structs:"application,omitempty" `
Relationship string ` json:"relationship,omitempty" structs:"relationship,omitempty" `
Object * RemoteLinkObject ` json:"object,omitempty" structs:"object,omitempty" `
}
// RemoteLinkApplication represents remote links application
type RemoteLinkApplication struct {
Type string ` json:"type,omitempty" structs:"type,omitempty" `
Name string ` json:"name,omitempty" structs:"name,omitempty" `
}
// RemoteLinkObject represents remote link object itself
type RemoteLinkObject struct {
URL string ` json:"url,omitempty" structs:"url,omitempty" `
Title string ` json:"title,omitempty" structs:"title,omitempty" `
Summary string ` json:"summary,omitempty" structs:"summary,omitempty" `
Icon * RemoteLinkIcon ` json:"icon,omitempty" structs:"icon,omitempty" `
Status * RemoteLinkStatus ` json:"status,omitempty" structs:"status,omitempty" `
}
// RemoteLinkIcon represents icon displayed next to link
type RemoteLinkIcon struct {
Url16x16 string ` json:"url16x16,omitempty" structs:"url16x16,omitempty" `
Title string ` json:"title,omitempty" structs:"title,omitempty" `
Link string ` json:"link,omitempty" structs:"link,omitempty" `
}
// RemoteLinkStatus if the link is a resolvable object (issue, epic) - the structure represent its status
type RemoteLinkStatus struct {
Resolved bool
Icon * RemoteLinkIcon
}
2018-06-02 00:37:01 +00:00
// Get returns a full representation of the issue for the given issue key.
// JIRA will attempt to identify the issue by the issueIdOrKey path parameter.
// This can be an issue id, or an issue key.
// If the issue cannot be found via an exact match, JIRA will also look for the issue in a case-insensitive way, or by looking to see if the issue was moved.
//
// The given options will be appended to the query string
//
// JIRA API docs: https://docs.atlassian.com/jira/REST/latest/#api/2/issue-getIssue
func ( s * IssueService ) Get ( issueID string , options * GetQueryOptions ) ( * Issue , * Response , error ) {
apiEndpoint := fmt . Sprintf ( "rest/api/2/issue/%s" , issueID )
req , err := s . client . NewRequest ( "GET" , apiEndpoint , nil )
if err != nil {
return nil , nil , err
}
if options != nil {
q , err := query . Values ( options )
if err != nil {
return nil , nil , err
}
req . URL . RawQuery = q . Encode ( )
}
issue := new ( Issue )
resp , err := s . client . Do ( req , issue )
if err != nil {
jerr := NewJiraError ( resp , err )
return nil , resp , jerr
}
return issue , resp , nil
}
// DownloadAttachment returns a Response of an attachment for a given attachmentID.
// The attachment is in the Response.Body of the response.
// This is an io.ReadCloser.
// The caller should close the resp.Body.
func ( s * IssueService ) DownloadAttachment ( attachmentID string ) ( * Response , error ) {
apiEndpoint := fmt . Sprintf ( "secure/attachment/%s/" , attachmentID )
req , err := s . client . NewRequest ( "GET" , apiEndpoint , nil )
if err != nil {
return nil , err
}
resp , err := s . client . Do ( req , nil )
if err != nil {
jerr := NewJiraError ( resp , err )
return resp , jerr
}
return resp , nil
}
// PostAttachment uploads r (io.Reader) as an attachment to a given issueID
func ( s * IssueService ) PostAttachment ( issueID string , r io . Reader , attachmentName string ) ( * [ ] Attachment , * Response , error ) {
apiEndpoint := fmt . Sprintf ( "rest/api/2/issue/%s/attachments" , issueID )
b := new ( bytes . Buffer )
writer := multipart . NewWriter ( b )
fw , err := writer . CreateFormFile ( "file" , attachmentName )
if err != nil {
return nil , nil , err
}
if r != nil {
// Copy the file
if _ , err = io . Copy ( fw , r ) ; err != nil {
return nil , nil , err
}
}
writer . Close ( )
req , err := s . client . NewMultiPartRequest ( "POST" , apiEndpoint , b )
if err != nil {
return nil , nil , err
}
req . Header . Set ( "Content-Type" , writer . FormDataContentType ( ) )
// PostAttachment response returns a JSON array (as multiple attachments can be posted)
attachment := new ( [ ] Attachment )
resp , err := s . client . Do ( req , attachment )
if err != nil {
jerr := NewJiraError ( resp , err )
return nil , resp , jerr
}
return attachment , resp , nil
}
2020-09-14 18:31:56 +00:00
// DeleteAttachment deletes an attachment of a given attachmentID
func ( s * IssueService ) DeleteAttachment ( attachmentID string ) ( * Response , error ) {
apiEndpoint := fmt . Sprintf ( "rest/api/2/attachment/%s" , attachmentID )
req , err := s . client . NewRequest ( "DELETE" , apiEndpoint , nil )
if err != nil {
return nil , err
}
resp , err := s . client . Do ( req , nil )
if err != nil {
jerr := NewJiraError ( resp , err )
return resp , jerr
}
return resp , nil
}
2018-06-02 00:37:01 +00:00
// GetWorklogs gets all the worklogs for an issue.
// This method is especially important if you need to read all the worklogs, not just the first page.
//
// https://docs.atlassian.com/jira/REST/cloud/#api/2/issue/{issueIdOrKey}/worklog-getIssueWorklog
2020-09-14 18:31:56 +00:00
func ( s * IssueService ) GetWorklogs ( issueID string , options ... func ( * http . Request ) error ) ( * Worklog , * Response , error ) {
2018-06-02 00:37:01 +00:00
apiEndpoint := fmt . Sprintf ( "rest/api/2/issue/%s/worklog" , issueID )
req , err := s . client . NewRequest ( "GET" , apiEndpoint , nil )
if err != nil {
return nil , nil , err
}
2020-09-14 18:31:56 +00:00
for _ , option := range options {
err = option ( req )
if err != nil {
return nil , nil , err
}
}
2018-06-02 00:37:01 +00:00
v := new ( Worklog )
resp , err := s . client . Do ( req , v )
return v , resp , err
}
2020-09-14 18:31:56 +00:00
// Applies query options to http request.
// This helper is meant to be used with all "QueryOptions" structs.
func WithQueryOptions ( options interface { } ) func ( * http . Request ) error {
q , err := query . Values ( options )
if err != nil {
return func ( * http . Request ) error {
return err
}
}
return func ( r * http . Request ) error {
r . URL . RawQuery = q . Encode ( )
return nil
}
}
2018-06-02 00:37:01 +00:00
// Create creates an issue or a sub-task from a JSON representation.
// Creating a sub-task is similar to creating a regular issue, with two important differences:
// The issueType field must correspond to a sub-task issue type and you must provide a parent field in the issue create request containing the id or key of the parent issue.
//
// JIRA API docs: https://docs.atlassian.com/jira/REST/latest/#api/2/issue-createIssues
func ( s * IssueService ) Create ( issue * Issue ) ( * Issue , * Response , error ) {
2020-09-14 18:31:56 +00:00
apiEndpoint := "rest/api/2/issue"
2018-06-02 00:37:01 +00:00
req , err := s . client . NewRequest ( "POST" , apiEndpoint , issue )
if err != nil {
return nil , nil , err
}
resp , err := s . client . Do ( req , nil )
if err != nil {
// incase of error return the resp for further inspection
return nil , resp , err
}
responseIssue := new ( Issue )
defer resp . Body . Close ( )
data , err := ioutil . ReadAll ( resp . Body )
if err != nil {
return nil , resp , fmt . Errorf ( "Could not read the returned data" )
}
err = json . Unmarshal ( data , responseIssue )
if err != nil {
return nil , resp , fmt . Errorf ( "Could not unmarshall the data into struct" )
}
return responseIssue , resp , nil
}
2020-09-14 18:31:56 +00:00
// UpdateWithOptions updates an issue from a JSON representation,
// while also specifiying query params. The issue is found by key.
2018-06-02 00:37:01 +00:00
//
// JIRA API docs: https://docs.atlassian.com/jira/REST/cloud/#api/2/issue-editIssue
2020-09-14 18:31:56 +00:00
func ( s * IssueService ) UpdateWithOptions ( issue * Issue , opts * UpdateQueryOptions ) ( * Issue , * Response , error ) {
2018-06-02 00:37:01 +00:00
apiEndpoint := fmt . Sprintf ( "rest/api/2/issue/%v" , issue . Key )
2020-09-14 18:31:56 +00:00
url , err := addOptions ( apiEndpoint , opts )
if err != nil {
return nil , nil , err
}
req , err := s . client . NewRequest ( "PUT" , url , issue )
2018-06-02 00:37:01 +00:00
if err != nil {
return nil , nil , err
}
resp , err := s . client . Do ( req , nil )
if err != nil {
jerr := NewJiraError ( resp , err )
return nil , resp , jerr
}
// This is just to follow the rest of the API's convention of returning an issue.
// Returning the same pointer here is pointless, so we return a copy instead.
ret := * issue
return & ret , resp , nil
}
2020-09-14 18:31:56 +00:00
// Update updates an issue from a JSON representation. The issue is found by key.
//
// JIRA API docs: https://docs.atlassian.com/jira/REST/cloud/#api/2/issue-editIssue
func ( s * IssueService ) Update ( issue * Issue ) ( * Issue , * Response , error ) {
return s . UpdateWithOptions ( issue , nil )
}
2018-06-02 00:37:01 +00:00
// UpdateIssue updates an issue from a JSON representation. The issue is found by key.
//
// https://docs.atlassian.com/jira/REST/7.4.0/#api/2/issue-editIssue
func ( s * IssueService ) UpdateIssue ( jiraID string , data map [ string ] interface { } ) ( * Response , error ) {
apiEndpoint := fmt . Sprintf ( "rest/api/2/issue/%v" , jiraID )
req , err := s . client . NewRequest ( "PUT" , apiEndpoint , data )
if err != nil {
return nil , err
}
resp , err := s . client . Do ( req , nil )
if err != nil {
return resp , err
}
// This is just to follow the rest of the API's convention of returning an issue.
// Returning the same pointer here is pointless, so we return a copy instead.
return resp , nil
}
// AddComment adds a new comment to issueID.
//
// JIRA API docs: https://docs.atlassian.com/jira/REST/latest/#api/2/issue-addComment
func ( s * IssueService ) AddComment ( issueID string , comment * Comment ) ( * Comment , * Response , error ) {
apiEndpoint := fmt . Sprintf ( "rest/api/2/issue/%s/comment" , issueID )
req , err := s . client . NewRequest ( "POST" , apiEndpoint , comment )
if err != nil {
return nil , nil , err
}
responseComment := new ( Comment )
resp , err := s . client . Do ( req , responseComment )
if err != nil {
jerr := NewJiraError ( resp , err )
return nil , resp , jerr
}
return responseComment , resp , nil
}
// UpdateComment updates the body of a comment, identified by comment.ID, on the issueID.
//
// JIRA API docs: https://docs.atlassian.com/jira/REST/cloud/#api/2/issue/{issueIdOrKey}/comment-updateComment
func ( s * IssueService ) UpdateComment ( issueID string , comment * Comment ) ( * Comment , * Response , error ) {
reqBody := struct {
Body string ` json:"body" `
} {
Body : comment . Body ,
}
apiEndpoint := fmt . Sprintf ( "rest/api/2/issue/%s/comment/%s" , issueID , comment . ID )
2020-09-14 18:31:56 +00:00
req , err := s . client . NewRequest ( "PUT" , apiEndpoint , reqBody )
2018-06-02 00:37:01 +00:00
if err != nil {
return nil , nil , err
}
responseComment := new ( Comment )
resp , err := s . client . Do ( req , responseComment )
if err != nil {
return nil , resp , err
}
return responseComment , resp , nil
}
2020-09-14 18:31:56 +00:00
// DeleteComment Deletes a comment from an issueID.
//
// JIRA API docs: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-api-3-issue-issueIdOrKey-comment-id-delete
func ( s * IssueService ) DeleteComment ( issueID , commentID string ) error {
apiEndpoint := fmt . Sprintf ( "rest/api/2/issue/%s/comment/%s" , issueID , commentID )
req , err := s . client . NewRequest ( "DELETE" , apiEndpoint , nil )
if err != nil {
return err
}
resp , err := s . client . Do ( req , nil )
if err != nil {
jerr := NewJiraError ( resp , err )
return jerr
}
return nil
}
2018-06-02 00:37:01 +00:00
// AddWorklogRecord adds a new worklog record to issueID.
//
// https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-issue-issueIdOrKey-worklog-post
2020-09-14 18:31:56 +00:00
func ( s * IssueService ) AddWorklogRecord ( issueID string , record * WorklogRecord , options ... func ( * http . Request ) error ) ( * WorklogRecord , * Response , error ) {
2018-06-02 00:37:01 +00:00
apiEndpoint := fmt . Sprintf ( "rest/api/2/issue/%s/worklog" , issueID )
req , err := s . client . NewRequest ( "POST" , apiEndpoint , record )
if err != nil {
return nil , nil , err
}
2020-09-14 18:31:56 +00:00
for _ , option := range options {
err = option ( req )
if err != nil {
return nil , nil , err
}
}
responseRecord := new ( WorklogRecord )
resp , err := s . client . Do ( req , responseRecord )
if err != nil {
jerr := NewJiraError ( resp , err )
return nil , resp , jerr
}
return responseRecord , resp , nil
}
// UpdateWorklogRecord updates a worklog record.
//
// https://docs.atlassian.com/software/jira/docs/api/REST/7.1.2/#api/2/issue-updateWorklog
func ( s * IssueService ) UpdateWorklogRecord ( issueID , worklogID string , record * WorklogRecord , options ... func ( * http . Request ) error ) ( * WorklogRecord , * Response , error ) {
apiEndpoint := fmt . Sprintf ( "rest/api/2/issue/%s/worklog/%s" , issueID , worklogID )
req , err := s . client . NewRequest ( "PUT" , apiEndpoint , record )
if err != nil {
return nil , nil , err
}
for _ , option := range options {
err = option ( req )
if err != nil {
return nil , nil , err
}
}
2018-06-02 00:37:01 +00:00
responseRecord := new ( WorklogRecord )
resp , err := s . client . Do ( req , responseRecord )
if err != nil {
jerr := NewJiraError ( resp , err )
return nil , resp , jerr
}
return responseRecord , resp , nil
}
// AddLink adds a link between two issues.
//
// JIRA API docs: https://docs.atlassian.com/jira/REST/latest/#api/2/issueLink
func ( s * IssueService ) AddLink ( issueLink * IssueLink ) ( * Response , error ) {
apiEndpoint := fmt . Sprintf ( "rest/api/2/issueLink" )
req , err := s . client . NewRequest ( "POST" , apiEndpoint , issueLink )
if err != nil {
return nil , err
}
resp , err := s . client . Do ( req , nil )
if err != nil {
err = NewJiraError ( resp , err )
}
return resp , err
}
// Search will search for tickets according to the jql
//
// JIRA API docs: https://developer.atlassian.com/jiradev/jira-apis/jira-rest-apis/jira-rest-api-tutorials/jira-rest-api-example-query-issues
func ( s * IssueService ) Search ( jql string , options * SearchOptions ) ( [ ] Issue , * Response , error ) {
var u string
if options == nil {
u = fmt . Sprintf ( "rest/api/2/search?jql=%s" , url . QueryEscape ( jql ) )
} else {
2020-09-14 18:31:56 +00:00
u = "rest/api/2/search?jql=" + url . QueryEscape ( jql )
if options . StartAt != 0 {
u += fmt . Sprintf ( "&startAt=%d" , options . StartAt )
}
if options . MaxResults != 0 {
u += fmt . Sprintf ( "&maxResults=%d" , options . MaxResults )
}
if options . Expand != "" {
u += fmt . Sprintf ( "&expand=%s" , options . Expand )
}
if strings . Join ( options . Fields , "," ) != "" {
u += fmt . Sprintf ( "&fields=%s" , strings . Join ( options . Fields , "," ) )
}
if options . ValidateQuery != "" {
u += fmt . Sprintf ( "&validateQuery=%s" , options . ValidateQuery )
}
2018-06-02 00:37:01 +00:00
}
req , err := s . client . NewRequest ( "GET" , u , nil )
if err != nil {
return [ ] Issue { } , nil , err
}
v := new ( searchResult )
resp , err := s . client . Do ( req , v )
if err != nil {
err = NewJiraError ( resp , err )
}
return v . Issues , resp , err
}
// SearchPages will get issues from all pages in a search
//
// JIRA API docs: https://developer.atlassian.com/jiradev/jira-apis/jira-rest-apis/jira-rest-api-tutorials/jira-rest-api-example-query-issues
func ( s * IssueService ) SearchPages ( jql string , options * SearchOptions , f func ( Issue ) error ) error {
if options == nil {
options = & SearchOptions {
StartAt : 0 ,
MaxResults : 50 ,
}
}
if options . MaxResults == 0 {
options . MaxResults = 50
}
issues , resp , err := s . Search ( jql , options )
if err != nil {
return err
}
for {
for _ , issue := range issues {
err = f ( issue )
if err != nil {
return err
}
}
if resp . StartAt + resp . MaxResults >= resp . Total {
return nil
}
options . StartAt += resp . MaxResults
issues , resp , err = s . Search ( jql , options )
if err != nil {
return err
}
}
}
// GetCustomFields returns a map of customfield_* keys with string values
func ( s * IssueService ) GetCustomFields ( issueID string ) ( CustomFields , * Response , error ) {
apiEndpoint := fmt . Sprintf ( "rest/api/2/issue/%s" , issueID )
req , err := s . client . NewRequest ( "GET" , apiEndpoint , nil )
if err != nil {
return nil , nil , err
}
issue := new ( map [ string ] interface { } )
resp , err := s . client . Do ( req , issue )
if err != nil {
jerr := NewJiraError ( resp , err )
return nil , resp , jerr
}
m := * issue
f := m [ "fields" ]
cf := make ( CustomFields )
if f == nil {
return cf , resp , nil
}
if rec , ok := f . ( map [ string ] interface { } ) ; ok {
for key , val := range rec {
if strings . Contains ( key , "customfield" ) {
if valMap , ok := val . ( map [ string ] interface { } ) ; ok {
if v , ok := valMap [ "value" ] ; ok {
val = v
}
}
cf [ key ] = fmt . Sprint ( val )
}
}
}
return cf , resp , nil
}
// GetTransitions gets a list of the transitions possible for this issue by the current user,
// along with fields that are required and their types.
//
// JIRA API docs: https://docs.atlassian.com/jira/REST/latest/#api/2/issue-getTransitions
func ( s * IssueService ) GetTransitions ( id string ) ( [ ] Transition , * Response , error ) {
apiEndpoint := fmt . Sprintf ( "rest/api/2/issue/%s/transitions?expand=transitions.fields" , id )
req , err := s . client . NewRequest ( "GET" , apiEndpoint , nil )
if err != nil {
return nil , nil , err
}
result := new ( transitionResult )
resp , err := s . client . Do ( req , result )
if err != nil {
err = NewJiraError ( resp , err )
}
return result . Transitions , resp , err
}
// DoTransition performs a transition on an issue.
// When performing the transition you can update or set other issue fields.
//
// JIRA API docs: https://docs.atlassian.com/jira/REST/latest/#api/2/issue-doTransition
func ( s * IssueService ) DoTransition ( ticketID , transitionID string ) ( * Response , error ) {
payload := CreateTransitionPayload {
Transition : TransitionPayload {
ID : transitionID ,
} ,
}
return s . DoTransitionWithPayload ( ticketID , payload )
}
// DoTransitionWithPayload performs a transition on an issue using any payload.
// When performing the transition you can update or set other issue fields.
//
// JIRA API docs: https://docs.atlassian.com/jira/REST/latest/#api/2/issue-doTransition
func ( s * IssueService ) DoTransitionWithPayload ( ticketID , payload interface { } ) ( * Response , error ) {
apiEndpoint := fmt . Sprintf ( "rest/api/2/issue/%s/transitions" , ticketID )
req , err := s . client . NewRequest ( "POST" , apiEndpoint , payload )
if err != nil {
return nil , err
}
resp , err := s . client . Do ( req , nil )
if err != nil {
err = NewJiraError ( resp , err )
}
return resp , err
}
// InitIssueWithMetaAndFields returns Issue with with values from fieldsConfig properly set.
// * metaProject should contain metaInformation about the project where the issue should be created.
// * metaIssuetype is the MetaInformation about the Issuetype that needs to be created.
// * fieldsConfig is a key->value pair where key represents the name of the field as seen in the UI
// And value is the string value for that particular key.
// Note: This method doesn't verify that the fieldsConfig is complete with mandatory fields. The fieldsConfig is
// supposed to be already verified with MetaIssueType.CheckCompleteAndAvailable. It will however return
// error if the key is not found.
// All values will be packed into Unknowns. This is much convenient. If the struct fields needs to be
// configured as well, marshalling and unmarshalling will set the proper fields.
func InitIssueWithMetaAndFields ( metaProject * MetaProject , metaIssuetype * MetaIssueType , fieldsConfig map [ string ] string ) ( * Issue , error ) {
issue := new ( Issue )
issueFields := new ( IssueFields )
issueFields . Unknowns = tcontainer . NewMarshalMap ( )
// map the field names the User presented to jira's internal key
allFields , _ := metaIssuetype . GetAllFields ( )
for key , value := range fieldsConfig {
jiraKey , found := allFields [ key ]
if ! found {
return nil , fmt . Errorf ( "key %s is not found in the list of fields" , key )
}
valueType , err := metaIssuetype . Fields . String ( jiraKey + "/schema/type" )
if err != nil {
return nil , err
}
switch valueType {
case "array" :
elemType , err := metaIssuetype . Fields . String ( jiraKey + "/schema/items" )
if err != nil {
return nil , err
}
switch elemType {
case "component" :
issueFields . Unknowns [ jiraKey ] = [ ] Component { { Name : value } }
case "option" :
issueFields . Unknowns [ jiraKey ] = [ ] map [ string ] string { { "value" : value } }
default :
issueFields . Unknowns [ jiraKey ] = [ ] string { value }
}
case "string" :
issueFields . Unknowns [ jiraKey ] = value
case "date" :
issueFields . Unknowns [ jiraKey ] = value
case "datetime" :
issueFields . Unknowns [ jiraKey ] = value
case "any" :
// Treat any as string
issueFields . Unknowns [ jiraKey ] = value
case "project" :
issueFields . Unknowns [ jiraKey ] = Project {
Name : metaProject . Name ,
ID : metaProject . Id ,
}
case "priority" :
issueFields . Unknowns [ jiraKey ] = Priority { Name : value }
case "user" :
issueFields . Unknowns [ jiraKey ] = User {
Name : value ,
}
case "issuetype" :
issueFields . Unknowns [ jiraKey ] = IssueType {
Name : value ,
}
case "option" :
issueFields . Unknowns [ jiraKey ] = Option {
Value : value ,
}
default :
return nil , fmt . Errorf ( "Unknown issue type encountered: %s for %s" , valueType , key )
}
}
issue . Fields = issueFields
return issue , nil
}
// Delete will delete a specified issue.
func ( s * IssueService ) Delete ( issueID string ) ( * Response , error ) {
apiEndpoint := fmt . Sprintf ( "rest/api/2/issue/%s" , issueID )
// to enable deletion of subtasks; without this, the request will fail if the issue has subtasks
deletePayload := make ( map [ string ] interface { } )
deletePayload [ "deleteSubtasks" ] = "true"
content , _ := json . Marshal ( deletePayload )
req , err := s . client . NewRequest ( "DELETE" , apiEndpoint , content )
if err != nil {
return nil , err
}
resp , err := s . client . Do ( req , nil )
return resp , err
}
// GetWatchers wil return all the users watching/observing the given issue
//
// JIRA API docs: https://docs.atlassian.com/software/jira/docs/api/REST/latest/#api/2/issue-getIssueWatchers
func ( s * IssueService ) GetWatchers ( issueID string ) ( * [ ] User , * Response , error ) {
watchesAPIEndpoint := fmt . Sprintf ( "rest/api/2/issue/%s/watchers" , issueID )
req , err := s . client . NewRequest ( "GET" , watchesAPIEndpoint , nil )
if err != nil {
return nil , nil , err
}
watches := new ( Watches )
resp , err := s . client . Do ( req , watches )
if err != nil {
return nil , nil , NewJiraError ( resp , err )
}
result := [ ] User { }
user := new ( User )
for _ , watcher := range watches . Watchers {
user , resp , err = s . client . User . Get ( watcher . Name )
if err != nil {
return nil , resp , NewJiraError ( resp , err )
}
result = append ( result , * user )
}
return & result , resp , nil
}
// AddWatcher adds watcher to the given issue
//
// JIRA API docs: https://docs.atlassian.com/software/jira/docs/api/REST/latest/#api/2/issue-addWatcher
func ( s * IssueService ) AddWatcher ( issueID string , userName string ) ( * Response , error ) {
apiEndPoint := fmt . Sprintf ( "rest/api/2/issue/%s/watchers" , issueID )
req , err := s . client . NewRequest ( "POST" , apiEndPoint , userName )
if err != nil {
return nil , err
}
resp , err := s . client . Do ( req , nil )
if err != nil {
err = NewJiraError ( resp , err )
}
return resp , err
}
// RemoveWatcher removes given user from given issue
//
// JIRA API docs: https://docs.atlassian.com/software/jira/docs/api/REST/latest/#api/2/issue-removeWatcher
func ( s * IssueService ) RemoveWatcher ( issueID string , userName string ) ( * Response , error ) {
apiEndPoint := fmt . Sprintf ( "rest/api/2/issue/%s/watchers" , issueID )
req , err := s . client . NewRequest ( "DELETE" , apiEndPoint , userName )
if err != nil {
return nil , err
}
resp , err := s . client . Do ( req , nil )
if err != nil {
err = NewJiraError ( resp , err )
}
return resp , err
}
2020-09-14 18:31:56 +00:00
// UpdateAssignee updates the user assigned to work on the given issue
//
// JIRA API docs: https://docs.atlassian.com/software/jira/docs/api/REST/7.10.2/#api/2/issue-assign
func ( s * IssueService ) UpdateAssignee ( issueID string , assignee * User ) ( * Response , error ) {
apiEndPoint := fmt . Sprintf ( "rest/api/2/issue/%s/assignee" , issueID )
req , err := s . client . NewRequest ( "PUT" , apiEndPoint , assignee )
if err != nil {
return nil , err
}
resp , err := s . client . Do ( req , nil )
if err != nil {
err = NewJiraError ( resp , err )
}
return resp , err
}
func ( c ChangelogHistory ) CreatedTime ( ) ( time . Time , error ) {
var t time . Time
// Ignore null
if string ( c . Created ) == "null" {
return t , nil
}
t , err := time . Parse ( "2006-01-02T15:04:05.999-0700" , c . Created )
return t , err
}
// GetRemoteLinks gets remote issue links on the issue.
//
// JIRA API docs: https://docs.atlassian.com/jira/REST/latest/#api/2/issue-getRemoteIssueLinks
func ( s * IssueService ) GetRemoteLinks ( id string ) ( * [ ] RemoteLink , * Response , error ) {
apiEndpoint := fmt . Sprintf ( "rest/api/2/issue/%s/remotelink" , id )
req , err := s . client . NewRequest ( "GET" , apiEndpoint , nil )
if err != nil {
return nil , nil , err
}
result := new ( [ ] RemoteLink )
resp , err := s . client . Do ( req , result )
if err != nil {
err = NewJiraError ( resp , err )
}
return result , resp , err
}