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

Commitf9eeed7

Browse files
committed
boom
1 parent89f9a18 commitf9eeed7

File tree

11 files changed

+158
-68
lines changed

11 files changed

+158
-68
lines changed

‎v3/events/types/index.html‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ <h1 id="event-types">Event Types</h1>
4545
They’re only created for various internal and repository hooks.</p>
4646

4747
<ul>
48-
<li><ahref="#commitcommentevent">CommitComment</a></li>
48+
<li><ahref="#commitcommentevent">CommitCommentEvent</a></li>
4949
<li><ahref="#createevent">CreateEvent</a></li>
5050
<li><ahref="#deleteevent">DeleteEvent</a></li>
5151
<li><ahref="#downloadevent">DownloadEvent</a></li>
@@ -59,10 +59,11 @@ <h1 id="event-types">Event Types</h1>
5959
<li><ahref="#memberevent">MemberEvent</a></li>
6060
<li><ahref="#publicevent">PublicEvent</a></li>
6161
<li><ahref="#pullrequestevent">PullRequestEvent</a></li>
62+
<li><ahref="#pullrequestreviewcommentevent">PullRequestReviewCommentEvent</a></li>
6263
<li><ahref="#pushevent">PushEvent</a></li>
6364
<li><ahref="#teamaddevent">TeamAddEvent</a></li>
6465
<li><ahref="#watchevent">WatchEvent</a></li>
65-
</ul><h2id="commitcomment">CommitComment</h2>
66+
</ul><h2id="commitcommentevent">CommitCommentEvent</h2>
6667

6768
<p>Hook name:<code>commit_comment</code></p>
6869

@@ -241,6 +242,14 @@ <h2 id="pullrequestevent">PullRequestEvent</h2>
241242
<dt>pull_request</dt>
242243
<dd>
243244
<strong>object</strong> - The<ahref="/v3/pulls">pull request</a> itself.</dd>
245+
</dl><h2id="pullrequestreviewcommentevent">PullRequestReviewCommentEvent</h2>
246+
247+
<p>Hook name:<code>pull_request_review_comment</code></p>
248+
249+
<dl>
250+
<dt>comment</dt>
251+
<dd>
252+
<strong>object</strong> - The<ahref="/v3/repos/commits/#list-commit-comments-for-a-repository">comment</a> itself.</dd>
244253
</dl><h2id="pushevent">PushEvent</h2>
245254

246255
<p>Hook name:<code>push</code></p>

‎v3/gists/index.html‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,14 @@
3434
<divclass="content">
3535
<h1id="gists-api">Gists API</h1>
3636

37+
<h2id="authentication">Authentication</h2>
38+
39+
<p>You can read public gists and create them for anonymous users without a token; however, to read or write gists on a user’s behalf the<strong>gists</strong> [oAuth scope][1] is required.</p>
40+
41+
<!-- When an oAuth client does not have the gists scope, the API will return a 404 "Not Found" response regardless of the validity of the credentials.
42+
43+
The API will return a 401 "Bad credentials" response if the gists scope was given to the application but the credentials are invalid. -->
44+
3745
<h2id="list-gists">List gists</h2>
3846

3947
<p>List a user’s gists:</p>
@@ -42,7 +50,7 @@ <h2 id="list-gists">List gists</h2>
4250
</code></pre>
4351

4452
<p>List the authenticated user’s gists or if called anonymously, this will
45-
returns all public gists:</p>
53+
return all public gists:</p>
4654

4755
<pre><code>GET /gists
4856
</code></pre>
@@ -476,6 +484,8 @@ <h3 id="response-7">Response</h3>
476484
<preclass="headers no-response"><code>Status: 204 No Content
477485
X-RateLimit-Limit: 5000
478486
X-RateLimit-Remaining: 4999</code></pre>
487+
488+
<p>[1] http://developer.github.com/v3/oauth/#scopes</p>
479489
</div>
480490

481491
<divid="js-sidebar"class="sidebar-shell">

‎v3/index.html‎

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -57,14 +57,18 @@ <h1 id="api-v3">API v3</h1>
5757
<preclass="terminal">
5858
$ curl -i https://api.github.com
5959

60-
HTTP/1.1 200 OK
61-
Content-Type: application/json
62-
Status: 200 OK
60+
HTTP/1.1 302 Found
61+
Server: nginx/1.0.12
62+
Date: Mon, 20 Feb 2012 11:15:49 GMT
63+
Content-Type: text/html;charset=utf-8
64+
Connection: keep-alive
65+
Status: 302 Found
6366
X-RateLimit-Limit: 5000
67+
ETag: "d41d8cd98f00b204e9800998ecf8427e"
68+
Location: http://developer.github.com
6469
X-RateLimit-Remaining: 4999
65-
Content-Length:2
70+
Content-Length:0
6671

67-
{}
6872
</pre>
6973

7074
<p>Blank fields are included as<code>null</code> instead of being omitted.</p>
@@ -158,7 +162,8 @@ <h2 id="http-verbs">HTTP Verbs</h2>
158162
relatively new and uncommon HTTP verb, so resource endpoints also accept
159163
POST requests.</dd>
160164
<dt>PUT</dt>
161-
<dd>Used for replacing resources or collections.</dd>
165+
<dd>Used for replacing resources or collections. For PUT requests
166+
with no<code>body</code> attribute, be sure to set the<code>Content-Length</code> header to zero.</dd>
162167
<dt>DELETE</dt>
163168
<dd>Used for deleting resources.</dd>
164169
</dl><h2id="authentication">Authentication</h2>
@@ -183,7 +188,9 @@ <h2 id="http-verbs">HTTP Verbs</h2>
183188
$ curl https://api.github.com?access_token=OAUTH-TOKEN
184189
</pre>
185190

186-
<p>Read<ahref="/v3/oauth/">more about OAuth2</a>.</p>
191+
<p>Read<ahref="/v3/oauth/">more about OAuth2</a>. Note that OAuth2 tokens can be<ahref="/v3/oauth/#create-a-new-authorization">acquired
192+
programmatically</a>, for applications that
193+
are not websites.</p>
187194

188195
<h2id="pagination">Pagination</h2>
189196

@@ -229,8 +236,7 @@ <h2 id="pagination">Pagination</h2>
229236
X-RateLimit-Remaining: 4966
230237
</pre>
231238

232-
<p>You can file a<ahref="http://support.github.com/dashboard/queues/2386-api">support issue</a>
233-
to request white listed access for your application. We prefer sites that
239+
<p>You can<ahref="https://github.com/contact">contact us</a> to request white listed access for your application. We prefer sites that
234240
setup OAuth applications for their users.</p>
235241

236242
<h2id="cross-origin-resource-sharing">Cross Origin Resource Sharing</h2>

‎v3/libraries/index.html‎

Lines changed: 40 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -36,48 +36,65 @@ <h1 id="libraries">Libraries</h1>
3636

3737
<p>Libraries for accessing the GitHub API from your favorite language.</p>
3838

39-
<h2id="java">Java</h2>
39+
<h2id="actionscript">ActionScript</h2>
40+
41+
<ul>
42+
<li><ahref="https://github.com/cbrammer/api-github-as3">ActionScript GitHub API</a></li>
43+
</ul><h2id="clojure">Clojure</h2>
44+
45+
<ul>
46+
<li><ahref="https://github.com/Raynes/tentacles">Tentacles</a></li>
47+
</ul><h2id="csharp">CSharp</h2>
48+
49+
<ul>
50+
<li><ahref="https://github.com/sgrassie/csharp-github-api">CSharp GitHub API</a></li>
51+
</ul><h2id="erlang">Erlang</h2>
52+
53+
<ul>
54+
<li><ahref="https://github.com/onlyshk/erlang-github-api">Erlang GitHub API</a></li>
55+
</ul><h2id="haskell">Haskell</h2>
56+
57+
<ul>
58+
<li><ahref="https://github.com/dmnpignaud/haskell-github-api">Haskell GitHub API</a></li>
59+
</ul><h2id="java">Java</h2>
4060

4161
<p>The<ahref="https://github.com/eclipse/egit-github/tree/master/org.eclipse.egit.github.core">GitHub Java API</a> library
4262
is part of the<ahref="https://github.com/eclipse/egit-github">GitHub Mylyn Connector</a> and aims to support the entire
4363
GitHub v3 API. Builds are available in<ahref="http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22org.eclipse.egit.github.core%22">Maven Central</a>.</p>
4464

45-
<h2id="ruby">Ruby</h2>
65+
<h2id="javascript">Javascript</h2>
4666

4767
<ul>
48-
<li><ahref="https://github.com/pengwynn/octokit">Octokit</a></li>
49-
<li><ahref="https://github.com/peter-murach/github">GitHub API Gem</a></li>
50-
<li><ahref="https://github.com/jhelwig/octocat_herder">Octocat Herder</a></li>
51-
<li><ahref="https://github.com/jwilger/github-v3-api">GitHub v3 API</a></li>
52-
<li><ahref="https://github.com/okonski/github-api-client">GitHub API Client</a></li>
68+
<li><ahref="https://github.com/pksunkara/octonode">NodeJS GitHub library</a></li>
5369
</ul><h2id="perl">Perl</h2>
5470

55-
<p>The<ahref="https://github.com/plu/Pithub">Pithub</a> library for Perl provides an interface
56-
to the entire GitHub v3 API. There are a lot of tests included and
57-
it is also available on the<ahref="http://metacpan.org/module/Pithub">CPAN</a>.</p>
58-
59-
<h2id="php">PHP</h2>
71+
<ul>
72+
<li>
73+
<ahref="https://github.com/plu/Pithub">Pithub</a> (<ahref="http://metacpan.org/module/Pithub">CPAN</a>)</li>
74+
<li>
75+
<ahref="https://github.com/fayland/perl-net-github">Net::Github</a> (<ahref="http://search.cpan.org/~fayland/Net-GitHub-0.30/lib/Net/GitHub.pm">CPAN</a>)</li>
76+
</ul><h2id="php">PHP</h2>
6077

6178
<ul>
6279
<li><ahref="https://github.com/yiiext/github-api">GitHub API</a></li>
63-
<li><ahref="https://github.com/ornicar/php-github-api">PHP GitHub API</a></li>
80+
<li>[PHP GitHub API][php-github-api]</li>
6481
<li><ahref="https://github.com/acoulton/github_v3_api">GitHub Kohana Module</a></li>
65-
</ul><h2id="csharp">CSharp</h2>
82+
</ul><h2id="python">Python</h2>
6683

6784
<ul>
68-
<li><ahref="https://github.com/sgrassie/csharp-github-api">CSharp GitHub API</a></li>
69-
</ul><h2id="erlang">Erlang</h2>
85+
<li><ahref="https://github.com/copitux/python-github3">Pygithub3</a></li>
86+
</ul><h2id="ruby">Ruby</h2>
7087

7188
<ul>
72-
<li><ahref="https://github.com/onlyshk/erlang-github-api">Erlang GitHub API</a></li>
73-
</ul><h2id="actionscript">ActionScript</h2>
74-
75-
<ul>
76-
<li><ahref="https://github.com/cbrammer/api-github-as3">ActionScriptGitHub API</a></li>
77-
</ul><h2id="haskell">Haskell</h2>
89+
<li><ahref="https://github.com/pengwynn/octokit">Octokit</a></li>
90+
<li><ahref="https://github.com/peter-murach/github">GitHub API Gem</a></li>
91+
<li><ahref="https://github.com/jhelwig/octocat_herder">Octocat Herder</a></li>
92+
<li><ahref="https://github.com/jwilger/github-v3-api">GitHub v3 API</a></li>
93+
<li><ahref="https://github.com/okonski/github-api-client">GitHub API Client</a></li>
94+
</ul><h2id="scala">Scala</h2>
7895

7996
<ul>
80-
<li><ahref="https://github.com/dmnpignaud/haskell-github-api">Haskell GitHub API</a></li>
97+
<li><ahref="https://github.com/andreazevedo/dispatch-github">Dispatch GitHub</a></li>
8198
</ul>
8299
</div>
83100

‎v3/oauth/index.html‎

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -98,20 +98,25 @@ <h3 id="parameters-1">Parameters</h3>
9898
<em>Required</em><strong>string</strong> - The code you received as a response to<ahref="#redirect-users-to-request-github-access">Step 1</a>.</dd>
9999
</dl><h3id="response">Response</h3>
100100

101-
<dl>
102-
<dt>access_token</dt>
103-
<dd>
104-
<em>Required</em><strong>string</strong> - OAuth access token.</dd>
105-
</dl><h3id="use-the-access-token-to-access-the-api">3. Use the access token to access the API</h3>
101+
<preclass="highlight"><codeclass="language-xml"><spanclass="tag">&lt;OAuth&gt;</span>
102+
<spanclass="tag">&lt;token_type&gt;</span>bearer<spanclass="tag">&lt;/token_type&gt;</span>
103+
<spanclass="tag">&lt;access_token&gt;</span>e72e16c7e42f292c6912e7710c838347ae178b4a<spanclass="tag">&lt;/access_token&gt;</span>
104+
<spanclass="tag">&lt;/OAuth&gt;</span>
105+
</code></pre>
106+
107+
<h3id="use-the-access-token-to-access-the-api">3. Use the access token to access the API</h3>
106108

107109
<p>The access token allows you to make requests to the API on a behalf of a user.</p>
108110

109111
<pre><code>GET https://api.github.com/user?access_token=...
110112
</code></pre>
111113

112-
<h2id="desktop-application-flow">Desktop Application Flow</h2>
114+
<h2id="non-web-application-flow">Non-Web Application Flow</h2>
113115

114-
<p>Use basic authentication for now…</p>
116+
<p>Use basic authentication to create an OAuth2 token using the<ahref="/v3/oauth#creating-a-new-authorization">interface
117+
below</a>. With this tecnique, a username
118+
and password need not be stored permanently, and the user can revoke access at
119+
any time.</p>
115120

116121
<h2id="redirect-urls">Redirect URLs</h2>
117122

@@ -151,11 +156,11 @@ <h2 id="scopes">Scopes</h2>
151156
<dd>public read-only access (includes public user profile info, public
152157
repo info, and gists).</dd>
153158
<dt>user</dt>
154-
<dd>DB read/write access to profile info only.</dd>
159+
<dd>Read/write access to profile info only.</dd>
155160
<dt>public_repo</dt>
156-
<dd>DB read/write access, and Git read access to public repos and organizations.</dd>
161+
<dd>Read/write access to public repos and organizations.</dd>
157162
<dt>repo</dt>
158-
<dd>DB read/write access, and Git read access to public and private repos and organizations.</dd>
163+
<dd>Read/write access to public and private repos and organizations.</dd>
159164
<dt>gist</dt>
160165
<dd>write access to gists.</dd>
161166
</dl><p>NOTE: Your application can request the scopes in the initial redirection. You
@@ -288,7 +293,7 @@ <h3 id="response-3">Response</h3>
288293

289294
<h2id="update-an-existing-authorization">Update an existing authorization</h2>
290295

291-
<pre><code>PATCH /authorizations/1
296+
<pre><code>PATCH /authorizations/:id
292297
</code></pre>
293298

294299
<h3id="input-1">Input</h3>
@@ -346,7 +351,7 @@ <h3 id="response-4">Response</h3>
346351

347352
<h2id="delete-an-authorization">Delete an authorization</h2>
348353

349-
<pre><code>DELETE /authorizations/1
354+
<pre><code>DELETE /authorizations/:id
350355
</code></pre>
351356

352357
<h3id="response-5">Response</h3>

‎v3/orgs/teams/index.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,8 @@ <h3 id="response-6">Response</h3>
304304
<spanclass="s2">"git_url"</span><spanclass="o">:</span><spanclass="s2">"git://github.com/octocat/Hello-World.git"</span><spanclass="p">,</span>
305305
<spanclass="s2">"ssh_url"</span><spanclass="o">:</span><spanclass="s2">"git@github.com:octocat/Hello-World.git"</span><spanclass="p">,</span>
306306
<spanclass="s2">"svn_url"</span><spanclass="o">:</span><spanclass="s2">"https://svn.github.com/octocat/Hello-World"</span><spanclass="p">,</span>
307+
<spanclass="s2">"mirror_url"</span><spanclass="o">:</span><spanclass="s2">"git://git.example.com/octocat/Hello-World"</span><spanclass="p">,</span>
308+
<spanclass="s2">"id"</span><spanclass="o">:</span><spanclass="mi">1296269</span><spanclass="p">,</span>
307309
<spanclass="s2">"owner"</span><spanclass="o">:</span><spanclass="p">{</span>
308310
<spanclass="s2">"login"</span><spanclass="o">:</span><spanclass="s2">"octocat"</span><spanclass="p">,</span>
309311
<spanclass="s2">"id"</span><spanclass="o">:</span><spanclass="mi">1</span><spanclass="p">,</span>
@@ -323,7 +325,8 @@ <h3 id="response-6">Response</h3>
323325
<spanclass="s2">"master_branch"</span><spanclass="o">:</span><spanclass="s2">"master"</span><spanclass="p">,</span>
324326
<spanclass="s2">"open_issues"</span><spanclass="o">:</span><spanclass="mi">0</span><spanclass="p">,</span>
325327
<spanclass="s2">"pushed_at"</span><spanclass="o">:</span><spanclass="s2">"2011-01-26T19:06:43Z"</span><spanclass="p">,</span>
326-
<spanclass="s2">"created_at"</span><spanclass="o">:</span><spanclass="s2">"2011-01-26T19:01:12Z"</span>
328+
<spanclass="s2">"created_at"</span><spanclass="o">:</span><spanclass="s2">"2011-01-26T19:01:12Z"</span><spanclass="p">,</span>
329+
<spanclass="s2">"updated_at"</span><spanclass="o">:</span><spanclass="s2">"2011-01-26T19:14:43Z"</span>
327330
<spanclass="p">}</span>
328331
<spanclass="p">]</span>
329332
</code></pre>

‎v3/pulls/index.html‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,8 @@ <h3 id="response-1">Response</h3>
173173
<spanclass="s2">"git_url"</span><spanclass="o">:</span><spanclass="s2">"git://github.com/octocat/Hello-World.git"</span><spanclass="p">,</span>
174174
<spanclass="s2">"ssh_url"</span><spanclass="o">:</span><spanclass="s2">"git@github.com:octocat/Hello-World.git"</span><spanclass="p">,</span>
175175
<spanclass="s2">"svn_url"</span><spanclass="o">:</span><spanclass="s2">"https://svn.github.com/octocat/Hello-World"</span><spanclass="p">,</span>
176+
<spanclass="s2">"mirror_url"</span><spanclass="o">:</span><spanclass="s2">"git://git.example.com/octocat/Hello-World"</span><spanclass="p">,</span>
177+
<spanclass="s2">"id"</span><spanclass="o">:</span><spanclass="mi">1296269</span><spanclass="p">,</span>
176178
<spanclass="s2">"owner"</span><spanclass="o">:</span><spanclass="p">{</span>
177179
<spanclass="s2">"login"</span><spanclass="o">:</span><spanclass="s2">"octocat"</span><spanclass="p">,</span>
178180
<spanclass="s2">"id"</span><spanclass="o">:</span><spanclass="mi">1</span><spanclass="p">,</span>
@@ -192,7 +194,8 @@ <h3 id="response-1">Response</h3>
192194
<spanclass="s2">"master_branch"</span><spanclass="o">:</span><spanclass="s2">"master"</span><spanclass="p">,</span>
193195
<spanclass="s2">"open_issues"</span><spanclass="o">:</span><spanclass="mi">0</span><spanclass="p">,</span>
194196
<spanclass="s2">"pushed_at"</span><spanclass="o">:</span><spanclass="s2">"2011-01-26T19:06:43Z"</span><spanclass="p">,</span>
195-
<spanclass="s2">"created_at"</span><spanclass="o">:</span><spanclass="s2">"2011-01-26T19:01:12Z"</span>
197+
<spanclass="s2">"created_at"</span><spanclass="o">:</span><spanclass="s2">"2011-01-26T19:01:12Z"</span><spanclass="p">,</span>
198+
<spanclass="s2">"updated_at"</span><spanclass="o">:</span><spanclass="s2">"2011-01-26T19:14:43Z"</span>
196199
<spanclass="p">}</span>
197200
<spanclass="p">},</span>
198201
<spanclass="s2">"base"</span><spanclass="o">:</span><spanclass="p">{</span>
@@ -213,6 +216,8 @@ <h3 id="response-1">Response</h3>
213216
<spanclass="s2">"git_url"</span><spanclass="o">:</span><spanclass="s2">"git://github.com/octocat/Hello-World.git"</span><spanclass="p">,</span>
214217
<spanclass="s2">"ssh_url"</span><spanclass="o">:</span><spanclass="s2">"git@github.com:octocat/Hello-World.git"</span><spanclass="p">,</span>
215218
<spanclass="s2">"svn_url"</span><spanclass="o">:</span><spanclass="s2">"https://svn.github.com/octocat/Hello-World"</span><spanclass="p">,</span>
219+
<spanclass="s2">"mirror_url"</span><spanclass="o">:</span><spanclass="s2">"git://git.example.com/octocat/Hello-World"</span><spanclass="p">,</span>
220+
<spanclass="s2">"id"</span><spanclass="o">:</span><spanclass="mi">1296269</span><spanclass="p">,</span>
216221
<spanclass="s2">"owner"</span><spanclass="o">:</span><spanclass="p">{</span>
217222
<spanclass="s2">"login"</span><spanclass="o">:</span><spanclass="s2">"octocat"</span><spanclass="p">,</span>
218223
<spanclass="s2">"id"</span><spanclass="o">:</span><spanclass="mi">1</span><spanclass="p">,</span>
@@ -232,7 +237,8 @@ <h3 id="response-1">Response</h3>
232237
<spanclass="s2">"master_branch"</span><spanclass="o">:</span><spanclass="s2">"master"</span><spanclass="p">,</span>
233238
<spanclass="s2">"open_issues"</span><spanclass="o">:</span><spanclass="mi">0</span><spanclass="p">,</span>
234239
<spanclass="s2">"pushed_at"</span><spanclass="o">:</span><spanclass="s2">"2011-01-26T19:06:43Z"</span><spanclass="p">,</span>
235-
<spanclass="s2">"created_at"</span><spanclass="o">:</span><spanclass="s2">"2011-01-26T19:01:12Z"</span>
240+
<spanclass="s2">"created_at"</span><spanclass="o">:</span><spanclass="s2">"2011-01-26T19:01:12Z"</span><spanclass="p">,</span>
241+
<spanclass="s2">"updated_at"</span><spanclass="o">:</span><spanclass="s2">"2011-01-26T19:14:43Z"</span>
236242
<spanclass="p">}</span>
237243
<spanclass="p">}</span>
238244
<spanclass="p">}</span>

0 commit comments

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