Sync changes from upstream repository

Hubot · Hubot · commit e0d08feb2f3a · 2016-05-27T10:01:08.000-07:00
diff --git a/content/changes/2016-5-27-multiple-assignees.md b/content/changes/2016-5-27-multiple-assignees.md
@@ -0,0 +1,23 @@
+---
+title: API changes for Multiple Issue Assignees
+author_name: nakajima
+---
+GitHub recently added the ability to assign up to ten people to issues. We're updating Issue payloads and adding a couple new endpoints to help you build apps. You can enable these changes during the preview period by providing a custom [media type][media-type] in the `Accept` header:
+
+    application/vnd.github.cerberus-preview
+
+For example:
+
+``` command-line
+curl "https://api.github.com/repos/github/hubot/issues" \
+  -H 'Authorization: token TOKEN' \
+  -H "Accept: application/vnd.github.cerberus-preview" \
+```
+
+The issues returned in this list will include the new `assignees` key.
+
+You can learn more about the new responses and endpoints in the updated [Issues][issues] and [Issue Assignees][issue-assignees] documentation
+
+[media-type]: /v3/media
+[issues]: /v3/issues
+[issue-assignees]: /v3/issues/assignees
diff --git a/content/v3/issues.md b/content/v3/issues.md
@@ -162,6 +162,23 @@ Name | Type | Description
 `assignee`|`string` | Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise._
 `milestone`|`integer` | The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._
 `labels`|`array` of `strings` | Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._
+`assignees`|`array` of `strings` | Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._
+
+{{#tip}}
+
+<a name="preview-period"></a>
+
+The `assignees` parameter is currently available for developers to preview.
+During the preview period, the API may change without advance notice.
+Please see the [blog post](/changes/2016-5-27-multiple-assignees) for full details.
+
+To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header:
+
+    application/vnd.github.cerberus-preview+json
+
+The `assignees` key will only be accepted in issue payloads if this header is passed.
+
+{{/tip}}
 
 #### Example
 
@@ -178,6 +195,25 @@ Name | Type | Description
 <%= headers 201, :Location => get_resource(:full_issue)['url'] %>
 <%= json :full_issue %>
 
+{% if page.version == 'dotcom' %}
+#### Multiple Assignees
+
+{{#tip}}
+
+  <a name="preview-period"></a>
+
+  An additional `assignees` object in the issue payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice.
+  Please see the [blog post](/changes/2016-5-27-multiple-assignees) for full details.
+
+  To access the API you must provide a custom [media type](/v3/media) in the `Accept` header:
+
+      application/vnd.github.cerberus-preview
+
+  The `assignees` key will be an Array of Users who are assigned to the issue.
+
+{{/tip}}
+{% endif %}
+
 ## Edit an issue
 
 Issue owners and users with push access can edit an issue.
@@ -194,7 +230,23 @@ Name | Type | Description
 `state`|`string` | State of the issue. Either `open` or `closed`.
 `milestone`|`integer` | The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._
 `labels`|`array` of `strings` | Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._
+`assignees`|`array` of `strings` | Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. .Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._
 
+{{#tip}}
+
+<a name="preview-period"></a>
+
+The `assignees` parameter is currently available for developers to preview.
+During the preview period, the API may change without advance notice.
+Please see the [blog post](/changes/2016-5-27-multiple-assignees) for full details.
+
+To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header:
+
+    application/vnd.github.cerberus-preview+json
+
+The `assignees` key will only be present in issue payloads if this header is passed.
+
+{{/tip}}
 
 #### Example
 
@@ -212,6 +264,25 @@ Name | Type | Description
 <%= headers 200 %>
 <%= json :full_issue %>
 
+{% if page.version == 'dotcom' %}
+#### Multiple Assignees
+
+{{#tip}}
+
+  <a name="preview-period"></a>
+
+  An additional `assignees` object in the issue payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice.
+  Please see the [blog post](/changes/2016-5-27-multiple-assignees) for full details.
+
+  To access the API you must provide a custom [media type](/v3/media) in the `Accept` header:
+
+      application/vnd.github.cerberus-preview
+
+  The `assignees` key will be an Array of Users who are assigned to the issue.
+
+{{/tip}}
+{% endif %}
+
 {% if page.version == 'dotcom' %}
 
 ## Lock an issue
diff --git a/content/v3/issues/assignees.md b/content/v3/issues/assignees.md
@@ -35,3 +35,62 @@ Otherwise a `404` status code is returned.
 <%= headers 404 %>
 
 [available assignees]: https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/
+
+## Add assignees to an Issue
+
+{{#tip}}
+
+<a name="preview-period"></a>
+
+This endpoint is currently available for developers to preview.
+During the preview period, the API may change without advance notice.
+Please see the [blog post](/changes/2016-5-27-multiple-assignees) for full details.
+
+To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header:
+
+    application/vnd.github.cerberus-preview+json
+
+{{/tip}}
+
+
+This call adds the users passed in the `assignees` key (as their logins) to the issue.
+
+    POST /repos/:owner/:repo/issues/:number/assignees
+
+### Input
+
+<%= json({"assignees" => %w(hubot other_assignee)}) %>
+
+### Response
+
+<%= headers 201 %>
+<%= json(:issue_with_assignees) { |h| [h] } %>
+
+## Remove assignees from an Issue
+
+{{#tip}}
+
+<a name="preview-period"></a>
+
+This endpoint is currently available for developers to preview.
+During the preview period, the API may change without advance notice.
+Please see the [blog post](/changes/2016-5-27-multiple-assignees) for full details.
+
+To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header:
+
+    application/vnd.github.cerberus-preview+json
+
+{{/tip}}
+
+This call removes the users passed in the `assignees` key (as their logins) from the issue.
+
+    DELETE /repos/:owner/:repo/issues/:number/assignees
+
+### Input
+
+<%= json({"assignees" => %w(hubot other_assignee)}) %>
+
+### Response
+
+<%= headers 200 %>
+<%= json(:issue_with_assignees) { |h| [h] } %>
diff --git a/lib/responses/issues_and_prs.rb b/lib/responses/issues_and_prs.rb
@@ -133,6 +133,13 @@ module Responses
         "closed_by" => USER
       })
 
+      ISSUE_WITH_ASSIGNEES ||= ISSUE.merge({
+        "assignees" => [
+          USER.merge("login" => "hubot"),
+          USER.merge("login" => "other_user")
+        ]
+      })
+
       ISSUE_COMMENT ||= {
         "id"         => 1,
         "url"        => "https://api.github.com/repos/octocat/Hello-World/issues/comments/1",
