Movatterモバイル変換

[0]ホーム
URL:

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

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

Commit65be038

Browse files
committed
Communicate that v3 is the default version
- Update all mentions of the "default" version to communicate that v3 is now the default.- Update the example responses to show the v3 representation.- Remove the *inline* notes that explained how the v3 representation differs from the default representation. (Note that we still provide a consolidated list of differences between beta and v3 [1]).[1]:https://developer.github.com/v3/versions/#differences-from-beta-version
1 parentfd5c0e6 commit65be038

File tree

11 files changed

+51
-81
lines changed

11 files changed

+51
-81
lines changed

‎content/changes/2014-01-07-upcoming-change-to-default-media-type.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,5 +58,5 @@ If you have any questions, please [get in touch][contact]. We'll be happy to hel
5858
[differences]:/v3/versions/#differences-from-beta-version
5959
[libraries]:/libraries/
6060
[media]:/v3/media
61-
[request-a-media-type]:/v3/media/#beta-v3-and-the-future
61+
[request-a-media-type]:/v3/media/#request-specific-version
6262
[versions]:/v3/versions

‎content/changes/2014-03-18-paginating-method-changes.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Here's the complete list of updated methods:
112112
[Repository keys]:/v3/repos/keys/#list
113113
[Repository labels]:/v3/issues/labels/#list-all-labels-for-this-repository
114114
[Team repositories]:/v3/orgs/teams/#list-team-repos
115-
[User emails]:/v3/users/emails/#future-response
115+
[User emails]:/v3/users/emails/#list-email-addresses-for-a-user
116116
[User keys]:/v3/users/keys/#list-public-keys-for-a-user
117117
[Issue labels]:/v3/issues/labels/#list-labels-on-an-issue
118118
[Milestone labels]:/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone

‎content/guides/getting-started.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ ETag: "bfd85cbf23ac0b0c8a29bee02e7117c6"
6060
X-RateLimit-Limit: 60
6161
X-RateLimit-Remaining: 57
6262
X-RateLimit-Reset: 1352660008
63-
X-GitHub-Media-Type: github.beta
63+
X-GitHub-Media-Type: github.v3
6464
Vary: Accept
6565
Cache-Control: public, max-age=60, s-maxage=60
6666
X-Content-Type-Options: nosniff
@@ -82,7 +82,7 @@ There are a few interesting bits in the response headers. As expected, the
8282
Any headers beginning with`X-` are custom headers, and are not included in the
8383
HTTP spec. Let's take a look at a few of them:
8484

85-
*`X-GitHub-Media-Type` has a value of`github.beta`. This lets us know the[media type][media types]
85+
*`X-GitHub-Media-Type` has a value of`github.v3`. This lets us know the[media type][media types]
8686
for the response. Media types have helped us version our output in API v3. We'll
8787
talk more about that later.
8888
* Take note of the`X-RateLimit-Limit` and`X-RateLimit-Remaining` headers. This

‎content/v3.md‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,11 @@ This describes the resources that make up the official GitHub API v3. If you hav
1212

1313
##Current Version
1414

15-
There are[two versions](/v3/versions) of the GitHub API:**beta** and**v3**. By default, all requests receive thebeta version:
15+
There are[two versions](/v3/versions) of the GitHub API:**v3** and**beta**. By default, all requests receive thev3 version:
1616

17-
Accept: application/vnd.github.beta+json
17+
Accept: application/vnd.github.v3+json
1818

19-
Soon, v3 will become the default version. Check out the[blog post](/changes/2014-01-07-upcoming-change-to-default-media-type/) for details.
20-
21-
We encourage you to[request a specific version via the`Accept` header](/v3/media/#beta-v3-and-the-future).
19+
We encourage you to[request a specific version via the`Accept` header](/v3/media/#request-specific-version).
2220

2321
##Schema
2422

@@ -36,7 +34,7 @@ Content-Type: application/json; charset=utf-8
3634
Connection: keep-alive
3735
Status: 200 OK
3836
ETag: "a00049ba79152d03380c34652f2cb612"
39-
X-GitHub-Media-Type: github.beta
37+
X-GitHub-Media-Type: github.v3
4038
X-RateLimit-Limit: 5000
4139
X-RateLimit-Remaining: 4987
4240
X-RateLimit-Reset: 1350085394

‎content/v3/gists.md‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,6 @@ Name | Type | Description
5151

5252
###Response
5353

54-
<divclass="alert">
55-
<p>
56-
<strong>Note</strong>: When using the <a href="/v3/media/#beta-v3-and-the-future">v3 media type</a>, the <code>user</code> attribute is renamed to <code>owner</code>.
57-
</p>
58-
</div>
59-
6054
<%= headers 200 %>
6155
<%= json:full_gist %>
6256

‎content/v3/issues.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Name | Type | Description
7676

7777
<divclass="alert">
7878
<p>
79-
<strong>Note</strong>: Every pull request is an issue, but not every issue is a pull request.When using the <a href="/v3/media/#beta-v3-and-the-future">v3 media type</a>, if the issue is not a pull request, the response omits the <code>pull_request</code> attribute.
79+
<strong>Note</strong>: Every pull request is an issue, but not every issue is a pull request.If the issue is not a pull request, the response omits the <code>pull_request</code> attribute.
8080
</p>
8181
</div>
8282

‎content/v3/media.md‎

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,19 @@ The most basic media types the API supports are:
2121
application/json
2222
application/vnd.github+json
2323

24-
Neither of these specify a[version][versions], so you will always get the current default
25-
JSON representation of resources. If you're building an application and
26-
care about the stability of the API, specify a version like so:
24+
Neither of these specify a[version][versions], so you will always get the
25+
current default JSON representation of resources.
26+
27+
<divclass="alert"id="request-specific-version">
28+
<p>
29+
<strong>Important</strong>: The default version of the API may change in the
30+
future. If you're building an application and care about the stability of
31+
the API, be sure to request a specific version in the <code>Accept</code>
32+
header as shown in the examples below.
33+
</p>
34+
</div>
35+
36+
You can specify a version like so:
2737

2838
application/vnd.github.v3+json
2939

@@ -37,33 +47,18 @@ for the `X-GitHub-Media-Type` header:
3747

3848
$ curl https://api.github.com/users/technoweenie -I
3949
HTTP/1.1 200 OK
40-
X-GitHub-Media-Type: github.beta
50+
X-GitHub-Media-Type: github.v3
4151

4252
$ curl https://api.github.com/users/technoweenie -I \
4353
-H "Accept: application/vnd.github.full+json"
4454
HTTP/1.1 200 OK
45-
X-GitHub-Media-Type: github.beta; param=full; format=json
55+
X-GitHub-Media-Type: github.v3; param=full; format=json
4656

4757
$ curl https://api.github.com/users/technoweenie -I \
4858
-H "Accept: application/vnd.github.v3.full+json"
4959
HTTP/1.1 200 OK
5060
X-GitHub-Media-Type: github.v3; param=full; format=json
5161

52-
53-
##Beta, v3, and the Future
54-
55-
If you don't specify a version in the`Accept` header, you'll
56-
get the[beta version](/v3/versions#beta) (as shown above) by default.
57-
58-
Soon,[v3](/v3/versions#v3) will become the default version. (Check out
59-
the[blog post](/changes/2014-01-07-upcoming-change-to-default-media-type/) for
60-
details.) We recommend that you start using v3 now. To get that version today,
61-
explicitly request the API v3 media type in the`Accept` header:
62-
63-
application/vnd.github.v3+json
64-
65-
Check out[version docs][versions] for the[full list of differences](/v3/versions#differences-from-beta-version) between beta and v3.
66-
6762
##Comment Body Properties
6863

6964
The body of a comment can be written in[GitHub Flavored Markdown][gfm].

‎content/v3/repos.md‎

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,6 @@ Name | Type | Description
5959
<%= headers 200,:pagination => default_pagination_rels %>
6060
<%= json(:repo) { |h|[h] } %>
6161

62-
<divclass="alert">
63-
<p>
64-
<strong>Note</strong>: When using the <a href="/v3/media/#beta-v3-and-the-future">v3 media type</a>, the response omits the <code>master_branch</code> attribute. API clients should instead use the <code>default_branch</code> attribute to obtain the repository's default branch.
65-
</p>
66-
</div>
67-
6862
##List all public repositories
6963

7064
This provides a dump of every public repository, in the order that they were created.
@@ -144,12 +138,6 @@ The `parent` and `source` objects are present when the repository is a fork.
144138
`parent` is the repository this repository was forked from,
145139
`source` is the ultimate source for the network.
146140

147-
<divclass="alert">
148-
<p>
149-
<strong>Note</strong>: When using the <a href="/v3/media/#beta-v3-and-the-future">v3 media type</a>, the response omits the <code>master_branch</code> attribute. API clients should instead use the <code>default_branch</code> attribute to obtain the repository's default branch.
150-
</p>
151-
</div>
152-
153141
<%= headers 200 %>
154142
<%= json:full_repo %>
155143

‎content/v3/users/emails.md‎

Lines changed: 12 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -18,30 +18,6 @@ This endpoint is accessible with the user:email scope.
1818

1919
###Response
2020

21-
<divclass="alert">
22-
<p>
23-
<strong>Deprecated</strong>: This response format is deprecated.
24-
The API will remove support for this response format in the future.
25-
</p>
26-
<p>
27-
We recommend that you start requesting the new response format as described
28-
in the <a href="#future-response">Future Response</a> section below.
29-
</p>
30-
</div>
31-
32-
<%= headers 200 %>
33-
<%= json["octocat@github.com", "support@github.com"] %>
34-
<br>
35-
36-
####Future Response
37-
38-
In the final version of the API, this method will return an array of hashes
39-
with extended information for each email address indicating if the address has
40-
been verified and if it's the user's primary email address for GitHub.
41-
42-
Until API v3 is finalized, use the`application/vnd.github.v3`
43-
[media type][media-types] to get this response format.
44-
4521
<%= headers 200 %>
4622
<%= json(:user_email) {|e|[e]} %>
4723

@@ -58,7 +34,18 @@ You can post a single email address or an array of addresses:
5834
###Response
5935

6036
<%= headers 201 %>
61-
<%= json["octocat@github.com", "support@github.com"] %>
37+
<%= json[
38+
{
39+
"email" => "octocat@github.com",
40+
"primary" => false,
41+
"verified" => false
42+
},
43+
{
44+
"email" => "support@github.com",
45+
"primary" => false,
46+
"verified" => false
47+
},
48+
] %>
6249

6350
##Delete email address(es)
6451

‎content/v3/versions.md‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ title: Versions | GitHub API
33
---
44
#Versions
55

6-
There are two stable versions of the GitHub API:[beta](#beta)and[v3](#v3). There are just a few[differences between these two versions](#differences-from-beta-version).
6+
There are two stable versions of the GitHub API:the[v3](#v3) versionandthe legacy[beta](#beta) version. There are just a few[differences between these two versions](#differences-from-beta-version).
77

8-
By default, all requests receive thebeta version. Soon,v3will become the defaultversion.(Check out the[blog post](/changes/2014-01-07-upcoming-change-to-default-media-type/) for details.)We encourage you to[request a specific version via the`Accept` header](/v3/media/#beta-v3-and-the-future).
8+
By default, all requests receive the v3 version. We encourage you to[request a specific version via the`Accept` header](/v3/media/#request-specific-version).
99

1010
#v3
1111

@@ -94,9 +94,17 @@ The recommendations below will help you prepare your application for the next ma
9494

9595
#beta
9696

97-
The[beta API](/v3) is now stable and unchangeable. Please[file a support issue][support] if you have problems.
98-
99-
Starting April 15, 2014, the[beta version will no longer be the_default_ version](/changes/2014-01-07-upcoming-change-to-default-media-type/). However, we expect to continue supporting the beta version for a while. We will eventually retire the beta version, but we have no official retirement date to annouce at the moment. When the time comes, rest assured that we'll announce the retirement with plenty of notice.
97+
<divclass="alert">
98+
<p>
99+
<strong>Note</strong>: We recommend using the <a href="#v3">v3 API</a>
100+
instead of the legacy beta version of the API. We will eventually retire the
101+
beta version, but we have no official retirement date to annouce at the
102+
moment. When the time comes, rest assured that we'll announce the retirement
103+
with plenty of notice.
104+
</p>
105+
</div>
106+
107+
The[beta API](/v3) is stable and unchangeable. Please[file a support issue][support] if you have problems.
100108

101109
##Breaking beta changes
102110

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp