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

GitLab.API.Notes

Contents

Issues
Snippets
Merge Requests

Description

Synopsis

issueNotes :: Project -> Int -> Maybe SortBy -> Maybe OrderBy -> GitLab (Either (Response ByteString) [Note])
issueNote :: Project -> Int -> Int -> GitLab (Either (Response ByteString) (Maybe Note))
newIssueNote :: Project -> Int -> Text -> Maybe Bool -> GitLab (Either (Response ByteString) (Maybe ()))
modifyIssueNote :: Project -> Int -> Int -> Maybe Text -> GitLab (Either (Response ByteString) (Maybe Note))
deleteIssueNote :: Project -> Int -> Int -> GitLab (Either (Response ByteString) (Maybe ()))
snippetNotes :: Project -> Int -> Maybe SortBy -> Maybe OrderBy -> GitLab (Either (Response ByteString) [Note])
snippetNote :: Project -> Int -> Int -> GitLab (Either (Response ByteString) (Maybe Note))
newSnippetNote :: Project -> Int -> Text -> Maybe Bool -> GitLab (Either (Response ByteString) (Maybe ()))
modifySnippetNote :: Project -> Int -> Int -> Maybe Text -> GitLab (Either (Response ByteString) (Maybe Note))
deleteSnippetNote :: Project -> Int -> Int -> GitLab (Either (Response ByteString) (Maybe ()))
mergeRequestNotes :: Project -> Int -> Maybe SortBy -> Maybe OrderBy -> GitLab (Either (Response ByteString) [Note])
mergeRequestNote :: Project -> Int -> Int -> GitLab (Either (Response ByteString) (Maybe Note))
newMergeRequestNote :: Project -> Int -> Text -> Maybe Bool -> GitLab (Either (Response ByteString) (Maybe ()))
modifyMergeRequestNote :: Project -> Int -> Int -> Maybe Text -> GitLab (Either (Response ByteString) (Maybe Note))
deleteMergeRequestNote :: Project -> Int -> Int -> GitLab (Either (Response ByteString) (Maybe ()))

Issues

issueNotes Source #

Arguments

:: Project	project
-> Int	issue IID
-> Maybe SortBy	sort the issues
-> Maybe OrderBy	Return issue notes ordered by created_at or updated_at fields
-> GitLab (Either (Response ByteString) [Note])

Gets a list of all notes for a single issue.

issueNote Source #

Arguments

:: Project	project
-> Int	issue IID
-> Int	note ID
-> GitLab (Either (Response ByteString) (Maybe Note))

Returns a single note for a specific project issue.

newIssueNote Source #

Arguments

:: Project	project
-> Int	issue IID
-> Text	the body of the note
-> Maybe Bool	The confidential flag of a note. Default is false.
-> GitLab (Either (Response ByteString) (Maybe ()))

Creates a new note to a single project issue.

modifyIssueNote Source #

Arguments

:: Project	project
-> Int	issue IID
-> Int	note ID
-> Maybe Text	the body of the note
-> GitLab (Either (Response ByteString) (Maybe Note))

Modify existing note of an issue.

deleteIssueNote Source #

Arguments

:: Project	project
-> Int	issue IID
-> Int	note ID
-> GitLab (Either (Response ByteString) (Maybe ()))

Deletes an existing note of an issue.

Snippets

snippetNotes Source #

Arguments

:: Project	project
-> Int	snippet IID
-> Maybe SortBy	sort the snippets
-> Maybe OrderBy	Return snippet notes ordered by created_at or updated_at fields
-> GitLab (Either (Response ByteString) [Note])

Gets a list of all notes for a single snippet.

snippetNote Source #

Arguments

:: Project	project
-> Int	snippet IID
-> Int	note ID
-> GitLab (Either (Response ByteString) (Maybe Note))

Returns a single note for a specific project snippet.

newSnippetNote Source #

Arguments

:: Project	project
-> Int	snippet IID
-> Text	the body of the note
-> Maybe Bool	The confidential flag of a note. Default is false.
-> GitLab (Either (Response ByteString) (Maybe ()))

Creates a new note to a single project snippet.

modifySnippetNote Source #

Arguments

:: Project	project
-> Int	snippet IID
-> Int	note ID
-> Maybe Text	the body of the note
-> GitLab (Either (Response ByteString) (Maybe Note))

Modify existing note of an snippet.

deleteSnippetNote Source #

Arguments

:: Project	project
-> Int	snippet IID
-> Int	note ID
-> GitLab (Either (Response ByteString) (Maybe ()))

Deletes an existing note of an snippet.

Merge Requests

mergeRequestNotes Source #

Arguments

:: Project	project
-> Int	merge request IID
-> Maybe SortBy	sort the merge requests
-> Maybe OrderBy	Return merge request notes ordered by created_at or updated_at fields
-> GitLab (Either (Response ByteString) [Note])

Gets a list of all notes for a single merge request.

mergeRequestNote Source #

Arguments

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

Returns a single note for a specific project merge request.

newMergeRequestNote Source #

Arguments

:: Project	project
-> Int	merge request IID
-> Text	the body of the note
-> Maybe Bool	The confidential flag of a note. Default is false.
-> GitLab (Either (Response ByteString) (Maybe ()))

Creates a new note to a single project merge request.

modifyMergeRequestNote Source #

Arguments

:: Project	project
-> Int	merge request IID
-> Int	note ID
-> Maybe Text	the body of the note
-> GitLab (Either (Response ByteString) (Maybe Note))

Modify existing note of an merge request.

deleteMergeRequestNote Source #

Arguments

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

Deletes an existing note of an merge request.