GitHub: Activity schemas
28 GitHub schemas with complete fields and constraints.
← Activity operations · All schemas
Get a repository subscription — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Repository invitations let you manage who you collaborate with. |
created_at | string | Required within parent | Format: date-time |
ignored | boolean | Required within parent | Determines if all notifications should be blocked from this repository. |
reason | JSON | Required within parent | |
reason (anyOf 1) | string | Alternative | |
reason (anyOf 2) | null | Alternative | |
repository_url | string | Required within parent | Format: uri |
subscribed | boolean | Required within parent | Determines if notifications should be received from this repository. |
url | string | Required within parent | Format: uri |
Get a thread — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Thread |
id | string | Required within parent | |
last_read_at | JSON | Required within parent | |
last_read_at (anyOf 1) | string | Alternative | |
last_read_at (anyOf 2) | null | Alternative | |
reason | string | Required within parent | |
repository | Model | Required within parent | Expand Transfer a repository — response body |
subject | object | Required within parent | |
subject.latest_comment_url | string | Required within parent | |
subject.title | string | Required within parent | |
subject.type | string | Required within parent | |
subject.url | string | Required within parent | |
subscription_url | string | Required within parent | |
unread | boolean | Required within parent | |
updated_at | string | Required within parent | |
url | string | Required within parent |
Referenced models: Transfer a repository — response body
Get feeds — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Feed |
_links | object | Required within parent | |
_links.current_user | Model | Optional | Expand Get feeds — response body — links user |
_links.current_user_actor | Model | Optional | Expand Get feeds — response body — links user |
_links.current_user_organization | Model | Optional | Expand Get feeds — response body — links user |
_links.current_user_organizations | array | Optional | |
_links.current_user_organizations[] | Model | Each item | Expand Get feeds — response body — links user |
_links.current_user_public | Model | Optional | Expand Get feeds — response body — links user |
_links.repository_discussions | Model | Optional | Expand Get feeds — response body — links user |
_links.repository_discussions_category | Model | Optional | Expand Get feeds — response body — links user |
_links.security_advisories | Model | Optional | Expand Get feeds — response body — links user |
_links.timeline | Model | Required within parent | Expand Get feeds — response body — links user |
_links.user | Model | Required within parent | Expand Get feeds — response body — links user |
current_user_actor_url | string | Optional | |
current_user_organization_url | string | Optional | |
current_user_organization_urls | array | Optional | |
current_user_organization_urls[] | string | Each item | Format: uri |
current_user_public_url | string | Optional | |
current_user_url | string | Optional | |
repository_discussions_category_url | string | Optional | A feed of discussions for a given repository and category. |
repository_discussions_url | string | Optional | A feed of discussions for a given repository. |
security_advisories_url | string | Optional | |
timeline_url | string | Required within parent | |
user_url | string | Required within parent |
Referenced models: Get feeds — response body — links user
Get feeds — response body — links user
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Hypermedia Link with Type |
href | string | Required within parent | |
type | string | Required within parent |
Get repository star history — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Stargazer History |
days | array | Required within parent | The number of stars created on each day of the week, starting on Sunday. |
days[] | JSON | Each item | |
days[] (anyOf 1) | integer | Alternative | |
days[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | The number of stars created during the week. |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
week | JSON | Required within parent | |
week (anyOf 1) | integer | Alternative | The start of the week, given as a Unix timestamp. |
week (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List public events — response body — item
Referenced models: List public events — response body — item org, List public events — response body — item payload Commit Comment Event, List public events — response body — item payload Create Event, List public events — response body — item payload Delete Event, List public events — response body — item payload Discussion Event, List public events — response body — item payload Fork Event, List public events — response body — item payload Gollum Event, List public events — response body — item payload Issue Comment Event, List public events — response body — item payload Issues Event, List public events — response body — item payload Member Event, List public events — response body — item payload Public Event, List public events — response body — item payload Pull Request Event, List public events — response body — item payload Pull Request Review Comment Event, List public events — response body — item payload Pull Request Review Event, List public events — response body — item payload Push Event, List public events — response body — item payload Release Event, List public events — response body — item payload Watch Event
List public events — response body — item org
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Actor |
avatar_url | string | Required within parent | Format: uri |
display_login | string | Optional | |
gravatar_id | JSON | Required within parent | |
gravatar_id (anyOf 1) | string | Alternative | |
gravatar_id (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
login | string | Required within parent | |
url | string | Required within parent | Format: uri |
List public events — response body — item payload Commit Comment Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
action | string | Required within parent | |
comment | object | Required within parent | |
comment.body | string | Optional | |
comment.commit_id | string | Optional | |
comment.created_at | string | Optional | Format: date-time |
comment.html_url | string | Optional | Format: uri |
comment.id | JSON | Optional | |
comment.id (anyOf 1) | integer | Alternative | |
comment.id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
comment.line | JSON | Optional | |
comment.line (anyOf 1) | JSON | Alternative | |
comment.line (anyOf 1) (anyOf 1) | integer | Alternative | |
comment.line (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
comment.line (anyOf 2) | null | Alternative | |
comment.node_id | string | Optional | |
comment.path | JSON | Optional | |
comment.path (anyOf 1) | string | Alternative | |
comment.path (anyOf 2) | null | Alternative | |
comment.position | JSON | Optional | |
comment.position (anyOf 1) | JSON | Alternative | |
comment.position (anyOf 1) (anyOf 1) | integer | Alternative | |
comment.position (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
comment.position (anyOf 2) | null | Alternative | |
comment.reactions | Model | Optional | Expand Get an issue — response body — reactions |
comment.updated_at | string | Optional | Format: date-time |
comment.url | string | Optional | Format: uri |
comment.user | Model | Optional | Expand Get an issue — response body — user |
Referenced models: Get an issue — response body — user, Get an issue — response body — reactions
List public events — response body — item payload Create Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
full_ref | string | Required within parent | |
master_branch | string | Required within parent | |
pusher_type | string | Required within parent | |
ref | string | Required within parent | |
ref_type | string | Required within parent |
List public events — response body — item payload Delete Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
full_ref | string | Required within parent | |
pusher_type | string | Required within parent | |
ref | string | Required within parent | |
ref_type | string | Required within parent |
List public events — response body — item payload Discussion Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
action | string | Required within parent | |
discussion | Model | Required within parent | Expand List public events — response body — item payload Discussion Event discussion |
Referenced models: List public events — response body — item payload Discussion Event discussion
List public events — response body — item payload Discussion Event discussion
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Discussion in a repository. |
active_lock_reason | JSON | Required within parent | |
active_lock_reason (anyOf 1) | string | Alternative | |
active_lock_reason (anyOf 2) | null | Alternative | |
answer_chosen_at | JSON | Required within parent | |
answer_chosen_at (anyOf 1) | string | Alternative | |
answer_chosen_at (anyOf 2) | null | Alternative | |
answer_chosen_by | JSON | Required within parent | |
answer_chosen_by (anyOf 1) | object | Alternative | |
answer_chosen_by (anyOf 1).avatar_url | string | Optional | Format: uri |
answer_chosen_by (anyOf 1).deleted | boolean | Optional | |
answer_chosen_by (anyOf 1).email | JSON | Optional | |
answer_chosen_by (anyOf 1).email (anyOf 1) | string | Alternative | |
answer_chosen_by (anyOf 1).email (anyOf 2) | null | Alternative | |
answer_chosen_by (anyOf 1).events_url | string | Optional | Format: uri-template |
answer_chosen_by (anyOf 1).followers_url | string | Optional | Format: uri |
answer_chosen_by (anyOf 1).following_url | string | Optional | Format: uri-template |
answer_chosen_by (anyOf 1).gists_url | string | Optional | Format: uri-template |
answer_chosen_by (anyOf 1).gravatar_id | string | Optional | |
answer_chosen_by (anyOf 1).html_url | string | Optional | Format: uri |
answer_chosen_by (anyOf 1).id | JSON | Required within parent | |
answer_chosen_by (anyOf 1).id (anyOf 1) | integer | Alternative | |
answer_chosen_by (anyOf 1).id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
answer_chosen_by (anyOf 1).login | string | Required within parent | |
answer_chosen_by (anyOf 1).name | string | Optional | |
answer_chosen_by (anyOf 1).node_id | string | Optional | |
answer_chosen_by (anyOf 1).organizations_url | string | Optional | Format: uri |
answer_chosen_by (anyOf 1).received_events_url | string | Optional | Format: uri |
answer_chosen_by (anyOf 1).repos_url | string | Optional | Format: uri |
answer_chosen_by (anyOf 1).site_admin | boolean | Optional | |
answer_chosen_by (anyOf 1).starred_url | string | Optional | Format: uri-template |
answer_chosen_by (anyOf 1).subscriptions_url | string | Optional | Format: uri |
answer_chosen_by (anyOf 1).type | string | Optional | Known values: Bot, User, Organization |
answer_chosen_by (anyOf 1).url | string | Optional | Format: uri |
answer_chosen_by (anyOf 1).user_view_type | string | Optional | |
answer_chosen_by (anyOf 2) | null | Alternative | |
answer_html_url | JSON | Required within parent | |
answer_html_url (anyOf 1) | string | Alternative | |
answer_html_url (anyOf 2) | null | Alternative | |
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 | Required within parent | |
category | object | Required within parent | |
category.created_at | string | Required within parent | Format: date-time |
category.description | string | Required within parent | |
category.emoji | string | Required within parent | |
category.id | JSON | Required within parent | |
category.id (anyOf 1) | integer | Alternative | |
category.id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
category.is_answerable | boolean | Required within parent | |
category.name | string | Required within parent | |
category.node_id | string | Optional | |
category.repository_id | JSON | Required within parent | |
category.repository_id (anyOf 1) | integer | Alternative | |
category.repository_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
category.slug | string | Required within parent | |
category.updated_at | string | Required within parent | |
comments | JSON | Required within parent | |
comments (anyOf 1) | integer | Alternative | |
comments (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_at | string | Required within parent | Format: date-time |
html_url | 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]+)?$ |
labels | array | Optional | |
labels[] | Model | Each item | Expand Get a label — response body |
locked | boolean | Required within parent | |
node_id | string | Required within parent | |
number | JSON | Required within parent | |
number (anyOf 1) | integer | Alternative | |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
reactions | Model | Optional | Expand List public events — response body — item payload Discussion Event discussion reactions |
repository_url | string | Required within parent | |
state | string | Required within parent | The current state of the discussion. `converting` means that the discussion is being converted from an issue. `transferring` means that the discussion is being transferred from another repository. Known values: open, closed, locked, converting, transferring |
state_reason | JSON | Required within parent | |
state_reason (anyOf 1) | string | Alternative | The reason for the current state Known values: resolved, outdated, duplicate, reopened |
state_reason (anyOf 2) | null | Alternative | |
timeline_url | string | Optional | |
title | string | Required within parent | |
updated_at | string | Required within parent | Format: date-time |
user | JSON | Required within parent | |
user (anyOf 1) | object | Alternative | |
user (anyOf 1).avatar_url | string | Optional | Format: uri |
user (anyOf 1).deleted | boolean | Optional | |
user (anyOf 1).email | JSON | Optional | |
user (anyOf 1).email (anyOf 1) | string | Alternative | |
user (anyOf 1).email (anyOf 2) | null | Alternative | |
user (anyOf 1).events_url | string | Optional | Format: uri-template |
user (anyOf 1).followers_url | string | Optional | Format: uri |
user (anyOf 1).following_url | string | Optional | Format: uri-template |
user (anyOf 1).gists_url | string | Optional | Format: uri-template |
user (anyOf 1).gravatar_id | string | Optional | |
user (anyOf 1).html_url | string | Optional | Format: uri |
user (anyOf 1).id | JSON | Required within parent | |
user (anyOf 1).id (anyOf 1) | integer | Alternative | Format: int64 |
user (anyOf 1).id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
user (anyOf 1).login | string | Required within parent | |
user (anyOf 1).name | string | Optional | |
user (anyOf 1).node_id | string | Optional | |
user (anyOf 1).organizations_url | string | Optional | Format: uri |
user (anyOf 1).received_events_url | string | Optional | Format: uri |
user (anyOf 1).repos_url | string | Optional | Format: uri |
user (anyOf 1).site_admin | boolean | Optional | |
user (anyOf 1).starred_url | string | Optional | Format: uri-template |
user (anyOf 1).subscriptions_url | string | Optional | Format: uri |
user (anyOf 1).type | string | Optional | Known values: Bot, User, Organization |
user (anyOf 1).url | string | Optional | Format: uri |
user (anyOf 1).user_view_type | string | Optional | |
user (anyOf 2) | null | Alternative |
Referenced models: Get a label — response body, List public events — response body — item payload Discussion Event discussion reactions
List public events — response body — item payload Discussion Event discussion 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 |
List public events — response body — item payload Fork Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
action | string | Required within parent | |
forkee | object | Required within parent | |
forkee.allow_forking | boolean | Optional | |
forkee.archive_url | string | Optional | |
forkee.archived | boolean | Optional | |
forkee.assignees_url | string | Optional | |
forkee.blobs_url | string | Optional | |
forkee.branches_url | string | Optional | |
forkee.clone_url | string | Optional | |
forkee.collaborators_url | string | Optional | |
forkee.comments_url | string | Optional | |
forkee.commits_url | string | Optional | |
forkee.compare_url | string | Optional | |
forkee.contents_url | string | Optional | |
forkee.contributors_url | string | Optional | |
forkee.created_at | JSON | Optional | |
forkee.created_at (anyOf 1) | string | Alternative | Format: date-time |
forkee.created_at (anyOf 2) | null | Alternative | |
forkee.default_branch | string | Optional | |
forkee.deployments_url | string | Optional | |
forkee.description | JSON | Optional | |
forkee.description (anyOf 1) | string | Alternative | |
forkee.description (anyOf 2) | null | Alternative | |
forkee.disabled | boolean | Optional | |
forkee.downloads_url | string | Optional | |
forkee.events_url | string | Optional | |
forkee.fork | boolean | Optional | |
forkee.forks | JSON | Optional | |
forkee.forks (anyOf 1) | integer | Alternative | |
forkee.forks (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
forkee.forks_count | JSON | Optional | |
forkee.forks_count (anyOf 1) | integer | Alternative | |
forkee.forks_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
forkee.forks_url | string | Optional | |
forkee.full_name | string | Optional | |
forkee.git_commits_url | string | Optional | |
forkee.git_refs_url | string | Optional | |
forkee.git_tags_url | string | Optional | |
forkee.git_url | string | Optional | |
forkee.has_discussions | boolean | Optional | |
forkee.has_downloads | boolean | Optional | |
forkee.has_issues | boolean | Optional | |
forkee.has_pages | boolean | Optional | |
forkee.has_projects | boolean | Optional | |
forkee.has_pull_requests | boolean | Optional | |
forkee.has_wiki | boolean | Optional | |
forkee.homepage | JSON | Optional | |
forkee.homepage (anyOf 1) | string | Alternative | |
forkee.homepage (anyOf 2) | null | Alternative | |
forkee.hooks_url | string | Optional | |
forkee.html_url | string | Optional | |
forkee.id | JSON | Optional | |
forkee.id (anyOf 1) | integer | Alternative | |
forkee.id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
forkee.is_template | boolean | Optional | |
forkee.issue_comment_url | string | Optional | |
forkee.issue_events_url | string | Optional | |
forkee.issues_url | string | Optional | |
forkee.keys_url | string | Optional | |
forkee.labels_url | string | Optional | |
forkee.language | JSON | Optional | |
forkee.language (anyOf 1) | string | Alternative | |
forkee.language (anyOf 2) | null | Alternative | |
forkee.languages_url | string | Optional | |
forkee.license | Model | Optional | Expand Create a fork — response body — license |
forkee.merges_url | string | Optional | |
forkee.milestones_url | string | Optional | |
forkee.mirror_url | JSON | Optional | |
forkee.mirror_url (anyOf 1) | string | Alternative | |
forkee.mirror_url (anyOf 2) | null | Alternative | |
forkee.name | string | Optional | |
forkee.node_id | string | Optional | |
forkee.notifications_url | string | Optional | |
forkee.open_issues | JSON | Optional | |
forkee.open_issues (anyOf 1) | integer | Alternative | |
forkee.open_issues (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
forkee.open_issues_count | JSON | Optional | |
forkee.open_issues_count (anyOf 1) | integer | Alternative | |
forkee.open_issues_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
forkee.owner | Model | Optional | Expand List users — response body — item |
forkee.private | boolean | Optional | |
forkee.public | boolean | Optional | |
forkee.pull_request_creation_policy | string | Optional | The policy controlling who can create pull requests: all or collaborators_only. Known values: all, collaborators_only |
forkee.pulls_url | string | Optional | |
forkee.pushed_at | JSON | Optional | |
forkee.pushed_at (anyOf 1) | string | Alternative | Format: date-time |
forkee.pushed_at (anyOf 2) | null | Alternative | |
forkee.releases_url | string | Optional | |
forkee.size | JSON | Optional | |
forkee.size (anyOf 1) | integer | Alternative | |
forkee.size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
forkee.ssh_url | string | Optional | |
forkee.stargazers_count | JSON | Optional | |
forkee.stargazers_count (anyOf 1) | integer | Alternative | |
forkee.stargazers_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
forkee.stargazers_url | string | Optional | |
forkee.statuses_url | string | Optional | |
forkee.subscribers_url | string | Optional | |
forkee.subscription_url | string | Optional | |
forkee.svn_url | string | Optional | |
forkee.tags_url | string | Optional | |
forkee.teams_url | string | Optional | |
forkee.topics | array | Optional | |
forkee.topics[] | string | Each item | |
forkee.trees_url | string | Optional | |
forkee.updated_at | JSON | Optional | |
forkee.updated_at (anyOf 1) | string | Alternative | Format: date-time |
forkee.updated_at (anyOf 2) | null | Alternative | |
forkee.url | string | Optional | |
forkee.visibility | string | Optional | |
forkee.watchers | JSON | Optional | |
forkee.watchers (anyOf 1) | integer | Alternative | |
forkee.watchers (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
forkee.watchers_count | JSON | Optional | |
forkee.watchers_count (anyOf 1) | integer | Alternative | |
forkee.watchers_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
forkee.web_commit_signoff_required | boolean | Optional |
Referenced models: Create a fork — response body — license, List users — response body — item
List public events — response body — item payload Gollum Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
pages | array | Required within parent | |
pages[] | object | Each item | |
pages[].action | string | Optional | |
pages[].html_url | string | Optional | |
pages[].page_name | JSON | Optional | |
pages[].page_name (anyOf 1) | string | Alternative | |
pages[].page_name (anyOf 2) | null | Alternative | |
pages[].sha | string | Optional | |
pages[].summary | JSON | Optional | |
pages[].summary (anyOf 1) | string | Alternative | |
pages[].summary (anyOf 2) | null | Alternative | |
pages[].title | JSON | Optional | |
pages[].title (anyOf 1) | string | Alternative | |
pages[].title (anyOf 2) | null | Alternative |
List public events — response body — item payload Issue Comment Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
action | string | Required within parent | |
comment | Model | Required within parent | Expand Get an issue comment — response body |
issue | Model | Required within parent | Expand Get an issue — response body |
Referenced models: Get an issue — response body, Get an issue comment — response body
List public events — response body — item payload Issues Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
action | string | Required within parent | |
assignee | Model | Optional | Expand List users — response body — item |
assignees | array | Optional | |
assignees[] | Model | Each item | Expand List users — response body — item |
issue | Model | Required within parent | Expand Get an issue — response body |
label | Model | Optional | Expand Get a label — response body |
labels | array | Optional | |
labels[] | Model | Each item | Expand Get a label — response body |
Referenced models: Get an issue — response body, Get a label — response body, List users — response body — item
List public events — response body — item payload Member Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
action | string | Required within parent | |
member | Model | Required within parent | Expand List users — response body — item |
Referenced models: List users — response body — item
List public events — response body — item payload Public Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root |
List public events — response body — item payload Pull Request Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
action | string | Required within parent | |
assignee | Model | Optional | Expand List users — response body — item |
assignees | array | Optional | |
assignees[] | Model | Each item | Expand List users — response body — item |
label | Model | Optional | Expand Get a label — response body |
labels | array | Optional | |
labels[] | Model | Each item | Expand Get a label — response body |
number | JSON | Required within parent | |
number (anyOf 1) | integer | Alternative | |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pull_request | Model | Required within parent | Expand Get a check run — response body — pull requests item |
Referenced models: Get a label — response body, Get a check run — response body — pull requests item, List users — response body — item
List public events — response body — item payload Pull Request Review Comment Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
action | string | Required within parent | |
comment | object | Required within parent | |
comment._links | object | Required within parent | |
comment._links.html | object | Required within parent | |
comment._links.html.href | string | Required within parent | Format: uri-template |
comment._links.pull_request | object | Required within parent | |
comment._links.pull_request.href | string | Required within parent | Format: uri-template |
comment._links.self | object | Required within parent | |
comment._links.self.href | string | Required within parent | Format: uri-template |
comment.body | string | Required within parent | |
comment.commit_id | string | Required within parent | |
comment.created_at | string | Required within parent | Format: date-time |
comment.diff_hunk | string | Required within parent | |
comment.html_url | string | Required within parent | Format: uri |
comment.id | JSON | Required within parent | |
comment.id (anyOf 1) | integer | Alternative | |
comment.id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
comment.in_reply_to_id | JSON | Optional | |
comment.in_reply_to_id (anyOf 1) | integer | Alternative | |
comment.in_reply_to_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
comment.node_id | string | Required within parent | |
comment.original_commit_id | string | Required within parent | |
comment.original_position | JSON | Required within parent | |
comment.original_position (anyOf 1) | integer | Alternative | |
comment.original_position (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
comment.path | string | Required within parent | |
comment.position | JSON | Required within parent | |
comment.position (anyOf 1) | JSON | Alternative | |
comment.position (anyOf 1) (anyOf 1) | integer | Alternative | |
comment.position (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
comment.position (anyOf 2) | null | Alternative | |
comment.pull_request_review_id | JSON | Required within parent | |
comment.pull_request_review_id (anyOf 1) | JSON | Alternative | |
comment.pull_request_review_id (anyOf 1) (anyOf 1) | integer | Alternative | |
comment.pull_request_review_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
comment.pull_request_review_id (anyOf 2) | null | Alternative | |
comment.pull_request_url | string | Required within parent | Format: uri |
comment.reactions | object | Required within parent | |
comment.reactions.+1 | JSON | Optional | |
comment.reactions.+1 (anyOf 1) | integer | Alternative | |
comment.reactions.+1 (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
comment.reactions.-1 | JSON | Optional | |
comment.reactions.-1 (anyOf 1) | integer | Alternative | |
comment.reactions.-1 (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
comment.reactions.confused | JSON | Optional | |
comment.reactions.confused (anyOf 1) | integer | Alternative | |
comment.reactions.confused (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
comment.reactions.eyes | JSON | Optional | |
comment.reactions.eyes (anyOf 1) | integer | Alternative | |
comment.reactions.eyes (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
comment.reactions.heart | JSON | Optional | |
comment.reactions.heart (anyOf 1) | integer | Alternative | |
comment.reactions.heart (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
comment.reactions.hooray | JSON | Optional | |
comment.reactions.hooray (anyOf 1) | integer | Alternative | |
comment.reactions.hooray (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
comment.reactions.laugh | JSON | Optional | |
comment.reactions.laugh (anyOf 1) | integer | Alternative | |
comment.reactions.laugh (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
comment.reactions.rocket | JSON | Optional | |
comment.reactions.rocket (anyOf 1) | integer | Alternative | |
comment.reactions.rocket (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
comment.reactions.total_count | JSON | Optional | |
comment.reactions.total_count (anyOf 1) | integer | Alternative | |
comment.reactions.total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
comment.reactions.url | string | Optional | Format: uri |
comment.subject_type | JSON | Optional | |
comment.subject_type (anyOf 1) | string | Alternative | |
comment.subject_type (anyOf 2) | null | Alternative | |
comment.updated_at | string | Required within parent | Format: date-time |
comment.url | string | Required within parent | Format: uri |
comment.user | JSON | Required within parent | |
comment.user (anyOf 1) | object | Alternative | |
comment.user (anyOf 1).avatar_url | string | Optional | Format: uri |
comment.user (anyOf 1).deleted | boolean | Optional | |
comment.user (anyOf 1).email | JSON | Optional | |
comment.user (anyOf 1).email (anyOf 1) | string | Alternative | |
comment.user (anyOf 1).email (anyOf 2) | null | Alternative | |
comment.user (anyOf 1).events_url | string | Optional | Format: uri-template |
comment.user (anyOf 1).followers_url | string | Optional | Format: uri |
comment.user (anyOf 1).following_url | string | Optional | Format: uri-template |
comment.user (anyOf 1).gists_url | string | Optional | Format: uri-template |
comment.user (anyOf 1).gravatar_id | string | Optional | |
comment.user (anyOf 1).html_url | string | Optional | Format: uri |
comment.user (anyOf 1).id | JSON | Optional | |
comment.user (anyOf 1).id (anyOf 1) | integer | Alternative | Format: int64 |
comment.user (anyOf 1).id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
comment.user (anyOf 1).login | string | Optional | |
comment.user (anyOf 1).name | string | Optional | |
comment.user (anyOf 1).node_id | string | Optional | |
comment.user (anyOf 1).organizations_url | string | Optional | Format: uri |
comment.user (anyOf 1).received_events_url | string | Optional | Format: uri |
comment.user (anyOf 1).repos_url | string | Optional | Format: uri |
comment.user (anyOf 1).site_admin | boolean | Optional | |
comment.user (anyOf 1).starred_url | string | Optional | Format: uri-template |
comment.user (anyOf 1).subscriptions_url | string | Optional | Format: uri |
comment.user (anyOf 1).type | string | Optional | Known values: Bot, User, Organization |
comment.user (anyOf 1).url | string | Optional | Format: uri |
comment.user (anyOf 1).user_view_type | string | Optional | |
comment.user (anyOf 2) | null | Alternative | |
pull_request | Model | Required within parent | Expand Get a check run — response body — pull requests item |
Referenced models: Get a check run — response body — pull requests item
List public events — response body — item payload Pull Request Review Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
action | string | Required within parent | |
pull_request | Model | Required within parent | Expand Get a check run — response body — pull requests item |
review | object | Required within parent | |
review._links | object | Optional | |
review._links.html | object | Required within parent | |
review._links.html.href | string | Required within parent | |
review._links.pull_request | object | Required within parent | |
review._links.pull_request.href | string | Required within parent | |
review.body | string | Optional | |
review.commit_id | string | Optional | |
review.html_url | string | Optional | Format: uri |
review.id | JSON | Optional | |
review.id (anyOf 1) | integer | Alternative | |
review.id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
review.node_id | string | Optional | |
review.pull_request_url | string | Optional | Format: uri |
review.state | string | Optional | |
review.submitted_at | JSON | Optional | |
review.submitted_at (anyOf 1) | string | Alternative | |
review.submitted_at (anyOf 2) | null | Alternative | |
review.updated_at | string | Optional | |
review.user | Model | Optional | Expand Get an issue — response body — user |
Referenced models: Get an issue — response body — user, Get a check run — response body — pull requests item
List public events — response body — item payload Push Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
before | string | Required within parent | |
head | string | Required within parent | |
push_id | JSON | Required within parent | |
push_id (anyOf 1) | integer | Alternative | |
push_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
ref | string | Required within parent | |
repository_id | JSON | Required within parent | |
repository_id (anyOf 1) | integer | Alternative | |
repository_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List public events — response body — item payload Release Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
action | string | Required within parent | |
release | JSON | Required within parent | |
release (allOf 1) | Model | All variants apply | Expand Get a release — response body |
release (allOf 2) | object | All variants apply | |
release (allOf 2).is_short_description_html_truncated | boolean | Optional | |
release (allOf 2).short_description_html | string | Optional |
Referenced models: Get a release — response body
List public events — response body — item payload Watch Event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
action | string | Required within parent |
List repositories starred by a user — response body — array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Starred Repository |
repo | Model | Required within parent | Expand List repositories for the authenticated user — response body — item |
starred_at | string | Required within parent | Format: date-time |
Referenced models: List repositories for the authenticated user — response body — item
List stargazers — response body — array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Stargazer |
starred_at | string | Required within parent | Format: date-time |
user | Model | Required within parent | Expand Get an issue — response body — user |
Referenced models: Get an issue — response body — user
Set a thread subscription — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Thread Subscription |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | Format: date-time |
created_at (anyOf 2) | null | Alternative | |
ignored | boolean | Required within parent | |
reason | JSON | Required within parent | |
reason (anyOf 1) | string | Alternative | |
reason (anyOf 2) | null | Alternative | |
repository_url | string | Optional | Format: uri |
subscribed | boolean | Required within parent | |
thread_url | string | Optional | Format: uri |
url | string | Required within parent | Format: uri |