Skip to content
This repository was archived by the owner on Nov 1, 2017. It is now read-only.

Sync changes from upstream repository #949

Merged
merged 1 commit into from
Jan 7, 2016
Merged

Sync changes from upstream repository #949

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
127 changes: 65 additions & 62 deletions content/v3/issues/events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,96 +12,100 @@ determine who should be notified of comments.

### Attributes

id
: The Integer ID of the event.
<dl>
<dt>id</dt>
<dd>The Integer ID of the event.</dd>

url
: The API URL for fetching the event.
<dt>url</dt>
<dd>The API URL for fetching the event.</dd>

actor
: Always the User that generated the event.
<dt>actor</dt>
<dd>Always the User that generated the event.</dd>

commit_id
: The String SHA of a commit that referenced this Issue
<dt>commit_id</dt>
<dd>The String SHA of a commit that referenced this Issue</dd>

event
: Identifies the actual type of Event that occurred.
<dt>event</dt>
<dd>Identifies the actual type of Event that occurred.</dd>

created_at
: The timestamp indicating when the event occurred.
<dt>created_at</dt>
<dd>The timestamp indicating when the event occurred.</dd>

label
: The Label object including 'name' and 'color' attributes. Only provided for 'labeled'
and 'unlabeled' events.
<dt>label</dt>
<dd>The Label object including 'name' and 'color' attributes. Only provided for 'labeled'
and 'unlabeled' events.</dd>

assignee
: The User object which was assigned to (or unassigned from) this Issue. Only provided for 'assigned'
and 'unassigned' events.
<dt>assignee</dt>
<dd>The User object which was assigned to (or unassigned from) this Issue. Only provided for 'assigned' and 'unassigned' events.</dd>

milestone
: The Milestone object including a 'title' attribute. Only provided for 'milestoned' and
'demilestoned' events.
<dt>milestone</dt>
<dd>The Milestone object including a 'title' attribute. Only provided for 'milestoned' and
'demilestoned' events.</dd>

rename
: An object containing rename details including 'from' and 'to' attributes. Only
provided for 'renamed' events.
<dt>rename</dt>
<dd>An object containing rename details including 'from' and 'to' attributes. Only
provided for 'renamed' events.</dd>
</dl>

### Events

closed
: The issue was closed by the actor. When the commit_id is present, it
<dl>
<dt>closed</dt>
<dd>The issue was closed by the actor. When the commit_id is present, it
identifies the commit that closed the issue using "closes / fixes #NN"
syntax.
syntax.</dd>

reopened
: The issue was reopened by the actor.

subscribed
: The actor subscribed to receive notifications for an issue.
<dt>reopened</dt>
<dd>The issue was reopened by the actor.</dd>

merged
: The issue was merged by the actor. The `commit_id` attribute is the SHA1 of
the HEAD commit that was merged.
<dt>subscribed</dt>
<dd>The actor subscribed to receive notifications for an issue.</dd>

referenced
: The issue was referenced from a commit message. The `commit_id` attribute is
the commit SHA1 of where that happened.
<dt>merged</dt>
<dd>The issue was merged by the actor. The `commit_id` attribute is the SHA1 of
the HEAD commit that was merged.</dd>

mentioned
: The actor was @mentioned in an issue body.
<dt>referenced</dt>
<dd>The issue was referenced from a commit message. The `commit_id` attribute is
the commit SHA1 of where that happened.</dd>

assigned
: The issue was assigned to the actor.
<dt>mentioned</dt>
<dd>The actor was @mentioned in an issue body.</dd>

unassigned
: The actor was unassigned from the issue.
<dt>assigned</dt>
<dd>The issue was assigned to the actor.</dd>

labeled
: A label was added to the issue.
<dt>unassigned</dt>
<dd>The actor was unassigned from the issue.</dd>

unlabeled
: A label was removed from the issue.
<dt>labeled</dt>
<dd>A label was added to the issue.</dd>

milestoned
: The issue was added to a milestone.
<dt>unlabeled</dt>
<dd>A label was removed from the issue.</dd>

demilestoned
: The issue was removed from a milestone.
<dt>milestoned</dt>
<dd>The issue was added to a milestone.</dd>

renamed
: The issue title was changed.
<dt>demilestoned</dt>
<dd>The issue was removed from a milestone.</dd>

locked
: The issue was locked by the actor.
<dt>renamed</dt>
<dd>The issue title was changed.</dd>

unlocked
: The issue was unlocked by the actor.
<dt>locked</dt>
<dd>The issue was locked by the actor.</dd>

head_ref_deleted
: The pull request's branch was deleted.
<dt>unlocked</dt>
<dd>The issue was unlocked by the actor.</dd>

head_ref_restored
: The pull request's branch was restored.
<dt>head_ref_deleted</dt>
<dd>The pull request's branch was deleted.</dd>

<dt>head_ref_restored</dt>
<dd>The pull request's branch was restored.</dd>
</dl>

## List events for an issue

Expand Down Expand Up @@ -129,4 +133,3 @@ head_ref_restored

<%= headers 200 %>
<%= json :full_issue_event %>

72 changes: 48 additions & 24 deletions content/v3/versions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,84 +42,108 @@ functionality _will be removed_ in the next major version of the API.
The recommendations below will help you prepare your application for the next major version of the API.

1. Method: /gists/:id/fork
: Recommendation: Use **/gists/:id/forks** (plural) instead.

Recommendation: Use **/gists/:id/forks** (plural) instead.

1. Method: /legacy/issues/search/:owner/:repository/:state/:keyword
: Recommendation: Use [v3 Issue Search API](/v3/search/#search-issues) instead.

Recommendation: Use [v3 Issue Search API](/v3/search/#search-issues) instead.

1. Method: /legacy/repos/search/:keyword
: Recommendation: Use [v3 Repository Search API](/v3/search/#search-repositories) instead.

Recommendation: Use [v3 Repository Search API](/v3/search/#search-repositories) instead.

1. Method: /legacy/user/search/:keyword
: Recommendation: Use [v3 User Search API](/v3/search/#search-users) instead.

Recommendation: Use [v3 User Search API](/v3/search/#search-users) instead.

1. Method: /legacy/user/email/:email
: Recommendation: Use [v3 User Search API](/v3/search/#search-users) instead.

Recommendation: Use [v3 User Search API](/v3/search/#search-users) instead.

1. Method: /repos/:owner/:repo/hooks/:id/test
: Recommendation: Use **/repos/:owner/:repo/hooks/:id/tests** (plural) instead.

Recommendation: Use **/repos/:owner/:repo/hooks/:id/tests** (plural) instead.

1. Method: /teams/:id/members/:username
: Recommendation: Use [Get Team Membership](/v3/orgs/teams/#get-team-membership), [Add Team Membership](/v3/orgs/teams/#add-team-membership), and [Remove Team Membership](/v3/orgs/teams/#remove-team-membership) instead.

Recommendation: Use [Get Team Membership](/v3/orgs/teams/#get-team-membership), [Add Team Membership](/v3/orgs/teams/#add-team-membership), and [Remove Team Membership](/v3/orgs/teams/#remove-team-membership) instead.

1. Query parameters when POSTing to /repos/:owner/:repo/forks
: Recommendation: Use JSON to POST to this method instead.

Recommendation: Use JSON to POST to this method instead.

1. Query parameter value: Passing "watchers" as the value for the "sort" parameter in a GET request to /repos/:owner/:repo/forks
: Recommendation: Use **stargazers** as the value instead.

Recommendation: Use **stargazers** as the value instead.

1. Pull Request attribute: merge_commit_sha
: Recommendation: [Do not use this attribute](/changes/2013-04-25-deprecating-merge-commit-sha/).

Recommendation: [Do not use this attribute](/changes/2013-04-25-deprecating-merge-commit-sha/).

1. Rate Limit attribute: rate
: Recommendation: Use **resources["core"]** instead.

Recommendation: Use **resources["core"]** instead.

1. Repository attribute: forks
: Recommendation: Use **forks_count** instead.

Recommendation: Use **forks_count** instead.

1. Repository attribute: master_branch
: Recommendation: Use **default_branch** instead.

Recommendation: Use **default_branch** instead.

1. Repository attribute: open_issues
: Recommendation: Use **open_issues_count** instead.

Recommendation: Use **open_issues_count** instead.

1. Repository attribute: public
: Recommendation: When [creating a repository](/v3/repos/#create), use the

Recommendation: When [creating a repository](/v3/repos/#create), use the
**private** attribute to indicate whether the repository should be public or
private. Do not use the **public** attribute.

1. Repository attribute: watchers
: Recommendation: Use **watchers_count** instead.

Recommendation: Use **watchers_count** instead.

1. User attribute: bio
: Recommendation: Do not use this attribute. It is obsolete.

Recommendation: Do not use this attribute. It is obsolete.

1. User attribute: plan["collaborators"]
: Recommendation: Do not use this attribute. It is obsolete.

Recommendation: Do not use this attribute. It is obsolete.

1. User attribute: gravatar_id
: Recommendation: Use **avatar_url** instead.

Recommendation: Use **avatar_url** instead.

1. Feed attribute: current_user_organization_url
: Recommendation: Use **current_user_organization_urls** instead.

Recommendation: Use **current_user_organization_urls** instead.

1. Feed attribute: current_user_organization
: Recommendation: Use **current_user_organizations** instead.

Recommendation: Use **current_user_organizations** instead.

1. Pagination parameters `top` and `sha` for method: /repos/:owner/:repo/commits
: Recommendation: When fetching [the list of commits for a repository](/v3/repos/commits/#list-commits-on-a-repository)

Recommendation: When fetching [the list of commits for a repository](/v3/repos/commits/#list-commits-on-a-repository)
use the [standard `per_page` and `page` parameters](/v3/#pagination) for pagination, instead of `per_page`,
`top`, and `sha`.

1. Authorization attribute: token
: Recommendation: This attribute will return an empty string in the majority of

Recommendation: This attribute will return an empty string in the majority of
the Authorizations API responses. Please see
[the deprecation blog post](/changes/2015-04-20-authorizations-api-response-changes-are-now-in-effect/)
and the [Authorizations API deprecation notice](/v3/oauth_authorizations/#deprecation-notice)
for full details.

1. Team attribute: permission
: Recommendation: This attribute no longer dictates the permission a team has on its repositories; it only dictates the default permission that the [Add team repository](/v3/orgs/teams/#add-team-repository) API will use for requests where no `permission` attribute is specified. To change the permission level for every repository on a team, use the [List team repositories](/v3/orgs/teams/#list-team-repos) API to list all of the team's repositories, and then use the [Add team repository](/v3/orgs/teams/#add-team-repository) with a `permission` attribute to update each repository's permission separately.

Recommendation: This attribute no longer dictates the permission a team has on its repositories; it only dictates the default permission that the [Add team repository](/v3/orgs/teams/#add-team-repository) API will use for requests where no `permission` attribute is specified. To change the permission level for every repository on a team, use the [List team repositories](/v3/orgs/teams/#list-team-repos) API to list all of the team's repositories, and then use the [Add team repository](/v3/orgs/teams/#add-team-repository) with a `permission` attribute to update each repository's permission separately.

<a id="beta">

Expand Down
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy