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

Commit 3ca3f26

Browse files
author
Hubot
committed
Sync changes from upstream repository
1 parent b565e2f commit 3ca3f26

File tree

4 files changed

+22
-101
lines changed

4 files changed

+22
-101
lines changed
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Multiple Assignees API is now official
3+
author_name: nakajima
4+
---
5+
6+
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]!
11+
12+
[blog-post]: /changes/2016-5-27-multiple-assignees/
13+
[contact]: https://github.com/contact?form[subject]=Multiple+Assignees+API

content/v3/issues.md

Lines changed: 4 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -159,33 +159,18 @@ Name | Type | Description
159159
-----|------|--------------
160160
`title`|`string` | **Required**. The title of the issue.
161161
`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).**_
163163
`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._
164164
`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._
165165
`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._
166166

167-
{{#tip}}
168-
169-
<a name="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-
183167
#### Example
184168

185169
<%= json \
186170
:title => "Found a bug",
187171
:body => "I'm having a problem with this.",
188172
:assignee => "octocat",
173+
:assignees => [get_resource(:user)],
189174
:milestone => 1,
190175
:labels => %w(bug)
191176
%>
@@ -195,25 +180,6 @@ The `assignees` key will only be accepted in issue payloads if this header is pa
195180
<%= headers 201, :Location => get_resource(:full_issue)['url'] %>
196181
<%= json :full_issue %>
197182

198-
{% if page.version == 'dotcom' %}
199-
#### Multiple Assignees
200-
201-
{{#tip}}
202-
203-
<a name="preview-period"></a>
204-
205-
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-
217183
## Edit an issue
218184

219185
Issue owners and users with push access can edit an issue.
@@ -226,34 +192,19 @@ Name | Type | Description
226192
-----|------|--------------
227193
`title`|`string` | The title of the issue.
228194
`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).**
230196
`state`|`string` | State of the issue. Either `open` or `closed`.
231197
`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._
232198
`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._
233199
`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._
234200

235-
{{#tip}}
236-
237-
<a name="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-
251201
#### Example
252202

253203
<%= json \
254204
:title => "Found a bug",
255205
:body => "I'm having a problem with this.",
256206
:assignee => "octocat",
207+
:assignees => [get_resource(:user)],
257208
:milestone => 1,
258209
:state => "open",
259210
:labels => %w(bug)
@@ -264,25 +215,6 @@ The `assignees` key will only be present in issue payloads if this header is pas
264215
<%= headers 200 %>
265216
<%= json :full_issue %>
266217

267-
{% if page.version == 'dotcom' %}
268-
#### Multiple Assignees
269-
270-
{{#tip}}
271-
272-
<a name="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-
286218
{% if page.version == 'dotcom' or page.version >= 2.6 %}
287219
## Lock an issue
288220

content/v3/issues/assignees.md

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -38,21 +38,6 @@ Otherwise a `404` status code is returned.
3838

3939
## Add assignees to an Issue
4040

41-
{{#tip}}
42-
43-
<a name="preview-period"></a>
44-
45-
This endpoint is currently available for developers to preview.
46-
During the preview period, the API may change without advance notice.
47-
Please see the [blog post](/changes/2016-5-27-multiple-assignees) for full details.
48-
49-
To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header:
50-
51-
application/vnd.github.cerberus-preview+json
52-
53-
{{/tip}}
54-
55-
5641
This call adds the users passed in the `assignees` key (as their logins) to the issue.
5742

5843
POST /repos/:owner/:repo/issues/:number/assignees
@@ -68,20 +53,6 @@ This call adds the users passed in the `assignees` key (as their logins) to the
6853

6954
## Remove assignees from an Issue
7055

71-
{{#tip}}
72-
73-
<a name="preview-period"></a>
74-
75-
This endpoint is currently available for developers to preview.
76-
During the preview period, the API may change without advance notice.
77-
Please see the [blog post](/changes/2016-5-27-multiple-assignees) for full details.
78-
79-
To access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header:
80-
81-
application/vnd.github.cerberus-preview+json
82-
83-
{{/tip}}
84-
8556
This call removes the users passed in the `assignees` key (as their logins) from the issue.
8657

8758
DELETE /repos/:owner/:repo/issues/:number/assignees

content/v3/versions.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,11 @@ The recommendations below will help you prepare your application for the next ma
145145

146146
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.
147147

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
151+
[assignees](https://developer.github.com/v3/issues/assignees/) endpoints.
152+
148153
<a id="beta">
149154

150155
# beta (Deprecated)

0 commit comments

Comments
 (0)