You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
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:
Copy file name to clipboardExpand all lines: content/v3/issues.md
+71Lines changed: 71 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -162,6 +162,23 @@ Name | Type | Description
162
162
`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._
163
163
`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._
164
164
`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._
165
+
`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._
166
+
167
+
{{#tip}}
168
+
169
+
<aname="preview-period"></a>
170
+
171
+
The`assignees` parameter is currently available for developers to preview.
172
+
During the preview period, the API may change without advance notice.
173
+
Please see the[blog post](/changes/2016-5-27-multiple-assignees) for full details.
174
+
175
+
To access the API during the preview period, you must provide a custom[media type](/v3/media) in the`Accept` header:
176
+
177
+
application/vnd.github.cerberus-preview+json
178
+
179
+
The`assignees` key will only be accepted in issue payloads if this header is passed.
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.
206
+
Please see the[blog post](/changes/2016-5-27-multiple-assignees) for full details.
207
+
208
+
To access the API you must provide a custom[media type](/v3/media) in the`Accept` header:
209
+
210
+
application/vnd.github.cerberus-preview
211
+
212
+
The`assignees` key will be an Array of Users who are assigned to the issue.
213
+
214
+
{{/tip}}
215
+
{% endif %}
216
+
181
217
##Edit an issue
182
218
183
219
Issue owners and users with push access can edit an issue.
@@ -194,7 +230,23 @@ Name | Type | Description
194
230
`state`|`string` | State of the issue. Either`open` or`closed`.
195
231
`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._
196
232
`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._
233
+
`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._
197
234
235
+
{{#tip}}
236
+
237
+
<aname="preview-period"></a>
238
+
239
+
The`assignees` parameter is currently available for developers to preview.
240
+
During the preview period, the API may change without advance notice.
241
+
Please see the[blog post](/changes/2016-5-27-multiple-assignees) for full details.
242
+
243
+
To access the API during the preview period, you must provide a custom[media type](/v3/media) in the`Accept` header:
244
+
245
+
application/vnd.github.cerberus-preview+json
246
+
247
+
The`assignees` key will only be present in issue payloads if this header is passed.
248
+
249
+
{{/tip}}
198
250
199
251
####Example
200
252
@@ -212,6 +264,25 @@ Name | Type | Description
212
264
<%= headers 200 %>
213
265
<%= json:full_issue %>
214
266
267
+
{% if page.version == 'dotcom' %}
268
+
####Multiple Assignees
269
+
270
+
{{#tip}}
271
+
272
+
<aname="preview-period"></a>
273
+
274
+
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.
275
+
Please see the[blog post](/changes/2016-5-27-multiple-assignees) for full details.
276
+
277
+
To access the API you must provide a custom[media type](/v3/media) in the`Accept` header:
278
+
279
+
application/vnd.github.cerberus-preview
280
+
281
+
The`assignees` key will be an Array of Users who are assigned to the issue.