Skip to content

Commit 191225c

Browse files
committed
Merge branch 'developer-next-groundwork'
Conflicts: layouts/default.html
2 parents 9cb8589 + 5d1f750 commit 191225c

77 files changed

Lines changed: 1072 additions & 1091 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Rules

100644100755
Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,29 +21,37 @@ compile '/feed/' do
2121
filter :kramdown, :toc_levels => [2]
2222
end
2323

24+
compile '/v3/*' do
25+
filter :erb
26+
filter :kramdown, :toc_levels => [2]
27+
filter :colorize_syntax,
28+
:colorizers => {:javascript => :pygmentsrb}
29+
layout item[:layout] || 'api'
30+
end
31+
2432
%w(v3 */).each do |version|
2533
compile "/changes/#{version}" do
2634
filter :erb
2735
filter :kramdown, :toc_levels => [2]
2836
filter :colorize_syntax,
2937
:colorizers => {:javascript => :pygmentsrb}
3038
layout 'changes' if version[0] == '*'
31-
layout 'default'
39+
layout item[:layout] || 'blog'
3240
end
3341
end
3442

3543
compile '/guides/*' do
3644
filter :kramdown, :toc_levels => [2]
3745
filter :erb
38-
layout 'default'
46+
layout item[:layout] || 'guides'
3947
end
4048

4149
compile '*' do
4250
filter :erb
4351
filter :kramdown, :toc_levels => [2]
4452
filter :colorize_syntax,
4553
:colorizers => {:javascript => :pygmentsrb}
46-
layout 'default'
54+
layout item[:layout] || 'default'
4755
end
4856

4957
route '/static/*' do

content/changes/2013-04-25-deprecating-merge-commit-sha.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
attribute](/v3/pulls/#mergability) for improved understanding.
1717

1818
To protect future API consumers from this confusion, we have
19-
[deprecated](/#deprecations) the `merge_commit_sha` attribute, and we will
19+
[deprecated](/v3/#deprecations) the `merge_commit_sha` attribute, and we will
2020
remove it in the next major version of the API.
2121

2222
As always, if you have any questions or feedback, please drop us a line at

content/changes/index.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
title: GitHub API Changes
3+
layout: blog
34
---
45

5-
# API Changes
6-
76
<%= render '_changes', :changes => api_changes %>
87

content/guides/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Development Guides | GitHub API
3+
layout: guides
34
---
45

56
# Development Guides
@@ -13,3 +14,5 @@ stored and documented in our public
1314
[platform-samples](https://github.com/github/platform-samples) repo.
1415

1516
Feel free to fork, clone, and improve these guides.
17+
18+
![](/images/professorcat.png)

content/index.md

Lines changed: 33 additions & 103 deletions
Original file line numberDiff line numberDiff line change
@@ -1,107 +1,37 @@
11
---
2-
title: GitHub API
2+
title: GitHub Developer
3+
layout: overview
34
---
45

5-
# The GitHub API
6+
<div class="wrapper feature">
7+
<h1>Leverage the power of<br />
8+
GitHub in your app</h1>
9+
<p class="intro">Get started with one of our guides, or jump straight into the API documentation.</p>
10+
<a href="/v3/" class="button">Browse the documentation</a>
11+
<img src="/shared/images/labtocat.png" class="labtocat" />
12+
</div>
13+
14+
<div class="full-width-divider">
15+
<ul class="wrapper highlights">
16+
<li>
17+
<h2>Get Started</h2>
18+
<p>New to the GitHub API? With these guides you’ll be up and running in a snap.</p>
19+
<a href="/guides/" class="button-secondary">View introduction guides</a>
20+
<img class="octocat professorcat" src="/shared/images/professorcat.png">
21+
</li>
22+
<li>
23+
<h2>Libraries</h2>
24+
<p>We’ve got you covered. Use the GitHub API in your favorite language.</p>
25+
<a href="/libraries/" class="button-secondary">Browse libraries</a>
26+
<img class="octocat" src="/shared/images/gundamcat-small.png">
27+
</li>
28+
<li>
29+
<h2>Support</h2>
30+
<p>Are you stuck? Already tried our <a href="/v3/troubleshooting/">troubleshooting guide</a>? Talk to a supportocat.</p>
31+
<a href="http://github.com/contact" class="button-secondary">Get in touch</a>
32+
<img class="octocat" src="/shared/images/supportocat.png">
33+
</li>
34+
35+
</ul>
36+
</div>
637

7-
This describes the resources that make up the official GitHub API v3. If
8-
you have any problems or requests please contact
9-
[support](https://github.com/contact?form[subject]=APIv3).
10-
11-
For the new API v3, start browsing the resources on the right >>
12-
13-
View the [API Changelog](/changes) for information on existing and
14-
planned changes to the API.
15-
16-
## Current Version
17-
18-
Accept: application/vnd.github.beta+json
19-
20-
The GitHub API version is currently in beta. [The `beta` media type](/v3/media/)
21-
property will be valid until sometime in 2013. A notice will be given closer
22-
to the actual date.
23-
24-
We consider the "beta" API unchangeable. [File a support issue](https://github.com/contact)
25-
if you have problems.
26-
27-
### Deprecations
28-
29-
The following functionality is deprecated. For backwards compatibility purposes,
30-
API v3 will continue to provide this functionality. However, this deprecated
31-
functionality **will be removed** in the _next_ major version of the API.
32-
33-
The recommendations below will help you prepare your application for the next major version of the API.
34-
35-
1. Method: /gists/:id/fork
36-
: Recommendation: Use **/gists/:id/forks** (plural) instead.
37-
38-
1. Method: /legacy/issues/search/:owner/:repository/:state/:keyword
39-
: Recommendation: Use [v3 Issue Search API](v3/search/#search-issues) instead.
40-
41-
1. Method: /legacy/repos/search/:keyword
42-
: Recommendation: Use [v3 Repository Search API](/v3/search/#search-repositories) instead.
43-
44-
1. Method: /legacy/user/search/:keyword
45-
: Recommendation: Use [v3 User Search API](/v3/search/#search-users) instead.
46-
47-
1. Method: /legacy/user/email/:email
48-
: Recommendation: Use [v3 User Search API](/v3/search/#search-users) instead.
49-
50-
1. Method: /repos/:owner/:repo/hooks/:id/test
51-
: Recommendation: Use **/repos/:owner/:repo/hooks/:id/tests** (plural) instead.
52-
53-
1. Query parameters when POSTing to /repos/:owner/:repo/forks
54-
: Recommendation: Use JSON to POST to this method instead.
55-
56-
1. Pull Request attribute: merge_commit_sha
57-
: Recommendation: [Do not use this attribute](/changes/2013-04-25-deprecating-merge-commit-sha/).
58-
59-
1. Rate Limit attribute: rate
60-
: Recommendation: Use **resources["core"]** instead.
61-
62-
1. Repository attribute: forks
63-
: Recommendation: Use **fork_count** instead.
64-
65-
1. Repository attribute: master_branch
66-
: Recommendation: Use **default_branch** instead.
67-
68-
1. Repository attribute: open_issues
69-
: Recommendation: Use **open_issues_count** instead.
70-
71-
1. Repository attribute: public
72-
: Recommendation: When [creating a repository](/v3/repos/#create), use the
73-
**private** attribute to indicate whether the repository should be public or
74-
private. Do not use the **public** attribute.
75-
76-
1. Repository attribute: watchers
77-
: Recommendation: Use **watchers_count** instead.
78-
79-
1. User attribute: bio
80-
: Recommendation: Do not use this attribute. It is obsolete.
81-
82-
### Breaking Beta Changes
83-
84-
##### June 12, 2012:
85-
* Removed API v1 support
86-
* Removed API v2 support
87-
88-
##### June 15th, 2011:
89-
90-
* `gravatar_url` is being deprecated in favor of `avatar_url` for all
91-
responses that include users or orgs. A default size is no longer
92-
included in the URL.
93-
* Creating new gists (both anonymously and with an authenticated user)
94-
should use `POST /gists` from now on. `POST /users/:user/gists` is no
95-
longer supported.
96-
97-
##### June 1st, 2011:
98-
99-
* Removed support for PUT verb on update requests. Use POST or PATCH
100-
instead.
101-
* Removed `.json` extension from all URLs.
102-
* No longer using the X-Next or X-Last headers. Pagination info is
103-
returned in the Link header instead.
104-
* JSON-P response has completely changed to a more consistent format.
105-
* Starring gists now uses PUT verb (instead of POST) and returns 204.
106-
107-
[v3-email]: /v3/users/emails/#future-response
Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,28 @@
11
---
22
title: Libraries | GitHub API
3+
layout: libraries
34
---
45

5-
# Libraries
6+
<div class="feature">
7+
<h1>Octokit comes in<br />
8+
many flavors</h1>
9+
<p class="intro">Use the official Octokit library, or choose between any of the available third party libraries.</p>
10+
<ul class="library-links">
11+
<li><span>Ruby</span><a href="https://github.com/octokit/octokit.rb">octokit.rb</a></li>
12+
<li><span>Obj-C</span><a href="https://github.com/octokit/octokit.objc">octokit.objc</a></li>
13+
<li><span>.NET</span><a href="https://github.com/octokit/octokit.net">octokit.net</a></li>
14+
</ul>
15+
<img src="/shared/images/gundamcat.png" class="gundamcat" />
16+
</div>
617

7-
Libraries for accessing the GitHub API from your favorite language.
18+
# Third-party libraries
819

920
## .NET
1021

11-
* **[Octokit][octokit.net]** (officially maintained by GitHub)
1222
* [IronGithub][irongithub]
1323
* [CSharp GitHub API][csharp]
1424
* [FSharp.GitHubApi][fsharp]
1525

16-
[octokit.net]: https://github.com/octokit/octokit.net
1726
[irongithub]: https://github.com/in2bits/IronGitHub
1827
[csharp]: https://github.com/sgrassie/csharp-github-api
1928
[fsharp]: https://github.com/saxonmatt/FSharp.GitHubApi
@@ -77,10 +86,8 @@ GitHub v3 API. Builds are available in [Maven Central](http://search.maven.org/
7786

7887
## Objective-C
7988

80-
* **[OctoKit][octokit.objc]** (officially maintained by GitHub)
8189
* [UAGithubEngine][uagithubengine]
8290

83-
[octokit.objc]: https://github.com/octokit/octokit.objc
8491
[uagithubengine]: http://github.com/owainhunt/uagithubengine
8592

8693
## OCaml
@@ -139,14 +146,12 @@ GitHub v3 API. Builds are available in [Maven Central](http://search.maven.org/
139146

140147
## Ruby
141148

142-
* **[Octokit][octokit.rb]** (officially maintained by GitHub)
143149
* [GitHub API Gem][ghapi]
144150
* [Octocat Herder][herder]
145151
* [GitHub v3 API][ruby1]
146152
* [GitHub API Client][ruby2]
147153
* [Ghee][ghee]
148154

149-
[octokit.rb]: https://github.com/octokit/octokit.rb
150155
[herder]: https://github.com/jhelwig/octocat_herder
151156
[ghapi]: https://github.com/peter-murach/github
152157
[ruby1]: https://github.com/jwilger/github-v3-api

content/v3.md

Lines changed: 93 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,25 @@
22
title: GitHub API v3
33
---
44

5-
# API v3
5+
# Overview
66

7-
This describes the resources that make up the official GitHub API v3. If
8-
you have any problems or requests please contact
7+
This describes the resources that make up the official GitHub API v3. If you have any problems or requests please contact
98
[support][].
109

1110
* TOC
1211
{:toc}
1312

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+
1424
## Schema
1525

1626
All API access is over HTTPS, and accessed from the `api.github.com`
@@ -537,4 +547,84 @@ A link that looks like this:
537547
["url1", {:rel => "next"}],
538548
["url2", {:rel => "foo", :bar => "baz"}]] %>
539549

550+
## Deprecations
551+
552+
The following functionality is deprecated. For backwards compatibility purposes,
553+
API v3 will continue to provide this functionality. However, this deprecated
554+
functionality **will be removed** in the _next_ major version of the API.
555+
556+
The recommendations below will help you prepare your application for the next major version of the API.
557+
558+
1. Method: /gists/:id/fork
559+
: Recommendation: Use **/gists/:id/forks** (plural) instead.
560+
561+
1. Method: /legacy/issues/search/:owner/:repository/:state/:keyword
562+
: Recommendation: Use [v3 Issue Search API](v3/search/#search-issues) instead.
563+
564+
1. Method: /legacy/repos/search/:keyword
565+
: Recommendation: Use [v3 Repository Search API](/v3/search/#search-repositories) instead.
566+
567+
1. Method: /legacy/user/search/:keyword
568+
: Recommendation: Use [v3 User Search API](/v3/search/#search-users) instead.
569+
570+
1. Method: /legacy/user/email/:email
571+
: Recommendation: Use [v3 User Search API](/v3/search/#search-users) instead.
572+
573+
1. Method: /repos/:owner/:repo/hooks/:id/test
574+
: Recommendation: Use **/repos/:owner/:repo/hooks/:id/tests** (plural) instead.
575+
576+
1. Query parameters when POSTing to /repos/:owner/:repo/forks
577+
: Recommendation: Use JSON to POST to this method instead.
578+
579+
1. Pull Request attribute: merge_commit_sha
580+
: Recommendation: [Do not use this attribute](/changes/2013-04-25-deprecating-merge-commit-sha/).
581+
582+
1. Rate Limit attribute: rate
583+
: Recommendation: Use **resources["core"]** instead.
584+
585+
1. Repository attribute: forks
586+
: Recommendation: Use **fork_count** instead.
587+
588+
1. Repository attribute: master_branch
589+
: Recommendation: Use **default_branch** instead.
590+
591+
1. Repository attribute: open_issues
592+
: Recommendation: Use **open_issues_count** instead.
593+
594+
1. Repository attribute: public
595+
: Recommendation: When [creating a repository](/v3/repos/#create), use the
596+
**private** attribute to indicate whether the repository should be public or
597+
private. Do not use the **public** attribute.
598+
599+
1. Repository attribute: watchers
600+
: Recommendation: Use **watchers_count** instead.
601+
602+
1. User attribute: bio
603+
: Recommendation: Do not use this attribute. It is obsolete.
604+
605+
### Breaking Beta Changes
606+
607+
#### June 12, 2012:
608+
* Removed API v1 support
609+
* Removed API v2 support
610+
611+
#### June 15th, 2011:
612+
613+
* `gravatar_url` is being deprecated in favor of `avatar_url` for all
614+
responses that include users or orgs. A default size is no longer
615+
included in the URL.
616+
* Creating new gists (both anonymously and with an authenticated user)
617+
should use `POST /gists` from now on. `POST /users/:user/gists` is no
618+
longer supported.
619+
620+
#### June 1st, 2011:
621+
622+
* Removed support for PUT verb on update requests. Use POST or PATCH
623+
instead.
624+
* Removed `.json` extension from all URLs.
625+
* No longer using the X-Next or X-Last headers. Pagination info is
626+
returned in the Link header instead.
627+
* JSON-P response has completely changed to a more consistent format.
628+
* Starring gists now uses PUT verb (instead of POST) and returns 204.
629+
540630
[support]: https://github.com/contact?form[subject]=APIv3

content/v3/activity.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Activity | GitHub API
33
---
4+
#Activity
45

56
Serving up the 'social' in Social Coding™, the Activity APIs provide access to
67
notifications, subscriptions, and timelines.

0 commit comments

Comments
 (0)