jira

Documentation

Index

• Variables
• type Board
• type BoardService
• type BoardsList
• type Client
  • func NewJiraClient(username, password, host string) *Client
• type Component
• type Fields
• type Issue
• type IssueFields
  • func (ifs IssueFields) String() string
• type IssueResult
• type IssueService
  • func (s *IssueService) GetByKeyOrID(keyOrID, fields string) (*Issue, error)
• type IssueType
• type LinkIssue
• type Priority
• type Project
• type ProjectService
• type Sprint
• type SprintService
• type SprintsList
• type Status
• type StatusCategory
• type User

Variables

var NormalIssueFields = IssueFields{
	"issuetype",
	"project",
	"created",
	"updated",
	"priority",
	"issuelinks",
	"status",
	"resolution",
	"summary",
	"description",
	"creator",
	"assignee",
	"reporter",
	"priority",
	"components",
	"customfield_10001",
}

NormalIssueFields is normal issue fields customfield_10001 represents epic link value

Types

type Board

type Board struct {
	ID   int    `json:"id,omitempty"`
	Self string `json:"self,omitempty"`
	Name string `json:"name,omitempty"`
	Type string `json:"type,omitempty"`
}

Board ...

type BoardService

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

BoardService ...

type BoardsList

type BoardsList struct {
	MaxResults int      `json:"maxResults"`
	StartAt    int      `json:"startAt"`
	Total      int      `json:"total"`
	IsLast     bool     `json:"isLast"`
	Values     []*Board `json:"values"`
}

BoardsList ...

type Client

type Client struct {
	Host    string
	Conn    *httpclient.Client
	Issue   *IssueService
	Project *ProjectService
	Board   *BoardService
	Sprint  *SprintService
}

Client is jira RPC client

func NewJiraClient

func NewJiraClient(username, password, host string) *Client

NewJiraClient is to get jira client func

type Component

type Component struct {
	ID          string `json:"id,omitempty"`
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
}

Component ...

type Fields

type Fields struct {
	Summary          string       `bson:"summary,omitempty"               json:"summary,omitempty"`
	Description      string       `bson:"description,omitempty"           json:"description,omitempty"`
	IssueType        *IssueType   `bson:"issuetype,omitempty"             json:"issuetype,omitempty"`
	IssueLinks       []*LinkIssue `bson:"issuelinks,omitempty"            json:"issuelinks,omitempty"`
	Project          *Project     `bson:"project,omitempty"               json:"project,omitempty"`
	CustomField10001 string       `bson:"customfield_10001,omitempty"     json:"customfield_10001,omitempty"` //epic link
	Creator          *User        `bson:"creator,omitempty"               json:"creator,omitempty"`
	Assignee         *User        `bson:"assignee,omitempty"              json:"assignee,omitempty"`
	Reporter         *User        `bson:"reporter,omitempty"              json:"reporter,omitempty"`
	Priority         *Priority    `bson:"priority,omitempty"              json:"priority,omitempty"`
	Status           *Status      `bson:"status,omitempty"                json:"status,omitempty"`
	Components       []*Component `bson:"components,omitempty"            json:"components,omitempty"`
}

Fields IssueResult:Issues:Fields

type Issue

type Issue struct {
	ID     string  `bson:"id,omitempty"     json:"id,omitempty"`
	Key    string  `bson:"key,omitempty"    json:"key,omitempty"`
	Self   string  `bson:"self,omitempty"   json:"self,omitempty"`
	Fields *Fields `bson:"fields,omitempty" json:"fields,omitempty"`
}

Issue IssueResult:Issues

type IssueFields

type IssueFields []string

IssueFields is jira issue fields

func (IssueFields) String

func (ifs IssueFields) String() string

String join issue fields

type IssueResult

type IssueResult struct {
	Total      int      `bson:"total,omitempty"      json:"total,omitempty"`
	MaxResults int      `bson:"maxResults,omitempty" json:"maxResults,omitempty"`
	Issues     []*Issue `bson:"issues,omitempty"     json:"issues,omitempty"`
}

IssueResult ...

type IssueService

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

IssueService ...

func (*IssueService) GetByKeyOrID

func (s *IssueService) GetByKeyOrID(keyOrID, fields string) (*Issue, error)

GetByKeyOrID https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-issue-issueIdOrKey-get

type IssueType

type IssueType struct {
	ID          string `bson:"id,omitempty"          json:"id,omitempty"`
	Self        string `bson:"self,omitempty"        json:"self,omitempty"`
	Name        string `bson:"name,omitempty"        json:"name,omitempty"`
	Description string `bson:"description,omitempty" json:"description,omitempty"`
	IconURL     string `bson:"iconUrl,omitempty"     json:"iconUrl,omitempty"`
}

IssueType is issue type

type LinkIssue

type LinkIssue struct {
	ID           string `bson:"id,omitempty"           json:"id,omitempty"`
	InwardIssue  *Issue `bson:"inwardIssue,omitempty"  json:"inwardIssue,omitempty"`
	OutwardIssue *Issue `bson:"outwardIssue,omitempty" json:"outwardIssue,omitempty"`
}

LinkIssue IssueResult:Issues:Field:LinkIssues

type Priority

type Priority struct {
	ID          string `bson:"id,omitempty"          json:"id,omitempty"`
	Name        string `bson:"name,omitempty"        json:"name,omitempty"`
	Self        string `bson:"self,omitempty"        json:"self,omitempty"`
	Description string `bson:"description,omitempty" json:"description,omitempty"`
}

Priority is jira Priority

type Project

type Project struct {
	ID   string `json:"id,omitempty"`
	Key  string `json:"key,omitempty"`
	Name string `json:"name,omitempty"`
}

Project ...

type ProjectService

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

ProjectService ...

type Sprint

type Sprint struct {
	ID            int       `json:"id,omitempty"`
	Self          string    `json:"self,omitempty"`
	State         string    `json:"state,omitempty"`
	Name          string    `json:"name,omitempty"`
	StartDate     time.Time `json:"startDate,omitempty"`
	EndDate       time.Time `json:"endDate,omitempty"`
	CompleteDate  time.Time `json:"completeDate,omitempty"`
	OriginBoardID int       `json:"originBoardId,omitempty"`
}

Sprint represents a JIRA agile board

type SprintService

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

SprintService ...

type SprintsList

type SprintsList struct {
	MaxResults int       `json:"maxResults"`
	StartAt    int       `json:"startAt"`
	IsLast     bool      `json:"isLast"`
	Values     []*Sprint `json:"values"`
}

SprintsList ...

type Status

type Status struct {
	ID             string          `bson:"id,omitempty"                 json:"id,omitempty"`
	Name           string          `bson:"name,omitempty"               json:"name,omitempty"`
	StatusCategory *StatusCategory `bson:"statusCategory,omitempty"     json:"statusCategory,omitempty"`
}

Status ...

type StatusCategory

type StatusCategory struct {
	ID  int    `bson:"id,omitempty"                       json:"id,omitempty"`
	Key string `bson:"key,omitempty"                      json:"key,omitempty"`
}

StatusCategory ...

type User

type User struct {
	Name        string `bson:"name,omitempty"        json:"name,omitempty"`
	Key         string `bson:"key,omitempty"         json:"key,omitempty"`
	Self        string `bson:"self,omitempty"        json:"self,omitempty"`
	DisplayName string `bson:"displayName,omitempty" json:"displayName,omitempty"`
}

User is jira user