Github API - Test Config

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:

Github GraphQL API

The contents of the review body comment.

clientMutationId String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:

Github GraphQL API

A unique identifier for the client performing the mutation.

comments DraftPullRequestReviewComment []

DraftPullRequestReviewComment [input]

Specifies a review comment to be left with a Pull Request Review.

Attributes

body String

Body of the comment to leave.

path String

Path to the file being commented on.

position Int

Position in the file to leave a comment on.

API:

Github GraphQL API

The review line comments.

Upcoming Change on 2023-10-01 UTC
Description: comments will be removed. use the threads argument instead
Reason: We are deprecating comment fields that use diff-relative positioning

commitOID GitObjectID

GitObjectID [scalar]

A Git object ID.

API:

Github GraphQL API

The commit OID the review pertains to.

event PullRequestReviewEvent

PullRequestReviewEvent [enum]

The possible events to perform on a pull request review.

Possible values

APPROVE

Submit feedback and approve merging these changes.

COMMENT

Submit general feedback without explicit approval.

DISMISS

Dismiss review so it now longer effects merging.

REQUEST_CHANGES

Submit feedback that must be addressed before merging.

API:

Github GraphQL API

The event to perform on the pull request review.

pullRequestId ID

ID [scalar]

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

API:

Github GraphQL API

The Node ID of the pull request to modify.

threads DraftPullRequestReviewThread []

DraftPullRequestReviewThread [input]

Specifies a review comment thread to be left with a Pull Request Review.

Attributes

body String

Body of the comment to leave.

line Int

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

path String

Path to the file being commented on.

side DiffSide

The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

startLine Int

The first line of the range to which the comment refers.

startSide DiffSide

The side of the diff on which the start line resides.

API:

Github GraphQL API

The review line comment threads.

API:

Github GraphQL API