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

GitLab.API.MergeRequests

Contents

List merge requests
Get single MR
Create MR
Accept MR
Delete a merge request
merge request attributes

Description

Synopsis

mergeRequests :: Project -> GitLab [MergeRequest]
mergeRequestsWith :: Project -> MergeProjectAttrs -> GitLab [MergeRequest]
mergeRequest :: Project -> Int -> GitLab (Either (Response ByteString) (Maybe MergeRequest))
createMergeRequest :: Project -> Text -> Text -> Int -> Text -> Text -> GitLab (Either (Response ByteString) (Maybe MergeRequest))
acceptMergeRequest :: Project -> Int -> GitLab (Either (Response ByteString) (Maybe MergeRequest))
deleteMergeRequest :: Project -> Int -> GitLab (Either (Response ByteString) (Maybe ()))
mrAttrs :: MergeProjectAttrs
data MergeProjectAttrs = MergeProjectAttrs {
- mr_attr_state :: Maybe MergeRequestState
- mr_attr_order_by :: Maybe OrderBy
- mr_attr_sort :: Maybe SortBy
- mr_attr_milestone :: Maybe Milestone
- mr_attr_labels :: Maybe Text
- mr_attr_with_labels_details :: Maybe Bool
- mr_attr_with_merge_status_recheck :: Maybe Bool
- mr_attr_created_after :: Maybe UTCTime
- mr_attr_created_before :: Maybe UTCTime
- mr_attr_updated_after :: Maybe UTCTime
- mr_attr_updated_before :: Maybe UTCTime
- mr_attr_scope :: Maybe Scope
- mr_attr_author_id :: Maybe Int
- mr_attr_author_username :: Maybe Text
- mr_attr_assignee_id :: Maybe Int
- mr_attr_approver_ids :: Maybe [Int]
- mr_attr_approved_by_ids :: Maybe [Int]
- mr_attr_reviewer_id :: Maybe Int
- mr_attr_reviewer_username :: Maybe Text
- mr_attr_my_reaction_emoji :: Maybe Text
- mr_attr_source_branch :: Maybe Text
- mr_attr_target_branch :: Maybe Text
- mr_attr_search :: Maybe Text
- mr_attr_in :: Maybe SearchIn
- mr_attr_wip :: Maybe WIP
- mr_attr_environment :: Maybe UTCTime
- mr_attr_deployed_before :: Maybe UTCTime
- mr_attr_deployed_after :: Maybe UTCTime
}
data MergeRequestState
- = MROpened
- | MRClosed
- | MRLocked
- | MRMerged
data WIP
- = WIPYes
- | WIPNo

List merge requests

mergeRequests Source #

Arguments

:: Project	the project
-> GitLab [MergeRequest]

returns the merge requests for a project.

mergeRequestsWith Source #

Arguments

:: Project	the project
-> MergeProjectAttrs	merge request search attributes
-> GitLab [MergeRequest]

returns the merge requests for a project and a set of search attributes as Just values in MergeProjectAttrs. The mrAttrs value has default merge request search values, which is a record that can be modified with Just values.

For example to search only for open merge requests for a project:

mergeRequestsWith myProject (mrAttrs {mr_attr_state = Just MROpened})

Get single MR

mergeRequest Source #

Arguments

:: Project	project
-> Int	merge request IID
-> GitLab (Either (Response ByteString) (Maybe MergeRequest))

returns the merge request for a project given its merge request IID.

Create MR

createMergeRequest Source #

Arguments

:: Project	project
-> Text	source branch
-> Text	target branch
-> Int	target project ID
-> Text	merge request title
-> Text	merge request description
-> GitLab (Either (Response ByteString) (Maybe MergeRequest))

Creates a merge request.

Accept MR

acceptMergeRequest Source #

Arguments

:: Project	project
-> Int	merge request IID
-> GitLab (Either (Response ByteString) (Maybe MergeRequest))

Accepts a merge request.

Delete a merge request

deleteMergeRequest Source #

Arguments

:: Project	project
-> Int	merge request IID
-> GitLab (Either (Response ByteString) (Maybe ()))

Deletes a merge request. Only for admins and project owners.

merge request attributes

mrAttrs :: MergeProjectAttrs Source #

No merge request search filters, thereby returning all merge requests. Default scope is "all".

data MergeProjectAttrs Source #

Attributes when searching for merge requests with the mergeRequestsWith functions.

Constructors

MergeProjectAttrs

Fields

mr_attr_state :: Maybe MergeRequestState
Return all merge requests or just those that are opened, closed, locked, or merged.
mr_attr_order_by :: Maybe OrderBy
Return requests ordered by created_at or updated_at fields. Default is created_at. Note that the OrderBy type has more options, but only CreatedAt and UpdatedAt are applicable for ordering merge requests.
mr_attr_sort :: Maybe SortBy
Return requests sorted in asc or desc order. Default is desc.
mr_attr_milestone :: Maybe Milestone
Return merge requests for a specific milestone. None returns merge requests with no milestone. Any returns merge requests that have an assigned milestone.
mr_attr_labels :: Maybe Text
Return merge requests matching a comma separated list of labels.
mr_attr_with_labels_details :: Maybe Bool
If true, response returns more details for each label in labels field: :name, :color, :description, :description_html, :text_color. Default is false.
mr_attr_with_merge_status_recheck :: Maybe Bool
If true, this projection requests (but does not guarantee) that the merge_status field be recalculated asynchronously. Default is false.
mr_attr_created_after :: Maybe UTCTime
Return merge requests created on or after the given time.
mr_attr_created_before :: Maybe UTCTime
Return merge requests created on or before the given time.
mr_attr_updated_after :: Maybe UTCTime
Return merge requests updated on or after the given time.
mr_attr_updated_before :: Maybe UTCTime
Return merge requests updated on or before the given time.
mr_attr_scope :: Maybe Scope
Return merge requests for the given scope: created_by_me, assigned_to_me or all. Defaults to created_by_me.
mr_attr_author_id :: Maybe Int
Returns merge requests created by the given user id. Mutually exclusive with author_username. Combine with scope=all or scope=assigned_to_me.
mr_attr_author_username :: Maybe Text
Returns merge requests created by the given username. Mutually exclusive with author_id.
mr_attr_assignee_id :: Maybe Int
Returns merge requests assigned to the given user id.
mr_attr_approver_ids :: Maybe [Int]
Returns merge requests which have specified all the users with the given ids as individual approvers.
mr_attr_approved_by_ids :: Maybe [Int]
Returns merge requests which have been approved by all the users with the given ids (Max: 5).
mr_attr_reviewer_id :: Maybe Int
Returns merge requests which have the user as a reviewer with the given user id. Mutually exclusive with reviewer_username.
mr_attr_reviewer_username :: Maybe Text
Returns merge requests which have the user as a reviewer with the given username. Mutually exclusive with reviewer_id.
mr_attr_my_reaction_emoji :: Maybe Text
Return merge requests reacted by the authenticated user by the given emoji.
mr_attr_source_branch :: Maybe Text
Return merge requests with the given source branch.
mr_attr_target_branch :: Maybe Text
Return merge requests with the given target branch.
mr_attr_search :: Maybe Text
Search merge requests against their title and description.
mr_attr_in :: Maybe SearchIn
Modify the scope of the search attribute. title, description, or a string joining them with comma. Default is title,description.
mr_attr_wip :: Maybe WIP
Filter merge requests against their wip status. yes to return only draft merge requests, no to return non-draft merge requests.
mr_attr_environment :: Maybe UTCTime
Returns merge requests deployed to the given environment.
mr_attr_deployed_before :: Maybe UTCTime
Return merge requests deployed before the given date/time.
mr_attr_deployed_after :: Maybe UTCTime
Return merge requests deployed after the given date/time.

data MergeRequestState Source #

for filtering by merge request state.

Constructors

MROpened	return only opened merge requests
MRClosed	return only closed merge requests
MRLocked	return only locked merge requests
MRMerged	return only merged merge requests

Instances

Instances details

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

data WIP Source #

WIP status of merge requests

Constructors

WIPYes	return only draft merge requests
WIPNo	return non-draft merge requests

Instances

Instances details

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