Skip to main content
Manja / GitHub
Schema1.1.4object

issue-event

Issue Event

Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Issue

object

Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.

Status: nullable

active_lock_reason string
optionalnullable
assignees array
optionalnullable
author_association
string<author_association>
required

How the author is associated with the repository.

Example:OWNER

Allowed: "COLLABORATOR""CONTRIBUTOR""FIRST_TIMER""FIRST_TIME_CONTRIBUTOR""MANNEQUIN""MEMBER""NONE""OWNER"

body string
optionalnullable

Contents of the issue

Example:It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?

body_html string
optional
body_text string
optional
closed_at string (date-time)
requirednullable
comments integer
required
comments_url string (uri)
required
created_at string (date-time)
required
draft boolean
optional
events_url string (uri)
required
html_url string (uri)
required
id integer
required
labels array
required

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

Example:[ "bug", "registration" ]

labels_url string
required
locked boolean
required
milestone Milestone object
requirednullable

A collection of related issues and pull requests.

node_id string
required
number integer
required

Number uniquely identifying the issue within its repository

Example:42

performed_via_github_app GitHub app object
optionalnullable

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.

pull_request object
optional
repository Repository object
optional

A git repository

repository_url string (uri)
required
state string
required

State of the issue; either 'open' or 'closed'

Example:open

timeline_url string (uri)
optional
title string
required

Title of the issue

Example:Widget creation fails in Safari on OS X 10.8

updated_at string (date-time)
required
url string (uri)
required

URL for the issue

Example:https://api.github.com/repositories/42/issues/1