From 11c14ac93dedf1337abc77a2445bfc9398fdd550 Mon Sep 17 00:00:00 2001 From: Hubot Date: Wed, 6 Jan 2016 16:38:24 -0800 Subject: [PATCH] Sync changes from upstream repository --- content/v3/issues/events.md | 127 ++++++++++++++++++------------------ content/v3/versions.md | 72 +++++++++++++------- 2 files changed, 113 insertions(+), 86 deletions(-) diff --git a/content/v3/issues/events.md b/content/v3/issues/events.md index a7ddb20460..c6024c827b 100644 --- a/content/v3/issues/events.md +++ b/content/v3/issues/events.md @@ -12,96 +12,100 @@ determine who should be notified of comments. ### Attributes -id -: The Integer ID of the event. +
+
id
+
The Integer ID of the event.
-url -: The API URL for fetching the event. +
url
+
The API URL for fetching the event.
-actor -: Always the User that generated the event. +
actor
+
Always the User that generated the event.
-commit_id -: The String SHA of a commit that referenced this Issue +
commit_id
+
The String SHA of a commit that referenced this Issue
-event -: Identifies the actual type of Event that occurred. +
event
+
Identifies the actual type of Event that occurred.
-created_at -: The timestamp indicating when the event occurred. +
created_at
+
The timestamp indicating when the event occurred.
-label -: The Label object including 'name' and 'color' attributes. Only provided for 'labeled' - and 'unlabeled' events. +
label
+
The Label object including 'name' and 'color' attributes. Only provided for 'labeled' + and 'unlabeled' events.
-assignee -: The User object which was assigned to (or unassigned from) this Issue. Only provided for 'assigned' - and 'unassigned' events. +
assignee
+
The User object which was assigned to (or unassigned from) this Issue. Only provided for 'assigned' and 'unassigned' events.
-milestone -: The Milestone object including a 'title' attribute. Only provided for 'milestoned' and - 'demilestoned' events. +
milestone
+
The Milestone object including a 'title' attribute. Only provided for 'milestoned' and + 'demilestoned' events.
-rename -: An object containing rename details including 'from' and 'to' attributes. Only - provided for 'renamed' events. +
rename
+
An object containing rename details including 'from' and 'to' attributes. Only + provided for 'renamed' events.
+
### Events -closed -: The issue was closed by the actor. When the commit_id is present, it +
+
closed
+
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.
-reopened -: The issue was reopened by the actor. -subscribed -: The actor subscribed to receive notifications for an issue. +
reopened
+
The issue was reopened by the actor.
-merged -: The issue was merged by the actor. The `commit_id` attribute is the SHA1 of - the HEAD commit that was merged. +
subscribed
+
The actor subscribed to receive notifications for an issue.
-referenced -: The issue was referenced from a commit message. The `commit_id` attribute is - the commit SHA1 of where that happened. +
merged
+
The issue was merged by the actor. The `commit_id` attribute is the SHA1 of + the HEAD commit that was merged.
-mentioned -: The actor was @mentioned in an issue body. +
referenced
+
The issue was referenced from a commit message. The `commit_id` attribute is + the commit SHA1 of where that happened.
-assigned -: The issue was assigned to the actor. +
mentioned
+
The actor was @mentioned in an issue body.
-unassigned -: The actor was unassigned from the issue. +
assigned
+
The issue was assigned to the actor.
-labeled -: A label was added to the issue. +
unassigned
+
The actor was unassigned from the issue.
-unlabeled -: A label was removed from the issue. +
labeled
+
A label was added to the issue.
-milestoned -: The issue was added to a milestone. +
unlabeled
+
A label was removed from the issue.
-demilestoned -: The issue was removed from a milestone. +
milestoned
+
The issue was added to a milestone.
-renamed -: The issue title was changed. +
demilestoned
+
The issue was removed from a milestone.
-locked -: The issue was locked by the actor. +
renamed
+
The issue title was changed.
-unlocked -: The issue was unlocked by the actor. +
locked
+
The issue was locked by the actor.
-head_ref_deleted -: The pull request's branch was deleted. +
unlocked
+
The issue was unlocked by the actor.
-head_ref_restored -: The pull request's branch was restored. +
head_ref_deleted
+
The pull request's branch was deleted.
+ +
head_ref_restored
+
The pull request's branch was restored.
+
## List events for an issue @@ -129,4 +133,3 @@ head_ref_restored <%= headers 200 %> <%= json :full_issue_event %> - diff --git a/content/v3/versions.md b/content/v3/versions.md index 97a7c1f145..1b1831982d 100644 --- a/content/v3/versions.md +++ b/content/v3/versions.md @@ -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.