GitHub: Issues schemas (part 2)
12 GitHub schemas with complete fields and constraints.
← Issues operations · All schemas
List timeline events for an issue — response body — item
Referenced models: List issue events — response body — item Added to Project Issue Event, List issue events — response body — item Blocked-by Added Issue Event, List issue events — response body — item Blocked-by Removed Issue Event, List issue events — response body — item Blocking Added Issue Event, List issue events — response body — item Blocking Removed Issue Event, List issue events — response body — item Converted Note to Issue Issue Event, List issue events — response body — item Demilestoned Issue Event, List issue events — response body — item Issue Type Added Issue Event, List issue events — response body — item Issue Type Changed Issue Event, List issue events — response body — item Issue Type Removed Issue Event, List issue events — response body — item Labeled Issue Event, List issue events — response body — item Locked Issue Event, List issue events — response body — item Milestoned Issue Event, List issue events — response body — item Moved Column in Project Issue Event, List issue events — response body — item Parent-issue Added Issue Event, List issue events — response body — item Parent-issue Removed Issue Event, List issue events — response body — item Removed from Project Issue Event, List issue events — response body — item Renamed Issue Event, List issue events — response body — item Review Dismissed Issue Event, List issue events — response body — item Review Request Removed Issue Event, List issue events — response body — item Review Requested Issue Event, List timeline events for an issue — response body — item State Change Issue Event, List issue events — response body — item Sub-issue Added Issue Event, List issue events — response body — item Sub-issue Removed Issue Event, List timeline events for an issue — response body — item Timeline Assigned Issue Event, List timeline events for an issue — response body — item Timeline Comment Event, List timeline events for an issue — response body — item Timeline Commit Commented Event, List timeline events for an issue — response body — item Timeline Committed Event, List timeline events for an issue — response body — item Timeline Connected Event, List timeline events for an issue — response body — item Timeline Cross Referenced Event, List timeline events for an issue — response body — item Timeline Disconnected Event, List timeline events for an issue — response body — item Timeline Line Commented Event, List timeline events for an issue — response body — item Timeline Reviewed Event, List timeline events for an issue — response body — item Timeline Unassigned Issue Event, List issue events — response body — item Unlabeled Issue Event
List timeline events for an issue — response body — item State Change Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | State Change Issue Event |
actor | Model | Required within parent | Expand List users — response body — item |
commit_id | JSON | Required within parent | |
commit_id (anyOf 1) | string | Alternative | |
commit_id (anyOf 2) | null | Alternative | |
commit_url | JSON | Required within parent | |
commit_url (anyOf 1) | string | Alternative | |
commit_url (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | |
event | string | Required within parent | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
intent | Model | Optional | Expand Get an issue event — response body — intent |
node_id | string | Required within parent | |
performed_via_github_app | Model | Required within parent | Expand Get an app — response body |
state_reason | JSON | Optional | |
state_reason (anyOf 1) | string | Alternative | |
state_reason (anyOf 2) | null | Alternative | |
url | string | Required within parent |
Referenced models: Get an app — response body, Get an issue event — response body — intent, List users — response body — item
List timeline events for an issue — response body — item Timeline Assigned Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Timeline Assigned Issue Event |
actor | Model | Required within parent | Expand List users — response body — item |
assignee | Model | Required within parent | Expand List users — response body — item |
commit_id | JSON | Required within parent | |
commit_id (anyOf 1) | string | Alternative | |
commit_id (anyOf 2) | null | Alternative | |
commit_url | JSON | Required within parent | |
commit_url (anyOf 1) | string | Alternative | |
commit_url (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | |
event | string | Required within parent | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
intent | Model | Optional | Expand Get an issue event — response body — intent |
node_id | string | Required within parent | |
performed_via_github_app | Model | Required within parent | Expand Get an app — response body |
url | string | Required within parent |
Referenced models: Get an app — response body, Get an issue event — response body — intent, List users — response body — item
List timeline events for an issue — response body — item Timeline Comment Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Timeline Comment Event |
actor | Model | Required within parent | Expand List users — response body — item |
author_association | string | Required within parent | How the author is associated with the repository. Known values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER |
body | string | Optional | Contents of the issue comment |
body_html | string | Optional | |
body_text | string | Optional | |
created_at | string | Required within parent | Format: date-time |
event | string | Required within parent | |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Unique identifier of the issue comment |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
issue_url | string | Required within parent | Format: uri |
minimized | Model | Optional | Expand Get an issue comment — response body — minimized |
node_id | string | Required within parent | |
performed_via_github_app | Model | Optional | Expand Get an app — response body |
pin | Model | Optional | Expand Get an issue comment — response body — pin |
reactions | Model | Optional | Expand Get an issue — response body — reactions |
updated_at | string | Required within parent | Format: date-time |
url | string | Required within parent | URL for the issue comment Format: uri |
user | Model | Required within parent | Expand List users — response body — item |
Referenced models: Get an app — response body, Get an issue comment — response body — minimized, Get an issue comment — response body — pin, Get an issue — response body — reactions, List users — response body — item
List timeline events for an issue — response body — item Timeline Commit Commented Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Timeline Commit Commented Event |
comments | array | Optional | |
comments[] | Model | Each item | Expand Get a commit comment — response body |
commit_id | string | Optional | |
event | string | Optional | |
node_id | string | Optional |
Referenced models: Get a commit comment — response body
List timeline events for an issue — response body — item Timeline Committed Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Timeline Committed Event |
author | object | Required within parent | Identifying information for the git-user |
author.date | string | Required within parent | Timestamp of the commit Format: date-time |
author.email | string | Required within parent | Git email address of the user |
author.name | string | Required within parent | Name of the git user |
committer | object | Required within parent | Identifying information for the git-user |
committer.date | string | Required within parent | Timestamp of the commit Format: date-time |
committer.email | string | Required within parent | Git email address of the user |
committer.name | string | Required within parent | Name of the git user |
event | string | Optional | |
html_url | string | Required within parent | Format: uri |
message | string | Required within parent | Message describing the purpose of the commit |
node_id | string | Required within parent | |
parents | array | Required within parent | |
parents[] | object | Each item | |
parents[].html_url | string | Required within parent | Format: uri |
parents[].sha | string | Required within parent | SHA for the commit |
parents[].url | string | Required within parent | Format: uri |
sha | string | Required within parent | SHA for the commit |
tree | object | Required within parent | |
tree.sha | string | Required within parent | SHA for the commit |
tree.url | string | Required within parent | Format: uri |
url | string | Required within parent | Format: uri |
verification | object | Required within parent | |
verification.payload | JSON | Required within parent | |
verification.payload (anyOf 1) | string | Alternative | |
verification.payload (anyOf 2) | null | Alternative | |
verification.reason | string | Required within parent | |
verification.signature | JSON | Required within parent | |
verification.signature (anyOf 1) | string | Alternative | |
verification.signature (anyOf 2) | null | Alternative | |
verification.verified | boolean | Required within parent | |
verification.verified_at | JSON | Required within parent | |
verification.verified_at (anyOf 1) | string | Alternative | |
verification.verified_at (anyOf 2) | null | Alternative |
List timeline events for an issue — response body — item Timeline Connected Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Timeline Connected Event |
actor | Model | Required within parent | Expand List users — response body — item |
commit_id | JSON | Required within parent | |
commit_id (anyOf 1) | string | Alternative | |
commit_id (anyOf 2) | null | Alternative | |
commit_url | JSON | Required within parent | |
commit_url (anyOf 1) | string | Alternative | |
commit_url (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | |
event | string | Required within parent | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
node_id | string | Required within parent | |
performed_via_github_app | Model | Required within parent | Expand Get an app — response body |
url | string | Required within parent |
Referenced models: Get an app — response body, List users — response body — item
List timeline events for an issue — response body — item Timeline Cross Referenced Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Timeline Cross Referenced Event |
actor | Model | Optional | Expand List users — response body — item |
created_at | string | Required within parent | Format: date-time |
event | string | Required within parent | |
source | object | Required within parent | |
source.issue | Model | Optional | Expand Get an issue — response body |
source.type | string | Optional | |
updated_at | string | Required within parent | Format: date-time |
Referenced models: Get an issue — response body, List users — response body — item
List timeline events for an issue — response body — item Timeline Disconnected Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Timeline Disconnected Event |
actor | Model | Required within parent | Expand List users — response body — item |
commit_id | JSON | Required within parent | |
commit_id (anyOf 1) | string | Alternative | |
commit_id (anyOf 2) | null | Alternative | |
commit_url | JSON | Required within parent | |
commit_url (anyOf 1) | string | Alternative | |
commit_url (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | |
event | string | Required within parent | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
node_id | string | Required within parent | |
performed_via_github_app | Model | Required within parent | Expand Get an app — response body |
url | string | Required within parent |
Referenced models: Get an app — response body, List users — response body — item
List timeline events for an issue — response body — item Timeline Line Commented Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Timeline Line Commented Event |
comments | array | Optional | |
comments[] | Model | Each item | Expand Create a reply for a review comment — response body |
event | string | Optional | |
node_id | string | Optional |
Referenced models: Create a reply for a review comment — response body
List timeline events for an issue — response body — item Timeline Reviewed Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Timeline Reviewed Event |
_links | object | Required within parent | |
_links.html | object | Required within parent | |
_links.html.href | string | Required within parent | |
_links.pull_request | object | Required within parent | |
_links.pull_request.href | string | Required within parent | |
author_association | string | Required within parent | How the author is associated with the repository. Known values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER |
body | JSON | Required within parent | |
body (anyOf 1) | string | Alternative | The text of the review. |
body (anyOf 2) | null | Alternative | |
body_html | string | Optional | |
body_text | string | Optional | |
commit_id | string | Required within parent | A commit SHA for the review. |
event | string | Required within parent | |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Unique identifier of the review |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
node_id | string | Required within parent | |
pull_request_url | string | Required within parent | Format: uri |
state | string | Required within parent | |
submitted_at | string | Optional | Format: date-time |
updated_at | JSON | Optional | |
updated_at (anyOf 1) | string | Alternative | Format: date-time |
updated_at (anyOf 2) | null | Alternative | |
user | Model | Required within parent | Expand List users — response body — item |
Referenced models: List users — response body — item
List timeline events for an issue — response body — item Timeline Unassigned Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Timeline Unassigned Issue Event |
actor | Model | Required within parent | Expand List users — response body — item |
assignee | Model | Required within parent | Expand List users — response body — item |
commit_id | JSON | Required within parent | |
commit_id (anyOf 1) | string | Alternative | |
commit_id (anyOf 2) | null | Alternative | |
commit_url | JSON | Required within parent | |
commit_url (anyOf 1) | string | Alternative | |
commit_url (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | |
event | string | Required within parent | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
node_id | string | Required within parent | |
performed_via_github_app | Model | Required within parent | Expand Get an app — response body |
url | string | Required within parent |
Referenced models: Get an app — response body, List users — response body — item