| License | BSD-3-Clause |
|---|---|
| Maintainer | Oleg Grenrus <oleg.grenrus@iki.fi> |
| Safe Haskell | None |
| Language | Haskell2010 |
GitHub.Endpoints.Issues.Comments
Description
The Github issue comments API from http://developer.github.com/v3/issues/comments/.
Synopsis
- comment :: Name Owner -> Name Repo -> Id Comment -> IO (Either Error IssueComment)
- commentR :: Name Owner -> Name Repo -> Id Comment -> Request k IssueComment
- comments :: Name Owner -> Name Repo -> IssueNumber -> IO (Either Error (Vector IssueComment))
- commentsR :: Name Owner -> Name Repo -> IssueNumber -> FetchCount -> Request k (Vector IssueComment)
- comments' :: Maybe Auth -> Name Owner -> Name Repo -> IssueNumber -> IO (Either Error (Vector IssueComment))
- createComment :: Auth -> Name Owner -> Name Repo -> IssueNumber -> Text -> IO (Either Error Comment)
- createCommentR :: Name Owner -> Name Repo -> IssueNumber -> Text -> Request RW Comment
- deleteComment :: Auth -> Name Owner -> Name Repo -> Id Comment -> IO (Either Error ())
- deleteCommentR :: Name Owner -> Name Repo -> Id Comment -> GenRequest MtUnit RW ()
- editComment :: Auth -> Name Owner -> Name Repo -> Id Comment -> Text -> IO (Either Error Comment)
- editCommentR :: Name Owner -> Name Repo -> Id Comment -> Text -> Request RW Comment
- module GitHub.Data
Documentation
comment :: Name Owner -> Name Repo -> Id Comment -> IO (Either Error IssueComment) Source #
A specific comment, by ID.
comment "thoughtbot" "paperclip" 1468184
commentR :: Name Owner -> Name Repo -> Id Comment -> Request k IssueComment Source #
Query a single comment. See https://developer.github.com/v3/issues/comments/#get-a-single-comment
comments :: Name Owner -> Name Repo -> IssueNumber -> IO (Either Error (Vector IssueComment)) Source #
All comments on an issue, by the issue's number.
comments "thoughtbot" "paperclip" 635
commentsR :: Name Owner -> Name Repo -> IssueNumber -> FetchCount -> Request k (Vector IssueComment) Source #
List comments on an issue. See https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue
comments' :: Maybe Auth -> Name Owner -> Name Repo -> IssueNumber -> IO (Either Error (Vector IssueComment)) Source #
All comments on an issue, by the issue's number, using authentication.
comments' (Just $ BasicAuth "github-username" "github-password") "thoughtbot" "paperclip" 635
createComment :: Auth -> Name Owner -> Name Repo -> IssueNumber -> Text -> IO (Either Error Comment) Source #
Create a new comment.
createComment (BasicAuth "github-username" "github-password") user repo issue "some words"
createCommentR :: Name Owner -> Name Repo -> IssueNumber -> Text -> Request RW Comment Source #
Create a comment. See https://developer.github.com/v3/issues/comments/#create-a-comment
deleteComment :: Auth -> Name Owner -> Name Repo -> Id Comment -> IO (Either Error ()) Source #
Delete a comment.
deleteComment (BasicAuth "github-username" "github-password") user repo commentid
deleteCommentR :: Name Owner -> Name Repo -> Id Comment -> GenRequest MtUnit RW () Source #
Delete a comment. See https://developer.github.com/v3/issues/comments/#delete-a-comment
editComment :: Auth -> Name Owner -> Name Repo -> Id Comment -> Text -> IO (Either Error Comment) Source #
Edit a comment.
editComment (BasicAuth "github-username" "github-password") user repo commentid "new words"
editCommentR :: Name Owner -> Name Repo -> Id Comment -> Text -> Request RW Comment Source #
Edit a comment. See https://developer.github.com/v3/issues/comments/#edit-a-comment
module GitHub.Data