Skip to content

Commit 3ed00d3

Browse files
committed
Merge the two overview articles
1 parent c629312 commit 3ed00d3

2 files changed

Lines changed: 62 additions & 76 deletions

File tree

content/overview.md

Lines changed: 0 additions & 76 deletions
This file was deleted.

content/v3.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,68 @@ This describes the resources that make up the official GitHub API v3. If you hav
1010
* TOC
1111
{:toc}
1212

13+
## Current Version
14+
15+
Accept: application/vnd.github.beta+json
16+
17+
The GitHub API version is currently in beta. [The `beta` media type](/v3/media/)
18+
property will be valid until sometime in 2013. A notice will be given closer
19+
to the actual date.
20+
21+
We consider the "beta" API unchangeable. [File a support issue](https://github.com/contact)
22+
if you have problems.
23+
24+
#### Expected Changes
25+
26+
These changes are _not_ implemented, just planned for the next major API version.
27+
28+
* `[ ]` Standardize on existing `*_url` attributes for hypermedia. Remove all `_links`
29+
objects.
30+
* `[✓]` <del>The '/repos/:owner/:repo/hooks/:id/test' action becomes
31+
'/repos/:owner/:repo/hooks/:id/tests'.</del>
32+
* `[✓]` <del>The '/gists/:id/fork' action becomes '/gists/:id/forks'.</del>
33+
* `[ ]` Gist forks/history objects become separate API calls.
34+
* `[ ]` Gist files object is not returned on Gist listings.
35+
* `[ ]` Commit schema will change to be [more consistent](https://gist.github.com/3a2e5779588e21b0c0f3).
36+
* `[ ]` `master_branch` becomes `default_branch`.
37+
* `[ ]` `integrate_branch` on the [repo API](/v3/repos/#get) will no longer be
38+
returned.
39+
* `[ ]` `merge_commit_sha` on the [pull request API](/v3/pulls/#get-a-single-pull-request)
40+
will no longer be returned.
41+
* `[ ]` Use the `private` attribute when creating a private repository,
42+
instead of setting `public` to false.
43+
* `[ ]` Use JSON to POST to the "repos/:owner/:repo/forks" endpoint, instead of a query string.
44+
* `[✓]` <del>User Emails come back [as a hash][v3-email] instead of a string.</del>
45+
* `[ ]` Remove the unused "bio" field for Users.
46+
* `[ ]` When listing the contents of a directory in the [Repository Contents API](/v3/repos/contents/#get-contents), fix the `type` value returned for submodules: change the value to `"submodule"` (instead of `"file"`).
47+
48+
### Breaking Beta Changes
49+
50+
##### June 12, 2012:
51+
* Removed API v1 support
52+
* Removed API v2 support
53+
54+
##### June 15th, 2011:
55+
56+
* `gravatar_url` is being deprecated in favor of `avatar_url` for all
57+
responses that include users or orgs. A default size is no longer
58+
included in the URL.
59+
* Creating new gists (both anonymously and with an authenticated user)
60+
should use `POST /gists` from now on. `POST /users/:user/gists` is no
61+
longer supported.
62+
63+
##### June 1st, 2011:
64+
65+
* Removed support for PUT verb on update requests. Use POST or PATCH
66+
instead.
67+
* Removed `.json` extension from all URLs.
68+
* No longer using the X-Next or X-Last headers. Pagination info is
69+
returned in the Link header instead.
70+
* JSON-P response has completely changed to a more consistent format.
71+
* Starring gists now uses PUT verb (instead of POST) and returns 204.
72+
73+
[v3-email]: /v3/users/emails/#future-response
74+
1375
## Schema
1476

1577
All API access is over HTTPS, and accessed from the `api.github.com`

0 commit comments

Comments
 (0)