GitHub: Issues schemas (part 1)
58 GitHub schemas with complete fields and constraints.
← Issues operations · All schemas
Add issue field values to an issue — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A value assigned to an issue field |
data_type | string | Required within parent | The data type of the issue field Known values: text, single_select, multi_select, number, date |
issue_field_id | JSON | Required within parent | |
issue_field_id (anyOf 1) | integer | Alternative | Unique identifier for the issue field. Format: int64 |
issue_field_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
issue_field_name | string | Optional | The human-readable name of the issue field. |
multi_select_options | JSON | Optional | |
multi_select_options (anyOf 1) | array | Alternative | Details about the selected options |
multi_select_options (anyOf 1)[] | object | Each item | |
multi_select_options (anyOf 1)[].color | string | Required within parent | The color of the option |
multi_select_options (anyOf 1)[].id | JSON | Required within parent | |
multi_select_options (anyOf 1)[].id (anyOf 1) | integer | Alternative | Unique identifier for the option. Format: int64 |
multi_select_options (anyOf 1)[].id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
multi_select_options (anyOf 1)[].name | string | Required within parent | The name of the option |
multi_select_options (anyOf 2) | null | Alternative | |
node_id | string | Required within parent | |
single_select_option | JSON | Optional | |
single_select_option (anyOf 1) | object | Alternative | Details about the selected option (only present for single_select fields) |
single_select_option (anyOf 1).color | string | Required within parent | The color of the option |
single_select_option (anyOf 1).id | JSON | Required within parent | |
single_select_option (anyOf 1).id (anyOf 1) | integer | Alternative | Unique identifier for the option. Format: int64 |
single_select_option (anyOf 1).id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
single_select_option (anyOf 1).name | string | Required within parent | The name of the option |
single_select_option (anyOf 2) | null | Alternative | |
value | JSON | Required within parent | |
value (anyOf 1) | JSON | Alternative | The value of the issue field |
value (anyOf 1) (anyOf 1) | string | Alternative | |
value (anyOf 1) (anyOf 2) | JSON | Alternative | |
value (anyOf 1) (anyOf 2) (anyOf 1) | number | Alternative | |
value (anyOf 1) (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
value (anyOf 1) (anyOf 3) | JSON | Alternative | |
value (anyOf 1) (anyOf 3) (anyOf 1) | integer | Alternative | |
value (anyOf 1) (anyOf 3) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
value (anyOf 2) | null | Alternative |
Approve an issue suggestion — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An agent-proposed change to an issue that a maintainer can approve or dismiss. |
action | string | Required within parent | The kind of change proposed. Known values: set_type, add_label, add_field, add_assignee, close_issue |
actor_id | JSON | Required within parent | |
actor_id (anyOf 1) | JSON | Alternative | |
actor_id (anyOf 1) (anyOf 1) | integer | Alternative | The unique identifier of the actor that proposed the suggestion. |
actor_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
actor_id (anyOf 2) | null | Alternative | |
confidence | JSON | Required within parent | |
confidence (anyOf 1) | string | Alternative | The actor's confidence level in the suggestion. Known values: LOW, MEDIUM, HIGH |
confidence (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | The time the suggestion was created. Format: date-time |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | The unique identifier of the suggestion. |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
issue_event_id | JSON | Required within parent | |
issue_event_id (anyOf 1) | JSON | Alternative | |
issue_event_id (anyOf 1) (anyOf 1) | integer | Alternative | The identifier of the timeline event created when the suggestion was approved, when applicable. |
issue_event_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
issue_event_id (anyOf 2) | null | Alternative | |
issue_id | JSON | Required within parent | |
issue_id (anyOf 1) | integer | Alternative | The unique identifier of the issue the suggestion applies to. |
issue_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rationale | JSON | Required within parent | |
rationale (anyOf 1) | string | Alternative | The rationale the actor provided for the suggestion. |
rationale (anyOf 2) | null | Alternative | |
resolved_by | JSON | Required within parent | |
resolved_by (anyOf 1) | JSON | Alternative | |
resolved_by (anyOf 1) (anyOf 1) | integer | Alternative | The unique identifier of the user who approved or dismissed the suggestion. |
resolved_by (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
resolved_by (anyOf 2) | null | Alternative | |
state | string | Required within parent | The suggestion's lifecycle state. Known values: pending, applied, approved, dismissed, replaced, invalidated |
target_id | JSON | Required within parent | |
target_id (anyOf 1) | JSON | Alternative | |
target_id (anyOf 1) (anyOf 1) | integer | Alternative | The identifier of the target the change applies to (issue type, label, field, assignee, or duplicate issue), when applicable. |
target_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
target_id (anyOf 2) | null | Alternative | |
target_value | JSON | Required within parent | |
target_value (anyOf 1) | JSON | Alternative | The proposed value, when applicable. An array for multi-select field suggestions. |
target_value (anyOf 1) (anyOf 1) | string | Alternative | |
target_value (anyOf 1) (anyOf 2) | JSON | Alternative | |
target_value (anyOf 1) (anyOf 2) (anyOf 1) | number | Alternative | |
target_value (anyOf 1) (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
target_value (anyOf 1) (anyOf 3) | boolean | Alternative | |
target_value (anyOf 1) (anyOf 4) | array | Alternative | |
target_value (anyOf 1) (anyOf 4)[] | string | Each item | |
target_value (anyOf 2) | null | Alternative | |
updated_at | string | Required within parent | The time the suggestion was last updated. Format: date-time |
Create an issue artifact — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Issue artifacts are named, typed pieces of content attached to an issue. They give people and agents a durable place to preserve context and supporting material alongside the work. Each artifact has a number unique within the issue. |
body | string | Required within parent | The artifact content. For `embedded_html` artifacts, this is the HTML source. |
body_html | JSON | Required within parent | |
body_html (anyOf 1) | string | Alternative | The artifact content rendered as HTML, or `null` if rendering times out or is skipped to protect the response's time budget. The raw content remains available in `body`. |
body_html (anyOf 2) | null | Alternative | |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | The time the artifact was created. Format: date-time |
created_at (anyOf 2) | null | Alternative | |
creator | JSON | Required within parent | |
creator (anyOf 1) | object | Alternative | The user or integration that created the artifact. |
creator (anyOf 1).id | JSON | Required within parent | |
creator (anyOf 1).id (anyOf 1) | integer | Alternative | Format: int64 |
creator (anyOf 1).id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
creator (anyOf 1).login | string | Required within parent | |
creator (anyOf 2) | null | Alternative | |
description | string | Required within parent | A short, generated summary of the artifact. |
html_url | string | Optional | The canonical browser URL for the artifact in its issue context. Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | The globally unique identifier of the artifact. Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Required within parent | The human-readable name of the artifact. |
number | JSON | Required within parent | |
number (anyOf 1) | integer | Alternative | The artifact number within the issue. |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
type | string | Required within parent | The artifact type. The types supported for external creation and filtering are: - `generic` is a general-purpose Markdown document. - `link` represents a named link. - `plan` is a Markdown plan. - `embedded_html` is a self-contained HTML document. Its `body` contains the HTML source. |
updated_at | JSON | Required within parent | |
updated_at (anyOf 1) | string | Alternative | The time the artifact was last updated. Format: date-time |
updated_at (anyOf 2) | null | Alternative | |
updated_by_actor | JSON | Required within parent | |
updated_by_actor (anyOf 1) | object | Alternative | The user or integration that most recently updated the artifact. |
updated_by_actor (anyOf 1).id | JSON | Required within parent | |
updated_by_actor (anyOf 1).id (anyOf 1) | integer | Alternative | Format: int64 |
updated_by_actor (anyOf 1).id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated_by_actor (anyOf 1).login | string | Required within parent | |
updated_by_actor (anyOf 2) | null | Alternative |
Get a label — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Color-coded labels help you categorize and filter your issues (just like labels in Gmail). |
archived_at | JSON | Required within parent | |
archived_at (anyOf 1) | string | Alternative | Timestamp indicating when the label was archived, or `null` if it has not been archived. Format: date-time |
archived_at (anyOf 2) | null | Alternative | |
archived_by | JSON | Required within parent | |
archived_by (anyOf 1) | JSON | Alternative | The user who archived the label, or `null` if it has not been archived. |
archived_by (anyOf 1) (allOf 1) | Model | All variants apply | Expand List users — response body — item |
archived_by (anyOf 2) | null | Alternative | |
color | string | Required within parent | 6-character hex code, without the leading #, identifying the color |
default | boolean | Required within parent | Whether this label comes by default in a new repository. |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Optional description of the label, such as its purpose. |
description (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Unique identifier for the label. Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Required within parent | The name of the label. |
node_id | string | Required within parent | |
url | string | Required within parent | URL for the label Format: uri |
Referenced models: List users — response body — item
Get a milestone — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A collection of related issues and pull requests. |
closed_at | JSON | Required within parent | |
closed_at (anyOf 1) | string | Alternative | Format: date-time |
closed_at (anyOf 2) | null | Alternative | |
closed_issues | JSON | Required within parent | |
closed_issues (anyOf 1) | integer | Alternative | |
closed_issues (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_at | string | Required within parent | Format: date-time |
creator | Model | Required within parent | Expand Get an issue — response body — user |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
due_on | JSON | Required within parent | |
due_on (anyOf 1) | string | Alternative | Format: date-time |
due_on (anyOf 2) | null | Alternative | |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
labels_url | string | Required within parent | Format: uri |
node_id | string | Required within parent | |
number | JSON | Required within parent | |
number (anyOf 1) | integer | Alternative | The number of the milestone. |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
open_issues | JSON | Required within parent | |
open_issues (anyOf 1) | integer | Alternative | |
open_issues (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
state | string | Required within parent | The state of the milestone. Known values: open, closed Default: open |
title | string | Required within parent | The title of the milestone. |
updated_at | string | Required within parent | Format: date-time |
url | string | Required within parent | Format: uri |
Referenced models: Get an issue — response body — user
Get an issue comment — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Comments provide a way for people to collaborate on an issue. |
author_association | string | Optional | 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 |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Unique identifier of the issue comment Format: int64 |
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 Get an issue — response body — user |
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 — user, Get an issue — response body — reactions
Get an issue comment — response body — minimized
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Details about why an issue comment was minimized. |
$ (anyOf 1).reason | JSON | Required within parent | |
$ (anyOf 1).reason (anyOf 1) | string | Alternative | The reason the comment was minimized. |
$ (anyOf 1).reason (anyOf 2) | null | Alternative | |
$ (anyOf 2) | null | Alternative |
Get an issue comment — response body — pin
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Context around who pinned an issue comment and when it was pinned. |
$ (anyOf 1).pinned_at | string | Required within parent | Format: date-time |
$ (anyOf 1).pinned_by | Model | Required within parent | Expand Get an issue — response body — user |
$ (anyOf 2) | null | Alternative |
Referenced models: Get an issue — response body — user
Get an issue event — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Issue Event |
actor | Model | Required within parent | Expand Get an issue — response body — user |
assignee | Model | Optional | Expand Get an issue — response body — user |
assigner | Model | Optional | Expand Get an issue — response body — user |
author_association | string | Optional | How the author is associated with the repository. Known values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER |
blocked_by | Model | Optional | Expand Get an issue event — response body — blocking |
blocking | Model | Optional | Expand Get an issue event — response body — blocking |
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 | Format: date-time |
dismissed_review | Model | Optional | Expand Get an issue event — response body — dismissed review |
event | string | Required within parent | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
intent | Model | Optional | Expand Get an issue event — response body — intent |
issue | Model | Optional | Expand Get an issue event — response body — issue |
issue_type | Model | Optional | Expand Get an issue event — response body — issue type |
label | Model | Optional | Expand Get an issue event — response body — label |
lock_reason | JSON | Optional | |
lock_reason (anyOf 1) | string | Alternative | |
lock_reason (anyOf 2) | null | Alternative | |
milestone | Model | Optional | Expand Get an issue event — response body — milestone |
node_id | string | Required within parent | |
parent_issue | Model | Optional | Expand Get an issue event — response body — blocking |
performed_via_github_app | Model | Optional | Expand Get an app — response body |
prev_issue_type | Model | Optional | Expand Get an issue event — response body — issue type |
project_card | Model | Optional | Expand Get an issue event — response body — project card |
rename | Model | Optional | Expand Get an issue event — response body — rename |
requested_reviewer | Model | Optional | Expand Get an issue — response body — user |
requested_team | Model | Optional | Expand List teams — response body — item |
review_requester | Model | Optional | Expand Get an issue — response body — user |
sub_issue | Model | Optional | Expand Get an issue event — response body — blocking |
url | string | Required within parent | Format: uri |
Referenced models: Get an app — response body, Get an issue event — response body — dismissed review, Get an issue event — response body — label, Get an issue event — response body — milestone, Get an issue event — response body — project card, Get an issue event — response body — rename, Get an issue event — response body — issue type, Get an issue event — response body — issue, Get an issue event — response body — intent, Get an issue event — response body — blocking, Get an issue — response body — user, List teams — response body — item
Get an issue event — response body — blocking
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | A minimal reference to an issue linked from a timeline event (e.g. sub-issue, parent-issue, or dependency events). |
$ (anyOf 1).issue_type | JSON | Required within parent | |
$ (anyOf 1).issue_type (anyOf 1) | object | Alternative | The type of the referenced issue. |
$ (anyOf 1).issue_type (anyOf 1).color | JSON | Optional | |
$ (anyOf 1).issue_type (anyOf 1).color (anyOf 1) | string | Alternative | The color of the issue type. |
$ (anyOf 1).issue_type (anyOf 1).color (anyOf 2) | null | Alternative | |
$ (anyOf 1).issue_type (anyOf 1).id | JSON | Required within parent | |
$ (anyOf 1).issue_type (anyOf 1).id (anyOf 1) | integer | Alternative | The unique identifier of the issue type. |
$ (anyOf 1).issue_type (anyOf 1).id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).issue_type (anyOf 1).name | string | Required within parent | The name of the issue type. |
$ (anyOf 1).issue_type (anyOf 1).node_id | string | Required within parent | The node identifier of the issue type. |
$ (anyOf 1).issue_type (anyOf 2) | null | Alternative | |
$ (anyOf 1).number | JSON | Required within parent | |
$ (anyOf 1).number (anyOf 1) | integer | Alternative | The number of the referenced issue. |
$ (anyOf 1).number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).repository | Model | Required within parent | Expand List repositories for a user migration — response body — item |
$ (anyOf 1).state | string | Required within parent | The state of the referenced issue. |
$ (anyOf 1).state_reason | JSON | Optional | |
$ (anyOf 1).state_reason (anyOf 1) | string | Alternative | The reason for the referenced issue's state. |
$ (anyOf 1).state_reason (anyOf 2) | null | Alternative | |
$ (anyOf 1).title | string | Required within parent | The title of the referenced issue. |
$ (anyOf 2) | null | Alternative |
Referenced models: List repositories for a user migration — response body — item
Get an issue event — response body — dismissed review
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
dismissal_commit_id | JSON | Optional | |
dismissal_commit_id (anyOf 1) | string | Alternative | |
dismissal_commit_id (anyOf 2) | null | Alternative | |
dismissal_message | JSON | Required within parent | |
dismissal_message (anyOf 1) | string | Alternative | |
dismissal_message (anyOf 2) | null | Alternative | |
review_id | JSON | Required within parent | |
review_id (anyOf 1) | integer | Alternative | |
review_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
state | string | Required within parent |
Get an issue event — response body — intent
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | The intent behind an agent's action on an issue, including the rationale and confidence. Present (and `null` when the event carried no agent intent) on supported event types while the issue suggestions feature is enabled for the repository; the property is omitted entirely when the feature is disabled or the event type does not support intent. |
$ (anyOf 1).confidence | JSON | Optional | |
$ (anyOf 1).confidence (anyOf 1) | string | Alternative | The confidence level the agent had when performing this action. Known values: LOW, MEDIUM, HIGH |
$ (anyOf 1).confidence (anyOf 2) | null | Alternative | |
$ (anyOf 1).rationale | JSON | Optional | |
$ (anyOf 1).rationale (anyOf 1) | string | Alternative | The reasoning the agent provided for the change. |
$ (anyOf 1).rationale (anyOf 2) | null | Alternative | |
$ (anyOf 2) | null | Alternative |
Get an issue event — response body — issue
Get an issue event — response body — issue active lock reason, assignees, author association, body, body html, body text, closed at, closed by, comments, comments url, created at, draft, events url, html url, id, issue dependencies summary, issue field values, labels, labels url, locked, milestone, node id, number, parent issue url, performed via github app, pinned comment, pull request, reactions, repository, repository url, state, state reason, sub issues summary, timeline url, title, type, updated at, url, user
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. |
active_lock_reason | JSON | Optional | |
active_lock_reason (anyOf 1) | string | Alternative | |
active_lock_reason (anyOf 2) | null | Alternative | |
assignees | array | Optional | |
assignees[] | Model | Each item | Expand List users — response body — item |
author_association | string | Optional | How the author is associated with the repository. Known values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER |
body | JSON | Optional | |
body (anyOf 1) | string | Alternative | Contents of the issue |
body (anyOf 2) | null | Alternative | |
body_html | string | Optional | |
body_text | string | Optional | |
closed_at | JSON | Required within parent | |
closed_at (anyOf 1) | string | Alternative | Format: date-time |
closed_at (anyOf 2) | null | Alternative | |
closed_by | Model | Optional | Expand Get an issue — response body — user |
comments | JSON | Required within parent | |
comments (anyOf 1) | integer | Alternative | |
comments (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
comments_url | string | Required within parent | Format: uri |
created_at | string | Required within parent | Format: date-time |
draft | boolean | Optional | |
events_url | string | Required within parent | Format: uri |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
issue_dependencies_summary | Model | Optional | Expand Get an issue — response body — issue dependencies summary |
issue_field_values | array | Optional | |
issue_field_values[] | Model | Each item | Expand Add issue field values to an issue — response body — item |
labels | array | Required within parent | Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository |
labels[] | JSON | Each item | |
labels[] (anyOf 1) | string | Alternative | |
labels[] (anyOf 2) | Model | Alternative | Expand Get an issue — response body — labels item archived by, color, default, description, id, name, node id, url |
labels_url | string | Required within parent | |
locked | boolean | Required within parent | |
milestone | Model | Required within parent | Expand Get an issue — response body — milestone |
node_id | string | Required within parent | |
number | JSON | Required within parent | |
number (anyOf 1) | integer | Alternative | Number uniquely identifying the issue within its repository |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
parent_issue_url | JSON | Optional | |
parent_issue_url (anyOf 1) | string | Alternative | URL to get the parent issue of this issue, if it is a sub-issue Format: uri |
parent_issue_url (anyOf 2) | null | Alternative | |
performed_via_github_app | Model | Optional | Expand Get an app — response body |
pinned_comment | Model | Optional | Expand Get an issue — response body — pinned comment |
pull_request | object | Optional | |
pull_request.diff_url | string | Required within parent | Format: uri |
pull_request.html_url | string | Required within parent | Format: uri |
pull_request.merged_at | string | Optional | Format: date-time |
pull_request.patch_url | string | Required within parent | Format: uri |
pull_request.url | string | Required within parent | Format: uri |
reactions | Model | Optional | Expand Get an issue — response body — reactions |
repository | Model | Optional | Expand List repositories for the authenticated user — response body — item |
repository_url | string | Required within parent | Format: uri |
state | string | Required within parent | State of the issue; either 'open' or 'closed' |
state_reason | JSON | Optional | |
state_reason (anyOf 1) | string | Alternative | The reason for the current state Known values: completed, reopened, not_planned, duplicate |
state_reason (anyOf 2) | null | Alternative | |
sub_issues_summary | Model | Optional | Expand Get an issue — response body — sub issues summary |
timeline_url | string | Optional | Format: uri |
title | string | Required within parent | Title of the issue |
type | Model | Optional | Expand Create issue type for an organization — response body |
updated_at | string | Required within parent | Format: date-time |
url | string | Required within parent | URL for the issue Format: uri |
user | Model | Required within parent | Expand Get an issue — response body — user |
Referenced models: Get an app — response body, Get an issue — response body — issue dependencies summary, Add issue field values to an issue — response body — item, Create issue type for an organization — response body, Get an issue — response body — pinned comment, Get an issue — response body — milestone, Get an issue — response body — user, Get an issue — response body — reactions, List repositories for the authenticated user — response body — item, List users — response body — item, Get an issue — response body — sub issues summary, Get an issue — response body — labels item archived by, color, default, description, id, name, node id, url
Get an issue event — response body — issue type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | The type of issue. |
$ (anyOf 1).color | JSON | Optional | |
$ (anyOf 1).color (anyOf 1) | string | Alternative | The color of the issue type. Known values: gray, blue, green, yellow, orange, red, pink, purple |
$ (anyOf 1).color (anyOf 2) | null | Alternative | |
$ (anyOf 1).id | JSON | Required within parent | |
$ (anyOf 1).id (anyOf 1) | integer | Alternative | The unique identifier of the issue type. |
$ (anyOf 1).id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).name | string | Required within parent | The name of the issue type. |
$ (anyOf 2) | null | Alternative |
Get an issue event — response body — label
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Issue Event Label |
color | JSON | Required within parent | |
color (anyOf 1) | string | Alternative | |
color (anyOf 2) | null | Alternative | |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative |
Get an issue event — response body — milestone
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Issue Event Milestone |
title | string | Required within parent |
Get an issue event — response body — project card
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Issue Event Project Card |
column_name | 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]+)?$ |
previous_column_name | string | Optional | |
project_id | JSON | Required within parent | |
project_id (anyOf 1) | integer | Alternative | |
project_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
project_url | string | Required within parent | Format: uri |
url | string | Required within parent | Format: uri |
Get an issue event — response body — rename
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Issue Event Rename |
from | string | Required within parent | |
to | string | Required within parent |
Get an issue — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. |
active_lock_reason | JSON | Optional | |
active_lock_reason (anyOf 1) | string | Alternative | |
active_lock_reason (anyOf 2) | null | Alternative | |
assignees | array | Optional | |
assignees[] | Model | Each item | Expand List users — response body — item |
author_association | string | Optional | How the author is associated with the repository. Known values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER |
body | JSON | Optional | |
body (anyOf 1) | string | Alternative | Contents of the issue |
body (anyOf 2) | null | Alternative | |
body_html | string | Optional | |
body_text | string | Optional | |
closed_at | JSON | Required within parent | |
closed_at (anyOf 1) | string | Alternative | Format: date-time |
closed_at (anyOf 2) | null | Alternative | |
closed_by | Model | Optional | Expand Get an issue — response body — user |
comments | JSON | Required within parent | |
comments (anyOf 1) | integer | Alternative | |
comments (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
comments_url | string | Required within parent | Format: uri |
created_at | string | Required within parent | Format: date-time |
draft | boolean | Optional | |
events_url | string | Required within parent | Format: uri |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
issue_dependencies_summary | Model | Optional | Expand Get an issue — response body — issue dependencies summary |
issue_field_values | array | Optional | |
issue_field_values[] | Model | Each item | Expand Add issue field values to an issue — response body — item |
labels | array | Required within parent | Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository |
labels[] | JSON | Each item | |
labels[] (anyOf 1) | string | Alternative | |
labels[] (anyOf 2) | Model | Alternative | Expand Get an issue — response body — labels item archived by, color, default, description, id, name, node id, url |
labels_url | string | Required within parent | |
locked | boolean | Required within parent | |
milestone | Model | Required within parent | Expand Get an issue — response body — milestone |
node_id | string | Required within parent | |
number | JSON | Required within parent | |
number (anyOf 1) | integer | Alternative | Number uniquely identifying the issue within its repository |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
parent_issue_url | JSON | Optional | |
parent_issue_url (anyOf 1) | string | Alternative | URL to get the parent issue of this issue, if it is a sub-issue Format: uri |
parent_issue_url (anyOf 2) | null | Alternative | |
performed_via_github_app | Model | Optional | Expand Get an app — response body |
pinned_comment | Model | Optional | Expand Get an issue — response body — pinned comment |
pull_request | object | Optional | |
pull_request.diff_url | string | Required within parent | Format: uri |
pull_request.html_url | string | Required within parent | Format: uri |
pull_request.merged_at | string | Optional | Format: date-time |
pull_request.patch_url | string | Required within parent | Format: uri |
pull_request.url | string | Required within parent | Format: uri |
reactions | Model | Optional | Expand Get an issue — response body — reactions |
repository | Model | Optional | Expand List repositories for the authenticated user — response body — item |
repository_url | string | Required within parent | Format: uri |
state | string | Required within parent | State of the issue; either 'open' or 'closed' |
state_reason | JSON | Optional | |
state_reason (anyOf 1) | string | Alternative | The reason for the current state Known values: completed, reopened, not_planned, duplicate |
state_reason (anyOf 2) | null | Alternative | |
sub_issues_summary | Model | Optional | Expand Get an issue — response body — sub issues summary |
timeline_url | string | Optional | Format: uri |
title | string | Required within parent | Title of the issue |
type | Model | Optional | Expand Create issue type for an organization — response body |
updated_at | string | Required within parent | Format: date-time |
url | string | Required within parent | URL for the issue Format: uri |
user | Model | Required within parent | Expand Get an issue — response body — user |
Referenced models: Get an app — response body, Get an issue — response body — issue dependencies summary, Add issue field values to an issue — response body — item, Create issue type for an organization — response body, Get an issue — response body — pinned comment, Get an issue — response body — milestone, Get an issue — response body — user, Get an issue — response body — reactions, List repositories for the authenticated user — response body — item, List users — response body — item, Get an issue — response body — sub issues summary, Get an issue — response body — labels item archived by, color, default, description, id, name, node id, url
Get an issue — response body — issue dependencies summary
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
blocked_by | JSON | Required within parent | |
blocked_by (anyOf 1) | integer | Alternative | |
blocked_by (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
blocking | JSON | Required within parent | |
blocking (anyOf 1) | integer | Alternative | |
blocking (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_blocked_by | JSON | Required within parent | |
total_blocked_by (anyOf 1) | integer | Alternative | |
total_blocked_by (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_blocking | JSON | Required within parent | |
total_blocking (anyOf 1) | integer | Alternative | |
total_blocking (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get an issue — response body — labels item archived by, color, default, description, id, name, node id, url
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
archived_by | JSON | Optional | |
archived_by (anyOf 1) | JSON | Alternative | The user who archived the label, or `null` if it has not been archived. |
archived_by (anyOf 1) (allOf 1) | Model | All variants apply | Expand List users — response body — item |
archived_by (anyOf 2) | null | Alternative | |
color | JSON | Optional | |
color (anyOf 1) | string | Alternative | |
color (anyOf 2) | null | Alternative | |
default | boolean | Optional | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | integer | Alternative | Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Optional | |
node_id | string | Optional | |
url | string | Optional | Format: uri |
Referenced models: List users — response body — item
Get an issue — response body — milestone
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Get an issue — response body — milestone / state: open, closed |
$ (anyOf 2) | null | Alternative |
Referenced models: Get an issue — response body — milestone / state: open, closed
Get an issue — response body — milestone / state: open, closed
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A collection of related issues and pull requests. |
closed_at | JSON | Required within parent | |
closed_at (anyOf 1) | string | Alternative | Format: date-time |
closed_at (anyOf 2) | null | Alternative | |
closed_issues | JSON | Required within parent | |
closed_issues (anyOf 1) | integer | Alternative | |
closed_issues (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_at | string | Required within parent | Format: date-time |
creator | Model | Required within parent | Expand Get an issue — response body — user |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
due_on | JSON | Required within parent | |
due_on (anyOf 1) | string | Alternative | Format: date-time |
due_on (anyOf 2) | null | Alternative | |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
labels_url | string | Required within parent | Format: uri |
node_id | string | Required within parent | |
number | JSON | Required within parent | |
number (anyOf 1) | integer | Alternative | The number of the milestone. |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
open_issues | JSON | Required within parent | |
open_issues (anyOf 1) | integer | Alternative | |
open_issues (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
state | string | Required within parent | The state of the milestone. Known values: open, closed Default: open |
title | string | Required within parent | The title of the milestone. |
updated_at | string | Required within parent | Format: date-time |
url | string | Required within parent | Format: uri |
Referenced models: Get an issue — response body — user
Get an issue — response body — pinned comment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Get an issue — response body — pinned comment author association, body, body html, body text, created at, html url, id, issue url, minimized, node id, performed via github app, pin, reactions, updated at, url, user |
$ (anyOf 2) | null | Alternative |
Get an issue — response body — pinned comment author association, body, body html, body text, created at, html url, id, issue url, minimized, node id, performed via github app, pin, reactions, updated at, url, user
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Comments provide a way for people to collaborate on an issue. |
author_association | string | Optional | 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 |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Unique identifier of the issue comment Format: int64 |
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 Get an issue — response body — user |
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 — user, Get an issue — response body — reactions
Get an issue — response body — reactions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
+1 | JSON | Required within parent | |
+1 (anyOf 1) | integer | Alternative | |
+1 (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
-1 | JSON | Required within parent | |
-1 (anyOf 1) | integer | Alternative | |
-1 (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
confused | JSON | Required within parent | |
confused (anyOf 1) | integer | Alternative | |
confused (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
eyes | JSON | Required within parent | |
eyes (anyOf 1) | integer | Alternative | |
eyes (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
heart | JSON | Required within parent | |
heart (anyOf 1) | integer | Alternative | |
heart (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hooray | JSON | Required within parent | |
hooray (anyOf 1) | integer | Alternative | |
hooray (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
laugh | JSON | Required within parent | |
laugh (anyOf 1) | integer | Alternative | |
laugh (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rocket | JSON | Required within parent | |
rocket (anyOf 1) | integer | Alternative | |
rocket (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
url | string | Required within parent | Format: uri |
Get an issue — response body — sub issues summary
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
completed | JSON | Required within parent | |
completed (anyOf 1) | integer | Alternative | |
completed (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
percent_completed | JSON | Required within parent | |
percent_completed (anyOf 1) | integer | Alternative | |
percent_completed (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get an issue — response body — user
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Get an issue — response body — user A Git Hub user |
$ (anyOf 2) | null | Alternative |
Referenced models: Get an issue — response body — user A Git Hub user
Get an issue — response body — user A Git Hub user
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A GitHub user. |
avatar_url | string | Required within parent | Format: uri |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | |
email (anyOf 2) | null | Alternative | |
events_url | string | Required within parent | |
followers_url | string | Required within parent | Format: uri |
following_url | string | Required within parent | |
gists_url | string | Required within parent | |
gravatar_id | JSON | Required within parent | |
gravatar_id (anyOf 1) | string | Alternative | |
gravatar_id (anyOf 2) | null | Alternative | |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
login | string | Required within parent | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
node_id | string | Required within parent | |
organizations_url | string | Required within parent | Format: uri |
received_events_url | string | Required within parent | Format: uri |
repos_url | string | Required within parent | Format: uri |
site_admin | boolean | Required within parent | |
starred_at | string | Optional | |
starred_url | string | Required within parent | |
subscriptions_url | string | Required within parent | Format: uri |
type | string | Required within parent | |
url | string | Required within parent | Format: uri |
user_view_type | string | Optional |
List issue events — response body — item
Referenced models: List issue events — response body — item Added to Project Issue Event, List issue events — response body — item Assigned 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 issue events — response body — item Sub-issue Added Issue Event, List issue events — response body — item Sub-issue Removed Issue Event, List issue events — response body — item Unassigned Issue Event, List issue events — response body — item Unlabeled Issue Event
List issue events — response body — item Added to Project Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Added to Project 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]+)?$ |
node_id | string | Required within parent | |
performed_via_github_app | Model | Required within parent | Expand Get an app — response body |
project_card | Model | Optional | Expand List issue events — response body — item Added to Project Issue Event project card |
url | string | Required within parent |
Referenced models: Get an app — response body, List users — response body — item, List issue events — response body — item Added to Project Issue Event project card
List issue events — response body — item Added to Project Issue Event project card
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
column_name | 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]+)?$ |
previous_column_name | string | Optional | |
project_id | JSON | Required within parent | |
project_id (anyOf 1) | integer | Alternative | |
project_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
project_url | string | Required within parent | Format: uri |
url | string | Required within parent | Format: uri |
List issue events — response body — item Assigned Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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 |
assigner | 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 issue events — response body — item Blocked-by Added Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Blocked-by Added Issue Event |
actor | Model | Required within parent | Expand List users — response body — item |
blocked_by | Model | Required within parent | Expand Get an issue event — response body — blocking |
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, Get an issue event — response body — blocking, List users — response body — item
List issue events — response body — item Blocked-by Removed Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Blocked-by Removed Issue Event |
actor | Model | Required within parent | Expand List users — response body — item |
blocked_by | Model | Required within parent | Expand Get an issue event — response body — blocking |
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, Get an issue event — response body — blocking, List users — response body — item
List issue events — response body — item Blocking Added Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Blocking Added Issue Event |
actor | Model | Required within parent | Expand List users — response body — item |
blocking | Model | Required within parent | Expand Get an issue event — response body — blocking |
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, Get an issue event — response body — blocking, List users — response body — item
List issue events — response body — item Blocking Removed Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Blocking Removed Issue Event |
actor | Model | Required within parent | Expand List users — response body — item |
blocking | Model | Required within parent | Expand Get an issue event — response body — blocking |
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, Get an issue event — response body — blocking, List users — response body — item
List issue events — response body — item Converted Note to Issue Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Converted Note to Issue 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]+)?$ |
node_id | string | Required within parent | |
performed_via_github_app | Model | Required within parent | Expand Get an app — response body |
project_card | Model | Optional | Expand List issue events — response body — item Added to Project Issue Event project card |
url | string | Required within parent |
Referenced models: Get an app — response body, List users — response body — item, List issue events — response body — item Added to Project Issue Event project card
List issue events — response body — item Demilestoned Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Demilestoned 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]+)?$ |
milestone | object | Required within parent | |
milestone.title | string | Required within parent | |
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 issue events — response body — item Issue Type Added Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Issue Type Added 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 |
issue_type | Model | Required within parent | Expand Get an issue event — response body — issue type |
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 — issue type, Get an issue event — response body — intent, List users — response body — item
List issue events — response body — item Issue Type Changed Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Issue Type Changed 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 |
issue_type | Model | Required within parent | Expand Get an issue event — response body — issue type |
node_id | string | Required within parent | |
performed_via_github_app | Model | Required within parent | Expand Get an app — response body |
prev_issue_type | Model | Required within parent | Expand Get an issue event — response body — issue type |
url | string | Required within parent |
Referenced models: Get an app — response body, Get an issue event — response body — issue type, Get an issue event — response body — intent, List users — response body — item
List issue events — response body — item Issue Type Removed Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Issue Type Removed 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 |
prev_issue_type | Model | Required within parent | Expand Get an issue event — response body — issue type |
url | string | Required within parent |
Referenced models: Get an app — response body, Get an issue event — response body — issue type, Get an issue event — response body — intent, List users — response body — item
List issue events — response body — item Labeled Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Labeled 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 |
label | object | Required within parent | |
label.color | string | Required within parent | |
label.name | string | Required within parent | |
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 issue events — response body — item Locked Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Locked 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]+)?$ |
lock_reason | JSON | Required within parent | |
lock_reason (anyOf 1) | string | Alternative | |
lock_reason (anyOf 2) | null | Alternative | |
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 issue events — response body — item Milestoned Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Milestoned 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]+)?$ |
milestone | object | Required within parent | |
milestone.title | string | Required within parent | |
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 issue events — response body — item Moved Column in Project Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Moved Column in Project 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]+)?$ |
node_id | string | Required within parent | |
performed_via_github_app | Model | Required within parent | Expand Get an app — response body |
project_card | Model | Optional | Expand List issue events — response body — item Added to Project Issue Event project card |
url | string | Required within parent |
Referenced models: Get an app — response body, List users — response body — item, List issue events — response body — item Added to Project Issue Event project card
List issue events — response body — item Parent-issue Added Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Parent-issue Added 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]+)?$ |
node_id | string | Required within parent | |
parent_issue | Model | Required within parent | Expand Get an issue event — response body — blocking |
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 — blocking, List users — response body — item
List issue events — response body — item Parent-issue Removed Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Parent-issue Removed 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]+)?$ |
node_id | string | Required within parent | |
parent_issue | Model | Required within parent | Expand Get an issue event — response body — blocking |
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 — blocking, List users — response body — item
List issue events — response body — item Removed from Project Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Removed from Project 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]+)?$ |
node_id | string | Required within parent | |
performed_via_github_app | Model | Required within parent | Expand Get an app — response body |
project_card | Model | Optional | Expand List issue events — response body — item Added to Project Issue Event project card |
url | string | Required within parent |
Referenced models: Get an app — response body, List users — response body — item, List issue events — response body — item Added to Project Issue Event project card
List issue events — response body — item Renamed Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Renamed 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]+)?$ |
node_id | string | Required within parent | |
performed_via_github_app | Model | Required within parent | Expand Get an app — response body |
rename | object | Required within parent | |
rename.from | string | Required within parent | |
rename.to | string | Required within parent | |
url | string | Required within parent |
Referenced models: Get an app — response body, List users — response body — item
List issue events — response body — item Review Dismissed Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Review Dismissed 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 | |
dismissed_review | object | Required within parent | |
dismissed_review.dismissal_commit_id | string | Optional | |
dismissed_review.dismissal_message | JSON | Required within parent | |
dismissed_review.dismissal_message (anyOf 1) | string | Alternative | |
dismissed_review.dismissal_message (anyOf 2) | null | Alternative | |
dismissed_review.review_id | JSON | Required within parent | |
dismissed_review.review_id (anyOf 1) | integer | Alternative | |
dismissed_review.review_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
dismissed_review.state | 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 issue events — response body — item Review Request Removed Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Review Request Removed 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]+)?$ |
node_id | string | Required within parent | |
performed_via_github_app | Model | Required within parent | Expand Get an app — response body |
requested_reviewer | Model | Optional | Expand List users — response body — item |
requested_team | Model | Optional | Expand List teams — response body — item |
review_requester | Model | Required within parent | Expand List users — response body — item |
url | string | Required within parent |
Referenced models: Get an app — response body, List users — response body — item, List teams — response body — item
List issue events — response body — item Review Requested Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Review Requested 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]+)?$ |
node_id | string | Required within parent | |
performed_via_github_app | Model | Required within parent | Expand Get an app — response body |
requested_reviewer | Model | Optional | Expand List users — response body — item |
requested_team | Model | Optional | Expand List teams — response body — item |
review_requester | Model | Required within parent | Expand List users — response body — item |
url | string | Required within parent |
Referenced models: Get an app — response body, List users — response body — item, List teams — response body — item
List issue events — response body — item Sub-issue Added Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Sub-issue Added 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]+)?$ |
node_id | string | Required within parent | |
performed_via_github_app | Model | Required within parent | Expand Get an app — response body |
sub_issue | Model | Required within parent | Expand Get an issue event — response body — blocking |
url | string | Required within parent |
Referenced models: Get an app — response body, Get an issue event — response body — blocking, List users — response body — item
List issue events — response body — item Sub-issue Removed Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Sub-issue Removed 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]+)?$ |
node_id | string | Required within parent | |
performed_via_github_app | Model | Required within parent | Expand Get an app — response body |
sub_issue | Model | Required within parent | Expand Get an issue event — response body — blocking |
url | string | Required within parent |
Referenced models: Get an app — response body, Get an issue event — response body — blocking, List users — response body — item
List issue events — response body — item Unassigned Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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 |
assigner | 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 issue events — response body — item Unlabeled Issue Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Unlabeled 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 |
label | object | Required within parent | |
label.color | string | Required within parent | |
label.name | string | Required within parent | |
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