Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings
This repository was archived by the owner on Nov 1, 2017. It is now read-only.

Commit c4da2e8

Browse filesBrowse files
Merge pull request #1 from github/master
Update My Fork
2 parents 130c623 + 0583822 commit c4da2e8
Copy full SHA for c4da2e8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Dismiss banner
Expand file treeCollapse file tree

42 files changed

+625
-199
lines changed
Open diff view settings
Collapse file

‎Rules‎

Copy file name to clipboardExpand all lines: Rules
+2-1Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ compile '/v3/*' do
3030
filter :search
3131
filter :erb
3232
filter :kramdown, :toc_levels => [2]
33-
filter :enterprise_purge_filter
33+
filter :enterprise_only_filter
34+
filter :not_enterprise_filter
3435
filter :tip_filter
3536
filter :colorize_syntax,
3637
:colorizers => {:javascript => :rouge}
Collapse file

‎content/changes/2015-01-07-prepare-for-organization-permissions-changes.md‎

Copy file name to clipboardExpand all lines: content/changes/2015-01-07-prepare-for-organization-permissions-changes.md
+7-4Lines changed: 7 additions & 4 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ created_at: 2015-01-07
55
author_name: jakeboxer
66
---
77

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.
8+
**UPDATE (2015-06-10):** As [announced on June 10][2015-06-10-update], these changes will become an official part of GitHub API v3 on June 24. (This post originally announced that these changes would come to GitHub API v3 on February 24.)
99

10-
### Breaking changes coming on February 24
10+
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 June 24** to account for these changes.
11+
12+
## Breaking changes coming on June 24
1113

1214
If your application uses any of the following APIs, then you are affected by this change:
1315

@@ -18,9 +20,9 @@ If your application uses any of the following APIs, then you are affected by thi
1820

1921
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.)
2022

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.
23+
Starting today, we're offering a migration period allowing applications to opt in to these changes (as described below). On June 24, these changes will become official parts of the GitHub API v3. At that time, these changes will apply to all API consumers.
2224

23-
### Migration period
25+
## Migration period
2426

2527
During the migration period, you can opt-in to these changes using the following custom media type in the `Accept` header:
2628

@@ -33,3 +35,4 @@ We want to make these updates as smooth as possible for everyone, and we hope th
3335
[list-user-organizations]: /v3/orgs/#list-user-organizations
3436
[list-your-organizations]: /v3/orgs/#list-your-organizations
3537
[contact]: https://github.com/contact?form[subject]=Organization+Permissions+API
38+
[2015-06-10-update]: /changes/2015-06-10-breaking-changes-to-organization-permissions-coming-on-june-24/
Collapse file
+22Lines changed: 22 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
kind: change
3+
title: Repository redirects are coming to API v3 in July
4+
created_at: 2015-05-26
5+
author_name: jasonrudolph
6+
---
7+
8+
Last month, we announced the [upcoming repository redirect behavior for the API][original announcement], and we made it available for developers to preview. Starting **July 21, 2015**, the API will automatically provide these redirects for all API consumers.
9+
10+
To learn more about repository redirects and how they will benefit your applications, be sure to check out the [original announcement][].
11+
12+
To start enjoying repository redirects right away, just provide the following custom [media type][] in the `Accept` header:
13+
14+
application/vnd.github.quicksilver-preview+json
15+
16+
Thanks to everyone that tried out this enhancement during the preview period.
17+
18+
As always, if you have any questions, please [get in touch][contact]. We love hearing from you.
19+
20+
[media type]: /v3/media/
21+
[original announcement]: /changes/2015-04-17-preview-repository-redirects/
22+
[contact]: https://github.com/contact?form%5Bsubject%5D=API+Repository+Redirects
Collapse file
+39Lines changed: 39 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
kind: change
3+
title: Breaking changes to organization permissions coming on June 24
4+
created_at: 2015-06-10
5+
author_name: jakeboxer
6+
---
7+
8+
Back in January, we [encouraged developers to update their applications][org-permissions-finalization] to prepare for [upcoming API changes][org-permissions-preview] related to managing organization members and repositories. In order to support the upcoming [improvements to organization permissions][direct-org-membership-blog-post], these changes will become official parts of GitHub API v3 on **June 24**.
9+
10+
If your application relies on any of the affected functionality (described below), be sure to **update your code before June 24** to account for these changes.
11+
12+
## Breaking changes coming on June 24
13+
14+
If your application uses any of the following APIs, then you are affected by this change:
15+
16+
- APIs for managing your organization's admins through the Owners team
17+
- The [List your repositories][list-your-repos] API
18+
- The [List your organizations][list-your-organizations] API
19+
- The [List user organizations][list-user-organizations] API
20+
21+
If your application uses these APIs, we urge you to update your application as soon as possible. (Read [December's announcement][org-permissions-preview] for full details on the changes.)
22+
23+
In January, we [announced a migration period][org-permissions-finalization] allowing API consumers to opt in to these changes. If you haven't already opted in to these changes, you still do so as described below. On June 24, these changes will become official parts of GitHub API v3. At that time, these changes will apply to all API consumers.
24+
25+
## Migration period
26+
27+
During these final days of the migration period, you can opt in to these changes using the following custom media type in the `Accept` header:
28+
29+
application/vnd.github.moondragon+json
30+
31+
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]!
32+
33+
[org-permissions-finalization]: /changes/2015-01-07-prepare-for-organization-permissions-changes/
34+
[org-permissions-preview]: /changes/2014-12-08-organization-permissions-api-preview/
35+
[direct-org-membership-blog-post]: https://github.com/blog/2020-improved-organization-permissions/
36+
[list-your-repos]: /v3/repos/#list-your-repositories
37+
[list-user-organizations]: /v3/orgs/#list-user-organizations
38+
[list-your-organizations]: /v3/orgs/#list-your-organizations
39+
[contact]: https://github.com/contact?form[subject]=Organization+Permissions+API
Collapse file
+33Lines changed: 33 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
kind: change
3+
title: GitHub Pages' A Records Added to Meta API
4+
created_at: 2015-06-11
5+
author_name: leereilly
6+
---
7+
8+
The [Meta API](/v3/meta/) now includes the A record IP addresses for [GitHub Pages](https://pages.github.com/).
9+
10+
<pre class="terminal">
11+
$ curl https://api.github.com/meta
12+
</pre>
13+
14+
<pre><code class="language-javascript">
15+
{
16+
"verifiable_password_authentication": true,
17+
"github_services_sha": "23c6105183b626cf74c045f6d53af7a178bfdb4c",
18+
"hooks": [
19+
"192.30.252.0/22"
20+
],
21+
"git": [
22+
"192.30.252.0/22"
23+
],
24+
"pages": [
25+
"192.30.252.153/32",
26+
"192.30.252.154/32"
27+
]
28+
}
29+
</code></pre>
30+
31+
These IP addresses are used to [configure A records with your DNS provider for GitHub Pages](https://help.github.com/articles/tips-for-configuring-an-a-record-with-your-dns-provider/). These addresses have changed a few times in the past. This API always provides the current addresses so that you can automate the process of keeping your DNS records up to date.
32+
33+
If you have any questions, please [get in touch](https://github.com/contact?form%5Bsubject%5D=GitHub+Pages+A+Records+Added+to+API). We’ll be happy to help.
Collapse file
+31Lines changed: 31 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
kind: change
3+
title: List all organizations
4+
created_at: 2015-06-17
5+
author_name: keavy
6+
---
7+
8+
We've added a [new API method](/v3/orgs#list-all-organizations) to list all organizations:
9+
10+
<pre class="terminal">
11+
$ curl https://api.github.com/organizations
12+
13+
[
14+
{
15+
"login": "github",
16+
"id": 9919,
17+
"url": "https://api.github.com/orgs/github",
18+
"repos_url": "https://api.github.com/orgs/github/repos",
19+
"events_url": "https://api.github.com/orgs/github/events",
20+
"members_url": "https://api.github.com/orgs/github/members{/member}",
21+
"public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
22+
"avatar_url": "https://avatars.githubusercontent.com/u/9919?v=3",
23+
"description": "GitHub, the company."
24+
},
25+
...
26+
]
27+
</pre>
28+
29+
As always, if you have any questions or feedback, please [drop us a line][contact].
30+
31+
[contact]: https://github.com/contact?form[subject]=API+-+Listing+Organizations
Collapse file
+88Lines changed: 88 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
kind: change
3+
title: API enhancements for working with organization permissions
4+
created_at: 2015-06-24
5+
author_name: jakeboxer
6+
---
7+
8+
We're introducing several enhancements to allow API developers to take advantage of the [improved organization permissions][dotcom-blog-post] that we are rolling out. Learn about these enhancements and how you can try them out below.
9+
10+
Since we're rolling out the [improved organization permissions][dotcom-blog-post] improvements slowly, these enhancements will only apply to certain organizations at first. Most of these enhancements will degrade gracefully (returning an empty array or something similar) if used on an organization that doesn't support improved organization permissions yet. Check the documentation for your specific API to see if errors are possible.
11+
12+
## API enhancements
13+
14+
### Team permissions
15+
16+
In our improved permissions system, a team no longer has a single permission that applies to all of its repositories. Instead, each repository is added to a team with its own permission. For example, an organization could use a single team to grant pull access to one repository, push access to a second, and admin access to a third.
17+
18+
The team APIs now support this more granular notion of permissions:
19+
20+
- The [Add team repository][add-team-repo] API accepts a `permission` parameter, so that you can specify whether a team should grant `pull`, `push`, or `admin` access on a given repository.
21+
- In the [List team repositories][list-team-repos] and [Check if a team manages a repository][get-team-repo] API, the response includes a `permissions` attribute, indicating whether the team grants `pull`, `push`, or `admin` access on each repository.
22+
- The `permission` parameter in the [Create team][create-team] and [Edit team][edit-team] APIs is deprecated. Since teams can grant a different permission on each repository, this parameter no longer dictates what permission a team grants on all of its repositories. Instead, it dictates the default permission that the [Add team repository][add-team-repo] API will use for requests where no `permission` parameter is specified.
23+
24+
### Team privacy
25+
26+
We now allow you to modify the privacy level of your teams. A "secret" team can only be seen by organization owners and people who are members of that team (which is how all teams have worked historically), while a "closed" team is visible to every member of the organization (which makes it easier to use [@mentions][team-mentions] throughout your organization).
27+
28+
The team APIs now support this new team privacy concept:
29+
30+
- The [Create team][create-team] and [Edit team][edit-team] APIs accept a `privacy` parameter, so that you can specify whether a team should be `secret` or `closed`.
31+
- All team resources in the API now include a `privacy` attribute, indicating whether the team is `secret` or `closed`.
32+
33+
### Team maintainers
34+
35+
We've added the ability for you to delegate team maintenance to non-owners, reducing the workload for your organization's owners. You can now promote a non-owner member of a team to be a "maintainer" of that team. A maintainer can add and remove team members and change the team's title and description.
36+
37+
The team membership APIs now support this new team maintainer concept:
38+
39+
- The [Add team membership][add-team-membership] API accepts a `role` parameter, so that you can specify whether a given team member should be a `maintainer` or a regular `member`.
40+
- The [List team members][list-team-members] API accepts an optional `role` parameter, allowing you to fetch only `maintainer`s or only regular `member`s.
41+
- In the [Get team membership][get-team-membership] and [Add team membership][add-team-membership] APIs, the response includes a `role` attribute, indicating whether a user is a `maintainer` or a regular `member` of the team.
42+
43+
For more information on our improved team permissions, check out our [documentation][understanding-team-permissions].
44+
45+
### Filtering organization members by role
46+
47+
The organization [Members list][org-members-list] API now accepts a `role` parameter, so that you can request to see only the owners (or non-owners) of your organization.
48+
49+
### Repository collaborators
50+
51+
We now allow you to add collaborators directly to organization-owned repositories, just like we always have for user-owned repositories.
52+
53+
The collaborator APIs now support organization-owned repositories:
54+
55+
- The [Add user as a collaborator][add-collab] API works for organization-owned repositories. We've also added a `permission` parameter to it (currently valid for organization-owned repositories only), so that you can specify what level of access the collaborator should have on the repository.
56+
- In the [List collaborators][list-collabs] API, the response includes a `permissions` attribute describing the permissions that each collaborator has on your organization's repositories.
57+
58+
## Preview period
59+
60+
Starting today, these API enhancements are available for developers to preview. At the end of the preview period, these enhancements will become official components of the GitHub API.
61+
62+
While these enhancements are in their preview period, you'll need to provide the following [custom media type][custom-media-types] in the `Accept` header:
63+
64+
application/vnd.github.ironman-preview+json
65+
66+
During the preview period, we may change aspects of these enhancements. If we do, we will announce the changes on the developer blog, but we will not provide any advance notice.
67+
68+
## Send us your feedback
69+
70+
We would love to hear your thoughts on these enhancements. If you have any questions or feedback, please [get in touch with us][contact]!
71+
72+
[dotcom-blog-post]: https://github.com/blog/2020-improved-organization-permissions
73+
[understanding-team-permissions]: https://help.github.com/articles/improved-organization-permissions/#understanding-team-permissions
74+
[create-team]: /v3/orgs/teams/#create-team
75+
[edit-team]: /v3/orgs/teams/#edit-team
76+
[list-team-members]: /v3/orgs/teams/#list-team-members
77+
[get-team-membership]: /v3/orgs/teams/#get-team-membership
78+
[add-team-membership]: /v3/orgs/teams/#add-team-membership
79+
[list-team-repos]: /v3/orgs/teams/#list-team-repos
80+
[get-team-repo]: /v3/orgs/teams/#get-team-repo
81+
[add-team-repo]: /v3/orgs/teams/#add-team-repo
82+
[org-members-list]: /v3/orgs/members/#members-list
83+
[org-public-members-list]: /v3/orgs/members/#public-members-list
84+
[list-collabs]: /v3/repos/collaborators/#list
85+
[add-collab]: /v3/repos/collaborators/#add-collaborator
86+
[contact]: https://github.com/contact?form[subject]=Organization+Permissions+API
87+
[team-mentions]: https://github.com/blog/1121-introducing-team-mentions
88+
[custom-media-types]: /v3/media/
Collapse file
+18Lines changed: 18 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
kind: change
3+
title: Breaking changes to organization permissions are now official
4+
created_at: 2015-06-24
5+
author_name: jakeboxer
6+
---
7+
8+
As [promised earlier this month][notice], the [API changes][api-changes] related to managing organization members and repositories are now official parts of the GitHub API.
9+
10+
During the migration period, you needed to [provide a custom media type in the `Accept` header][migration-period] to opt-in to the changes. Now that the migration period has ended, you no longer need to specify this custom [media type][media-types].
11+
12+
If you have any questions or feedback, please [get in touch with us][contact]!
13+
14+
[notice]: /changes/2015-06-10-breaking-changes-to-organization-permissions-coming-on-june-24
15+
[api-changes]: /changes/2014-12-08-organization-permissions-api-preview/
16+
[contact]: https://github.com/contact?form[subject]=Organization+Permissions+API
17+
[media-types]: /v3/media
18+
[migration-period]: /changes/2015-06-10-breaking-changes-to-organization-permissions-coming-on-june-24/#migration-period
Collapse file
+22Lines changed: 22 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
kind: change
3+
title: Licenses API update
4+
created_at: 2015-06-24
5+
author_name: mislav
6+
---
7+
8+
We are expanding the [Licenses API](/v3/licenses) to make it more useful for auditing license usage across all repositories owned by a user or organization.
9+
10+
Before, license information was only returned for an individual repository:
11+
12+
GET /repos/github/hubot
13+
14+
Now, license information will also be included in reponses from endpoints that list multiple repositories, such as [List organization repositories](/v3/repos/#list-organization-repositories):
15+
16+
GET /orgs/github/repos
17+
18+
As before, to access the API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header:
19+
20+
application/vnd.github.drax-preview+json
21+
22+
For more information, see the [Licenses API documentation](/v3/licenses/), and if you have any questions or feedback, please [let us know](https://github.com/contact?form%5Bsubject%5D=Licenses+API).
Collapse file

‎content/guides/discovering-resources-for-a-user.md‎

Copy file name to clipboardExpand all lines: content/guides/discovering-resources-for-a-user.md
+2-12Lines changed: 2 additions & 12 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,7 @@ As always, first we'll require [GitHub's Octokit.rb][octokit.rb] Ruby library. T
2828

2929
Octokit.auto_paginate = true
3030

31-
Next, we want to opt in to the [upcoming improvements to the repository listing API][list-repositories-for-current-user]. To do so, we'll set the media type that gives us access to that functionality.
32-
33-
#!ruby
34-
Octokit.default_media_type = "application/vnd.github.moondragon+json"
35-
36-
Now, we'll pass in our application's [OAuth token for a given user][make-authenticated-request-for-user]:
31+
Next, we'll pass in our application's [OAuth token for a given user][make-authenticated-request-for-user]:
3732

3833
#!ruby
3934
# !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!!
@@ -67,12 +62,7 @@ Just as we did when discovering repositories above, we'll start by requiring [Gi
6762

6863
Octokit.auto_paginate = true
6964

70-
Next, we'll opt in to the [upcoming enhancements to the organization listing API][list-orgs-for-current-user]. To do so, we'll set the media type that gives us access to that functionality.
71-
72-
#!ruby
73-
Octokit.default_media_type = "application/vnd.github.moondragon+json"
74-
75-
Now, we'll pass in our application's [OAuth token for a given user][make-authenticated-request-for-user] to initialize our API client:
65+
Next, we'll pass in our application's [OAuth token for a given user][make-authenticated-request-for-user] to initialize our API client:
7666

7767
#!ruby
7868
# !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!!

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.