Documentation ¶
Index ¶
- type AuthenticationService
- type BoardService
- func (b *BoardService) Backlog(ctx context.Context, boardID, startAt, maxResults int, ...) (result *models.BoardIssuePageScheme, response *ResponseScheme, err error)
- func (b *BoardService) Configuration(ctx context.Context, boardID int) (result *models.BoardConfigurationScheme, response *ResponseScheme, err error)
- func (b *BoardService) Create(ctx context.Context, payload *models.BoardPayloadScheme) (result *models.BoardScheme, response *ResponseScheme, err error)
- func (b *BoardService) Delete(ctx context.Context, boardID int) (response *ResponseScheme, err error)
- func (b *BoardService) Epics(ctx context.Context, boardID, startAt, maxResults int, done bool) (result *models.BoardEpicPageScheme, response *ResponseScheme, err error)
- func (b *BoardService) Filter(ctx context.Context, filterID, startAt, maxResults int) (result *models.BoardPageScheme, response *ResponseScheme, err error)
- func (b *BoardService) Get(ctx context.Context, boardID int) (result *models.BoardScheme, response *ResponseScheme, err error)
- func (b *BoardService) Gets(ctx context.Context, opts *models.GetBoardsOptions, startAt, maxResults int) (result *models.BoardPageScheme, response *ResponseScheme, err error)
- func (b *BoardService) Issues(ctx context.Context, boardID, startAt, maxResults int, ...) (result *models.BoardIssuePageScheme, response *ResponseScheme, err error)
- func (b *BoardService) IssuesByEpic(ctx context.Context, boardID, epicID, startAt, maxResults int, ...) (result *models.BoardIssuePageScheme, response *ResponseScheme, err error)
- func (b *BoardService) IssuesBySprint(ctx context.Context, boardID, sprintID, startAt, maxResults int, ...) (result *models.BoardIssuePageScheme, response *ResponseScheme, err error)
- func (b *BoardService) IssuesWithoutEpic(ctx context.Context, boardID, startAt, maxResults int, ...) (result *models.BoardIssuePageScheme, response *ResponseScheme, err error)
- func (b *BoardService) Move(ctx context.Context, boardID int, payload *models.BoardMovementPayloadScheme) (response *ResponseScheme, err error)
- func (b *BoardService) Projects(ctx context.Context, boardID, startAt, maxResults int) (result *models.BoardProjectPageScheme, response *ResponseScheme, err error)
- func (b *BoardService) Sprints(ctx context.Context, boardID, startAt, maxResults int, states []string) (result *models.BoardSprintPageScheme, response *ResponseScheme, err error)
- func (b *BoardService) Versions(ctx context.Context, boardID, startAt, maxResults int, released bool) (result *models.BoardVersionPageScheme, response *ResponseScheme, err error)
- type Client
- type EpicService
- func (e *EpicService) Get(ctx context.Context, epicIDOrKey string) (result *models.EpicScheme, response *ResponseScheme, err error)
- func (e *EpicService) Issues(ctx context.Context, epicIDOrKey string, startAt, maxResults int, ...) (result *models.BoardIssuePageScheme, response *ResponseScheme, err error)
- func (e *EpicService) Move(ctx context.Context, epicIDOrKey string, issues []string) (response *ResponseScheme, err error)
- type ResponseScheme
- type SprintService
- func (s *SprintService) Close(ctx context.Context, sprintID int) (response *ResponseScheme, err error)
- func (s *SprintService) Create(ctx context.Context, payload *models.SprintPayloadScheme) (result *models.SprintScheme, response *ResponseScheme, err error)
- func (s *SprintService) Delete(ctx context.Context, sprintID int) (response *ResponseScheme, err error)
- func (s *SprintService) Get(ctx context.Context, sprintID int) (result *models.SprintScheme, response *ResponseScheme, err error)
- func (s *SprintService) Issues(ctx context.Context, sprintID int, opts *models.IssueOptionScheme, ...) (result *models.SprintIssuePageScheme, response *ResponseScheme, err error)
- func (s *SprintService) Path(ctx context.Context, sprintID int, payload *models.SprintPayloadScheme) (result *models.SprintScheme, response *ResponseScheme, err error)
- func (s *SprintService) Start(ctx context.Context, sprintID int) (response *ResponseScheme, err error)
- func (s *SprintService) Update(ctx context.Context, sprintID int, payload *models.SprintPayloadScheme) (result *models.SprintScheme, response *ResponseScheme, err error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuthenticationService ¶
type AuthenticationService struct {
// contains filtered or unexported fields
}
func (*AuthenticationService) SetBasicAuth ¶
func (a *AuthenticationService) SetBasicAuth(mail, token string)
func (*AuthenticationService) SetUserAgent ¶
func (a *AuthenticationService) SetUserAgent(agent string)
type BoardService ¶
type BoardService struct {
// contains filtered or unexported fields
}
func (*BoardService) Backlog ¶
func (b *BoardService) Backlog(ctx context.Context, boardID, startAt, maxResults int, opts *models.IssueOptionScheme) (result *models.BoardIssuePageScheme, response *ResponseScheme, err error)
Backlog returns all issues from the board's backlog, for the given board ID. This only includes issues that the user has permission to view. The backlog contains incomplete issues that are not assigned to any future or active sprint. Note, if the user does not have permission to view the board, no issues will be returned at all. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank. Docs: https://docs.go-atlassian.io/jira-agile/boards#get-issues-for-backlog
func (*BoardService) Configuration ¶
func (b *BoardService) Configuration(ctx context.Context, boardID int) (result *models.BoardConfigurationScheme, response *ResponseScheme, err error)
Configuration get the board configuration. Docs: https://docs.go-atlassian.io/jira-agile/boards#get-configuration
func (*BoardService) Create ¶
func (b *BoardService) Create(ctx context.Context, payload *models.BoardPayloadScheme) (result *models.BoardScheme, response *ResponseScheme, err error)
Create creates a new board. Board name, type and filter ID is required. Docs: https://docs.go-atlassian.io/jira-agile/boards#create-board
func (*BoardService) Delete ¶ added in v1.3.1
func (b *BoardService) Delete(ctx context.Context, boardID int) (response *ResponseScheme, err error)
Delete deletes the board. Admin without the view permission can still remove the board. Docs: N/A Atlassian Docs: https://developer.atlassian.com/cloud/jira/software/rest/api-group-board/#api-agile-1-0-board-boardid-delete
func (*BoardService) Epics ¶
func (b *BoardService) Epics(ctx context.Context, boardID, startAt, maxResults int, done bool) (result *models.BoardEpicPageScheme, response *ResponseScheme, err error)
Epics returns all epics from the board, for the given board ID. This only includes epics that the user has permission to view. Note, if the user does not have permission to view the board, no epics will be returned at all. Docs: https://docs.go-atlassian.io/jira-agile/boards#get-epics
func (*BoardService) Filter ¶
func (b *BoardService) Filter(ctx context.Context, filterID, startAt, maxResults int) (result *models.BoardPageScheme, response *ResponseScheme, err error)
Filter returns any boards which use the provided filter id. This method can be executed by users without a valid software license in order to find which boards are using a particular filter. Docs: https://docs.go-atlassian.io/jira-agile/boards#get-board-by-filter-id
func (*BoardService) Get ¶
func (b *BoardService) Get(ctx context.Context, boardID int) (result *models.BoardScheme, response *ResponseScheme, err error)
Get returns the board for the given board ID. This board will only be returned if the user has permission to view it. Admins without the view permission will see the board as a private one, so will see only a subset of the board's data (board location for instance). Docs: https://docs.go-atlassian.io/jira-agile/boards#get-board
func (*BoardService) Gets ¶ added in v1.3.1
func (b *BoardService) Gets(ctx context.Context, opts *models.GetBoardsOptions, startAt, maxResults int) (result *models.BoardPageScheme, response *ResponseScheme, err error)
Gets returns all boards. This only includes boards that the user has permission to view. Docs: https://developer.atlassian.com/cloud/jira/software/rest/api-group-other-operations/#api-agile-1-0-board-get
func (*BoardService) Issues ¶
func (b *BoardService) Issues(ctx context.Context, boardID, startAt, maxResults int, opts *models.IssueOptionScheme) ( result *models.BoardIssuePageScheme, response *ResponseScheme, err error)
Issues returns all issues from a board, for a given board ID. This only includes issues that the user has permission to view. An issue belongs to the board if its status is mapped to the board's column. Epic issues do not belongs to the scrum boards. Note, if the user does not have permission to view the board, no issues will be returned at all. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank. Docs: https://docs.go-atlassian.io/jira-agile/boards#get-issues-for-board
func (*BoardService) IssuesByEpic ¶
func (b *BoardService) IssuesByEpic(ctx context.Context, boardID, epicID, startAt, maxResults int, opts *models.IssueOptionScheme) ( result *models.BoardIssuePageScheme, response *ResponseScheme, err error)
IssuesByEpic returns all issues that belong to an epic on the board, for the given epic ID and the board ID. This only includes issues that the user has permission to view. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank. Docs: https://docs.go-atlassian.io/jira-agile/boards#get-board-issues-for-epic
func (*BoardService) IssuesBySprint ¶
func (b *BoardService) IssuesBySprint(ctx context.Context, boardID, sprintID, startAt, maxResults int, opts *models.IssueOptionScheme) (result *models.BoardIssuePageScheme, response *ResponseScheme, err error)
IssuesBySprint get all issues you have access to that belong to the sprint from the board. Issue returned from this resource contains additional fields like: sprint, closedSprints, flagged and epic. Issues are returned ordered by rank. JQL order has higher priority than default rank. Docs: https://docs.go-atlassian.io/jira-agile/boards#get-board-issues-for-sprint
func (*BoardService) IssuesWithoutEpic ¶
func (b *BoardService) IssuesWithoutEpic(ctx context.Context, boardID, startAt, maxResults int, opts *models.IssueOptionScheme) ( result *models.BoardIssuePageScheme, response *ResponseScheme, err error)
IssuesWithoutEpic returns all issues that do not belong to any epic on a board, for a given board ID. This only includes issues that the user has permission to view. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank. Docs: https://docs.go-atlassian.io/jira-agile/boards#get-issues-without-epic-for-board
func (*BoardService) Move ¶
func (b *BoardService) Move(ctx context.Context, boardID int, payload *models.BoardMovementPayloadScheme) (response *ResponseScheme, err error)
Move issues from the backlog to the board (if they are already in the backlog of that board). This operation either moves an issue(s) onto a board from the backlog (by adding it to the issueList for the board) Or transitions the issue(s) to the first column for a kanban board with backlog. At most 50 issues may be moved at once. Docs: https://docs.go-atlassian.io/jira-agile/boards#move-issues-to-backlog-for-board
func (*BoardService) Projects ¶
func (b *BoardService) Projects(ctx context.Context, boardID, startAt, maxResults int) ( result *models.BoardProjectPageScheme, response *ResponseScheme, err error)
Projects returns all projects that are associated with the board, for the given board ID. If the user does not have permission to view the board, no projects will be returned at all. Returned projects are ordered by the name. Docs: https://docs.go-atlassian.io/jira-agile/boards#get-projects
func (*BoardService) Sprints ¶
func (b *BoardService) Sprints(ctx context.Context, boardID, startAt, maxResults int, states []string) ( result *models.BoardSprintPageScheme, response *ResponseScheme, err error)
Sprints returns all sprints from a board, for a given board ID. This only includes sprints that the user has permission to view. Docs: https://docs.go-atlassian.io/jira-agile/boards#get-all-sprints
func (*BoardService) Versions ¶
func (b *BoardService) Versions(ctx context.Context, boardID, startAt, maxResults int, released bool) ( result *models.BoardVersionPageScheme, response *ResponseScheme, err error)
Versions returns all versions from a board, for a given board ID. This only includes versions that the user has permission to view. Note, if the user does not have permission to view the board, no versions will be returned at all. Returned versions are ordered by the name of the project from which they belong and then by sequence defined by user. Docs: https://docs.go-atlassian.io/jira-agile/boards#get-all-versions
type Client ¶
type Client struct { HTTP *http.Client Site *url.URL Auth *AuthenticationService Sprint *SprintService Board *BoardService Epic *EpicService }
type EpicService ¶
type EpicService struct {
// contains filtered or unexported fields
}
func (*EpicService) Get ¶
func (e *EpicService) Get(ctx context.Context, epicIDOrKey string) (result *models.EpicScheme, response *ResponseScheme, err error)
Get returns the epic for a given epic ID. This epic will only be returned if the user has permission to view it. Note: This operation does not work for epics in next-gen projects. Docs: https://docs.go-atlassian.io/jira-agile/epics#get-epic
func (*EpicService) Issues ¶
func (e *EpicService) Issues(ctx context.Context, epicIDOrKey string, startAt, maxResults int, opts *models.IssueOptionScheme) (result *models.BoardIssuePageScheme, response *ResponseScheme, err error)
Issues returns all issues that belong to the epic, for the given epic ID. This only includes issues that the user has permission to view. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank. Docs: https://docs.go-atlassian.io/jira-agile/epics#get-issues-for-epic
func (*EpicService) Move ¶ added in v1.3.1
func (e *EpicService) Move(ctx context.Context, epicIDOrKey string, issues []string) (response *ResponseScheme, err error)
Move moves issues to an epic, for a given epic id. Issues can be only in a single epic at the same time. That means that already assigned issues to an epic, will not be assigned to the previous epic anymore. The user needs to have the edit issue permission for all issue they want to move and to the epic. The maximum number of issues that can be moved in one operation is 50.
type ResponseScheme ¶ added in v1.3.0
type SprintService ¶
type SprintService struct {
// contains filtered or unexported fields
}
func (*SprintService) Close ¶
func (s *SprintService) Close(ctx context.Context, sprintID int) (response *ResponseScheme, err error)
Close closes the Sprint Docs: https://docs.go-atlassian.io/jira-agile/sprints#close-sprint
func (*SprintService) Create ¶
func (s *SprintService) Create(ctx context.Context, payload *models.SprintPayloadScheme) (result *models.SprintScheme, response *ResponseScheme, err error)
Create creates a future sprint. Sprint name and origin board id are required. Start date, end date, and goal are optional. Docs: https://docs.go-atlassian.io/jira-agile/sprints#create-print
func (*SprintService) Delete ¶
func (s *SprintService) Delete(ctx context.Context, sprintID int) (response *ResponseScheme, err error)
Delete deletes a sprint. Once a sprint is deleted, all open issues in the sprint will be moved to the backlog.
func (*SprintService) Get ¶
func (s *SprintService) Get(ctx context.Context, sprintID int) (result *models.SprintScheme, response *ResponseScheme, err error)
Get Returns the sprint for a given sprint ID. The sprint will only be returned if the user can view the board that the sprint was created on, or view at least one of the issues in the sprint. Docs: https://docs.go-atlassian.io/jira-agile/sprints#get-sprint
func (*SprintService) Issues ¶
func (s *SprintService) Issues(ctx context.Context, sprintID int, opts *models.IssueOptionScheme, startAt, maxResults int) ( result *models.SprintIssuePageScheme, response *ResponseScheme, err error)
Issues returns all issues in a sprint, for a given sprint ID. This only includes issues that the user has permission to view. By default, the returned issues are ordered by rank. Docs: https://docs.go-atlassian.io/jira-agile/sprints#get-issues-for-sprint
func (*SprintService) Path ¶
func (s *SprintService) Path(ctx context.Context, sprintID int, payload *models.SprintPayloadScheme) (result *models.SprintScheme, response *ResponseScheme, err error)
Path Performs a partial update of a sprint. A partial update means that fields not present in the request JSON will not be updated. Docs: https://docs.go-atlassian.io/jira-agile/sprints#partially-update-sprint
func (*SprintService) Start ¶
func (s *SprintService) Start(ctx context.Context, sprintID int) (response *ResponseScheme, err error)
Start initiate the Sprint Docs: https://docs.go-atlassian.io/jira-agile/sprints#start-sprint
func (*SprintService) Update ¶
func (s *SprintService) Update(ctx context.Context, sprintID int, payload *models.SprintPayloadScheme) (result *models.SprintScheme, response *ResponseScheme, err error)
Update Performs a full update of a sprint. A full update means that the result will be exactly the same as the request body. Any fields not present in the request JSON will be set to null. Docs: https://docs.go-atlassian.io/jira-agile/sprints#update-sprint