{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/github/main/json-schema/github-timeline-issue-events-schema.json", "title": "Timeline Event", "description": "Timeline Event", "x-generated": "2026-10-03", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/github-issues-api-openapi.yml#/components/schemas/timeline-issue-events", "type": "object", "anyOf": [ { "$ref": "#/$defs/labeled-issue-event" }, { "$ref": "#/$defs/unlabeled-issue-event" }, { "$ref": "#/$defs/milestoned-issue-event" }, { "$ref": "#/$defs/demilestoned-issue-event" }, { "$ref": "#/$defs/renamed-issue-event" }, { "$ref": "#/$defs/review-requested-issue-event" }, { "$ref": "#/$defs/review-request-removed-issue-event" }, { "$ref": "#/$defs/review-dismissed-issue-event" }, { "$ref": "#/$defs/locked-issue-event" }, { "$ref": "#/$defs/added-to-project-issue-event" }, { "$ref": "#/$defs/moved-column-in-project-issue-event" }, { "$ref": "#/$defs/removed-from-project-issue-event" }, { "$ref": "#/$defs/converted-note-to-issue-issue-event" }, { "$ref": "#/$defs/timeline-comment-event" }, { "$ref": "#/$defs/timeline-cross-referenced-event" }, { "$ref": "#/$defs/timeline-committed-event" }, { "$ref": "#/$defs/timeline-reviewed-event" }, { "$ref": "#/$defs/timeline-line-commented-event" }, { "$ref": "#/$defs/timeline-commit-commented-event" }, { "$ref": "#/$defs/timeline-assigned-issue-event" }, { "$ref": "#/$defs/timeline-unassigned-issue-event" }, { "$ref": "#/$defs/state-change-issue-event" } ], "$defs": { "added-to-project-issue-event": { "title": "Added to Project Issue Event", "description": "Added to Project Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "$ref": "#/$defs/simple-user" }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "$ref": "#/$defs/nullable-integration" }, "project_card": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string", "format": "uri" }, "project_id": { "type": "integer" }, "project_url": { "type": "string", "format": "uri" }, "column_name": { "type": "string" }, "previous_column_name": { "type": "string" } }, "required": [ "id", "url", "project_id", "project_url", "column_name" ] } }, "required": [ "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, "author-association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, "commit-comment": { "title": "Commit Comment", "description": "Commit Comment", "type": "object", "properties": { "html_url": { "type": "string", "format": "uri" }, "url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "body": { "type": "string" }, "path": { "type": [ "string", "null" ] }, "position": { "type": [ "integer", "null" ] }, "line": { "type": [ "integer", "null" ] }, "commit_id": { "type": "string" }, "user": { "$ref": "#/$defs/nullable-simple-user" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "author_association": { "$ref": "#/$defs/author-association" }, "reactions": { "$ref": "#/$defs/reaction-rollup" } }, "required": [ "url", "html_url", "id", "node_id", "user", "position", "line", "path", "commit_id", "body", "author_association", "created_at", "updated_at" ] }, "converted-note-to-issue-issue-event": { "title": "Converted Note to Issue Issue Event", "description": "Converted Note to Issue Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "$ref": "#/$defs/simple-user" }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "$ref": "#/$defs/integration" }, "project_card": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string", "format": "uri" }, "project_id": { "type": "integer" }, "project_url": { "type": "string", "format": "uri" }, "column_name": { "type": "string" }, "previous_column_name": { "type": "string" } }, "required": [ "id", "url", "project_id", "project_url", "column_name" ] } }, "required": [ "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, "demilestoned-issue-event": { "title": "Demilestoned Issue Event", "description": "Demilestoned Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "$ref": "#/$defs/simple-user" }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "$ref": "#/$defs/nullable-integration" }, "milestone": { "type": "object", "properties": { "title": { "type": "string" } }, "required": [ "title" ] } }, "required": [ "milestone", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, "integration": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer" }, "slug": { "description": "The slug name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "$ref": "#/$defs/nullable-simple-user" }, "name": { "description": "The name of the GitHub app", "type": "string" }, "description": { "type": [ "string", "null" ] }, "external_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" } }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "webhook_secret": { "type": [ "string", "null" ] }, "pem": { "type": "string" } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri" }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer" }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string" }, "state_reason": { "description": "The reason for the current state", "type": [ "string", "null" ], "enum": [ "completed", "reopened", "not_planned" ] }, "title": { "description": "Title of the issue", "type": "string" }, "body": { "description": "Contents of the issue", "type": [ "string", "null" ] }, "user": { "$ref": "#/$defs/nullable-simple-user" }, "labels": { "description": "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", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] }, "default": { "type": "boolean" } } } ] } }, "assignee": { "$ref": "#/$defs/nullable-simple-user" }, "assignees": { "type": [ "array", "null" ], "items": { "$ref": "#/$defs/simple-user" } }, "milestone": { "$ref": "#/$defs/nullable-milestone" }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": [ "string", "null" ] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": [ "string", "null" ], "format": "date-time" }, "diff_url": { "type": [ "string", "null" ], "format": "uri" }, "html_url": { "type": [ "string", "null" ], "format": "uri" }, "patch_url": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": [ "string", "null" ], "format": "uri" } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "$ref": "#/$defs/nullable-simple-user" }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "repository": { "$ref": "#/$defs/repository" }, "performed_via_github_app": { "$ref": "#/$defs/nullable-integration" }, "author_association": { "$ref": "#/$defs/author-association" }, "reactions": { "$ref": "#/$defs/reaction-rollup" } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "author_association", "created_at", "updated_at" ] }, "labeled-issue-event": { "title": "Labeled Issue Event", "description": "Labeled Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "$ref": "#/$defs/simple-user" }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "$ref": "#/$defs/nullable-integration" }, "label": { "type": "object", "properties": { "name": { "type": "string" }, "color": { "type": "string" } }, "required": [ "name", "color" ] } }, "required": [ "label", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, "locked-issue-event": { "title": "Locked Issue Event", "description": "Locked Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "$ref": "#/$defs/simple-user" }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "$ref": "#/$defs/nullable-integration" }, "lock_reason": { "type": [ "string", "null" ] } }, "required": [ "lock_reason", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, "milestoned-issue-event": { "title": "Milestoned Issue Event", "description": "Milestoned Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "$ref": "#/$defs/simple-user" }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "$ref": "#/$defs/nullable-integration" }, "milestone": { "type": "object", "properties": { "title": { "type": "string" } }, "required": [ "title" ] } }, "required": [ "milestone", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, "moved-column-in-project-issue-event": { "title": "Moved Column in Project Issue Event", "description": "Moved Column in Project Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "$ref": "#/$defs/simple-user" }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "$ref": "#/$defs/nullable-integration" }, "project_card": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string", "format": "uri" }, "project_id": { "type": "integer" }, "project_url": { "type": "string", "format": "uri" }, "column_name": { "type": "string" }, "previous_column_name": { "type": "string" } }, "required": [ "id", "url", "project_id", "project_url", "column_name" ] } }, "required": [ "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, "nullable-integration": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": [ "object", "null" ], "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer" }, "slug": { "description": "The slug name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "$ref": "#/$defs/nullable-simple-user" }, "name": { "description": "The name of the GitHub app", "type": "string" }, "description": { "type": [ "string", "null" ] }, "external_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" } }, "events": { "description": "The list of events for the GitHub app", "type": "array", "items": { "type": "string" } }, "installations_count": { "description": "The number of installations associated with the GitHub app", "type": "integer" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "webhook_secret": { "type": [ "string", "null" ] }, "pem": { "type": "string" } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] }, "nullable-license-simple": { "title": "License Simple", "description": "License Simple", "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "url": { "type": [ "string", "null" ], "format": "uri" }, "spdx_id": { "type": [ "string", "null" ] }, "node_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] }, "nullable-milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": [ "object", "null" ], "properties": { "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "number": { "description": "The number of the milestone.", "type": "integer" }, "state": { "description": "The state of the milestone.", "type": "string", "enum": [ "open", "closed" ], "default": "open" }, "title": { "description": "The title of the milestone.", "type": "string" }, "description": { "type": [ "string", "null" ] }, "creator": { "$ref": "#/$defs/nullable-simple-user" }, "open_issues": { "type": "integer" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "due_on": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] }, "nullable-simple-user": { "title": "Simple User", "description": "A GitHub user.", "type": [ "object", "null" ], "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string", "format": "uri" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "organizations_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "nullable-team-simple": { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": [ "object", "null" ], "properties": { "id": { "description": "Unique identifier of the team", "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the team", "type": "string", "format": "uri" }, "members_url": { "type": "string" }, "name": { "description": "Name of the team", "type": "string" }, "description": { "description": "Description of the team", "type": [ "string", "null" ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string" }, "privacy": { "description": "The level of privacy this team should have", "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "repositories_url": { "type": "string", "format": "uri" }, "slug": { "type": "string" }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string" } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug" ] }, "pull-request-review-comment": { "title": "Pull Request Review Comment", "description": "Pull Request Review Comments are comments on a portion of the Pull Request's diff.", "type": "object", "properties": { "url": { "description": "URL for the pull request review comment", "type": "string" }, "pull_request_review_id": { "description": "The ID of the pull request review to which the comment belongs.", "type": [ "integer", "null" ] }, "id": { "description": "The ID of the pull request review comment.", "type": "integer" }, "node_id": { "description": "The node ID of the pull request review comment.", "type": "string" }, "diff_hunk": { "description": "The diff of the line that the comment refers to.", "type": "string" }, "path": { "description": "The relative path of the file to which the comment applies.", "type": "string" }, "position": { "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer" }, "original_position": { "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer" }, "commit_id": { "description": "The SHA of the commit to which the comment applies.", "type": "string" }, "original_commit_id": { "description": "The SHA of the original commit to which the comment applies.", "type": "string" }, "in_reply_to_id": { "description": "The comment ID to reply to.", "type": "integer" }, "user": { "$ref": "#/$defs/simple-user" }, "body": { "description": "The text of the comment.", "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "html_url": { "description": "HTML URL for the pull request review comment.", "type": "string", "format": "uri" }, "pull_request_url": { "description": "URL for the pull request that the review comment belongs to.", "type": "string", "format": "uri" }, "author_association": { "$ref": "#/$defs/author-association" }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string", "format": "uri" } }, "required": [ "href" ] }, "html": { "type": "object", "properties": { "href": { "type": "string", "format": "uri" } }, "required": [ "href" ] }, "pull_request": { "type": "object", "properties": { "href": { "type": "string", "format": "uri" } }, "required": [ "href" ] } }, "required": [ "self", "html", "pull_request" ] }, "start_line": { "type": [ "integer", "null" ], "description": "The first line of the range for a multi-line comment." }, "original_start_line": { "type": [ "integer", "null" ], "description": "The first line of the range for a multi-line comment." }, "start_side": { "type": [ "string", "null" ], "description": "The side of the first line of the range for a multi-line comment.", "enum": [ "LEFT", "RIGHT" ], "default": "RIGHT" }, "line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", "type": "integer" }, "original_line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", "type": "integer" }, "side": { "description": "The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment", "enum": [ "LEFT", "RIGHT" ], "default": "RIGHT", "type": "string" }, "subject_type": { "description": "The level at which the comment is targeted, can be a diff line or a file.", "type": "string", "enum": [ "line", "file" ] }, "reactions": { "$ref": "#/$defs/reaction-rollup" }, "body_html": { "type": "string" }, "body_text": { "type": "string" } }, "required": [ "url", "id", "node_id", "pull_request_review_id", "diff_hunk", "path", "commit_id", "original_commit_id", "user", "body", "created_at", "updated_at", "html_url", "pull_request_url", "author_association", "_links" ] }, "reaction-rollup": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] }, "removed-from-project-issue-event": { "title": "Removed from Project Issue Event", "description": "Removed from Project Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "$ref": "#/$defs/simple-user" }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "$ref": "#/$defs/nullable-integration" }, "project_card": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string", "format": "uri" }, "project_id": { "type": "integer" }, "project_url": { "type": "string", "format": "uri" }, "column_name": { "type": "string" }, "previous_column_name": { "type": "string" } }, "required": [ "id", "url", "project_id", "project_url", "column_name" ] } }, "required": [ "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, "renamed-issue-event": { "title": "Renamed Issue Event", "description": "Renamed Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "$ref": "#/$defs/simple-user" }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "$ref": "#/$defs/nullable-integration" }, "rename": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "from", "to" ] } }, "required": [ "rename", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, "repository": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer" }, "node_id": { "type": "string" }, "name": { "description": "The name of the repository.", "type": "string" }, "full_name": { "type": "string" }, "license": { "$ref": "#/$defs/nullable-license-simple" }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "$ref": "#/$defs/simple-user" }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri" }, "description": { "type": [ "string", "null" ] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri" }, "archive_url": { "type": "string" }, "assignees_url": { "type": "string" }, "blobs_url": { "type": "string" }, "branches_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "comments_url": { "type": "string" }, "commits_url": { "type": "string" }, "compare_url": { "type": "string" }, "contents_url": { "type": "string" }, "contributors_url": { "type": "string", "format": "uri" }, "deployments_url": { "type": "string", "format": "uri" }, "downloads_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "forks_url": { "type": "string", "format": "uri" }, "git_commits_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "issues_url": { "type": "string" }, "keys_url": { "type": "string" }, "labels_url": { "type": "string" }, "languages_url": { "type": "string", "format": "uri" }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "pulls_url": { "type": "string" }, "releases_url": { "type": "string" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri" }, "statuses_url": { "type": "string" }, "subscribers_url": { "type": "string", "format": "uri" }, "subscription_url": { "type": "string", "format": "uri" }, "tags_url": { "type": "string", "format": "uri" }, "teams_url": { "type": "string", "format": "uri" }, "trees_url": { "type": "string" }, "clone_url": { "type": "string" }, "mirror_url": { "type": [ "string", "null" ], "format": "uri" }, "hooks_url": { "type": "string", "format": "uri" }, "svn_url": { "type": "string", "format": "uri" }, "homepage": { "type": [ "string", "null" ], "format": "uri" }, "language": { "type": [ "string", "null" ] }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer" }, "default_branch": { "description": "The default branch of the repository.", "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean" }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean" }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "deprecated": true }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "type": "boolean" }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean" }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean" }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean" }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean" }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean" }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean" }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string" }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "review-dismissed-issue-event": { "title": "Review Dismissed Issue Event", "description": "Review Dismissed Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "$ref": "#/$defs/simple-user" }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "$ref": "#/$defs/nullable-integration" }, "dismissed_review": { "type": "object", "properties": { "state": { "type": "string" }, "review_id": { "type": "integer" }, "dismissal_message": { "type": [ "string", "null" ] }, "dismissal_commit_id": { "type": "string" } }, "required": [ "state", "review_id", "dismissal_message" ] } }, "required": [ "dismissed_review", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, "review-request-removed-issue-event": { "title": "Review Request Removed Issue Event", "description": "Review Request Removed Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "$ref": "#/$defs/simple-user" }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "$ref": "#/$defs/nullable-integration" }, "review_requester": { "$ref": "#/$defs/simple-user" }, "requested_team": { "$ref": "#/$defs/team" }, "requested_reviewer": { "$ref": "#/$defs/simple-user" } }, "required": [ "review_requester", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, "review-requested-issue-event": { "title": "Review Requested Issue Event", "description": "Review Requested Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "$ref": "#/$defs/simple-user" }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "$ref": "#/$defs/nullable-integration" }, "review_requester": { "$ref": "#/$defs/simple-user" }, "requested_team": { "$ref": "#/$defs/team" }, "requested_reviewer": { "$ref": "#/$defs/simple-user" } }, "required": [ "review_requester", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, "simple-user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string", "format": "uri" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "organizations_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "state-change-issue-event": { "title": "State Change Issue Event", "description": "State Change Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "$ref": "#/$defs/simple-user" }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "$ref": "#/$defs/nullable-integration" }, "state_reason": { "type": [ "string", "null" ] } }, "required": [ "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] }, "team": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "privacy": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "parent": { "$ref": "#/$defs/nullable-team-simple" } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent" ] }, "timeline-assigned-issue-event": { "title": "Timeline Assigned Issue Event", "description": "Timeline Assigned Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "$ref": "#/$defs/simple-user" }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "$ref": "#/$defs/nullable-integration" }, "assignee": { "$ref": "#/$defs/simple-user" } }, "required": [ "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app", "assignee" ] }, "timeline-comment-event": { "title": "Timeline Comment Event", "description": "Timeline Comment Event", "type": "object", "properties": { "event": { "type": "string" }, "actor": { "$ref": "#/$defs/simple-user" }, "id": { "description": "Unique identifier of the issue comment", "type": "integer" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue comment", "type": "string", "format": "uri" }, "body": { "description": "Contents of the issue comment", "type": "string" }, "body_text": { "type": "string" }, "body_html": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "user": { "$ref": "#/$defs/simple-user" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "issue_url": { "type": "string", "format": "uri" }, "author_association": { "$ref": "#/$defs/author-association" }, "performed_via_github_app": { "$ref": "#/$defs/nullable-integration" }, "reactions": { "$ref": "#/$defs/reaction-rollup" } }, "required": [ "event", "actor", "id", "node_id", "html_url", "issue_url", "author_association", "user", "url", "created_at", "updated_at" ] }, "timeline-commit-commented-event": { "title": "Timeline Commit Commented Event", "description": "Timeline Commit Commented Event", "type": "object", "properties": { "event": { "type": "string" }, "node_id": { "type": "string" }, "commit_id": { "type": "string" }, "comments": { "type": "array", "items": { "$ref": "#/$defs/commit-comment" } } } }, "timeline-committed-event": { "title": "Timeline Committed Event", "description": "Timeline Committed Event", "type": "object", "properties": { "event": { "type": "string" }, "sha": { "description": "SHA for the commit", "type": "string" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "author": { "description": "Identifying information for the git-user", "type": "object", "properties": { "date": { "description": "Timestamp of the commit", "format": "date-time", "type": "string" }, "email": { "type": "string", "description": "Git email address of the user" }, "name": { "description": "Name of the git user", "type": "string" } }, "required": [ "email", "name", "date" ] }, "committer": { "description": "Identifying information for the git-user", "type": "object", "properties": { "date": { "description": "Timestamp of the commit", "format": "date-time", "type": "string" }, "email": { "type": "string", "description": "Git email address of the user" }, "name": { "description": "Name of the git user", "type": "string" } }, "required": [ "email", "name", "date" ] }, "message": { "description": "Message describing the purpose of the commit", "type": "string" }, "tree": { "type": "object", "properties": { "sha": { "description": "SHA for the commit", "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "sha", "url" ] }, "parents": { "type": "array", "items": { "type": "object", "properties": { "sha": { "description": "SHA for the commit", "type": "string" }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "sha", "url", "html_url" ] } }, "verification": { "type": "object", "properties": { "verified": { "type": "boolean" }, "reason": { "type": "string" }, "signature": { "type": [ "string", "null" ] }, "payload": { "type": [ "string", "null" ] } }, "required": [ "verified", "reason", "signature", "payload" ] }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "sha", "node_id", "url", "html_url", "author", "committer", "tree", "message", "parents", "verification" ] }, "timeline-cross-referenced-event": { "title": "Timeline Cross Referenced Event", "description": "Timeline Cross Referenced Event", "type": "object", "properties": { "event": { "type": "string" }, "actor": { "$ref": "#/$defs/simple-user" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "source": { "type": "object", "properties": { "type": { "type": "string" }, "issue": { "$ref": "#/$defs/issue" } } } }, "required": [ "event", "created_at", "updated_at", "source" ] }, "timeline-line-commented-event": { "title": "Timeline Line Commented Event", "description": "Timeline Line Commented Event", "type": "object", "properties": { "event": { "type": "string" }, "node_id": { "type": "string" }, "comments": { "type": "array", "items": { "$ref": "#/$defs/pull-request-review-comment" } } } }, "timeline-reviewed-event": { "title": "Timeline Reviewed Event", "description": "Timeline Reviewed Event", "type": "object", "properties": { "event": { "type": "string" }, "id": { "description": "Unique identifier of the review", "type": "integer" }, "node_id": { "type": "string" }, "user": { "$ref": "#/$defs/simple-user" }, "body": { "description": "The text of the review.", "type": [ "string", "null" ] }, "state": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "pull_request_url": { "type": "string", "format": "uri" }, "_links": { "type": "object", "properties": { "html": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "pull_request": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] } }, "required": [ "html", "pull_request" ] }, "submitted_at": { "type": "string", "format": "date-time" }, "commit_id": { "description": "A commit SHA for the review.", "type": "string" }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "author_association": { "$ref": "#/$defs/author-association" } }, "required": [ "event", "id", "node_id", "user", "body", "state", "commit_id", "html_url", "pull_request_url", "_links", "author_association" ] }, "timeline-unassigned-issue-event": { "title": "Timeline Unassigned Issue Event", "description": "Timeline Unassigned Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "$ref": "#/$defs/simple-user" }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "$ref": "#/$defs/nullable-integration" }, "assignee": { "$ref": "#/$defs/simple-user" } }, "required": [ "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app", "assignee" ] }, "unlabeled-issue-event": { "title": "Unlabeled Issue Event", "description": "Unlabeled Issue Event", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "actor": { "$ref": "#/$defs/simple-user" }, "event": { "type": "string" }, "commit_id": { "type": [ "string", "null" ] }, "commit_url": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "performed_via_github_app": { "$ref": "#/$defs/nullable-integration" }, "label": { "type": "object", "properties": { "name": { "type": "string" }, "color": { "type": "string" } }, "required": [ "name", "color" ] } }, "required": [ "label", "id", "node_id", "url", "actor", "event", "commit_id", "commit_url", "created_at", "performed_via_github_app" ] } } }