Objects - Charter

Model tree

IssueCreateBody

IssueUpdateBody

CommentCreateBody

IssueCreateBody

The body of a create-issue request.

Field	Type	Description
`title` *	`string`	The title of the issue.
`body`	`string`	The contents of the issue.
`milestone`	`integer` \| `string`	The number of the milestone to associate this issue with.
`labels`	`string`[]	Labels to associate with this issue. Pass label names, not IDs.
`assignees`	`string`[]	Logins for Users to assign to this issue.

IssueUpdateBody

The body of an update-issue request.

Field	Type	Description
`title`	`string`	The title of the issue.
`body`	`string`	The contents of the issue.
`state`	PullUpdateState	The open or closed state of the issue.
`stateReason`	StateReason	The reason for the state change. Ignored unless `state` is changed.
`milestone`	`integer` \| `string`	The number of the milestone to associate this issue with. Set to null to remove the current milestone.
`labels`	`string`[]	Labels to associate with this issue. Pass one or more label names to replace the set of labels on this issue.
`assignees`	`string`[]	Usernames to assign to this issue. Pass one or more user logins to replace the set of assignees on this issue.

CommentCreateBody

The body of a create-comment request.

Field	Type	Description
`body` *	`string`	The contents of the comment.

SortDirection

Value
`asc`
`desc`

IssueFilter

Value
`assigned`
`created`
`mentioned`
`subscribed`
`repos`
`all`

IssueSort

Value
`created`
`updated`
`comments`

IssueState

Value
`open`
`closed`
`all`

LockReason

Value
`off-topic`
`too heated`
`resolved`
`spam`

MilestoneSort

Value
`due_on`
`completeness`

StateReason

Value
`completed`
`not_planned`
`duplicate`
`reopened`

PullUpdateState

Value
`open`
`closed`