Skip to content

Commit 3e30ea0

Browse files
author
Jake Boxer
committed
Conflicts:
 content/guides/best-practices-for-integrators.md
1 parent ff6fd9d commit 3e30ea0

5 files changed

Lines changed: 27 additions & 84 deletions

File tree

‎content/changes/2014-09-23-one-more-week-before-the-add-team-member-api-breaking-change.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
kind: change
3+
title: One more week before the "Add team member" API breaking change
4+
created_at: 2014-09-23
5+
author_name: jakeboxer
6+
---
7+
8+
We're delaying the breaking change to the ["Add team member" API][add-team-member] by another week to give developers more time to update their applications.
9+
10+
The [breaking change to the "Add team member" API][finalizing] will go into effect for all requests on **September 30, 2014**. At that time, if you use [the "Add team member" API][add-team-member] to add a user to a team and that user isn't already on another team in your organization, the request will fail. To avoid this, be sure to use the [the "Add team membership" API][add-team-membership].
11+
12+
### The Organization and Team Membership APIs are now official
13+
14+
As promised in [our blog post last week][finalizing], the [Organization Membership][org-membership-api] and [Team Membership][team-membership-api] APIs are now an official part of the GitHub API! The preview media type is no longer required to access them.
15+
16+
If you have any questions or feedback, please [get in touch with us][contact]!
17+
18+
[add-team-member]: /v3/orgs/teams/#add-team-member
19+
[add-team-membership]: /v3/orgs/teams/#add-team-membership
20+
[finalizing]: /changes/2014-09-16-finalizing-the-organization-and-team-membership-apis/
21+
[org-membership-api]: /changes/2014-08-28-accepting-organization-invitations-from-the-api/
22+
[team-membership-api]: /changes/2014-08-05-team-memberships-api/
23+
[contact]: https://github.com/contact?form[subject]=Organization+and+Team+Membership+APIs

‎content/guides/best-practices-for-integrators.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,29 +41,29 @@ Users can dig into the server responses you send back to GitHub. Ensure that you
4141

4242
![Viewing a payload response](/images/payload_response_tab.png)
4343

44-
## Follow any redirects that the API sends you
44+
### Follow any redirects that the API sends you
4545

4646
GitHub is explicit in telling you when a resource has moved by providing a redirect status code. You should follow these redirections. Every redirect response sets the `Location` header with the new URI to go to. If you receive a redirect, it's best to update your code to follow the new URI, in case you're requesting a deprecated path that we might remove.
4747

4848
We've provided [a list of HTTP status codes](/v3/#http-redirects) to watch out for when designing your app to follow redirects.
4949

50-
## Don't manually parse URLs
50+
### Don't manually parse URLs
5151

5252
Often, API responses contain data in the form of URLs. For example, when requesting a repository, we'll send a key called `clone_url` with a URL you can use to clone the repository.
5353

5454
For the stability of your app, you shouldn't try to parse this data or try to guess and construct the format of future URLs. Your app is liable to break if we decide to change the URL.
5555

5656
For example, when working with paginated results, it's often tempting to construct URLs that append `?page=<number>` to the end. Avoid that temptation. [Our guide on pagination](/guides/traversing-with-pagination) offers some safe tips on dependably following paginated results.
5757

58-
## Dealing with rate limits
58+
### Dealing with rate limits
5959

6060
The GitHub API [rate limit](/v3/#rate-limiting) ensures that the API is fast and available for everyone.
6161

6262
If you hit a rate limit, it's expected that you back off from making requests and try again later when you're permitted to do so. Failure to do so may result in the banning of your app.
6363

6464
You can always [check your rate limit status](/v3/rate_limit/) at any time. Checking your rate limit incurs no cost against your rate limit.
6565

66-
## Dealing with API errors
66+
### Dealing with API errors
6767

6868
Although your code would never introduce a bug, you may find that you've encountered successive errors when trying to access the API.
6969

‎content/libraries.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,12 +161,10 @@ covers the entire API.
161161
## Ruby
162162

163163
* [GitHub API Gem][ghapi]
164-
* [Octocat Herder][herder]
165164
* [GitHub v3 API][ruby1]
166165
* [GitHub API Client][ruby2]
167166
* [Ghee][ghee]
168167

169-
[herder]: https://github.com/jhelwig/octocat_herder
170168
[ghapi]: https://github.com/peter-murach/github
171169
[ruby1]: https://github.com/jwilger/github-v3-api
172170
[ruby2]: https://github.com/okonski/github-api-client

‎content/v3/orgs/members.md‎

Lines changed: 0 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -118,19 +118,6 @@ The user can publicize their own membership.
118118

119119
## List your organization memberships
120120

121-
<div class="alert">
122-
<p>
123-
The Organization Memberships API is currently available for developers to preview.
124-
During the preview period, the API may change without notice.
125-
Please see the <a href="/changes/2014-08-28-accepting-organization-invitations-from-the-api/">blog post</a> for full details.
126-
</p>
127-
128-
<p>
129-
To access the API during the preview period, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> header:
130-
<pre>application/vnd.github.the-wasp-preview+json</pre>
131-
</p>
132-
</div>
133-
134121
An optional `state` can be passed to request only pending or active memberships.
135122

136123
GET /user/memberships/orgs
@@ -154,19 +141,6 @@ An optional `state` can be passed to request only pending or active memberships.
154141

155142
## Get your organization membership
156143

157-
<div class="alert">
158-
<p>
159-
The Organization Memberships API is currently available for developers to preview.
160-
During the preview period, the API may change without notice.
161-
Please see the <a href="/changes/2014-08-28-accepting-organization-invitations-from-the-api/">blog post</a> for full details.
162-
</p>
163-
164-
<p>
165-
To access the API during the preview period, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> header:
166-
<pre>application/vnd.github.the-wasp-preview+json</pre>
167-
</p>
168-
</div>
169-
170144
GET /user/memberships/orgs/:org
171145

172146
### Response
@@ -176,19 +150,6 @@ An optional `state` can be passed to request only pending or active memberships.
176150

177151
## Edit your organization membership
178152

179-
<div class="alert">
180-
<p>
181-
The Organization Memberships API is currently available for developers to preview.
182-
During the preview period, the API may change without notice.
183-
Please see the <a href="/changes/2014-08-28-accepting-organization-invitations-from-the-api/">blog post</a> for full details.
184-
</p>
185-
186-
<p>
187-
To access the API during the preview period, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> header:
188-
<pre>application/vnd.github.the-wasp-preview+json</pre>
189-
</p>
190-
</div>
191-
192153
PATCH /user/memberships/orgs/:org
193154

194155
### Input

‎content/v3/orgs/teams.md‎

Lines changed: 0 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -174,19 +174,6 @@ NOTE: This does not delete the user, it just removes them from the team.
174174

175175
## Get team membership
176176

177-
<div class="alert">
178-
<p>
179-
The Team Memberships API is currently available for developers to preview.
180-
During the preview period, the API may change without notice.
181-
Please see the <a href="/changes/2014-08-05-team-memberships-api/">blog post</a> for full details.
182-
</p>
183-
184-
<p>
185-
To access the API during the preview period, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> header:
186-
<pre>application/vnd.github.the-wasp-preview+json</pre>
187-
</p>
188-
</div>
189-
190177
In order to get a user's membership with a team, the authenticated user must be
191178
a member of the team or an owner of the team's organization.
192179

@@ -208,19 +195,6 @@ a member of the team or an owner of the team's organization.
208195

209196
## Add team membership
210197

211-
<div class="alert">
212-
<p>
213-
The Team Memberships API is currently available for developers to preview.
214-
During the preview period, the API may change without notice.
215-
Please see the <a href="/changes/2014-08-05-team-memberships-api/">blog post</a> for full details.
216-
</p>
217-
218-
<p>
219-
To access the API during the preview period, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> header:
220-
<pre>application/vnd.github.the-wasp-preview+json</pre>
221-
</p>
222-
</div>
223-
224198
In order to add a membership between a user and a team, the authenticated user
225199
must have 'admin' permissions to the team or be an owner of the organization
226200
that the team is associated with.
@@ -262,19 +236,6 @@ If you attempt to add an organization to a team, you will get this:
262236

263237
## Remove team membership
264238

265-
<div class="alert">
266-
<p>
267-
The Team Memberships API is currently available for developers to preview.
268-
During the preview period, the API may change without notice.
269-
Please see the <a href="/changes/2014-08-05-team-memberships-api/">blog post</a> for full details.
270-
</p>
271-
272-
<p>
273-
To access the API during the preview period, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> header:
274-
<pre>application/vnd.github.the-wasp-preview+json</pre>
275-
</p>
276-
</div>
277-
278239
In order to remove a membership between a user and a team, the authenticated
279240
user must have 'admin' permissions to the team or be an owner of the
280241
organization that the team is associated with.

0 commit comments

Comments
 (0)