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
{{ message }}
This repository was archived by the owner on Nov 1, 2017. It is now read-only.
We're making[Multiple Assignees][blog-post] part of the official GitHub API.
7
+
8
+
During the preview period you needed to provide the`application/vnd.github.cerberus-preview` preview media type in the`Accept` header to opt-in to the changes. Now that the preview period has ended, you no longer need to specify this custom media type.
9
+
10
+
If you have any questions or feedback, please[get in touch with us][contact]!
Copy file name to clipboardExpand all lines: content/v3/issues.md
+4-72Lines changed: 4 additions & 72 deletions
Original file line number
Diff line number
Diff line change
@@ -159,33 +159,18 @@ Name | Type | Description
159
159
-----|------|--------------
160
160
`title`|`string` |**Required**. The title of the issue.
161
161
`body`|`string` | The contents of the issue.
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._
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.**This field is[deprecated](https://developer.github.com/v3/versions/#v3-deprecations).**_
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
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
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.
180
-
181
-
{{/tip}}
182
-
183
167
####Example
184
168
185
169
<%= json\
186
170
:title => "Found a bug",
187
171
:body => "I'm having a problem with this.",
188
172
:assignee => "octocat",
173
+
:assignees =>[get_resource(:user)],
189
174
:milestone => 1,
190
175
:labels => %w(bug)
191
176
%>
@@ -195,25 +180,6 @@ The `assignees` key will only be accepted in issue payloads if this header is pa
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
-
217
183
##Edit an issue
218
184
219
185
Issue owners and users with push access can edit an issue.
@@ -226,34 +192,19 @@ Name | Type | Description
226
192
-----|------|--------------
227
193
`title`|`string` | The title of the issue.
228
194
`body`|`string` | The contents of the issue.
229
-
`assignee`|`string` | Login for the user that this issue should be assigned to.
195
+
`assignee`|`string` | Login for the user that this issue should be assigned to.**This field is[deprecated](https://developer.github.com/v3/versions/#v3-deprecations).**
230
196
`state`|`string` | State of the issue. Either`open` or`closed`.
231
197
`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._
232
198
`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
199
`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._
234
200
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}}
250
-
251
201
####Example
252
202
253
203
<%= json\
254
204
:title => "Found a bug",
255
205
:body => "I'm having a problem with this.",
256
206
:assignee => "octocat",
207
+
:assignees =>[get_resource(:user)],
257
208
:milestone => 1,
258
209
:state => "open",
259
210
:labels => %w(bug)
@@ -264,25 +215,6 @@ The `assignees` key will only be present in issue payloads if this header is pas
264
215
<%= headers 200 %>
265
216
<%= json:full_issue %>
266
217
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.
282
-
283
-
{{/tip}}
284
-
{% endif %}
285
-
286
218
{% if page.version == 'dotcom' or page.version >= 2.6 %}
Copy file name to clipboardExpand all lines: content/v3/versions.md
+5Lines changed: 5 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -145,6 +145,11 @@ The recommendations below will help you prepare your application for the next ma
145
145
146
146
Recommendation: This attribute no longer dictates the permission a team has on its repositories; it only dictates the default permission that the[Add or update team repository](/v3/orgs/teams/#add-or-update-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 or update team repository](/v3/orgs/teams/#add-or-update-team-repository) with a`permission` attribute to update each repository's permission separately.
147
147
148
+
1. Issue attribute: assignee
149
+
150
+
Recommendation: Use the[`assignees`](https://developer.github.com/v3/issues/#create-an-issue) key instead, since issues can have more than one assignee. Alternatively, you can use the