Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Posts a comment on a pull request.
- postCommentForPullRequest :: Text -> Text -> Text -> Text -> Text -> PostCommentForPullRequest
- data PostCommentForPullRequest
- pcfprLocation :: Lens' PostCommentForPullRequest (Maybe Location)
- pcfprClientRequestToken :: Lens' PostCommentForPullRequest (Maybe Text)
- pcfprPullRequestId :: Lens' PostCommentForPullRequest Text
- pcfprRepositoryName :: Lens' PostCommentForPullRequest Text
- pcfprBeforeCommitId :: Lens' PostCommentForPullRequest Text
- pcfprAfterCommitId :: Lens' PostCommentForPullRequest Text
- pcfprContent :: Lens' PostCommentForPullRequest Text
- postCommentForPullRequestResponse :: Int -> PostCommentForPullRequestResponse
- data PostCommentForPullRequestResponse
- pcfprrsBeforeBlobId :: Lens' PostCommentForPullRequestResponse (Maybe Text)
- pcfprrsLocation :: Lens' PostCommentForPullRequestResponse (Maybe Location)
- pcfprrsAfterCommitId :: Lens' PostCommentForPullRequestResponse (Maybe Text)
- pcfprrsPullRequestId :: Lens' PostCommentForPullRequestResponse (Maybe Text)
- pcfprrsAfterBlobId :: Lens' PostCommentForPullRequestResponse (Maybe Text)
- pcfprrsBeforeCommitId :: Lens' PostCommentForPullRequestResponse (Maybe Text)
- pcfprrsRepositoryName :: Lens' PostCommentForPullRequestResponse (Maybe Text)
- pcfprrsComment :: Lens' PostCommentForPullRequestResponse (Maybe Comment)
- pcfprrsResponseStatus :: Lens' PostCommentForPullRequestResponse Int
Creating a Request
postCommentForPullRequest Source #
Creates a value of PostCommentForPullRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pcfprLocation
- The location of the change where you want to post your comment. If no location is provided, the comment will be posted as a general comment on the pull request difference between the before commit ID and the after commit ID.pcfprClientRequestToken
- A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token.pcfprPullRequestId
- The system-generated ID of the pull request. To get this ID, useListPullRequests
.pcfprRepositoryName
- The name of the repository where you want to post a comment on a pull request.pcfprBeforeCommitId
- The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created.pcfprAfterCommitId
- The full commit ID of the commit in the source branch that is the current tip of the branch for the pull request when you post the comment.pcfprContent
- The content of your comment on the change.
data PostCommentForPullRequest Source #
See: postCommentForPullRequest
smart constructor.
Request Lenses
pcfprLocation :: Lens' PostCommentForPullRequest (Maybe Location) Source #
The location of the change where you want to post your comment. If no location is provided, the comment will be posted as a general comment on the pull request difference between the before commit ID and the after commit ID.
pcfprClientRequestToken :: Lens' PostCommentForPullRequest (Maybe Text) Source #
A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token.
pcfprPullRequestId :: Lens' PostCommentForPullRequest Text Source #
The system-generated ID of the pull request. To get this ID, use ListPullRequests
.
pcfprRepositoryName :: Lens' PostCommentForPullRequest Text Source #
The name of the repository where you want to post a comment on a pull request.
pcfprBeforeCommitId :: Lens' PostCommentForPullRequest Text Source #
The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created.
pcfprAfterCommitId :: Lens' PostCommentForPullRequest Text Source #
The full commit ID of the commit in the source branch that is the current tip of the branch for the pull request when you post the comment.
pcfprContent :: Lens' PostCommentForPullRequest Text Source #
The content of your comment on the change.
Destructuring the Response
postCommentForPullRequestResponse Source #
Creates a value of PostCommentForPullRequestResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pcfprrsBeforeBlobId
- In the directionality of the pull request, the blob ID of thebefore
blob.pcfprrsLocation
- The location of the change where you posted your comment.pcfprrsAfterCommitId
- The full commit ID of the commit in the destination branch where the pull request will be merged.pcfprrsPullRequestId
- The system-generated ID of the pull request.pcfprrsAfterBlobId
- In the directionality of the pull request, the blob ID of theafter
blob.pcfprrsBeforeCommitId
- The full commit ID of the commit in the source branch used to create the pull request, or in the case of an updated pull request, the full commit ID of the commit used to update the pull request.pcfprrsRepositoryName
- The name of the repository where you posted a comment on a pull request.pcfprrsComment
- The content of the comment you posted.pcfprrsResponseStatus
- -- | The response status code.
data PostCommentForPullRequestResponse Source #
See: postCommentForPullRequestResponse
smart constructor.
Response Lenses
pcfprrsBeforeBlobId :: Lens' PostCommentForPullRequestResponse (Maybe Text) Source #
In the directionality of the pull request, the blob ID of the before
blob.
pcfprrsLocation :: Lens' PostCommentForPullRequestResponse (Maybe Location) Source #
The location of the change where you posted your comment.
pcfprrsAfterCommitId :: Lens' PostCommentForPullRequestResponse (Maybe Text) Source #
The full commit ID of the commit in the destination branch where the pull request will be merged.
pcfprrsPullRequestId :: Lens' PostCommentForPullRequestResponse (Maybe Text) Source #
The system-generated ID of the pull request.
pcfprrsAfterBlobId :: Lens' PostCommentForPullRequestResponse (Maybe Text) Source #
In the directionality of the pull request, the blob ID of the after
blob.
pcfprrsBeforeCommitId :: Lens' PostCommentForPullRequestResponse (Maybe Text) Source #
The full commit ID of the commit in the source branch used to create the pull request, or in the case of an updated pull request, the full commit ID of the commit used to update the pull request.
pcfprrsRepositoryName :: Lens' PostCommentForPullRequestResponse (Maybe Text) Source #
The name of the repository where you posted a comment on a pull request.
pcfprrsComment :: Lens' PostCommentForPullRequestResponse (Maybe Comment) Source #
The content of the comment you posted.
pcfprrsResponseStatus :: Lens' PostCommentForPullRequestResponse Int Source #
- - | The response status code.