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.
title:Prepare for upcoming organization permissions changes
4
+
created_at:2015-01-07
5
+
author_name:jakeboxer
6
+
---
7
+
8
+
Last month, we[released a preview][org-permissions-preview] of several API changes related to managing organization members and repositories. Today, we're finalizing these changes. This new functionality is now stable and suitable for production use. If your application relies on any of the affected functionality (described below), be sure to**update your code before February 24** to account for these changes.
9
+
10
+
###Breaking changes coming on February 24
11
+
12
+
If your application uses any of the following APIs, then you are affected by this change:
13
+
14
+
- APIs for managing your organization's admins through the Owners team
15
+
- The[List your repositories][list-your-repos] API
16
+
- The[List your organizations][list-your-organizations] API
17
+
- The[List user organizations][list-user-organizations] API
18
+
19
+
If your application uses these APIs, we urge you to update your application as soon as possible. (Read[last month's announcement][org-permissions-preview] for more details on the changes.)
20
+
21
+
Starting today, we're offering a migration period allowing applications to opt in to these changes (as described below). On February 24, these changes will become official parts of the GitHub API v3. At that time, these changes will apply to all API consumers.
22
+
23
+
###Migration period
24
+
25
+
During the migration period, you can opt-in to these changes using the following custom media type in the`Accept` header:
26
+
27
+
application/vnd.github.moondragon+json
28
+
29
+
We want to make these updates as smooth as possible for everyone, and we hope that the migration period gives you flexibility to adopt these changes on your own schedule. If you have any questions or feedback, please[get in touch with us][contact]!
Copy file name to clipboardExpand all lines: content/v3/orgs.md
+6-10Lines changed: 6 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -19,14 +19,12 @@ With the new Organization Permissions API (described below), this method will on
19
19
20
20
<divclass="alert">
21
21
<p>
22
-
The Organization Permissions API is currently available for developers to preview.
23
-
During the preview period, the API may change without notice.
24
-
Please see the <a href="/changes/2014-12-08-organization-permissions-api-preview/">blog post</a> for full details.
22
+
We're currently offering a migration period allowing applications to opt in to the Organization Permissions API. This functionality will apply to all API consumers beginning February 24, 2015. Please see the <a href="/changes/2015-01-07-prepare-for-organization-permissions-changes/">blog post</a> for full details.
25
23
</p>
26
24
27
25
<p>
28
-
To access the API during thepreview period, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> header:
To access the API during themigration period, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> header:
27
+
<pre>application/vnd.github.moondragon+json</pre>
30
28
</p>
31
29
</div>
32
30
@@ -47,14 +45,12 @@ With the new Organization Permissions API (described below), this method will on
47
45
48
46
<divclass="alert">
49
47
<p>
50
-
The Organization Permissions API is currently available for developers to preview.
51
-
During the preview period, the API may change without notice.
52
-
Please see the <a href="/changes/2014-12-08-organization-permissions-api-preview/">blog post</a> for full details.
48
+
We're currently offering a migration period allowing applications to opt in to the Organization Permissions API. This functionality will apply to all API consumers beginning February 24, 2015. Please see the <a href="/changes/2015-01-07-prepare-for-organization-permissions-changes/">blog post</a> for full details.
53
49
</p>
54
50
55
51
<p>
56
-
To access the API during thepreview period, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> header:
Copy file name to clipboardExpand all lines: content/v3/orgs/members.md
+12-20Lines changed: 12 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -27,14 +27,12 @@ Name | Type | Description
27
27
28
28
<divclass="alert">
29
29
<p>
30
-
The Organization Permissions API is currently available for developers to preview.
31
-
During the preview period, the API may change without notice.
32
-
Please see the <a href="/changes/2014-12-08-organization-permissions-api-preview/">blog post</a> for full details.
30
+
We're currently offering a migration period allowing applications to opt in to the Organization Permissions API. This functionality will apply to all API consumers beginning February 24, 2015. Please see the <a href="/changes/2015-01-07-prepare-for-organization-permissions-changes/">blog post</a> for full details.
33
31
</p>
34
32
35
33
<p>
36
-
To access the API during thepreview period, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> header:
To access the API during themigration period, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> header:
35
+
<pre>application/vnd.github.moondragon+json</pre>
38
36
</p>
39
37
</div>
40
38
@@ -134,14 +132,12 @@ The user can publicize their own membership.
134
132
135
133
<divclass="alert">
136
134
<p>
137
-
The Organization Permissions API is currently available for developers to preview.
138
-
During the preview period, the API may change without notice.
139
-
Please see the <a href="/changes/2014-12-08-organization-permissions-api-preview/">blog post</a> for full details.
135
+
We're currently offering a migration period allowing applications to opt in to the Organization Permissions API. Please see the <a href="/changes/2015-01-07-prepare-for-organization-permissions-changes/">blog post</a> for full details.
140
136
</p>
141
137
142
138
<p>
143
-
To accessthe API during thepreview period, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> header:
To accessthis APImethodduring themigration period, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> header:
140
+
<pre>application/vnd.github.moondragon+json</pre>
145
141
</p>
146
142
</div>
147
143
@@ -168,14 +164,12 @@ In order to get a user's membership with an organization, the authenticated user
168
164
169
165
<divclass="alert">
170
166
<p>
171
-
The Organization Permissions API is currently available for developers to preview.
172
-
During the preview period, the API may change without notice.
173
-
Please see the <a href="/changes/2014-12-08-organization-permissions-api-preview/">blog post</a> for full details.
167
+
We're currently offering a migration period allowing applications to opt in to the Organization Permissions API. Please see the <a href="/changes/2015-01-07-prepare-for-organization-permissions-changes/">blog post</a> for full details.
174
168
</p>
175
169
176
170
<p>
177
-
To accessthe API during thepreview period, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> header:
To accessthis APImethodduring themigration period, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> header:
172
+
<pre>application/vnd.github.moondragon+json</pre>
179
173
</p>
180
174
</div>
181
175
@@ -203,14 +197,12 @@ Name | Type | Description
203
197
204
198
<divclass="alert">
205
199
<p>
206
-
The Organization Permissions API is currently available for developers to preview.
207
-
During the preview period, the API may change without notice.
208
-
Please see the <a href="/changes/2014-12-08-organization-permissions-api-preview/">blog post</a> for full details.
200
+
We're currently offering a migration period allowing applications to opt in to the Organization Permissions API. Please see the <a href="/changes/2015-01-07-prepare-for-organization-permissions-changes/">blog post</a> for full details.
209
201
</p>
210
202
211
203
<p>
212
-
To accessthe API during thepreview period, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> header:
Copy file name to clipboardExpand all lines: content/v3/repos.md
+3-5Lines changed: 3 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -24,14 +24,12 @@ list the authenticated user's organization-owned repositories.
24
24
25
25
<divclass="alert">
26
26
<p>
27
-
The Organization Permissions API is currently available for developers to preview.
28
-
During the preview period, the API may change without notice.
29
-
Please see the <a href="/changes/2014-12-08-organization-permissions-api-preview/">blog post</a> for full details.
27
+
We're currently offering a migration period allowing applications to opt in to the Organization Permissions API. This functionality will apply to all API consumers beginning February 24, 2015. Please see the <a href="/changes/2015-01-07-prepare-for-organization-permissions-changes/">blog post</a> for full details.
30
28
</p>
31
29
32
30
<p>
33
-
To access the API during thepreview period, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> header: