Copyright	(c) Rob Stewart Heriot-Watt University 2019
License	BSD3
Maintainer	robstewart57@gmail.com
Stability	stable
Safe Haskell	Safe-Inferred
Language	Haskell2010

GitLab.API.Issues

Contents

List issues
List group issues
List project issues
Single issue
User issues
Single project issue
New issue
Edit issue
Delete an issue
Reorder an issue
Move an issue
Clone an issue
Subscribe to an issue
Unsubscribe from an issue
Create a to-do item
List merge requests related to issue
List merge requests that close a particular issue on merge
Participants on issues
Comments on issues
Get issues statistics
Get group issues statistics
Get project issues statistics
Issues attributes

Description

Synopsis

groupIssues :: Group -> IssueFilterAttrs -> GitLab [Issue]
projectIssues :: Project -> IssueFilterAttrs -> GitLab [Issue]
issue :: Int -> GitLab (Either (Response ByteString) (Maybe Issue))
userIssues :: User -> GitLab [Issue]
projectIssue :: Project -> Int -> GitLab (Either (Response ByteString) (Maybe Issue))
newIssue :: Project -> Text -> Text -> IssueAttrs -> GitLab (Either (Response ByteString) (Maybe Issue))
newIssue' :: Int -> Text -> Text -> IssueAttrs -> GitLab (Either (Response ByteString) (Maybe Issue))
editIssue :: Project -> IssueId -> IssueAttrs -> GitLab (Either (Response ByteString) Issue)
deleteIssue :: Project -> IssueId -> GitLab (Either (Response ByteString) (Maybe ()))
reorderIssue :: Project -> IssueId -> Int -> Int -> GitLab (Either (Response ByteString) Issue)
moveIssue :: Project -> IssueId -> ProjectId -> GitLab (Either (Response ByteString) (Maybe Issue))
cloneIssue :: Project -> IssueId -> ProjectId -> GitLab (Either (Response ByteString) (Maybe Issue))
subscribeIssue :: Project -> IssueId -> GitLab (Either (Response ByteString) (Maybe Issue))
unsubscribeIssue :: Project -> IssueId -> GitLab (Either (Response ByteString) (Maybe Issue))
createTodo :: Project -> IssueId -> GitLab (Either (Response ByteString) (Maybe Todo))
issueMergeRequests :: Project -> IssueId -> GitLab (Either (Response ByteString) [MergeRequest])
issueMergeRequestsThatClose :: Project -> IssueId -> GitLab (Either (Response ByteString) [MergeRequest])
issueParticipants :: Project -> IssueId -> GitLab (Either (Response ByteString) [User])
issueStatisticsUser :: IssueFilterAttrs -> GitLab IssueStatistics
issueStatisticsGroup :: Group -> IssueFilterAttrs -> GitLab IssueStatistics
issueStatisticsProject :: Project -> IssueFilterAttrs -> GitLab IssueStatistics
defaultIssueFilters :: IssueFilterAttrs
defaultIssueAttrs :: Int -> IssueAttrs
data IssueAttrs = IssueAttrs {
- set_issue_id :: ProjectId
- set_issue_title :: Maybe Text
- set_issue_description :: Maybe Text
- set_issue_confidential :: Maybe Bool
- set_issue_assignee_id :: Maybe Int
- set_issue_assignee_ids :: Maybe [Int]
- set_issue_milestone_id :: Maybe Int
- set_issue_labels :: Maybe [Text]
- set_issue_state_event :: Maybe Text
- set_issue_updated_at :: Maybe UTCTime
- set_issue_due_date :: Maybe UTCTime
- set_issue_weight :: Maybe Int
- set_issue_discussion_locked :: Maybe Bool
- set_issue_epic_id :: Maybe Int
- set_issue_epic_iid :: Maybe Int
}
data DueDate
- = NoDueDate
- | Overdue
- | Week
- | Month
- | NextMonthPreviousTwoWeeks
data IssueState
- = IssueOpen
- | IssueClosed

List issues

List group issues

groupIssues Source #

Arguments

:: Group	the group
-> IssueFilterAttrs	filter the issues, see https://docs.gitlab.com/ee/api/issues.html#list-issues
-> GitLab [Issue]

Get a list of a project’s issues

List project issues

projectIssues Source #

Arguments

:: Project	the project
-> IssueFilterAttrs	filter the issues, see https://docs.gitlab.com/ee/api/issues.html#list-issues
-> GitLab [Issue]

Get a list of a project’s issues

Single issue

issue Source #

Arguments

:: Int	issue ID
-> GitLab (Either (Response ByteString) (Maybe Issue))

Only for administrators. Get a single issue.

User issues

userIssues Source #

Arguments

:: User	the user
-> GitLab [Issue]

gets all issues create by a user.

Single project issue

projectIssue Source #

Arguments

:: Project	Project
-> Int	issue ID
-> GitLab (Either (Response ByteString) (Maybe Issue))

Get a single project issue. If the project is private or the issue is confidential, you need to provide credentials to authorize.

New issue

newIssue Source #

Arguments

:: Project	project
-> Text	issue title
-> Text	issue description
-> IssueAttrs	issue attributes
-> GitLab (Either (Response ByteString) (Maybe Issue))

create a new issue.

newIssue' Source #

Arguments

:: Int	project ID
-> Text	issue title
-> Text	issue description
-> IssueAttrs	issue attributes
-> GitLab (Either (Response ByteString) (Maybe Issue))

create a new issue.

Edit issue

editIssue Source #

Arguments

:: Project
-> IssueId	issue ID
-> IssueAttrs	issue attributes
-> GitLab (Either (Response ByteString) Issue)

edits an issue. see https://docs.gitlab.com/ee/api/issues.html#edit-issue

Delete an issue

deleteIssue Source #

Arguments

:: Project
-> IssueId	issue ID
-> GitLab (Either (Response ByteString) (Maybe ()))

deletes an issue. see https://docs.gitlab.com/ee/api/issues.html#delete-an-issue

Reorder an issue

reorderIssue Source #

Arguments

:: Project
-> IssueId	issue ID
-> Int	The ID of a project’s issue that should be placed after this issue
-> Int	The ID of a project’s issue that should be placed before this issue
-> GitLab (Either (Response ByteString) Issue)

edits an issue. see https://docs.gitlab.com/ee/api/issues.html#edit-issue

Move an issue

moveIssue Source #

Arguments

:: Project	project
-> IssueId	The internal ID of a project’s issue
-> ProjectId	The ID of the new project
-> GitLab (Either (Response ByteString) (Maybe Issue))

Moves an issue to a different project. If a given label or milestone with the same name also exists in the target project, it’s then assigned to the issue being moved.

Clone an issue

cloneIssue Source #

Arguments

:: Project	project
-> IssueId	The internal ID of a project’s issue
-> ProjectId	The ID of the new project
-> GitLab (Either (Response ByteString) (Maybe Issue))

Clone the issue to given project. Copies as much data as possible as long as the target project contains equivalent labels, milestones, and so on.

Subscribe to an issue

subscribeIssue Source #

Arguments

:: Project	project
-> IssueId	The internal ID of a project’s issue
-> GitLab (Either (Response ByteString) (Maybe Issue))

Subscribes the authenticated user to an issue to receive notifications.

Unsubscribe from an issue

unsubscribeIssue Source #

Arguments

:: Project	project
-> IssueId	The internal ID of a project’s issue
-> GitLab (Either (Response ByteString) (Maybe Issue))

Unsubscribes the authenticated user from the issue to not receive notifications from it.

Create a to-do item

createTodo Source #

Arguments

:: Project	project
-> IssueId	The internal ID of a project’s issue
-> GitLab (Either (Response ByteString) (Maybe Todo))

Get all the merge requests that are related to the issue.

List merge requests related to issue

issueMergeRequests Source #

Arguments

:: Project	project
-> IssueId	The internal ID of a project’s issue
-> GitLab (Either (Response ByteString) [MergeRequest])

Get all the merge requests that are related to the issue.

List merge requests that close a particular issue on merge

issueMergeRequestsThatClose Source #

Arguments

:: Project	project
-> IssueId	The internal ID of a project’s issue
-> GitLab (Either (Response ByteString) [MergeRequest])

get all merge requests that close a particular issue when merged.

Participants on issues

issueParticipants Source #

Arguments

:: Project	project
-> IssueId	The internal ID of a project’s issue
-> GitLab (Either (Response ByteString) [User])

get all merge requests that close a particular issue when merged.

Comments on issues

Get issues statistics

issueStatisticsUser Source #

Arguments

:: IssueFilterAttrs	filter the issues, see https://docs.gitlab.com/ee/api/issues_statistics.html#get-issues-statistics
-> GitLab IssueStatistics	the issue statistics

Gets issues count statistics on all issues the authenticated user has access to.

Get group issues statistics

issueStatisticsGroup Source #

Arguments

:: Group	the group
-> IssueFilterAttrs	filter the issues, see https://docs.gitlab.com/ee/api/issues_statistics.html#get-issues-statistics
-> GitLab IssueStatistics	the issue statistics

Gets issues count statistics for a given group.

Get project issues statistics

issueStatisticsProject Source #

Arguments

:: Project	the project
-> IssueFilterAttrs	filter the issues, see https://docs.gitlab.com/ee/api/issues_statistics.html#get-issues-statistics
-> GitLab IssueStatistics	the issue statistics

Gets issues count statistics for a given group.

Issues attributes

defaultIssueFilters :: IssueFilterAttrs Source #

No issue filters, thereby returning all issues. Default scope is "all".

defaultIssueAttrs Source #

Arguments

:: Int	project ID
-> IssueAttrs

issue attributes when creating or editing issues.

data IssueAttrs Source #

issue attributes.

Constructors

IssueAttrs

Fields

set_issue_id :: ProjectId
set_issue_title :: Maybe Text
set_issue_description :: Maybe Text
set_issue_confidential :: Maybe Bool
set_issue_assignee_id :: Maybe Int
set_issue_assignee_ids :: Maybe [Int]
set_issue_milestone_id :: Maybe Int
set_issue_labels :: Maybe [Text]
set_issue_state_event :: Maybe Text
set_issue_updated_at :: Maybe UTCTime
set_issue_due_date :: Maybe UTCTime
set_issue_weight :: Maybe Int
set_issue_discussion_locked :: Maybe Bool
set_issue_epic_id :: Maybe Int
set_issue_epic_iid :: Maybe Int

Instances

Instances details

FromJSON IssueAttrs Source #
Instance details Defined in GitLab.API.Issues Methods parseJSON :: Value -> Parser IssueAttrs # parseJSONList :: Value -> Parser [IssueAttrs] # omittedField :: Maybe IssueAttrs #
ToJSON IssueAttrs Source #
Instance details Defined in GitLab.API.Issues Methods toJSON :: IssueAttrs -> Value # toEncoding :: IssueAttrs -> Encoding # toJSONList :: [IssueAttrs] -> Value # toEncodingList :: [IssueAttrs] -> Encoding # omitField :: IssueAttrs -> Bool #
Show IssueAttrs Source #
Instance details Defined in GitLab.API.Issues Methods showsPrec :: Int -> IssueAttrs -> ShowS # show :: IssueAttrs -> String # showList :: [IssueAttrs] -> ShowS #

data DueDate Source #

When an issue is due

Constructors

NoDueDate
Overdue
Week
Month
NextMonthPreviousTwoWeeks

Instances

Instances details

Show DueDate Source #
Instance details Defined in GitLab.API.Issues Methods showsPrec :: Int -> DueDate -> ShowS # show :: DueDate -> String # showList :: [DueDate] -> ShowS #

data IssueState Source #

Is a project issues open or closed

Constructors

IssueOpen
IssueClosed

Instances

Instances details

Show IssueState Source #
Instance details Defined in GitLab.API.Issues Methods showsPrec :: Int -> IssueState -> ShowS # show :: IssueState -> String # showList :: [IssueState] -> ShowS #