APIs.io Engineering Platform · Schema
Issue
The [issue](https://docs.github.com/[email protected]/rest/issues/issues#get-an-issue) itself.
APIs.ioEngineeringPlatform
Properties
| Name | Type | Description |
|---|---|---|
| active_lock_reason | string | |
| assignee | object | |
| assignees | array | |
| author_association | string | How the author is associated with the repository. |
| body | string | Contents of the issue |
| closed_at | string | |
| comments | integer | |
| comments_url | string | |
| created_at | string | |
| draft | boolean | |
| events_url | string | |
| html_url | string | |
| id | integer | |
| labels | array | |
| labels_url | string | |
| locked | boolean | |
| milestone | object | A collection of related issues and pull requests. |
| node_id | string | |
| number | integer | |
| performed_via_github_app | object | 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 |
| pull_request | object | |
| reactions | object | |
| repository_url | string | |
| state | string | State of the issue; either 'open' or 'closed' |
| state_reason | string | |
| timeline_url | string | |
| title | string | Title of the issue |
| updated_at | string | |
| url | string | URL for the issue |
| user | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/webhooks_issue_2",
"title": "Issue",
"description": "The [issue](https://docs.github.com/[email protected]/rest/issues/issues#get-an-issue) itself.",
"type": "object",
"properties": {
"active_lock_reason": {
"type": "string",
"nullable": true,
"enum": [
"resolved",
"off-topic",
"too heated",
"spam",
null
]
},
"assignee": {
"title": "User",
"type": "object",
"nullable": true,
"properties": {
"avatar_url": {
"type": "string",
"format": "uri"
},
"deleted": {
"type": "boolean"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"format": "uri-template"
},
"followers_url": {
"type": "string",
"format": "uri"
},
"following_url": {
"type": "string",
"format": "uri-template"
},
"gists_url": {
"type": "string",
"format": "uri-template"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string",
"format": "uri"
},
"received_events_url": {
"type": "string",
"format": "uri"
},
"repos_url": {
"type": "string",
"format": "uri"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string",
"format": "uri-template"
},
"subscriptions_url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string",
"enum": [
"Bot",
"User",
"Organization"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"login",
"id"
]
},
"assignees": {
"type": "array",
"items": {
"title": "User",
"type": "object",
"nullable": true,
"properties": {
"avatar_url": {
"type": "string",
"format": "uri"
},
"deleted": {
"type": "boolean"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"format": "uri-template"
},
"followers_url": {
"type": "string",
"format": "uri"
},
"following_url": {
"type": "string",
"format": "uri-template"
},
"gists_url": {
"type": "string",
"format": "uri-template"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string",
"format": "uri"
},
"received_events_url": {
"type": "string",
"format": "uri"
},
"repos_url": {
"type": "string",
"format": "uri"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string",
"format": "uri-template"
},
"subscriptions_url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string",
"enum": [
"Bot",
"User",
"Organization"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"login",
"id"
]
}
},
"author_association": {
"title": "AuthorAssociation",
"description": "How the author is associated with the repository.",
"type": "string",
"enum": [
"COLLABORATOR",
"CONTRIBUTOR",
"FIRST_TIMER",
"FIRST_TIME_CONTRIBUTOR",
"MANNEQUIN",
"MEMBER",
"NONE",
"OWNER"
]
},
"body": {
"description": "Contents of the issue",
"type": "string",
"nullable": true
},
"closed_at": {
"type": "string",
"nullable": true,
"format": "date-time"
},
"comments": {
"type": "integer"
},
"comments_url": {
"type": "string",
"format": "uri"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"draft": {
"type": "boolean"
},
"events_url": {
"type": "string",
"format": "uri"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer",
"format": "int64"
},
"labels": {
"type": "array",
"items": {
"title": "Label",
"type": "object",
"properties": {
"color": {
"description": "6-character hex code, without the leading #, identifying the color",
"type": "string"
},
"default": {
"type": "boolean"
},
"description": {
"type": "string",
"nullable": true
},
"id": {
"type": "integer"
},
"name": {
"description": "The name of the label.",
"type": "string"
},
"node_id": {
"type": "string"
},
"url": {
"description": "URL for the label",
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"node_id",
"url",
"name",
"color",
"default",
"description"
]
}
},
"labels_url": {
"type": "string",
"format": "uri-template"
},
"locked": {
"type": "boolean"
},
"milestone": {
"title": "Milestone",
"description": "A collection of related issues and pull requests.",
"type": "object",
"nullable": true,
"properties": {
"closed_at": {
"type": "string",
"nullable": true,
"format": "date-time"
},
"closed_issues": {
"type": "integer"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"creator": {
"title": "User",
"type": "object",
"nullable": true,
"properties": {
"avatar_url": {
"type": "string",
"format": "uri"
},
"deleted": {
"type": "boolean"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"format": "uri-template"
},
"followers_url": {
"type": "string",
"format": "uri"
},
"following_url": {
"type": "string",
"format": "uri-template"
},
"gists_url": {
"type": "string",
"format": "uri-template"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string",
"format": "uri"
},
"received_events_url": {
"type": "string",
"format": "uri"
},
"repos_url": {
"type": "string",
"format": "uri"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string",
"format": "uri-template"
},
"subscriptions_url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string",
"enum": [
"Bot",
"User",
"Organization"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"login",
"id"
]
},
"description": {
"type": "string",
"nullable": true
},
"due_on": {
"type": "string",
"nullable": true,
"format": "date-time"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer"
},
"labels_url": {
"type": "string",
"format": "uri"
},
"node_id": {
"type": "string"
},
"number": {
"description": "The number of the milestone.",
"type": "integer"
},
"open_issues": {
"type": "integer"
},
"state": {
"description": "The state of the milestone.",
"type": "string",
"enum": [
"open",
"closed"
]
},
"title": {
"description": "The title of the milestone.",
"type": "string"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"url",
"html_url",
"labels_url",
"id",
"node_id",
"number",
"title",
"description",
"creator",
"open_issues",
"closed_issues",
"state",
"created_at",
"updated_at",
"due_on",
"closed_at"
]
},
"node_id": {
"type": "string"
},
"number": {
"type": "integer"
},
"performed_via_github_app": {
"title": "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",
"nullable": true,
"properties": {
"created_at": {
"type": "string",
"nullable": true,
"format": "date-time"
},
"description": {
"type": "string",
"nullable": true
},
"events": {
"description": "The list of events for the GitHub app",
"type": "array",
"items": {
"type": "string",
"enum": [
"branch_protection_rule",
"check_run",
"check_suite",
"code_scanning_alert",
"commit_comment",
"content_reference",
"create",
"delete",
"deployment",
"deployment_review",
"deployment_status",
"deploy_key",
"discussion",
"discussion_comment",
"fork",
"gollum",
"issues",
"issue_comment",
"label",
"member",
"membership",
"milestone",
"organization",
"org_block",
"page_build",
"project",
"project_card",
"project_column",
"public",
"pull_request",
"pull_request_review",
"pull_request_review_comment",
"push",
"registry_package",
"release",
"repository",
"repository_dispatch",
"secret_scanning_alert",
"star",
"status",
"team",
"team_add",
"watch",
"workflow_dispatch",
"workflow_run"
]
}
},
"external_url": {
"type": "string",
"nullable": true,
"format": "uri"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"description": "Unique identifier of the GitHub app",
"type": "integer",
"nullable": true
},
"name": {
"description": "The name of the GitHub app",
"type": "string"
},
"node_id": {
"type": "string"
},
"owner": {
"title": "User",
"type": "object",
"nullable": true,
"properties": {
"avatar_url": {
"type": "string",
"format": "uri"
},
"deleted": {
"type": "boolean"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"format": "uri-template"
},
"followers_url": {
"type": "string",
"format": "uri"
},
"following_url": {
"type": "string",
"format": "uri-template"
},
"gists_url": {
"type": "string",
"format": "uri-template"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string",
"format": "uri"
},
"received_events_url": {
"type": "string",
"format": "uri"
},
"repos_url": {
"type": "string",
"format": "uri"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string",
"format": "uri-template"
},
"subscriptions_url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string",
"enum": [
"Bot",
"User",
"Organization"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"login",
"id"
]
},
"permissions": {
"description": "The set of permissions for the GitHub app",
"type": "object",
"properties": {
"actions": {
"type": "string",
"enum": [
"read",
"write"
]
},
"administration": {
"type": "string",
"enum": [
"read",
"write"
]
},
"checks": {
"type": "string",
"enum": [
"read",
"write"
]
},
"content_references": {
"type": "string",
"enum": [
"read",
"write"
]
},
"contents": {
"type": "string",
"enum": [
"read",
"write"
]
},
"deployments": {
"type": "string",
"enum": [
"read",
"write"
]
},
"discussions": {
"type": "string",
"enum": [
"read",
"write"
]
},
"emails": {
"type": "string",
"enum": [
"read",
"write"
]
},
"environments": {
"type": "string",
"enum": [
"read",
"write"
]
},
"issues": {
"type": "string",
"enum": [
"read",
"write"
]
},
"keys": {
"type": "string",
"enum": [
"read",
"write"
]
},
"members": {
"type": "string",
"enum": [
"read",
"write"
]
},
"metadata": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_administration": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_hooks": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_packages": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_plan": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_projects": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_secrets": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_self_hosted_runners": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_user_blocking": {
"type": "string",
"enum": [
"read",
"write"
]
},
"packages": {
"type": "string",
"enum": [
"read",
"write"
]
},
"pages": {
"type": "string",
"enum": [
"read",
"write"
]
},
"pull_requests": {
"type": "string",
"enum": [
"read",
"write"
]
},
"repository_hooks": {
"type": "string",
"enum": [
"read",
"write"
]
},
"repository_projects": {
"type": "string",
"enum": [
"read",
"write"
]
},
"secret_scanning_alerts": {
"type": "string",
"enum": [
"read",
"write"
]
},
"secrets": {
"type": "string",
"enum": [
"read",
"write"
]
},
"security_events": {
"type": "string",
"enum": [
"read",
"write"
]
},
"security_scanning_alert": {
"type": "string",
"enum": [
"read",
"write"
]
},
"single_file": {
"type": "string",
"enum": [
"read",
"write"
]
},
"statuses": {
"type": "string",
"enum": [
"read",
"write"
]
},
"team_discussions": {
"type": "string",
"enum": [
"read",
"write"
]
},
"vulnerability_alerts": {
"type": "string",
"enum": [
"read",
"write"
]
},
"workflows": {
"type": "string",
"enum": [
"read",
"write"
]
}
}
},
"slug": {
"description": "The slug name of the GitHub app",
"type": "string"
},
"updated_at": {
"type": "string",
"nullable": true,
"format": "date-time"
}
},
"required": [
"id",
"node_id",
"owner",
"name",
"description",
"external_url",
"html_url",
"created_at",
"updated_at"
]
},
"pull_request": {
"type": "object",
"properties": {
"diff_url": {
"type": "string",
"format": "uri"
},
"html_url": {
"type": "string",
"format": "uri"
},
"merged_at": {
"type": "string",
"nullable": true,
"format": "date-time"
},
"patch_url": {
"type": "string",
"format": "uri"
},
"url": {
"type": "string",
"format": "uri"
}
}
},
"reactions": {
"title": "Reactions",
"type": "object",
"properties": {
"+1": {
"type": "integer"
},
"-1": {
"type": "integer"
},
"confused": {
"type": "integer"
},
"eyes": {
"type": "integer"
},
"heart": {
"type": "integer"
},
"hooray": {
"type": "integer"
},
"laugh": {
"type": "integer"
},
"rocket": {
"type": "integer"
},
"total_count": {
"type": "integer"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"url",
"total_count",
"+1",
"-1",
"laugh",
"confused",
"heart",
"hooray",
"eyes",
"rocket"
]
},
"repository_url": {
"type": "string",
"format": "uri"
},
"state": {
"description": "State of the issue; either 'open' or 'closed'",
"type": "string",
"enum": [
"open",
"closed"
]
},
"state_reason": {
"type": "string",
"nullable": true
},
"timeline_url": {
"type": "string",
"format": "uri"
},
"title": {
"description": "Title of the issue",
"type": "string"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"url": {
"description": "URL for the issue",
"type": "string",
"format": "uri"
},
"user": {
"title": "User",
"type": "object",
"nullable": true,
"properties": {
"avatar_url": {
"type": "string",
"format": "uri"
},
"deleted": {
"type": "boolean"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"format": "uri-template"
},
"followers_url": {
"type": "string",
"format": "uri"
},
"following_url": {
"type": "string",
"format": "uri-template"
},
"gists_url": {
"type": "string",
"format": "uri-template"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer",
"format": "int64"
},
"login": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string",
"format": "uri"
},
"received_events_url": {
"type": "string",
"format": "uri"
},
"repos_url": {
"type": "string",
"format": "uri"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string",
"format": "uri-template"
},
"subscriptions_url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string",
"enum": [
"Bot",
"User",
"Organization"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"login",
"id"
]
}
},
"required": [
"url",
"repository_url",
"labels_url",
"comments_url",
"events_url",
"html_url",
"id",
"node_id",
"number",
"title",
"user",
"assignees",
"milestone",
"comments",
"created_at",
"updated_at",
"closed_at",
"author_association",
"active_lock_reason",
"body",
"reactions"
]
}