Objects - Charter Docs

Model tree

PullCreateBody

The body of a create-pull-request request.

Field	Type	Description
`title`	`string`	The title of the new pull request. Required unless `issue` is given.
`head` *	`string`	The name of the branch where your changes are implemented. For cross-repository pull requests, prefix with a username, e.g. `username:branch`.
`headRepo`	`string`	The name of the repository where the changes in the pull request were made. Used for cross-repository pull requests from forks.
`base` *	`string`	The name of the branch you want the changes pulled into. This should be an existing branch on the current repository.
`body`	`string`	The contents of the pull request.
`maintainerCanModify`	`boolean`	Indicates whether maintainers can modify the pull request.
`draft`	`boolean`	Indicates whether the pull request is a draft.
`issue`	`integer`	An issue number to convert into a pull request. Required unless `title` is given. The issue’s title, body and comments carry over.

ReviewComment

One inline comment left as part of a review.

Field	Type	Description
`path` *	`string`	The file the comment is on, relative to the repo root.
`body` *	`string`	The comment text.
`line`	`integer`	The line in the diff the comment applies to. For a multi-line comment, the last line of the range.
`side`	ReviewSide	Which side of the diff: ‘LEFT’ is the old file, ‘RIGHT’ the new.
`startLine`	`integer`	The first line of a multi-line comment.
`startSide`	ReviewSide	Which side the multi-line range starts on.

CodeScanningSort

Value
`created`
`updated`

MergeMethod

Value
`merge`
`squash`
`rebase`

RepoReviewCommentSort

Value
`created`
`updated`
`created_at`

ReviewEvent

Value
`APPROVE`
`REQUEST_CHANGES`
`COMMENT`

ReviewSide

Value
`LEFT`
`RIGHT`

SubjectType

Value
`line`
`file`

PullSort

Value
`created`
`updated`
`popularity`
`long-running`