Permalink
Browse files

regenerate

  • Loading branch information...
1 parent 444f1b4 commit efaf6acd04b66419dd5b89091f2e42a0877d437a @paul committed Aug 2, 2012
Showing with 387 additions and 402 deletions.
  1. +40 −42 general/mime_type.html
  2. +59 −61 general/quick_ref.html
  3. +39 −41 index.html
  4. +46 −48 user/current_user.html
  5. +60 −62 user/from_login.html
  6. +46 −48 user/index.html
  7. +44 −46 user/representation.html
  8. +53 −54 user/update_current_user.html
View
@@ -49,7 +49,7 @@
<a href="#user-representation">Representation</a>
</li>
<li class='page'>
- <a href="#retrieve-current-user">Retrieve current user</a>
+ <a href="#retrieve-the-current-user">Retrieve the current user</a>
</li>
<li class='page'>
<a href="#update-current-user">Update current user</a>
@@ -64,12 +64,9 @@
<h1>GitHub API</h1>
-<p>This describes the resources that make up the official GitHub API v3. If<br>
-you have any problems or requests please contact<br>
-<a href="mailto:support@github.com?subject=APIv3">support</a>.</p>
+<p>This describes the resources that make up the official GitHub API v3. If you have any problems or requests please contact <a href="mailto:support@github.com?subject=APIv3">support</a>.</p>
-<p>View the <a href="/v3/changelog">API Changelog</a> for information on existing and<br>
-planned changes to the API.</p>
+<p>View the <a href="/v3/changelog">API Changelog</a> for information on existing and planned changes to the API.</p>
<h1>Content Type</h1>
<p>The GitHub API uses a vendor-specific mime type for web service requests and responses.</p>
@@ -93,7 +90,7 @@
<tbody>
<tr>
<td class='usage'>
- <a href="#retrieve-current-user">Retrieve current user</a>
+ <a href="#retrieve-the-current-user">Retrieve the current user</a>
</td>
<td class='method'>
GET
@@ -107,7 +104,7 @@
<a href="#update-current-user">Update current user</a>
</td>
<td class='method'>
-
+ POST, PATCH
</td>
<td class='url'>
/user
@@ -183,27 +180,27 @@ <h2 id='user-representation'>Representation</h2>
</dl>
<h3>Example</h3>
<pre><code>{
- "followers": 37,
+ "public_repos": 83,
+ "html_url": "https://github.com/paul",
"type": "User",
- "gravatar_id": "d587890d0fcf8f45724baa8b1bfe1bf4",
+ "email": "psadauskas@gmail.com",
+ "created_at": "2008-02-11T18:44:09Z",
"hireable": false,
- "avatar_url": "https://secure.gravatar.com/avatar/d587890d0fcf8f45724baa8b1bfe1bf4?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png",
- "blog": "blog.theamazingrando.com",
"public_gists": 323,
+ "followers": 37,
"bio": "The GitHub API Dude",
- "login": "paul",
+ "gravatar_id": "d587890d0fcf8f45724baa8b1bfe1bf4",
+ "avatar_url": "https://secure.gravatar.com/avatar/d587890d0fcf8f45724baa8b1bfe1bf4?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png",
+ "blog": "blog.theamazingrando.com",
"following": 1,
"company": "GitHub",
"location": "Boulder, CO",
- "email": "psadauskas@gmail.com",
- "public_repos": 83,
- "created_at": "2008-02-11T18:44:09Z",
- "html_url": "https://github.com/paul",
"name": "Paul Sadauskas",
"url": "https://api.github.com/users/paul",
- "id": 184
+ "id": 184,
+ "login": "paul"
}</code></pre>
-<h2 id='retrieve-current-user'>Retrieve current user</h2>
+<h2 id='retrieve-the-current-user'>Retrieve the current user</h2>
<pre><code>GET /user</code></pre>
<p class='alert'>Requires authentication</p>
<p>You can use <code>/user</code> to get the currently logged in user. This is a shortcut to <code>/user/{login}</code> for<br>
@@ -218,31 +215,31 @@ <h2 id='retrieve-current-user'>Retrieve current user</h2>
&quot;type&quot;: &quot;User&quot;,
&quot;email&quot;: &quot;psadauskas@gmail.com&quot;,
&quot;created_at&quot;: &quot;2008-02-11T18:44:09Z&quot;,
- &quot;blog&quot;: &quot;blog.theamazingrando.com&quot;,
- &quot;hireable&quot;: false,
+ &quot;total_private_repos&quot;: 5,
+ &quot;public_gists&quot;: 323,
&quot;collaborators&quot;: 3,
- &quot;public_repos&quot;: 83,
&quot;followers&quot;: 37,
&quot;gravatar_id&quot;: &quot;d587890d0fcf8f45724baa8b1bfe1bf4&quot;,
- &quot;bio&quot;: &quot;The GitHub API Dude&quot;,
- &quot;public_gists&quot;: 323,
- &quot;total_private_repos&quot;: 5,
- &quot;disk_usage&quot;: 57572,
+ &quot;owned_private_repos&quot;: 5,
&quot;private_gists&quot;: 103,
+ &quot;hireable&quot;: false,
+ &quot;disk_usage&quot;: 57572,
+ &quot;blog&quot;: &quot;blog.theamazingrando.com&quot;,
+ &quot;public_repos&quot;: 83,
&quot;following&quot;: 1,
&quot;company&quot;: &quot;GitHub&quot;,
&quot;location&quot;: &quot;Boulder, CO&quot;,
- &quot;owned_private_repos&quot;: 5,
+ &quot;bio&quot;: &quot;The GitHub API Dude&quot;,
&quot;plan&quot;: {
&quot;collaborators&quot;: 100,
- &quot;private_repos&quot;: 300,
&quot;name&quot;: &quot;giga&quot;,
+ &quot;private_repos&quot;: 300,
&quot;space&quot;: 62914560
},
&quot;name&quot;: &quot;Paul Sadauskas&quot;,
&quot;url&quot;: &quot;https://api.github.com/users/paul&quot;,
- &quot;avatar_url&quot;: &quot;https://secure.gravatar.com/avatar/d587890d0fcf8f45724baa8b1bfe1bf4?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png&quot;,
&quot;id&quot;: 184,
+ &quot;avatar_url&quot;: &quot;https://secure.gravatar.com/avatar/d587890d0fcf8f45724baa8b1bfe1bf4?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png&quot;,
&quot;login&quot;: &quot;paul&quot;
}
@@ -254,7 +251,8 @@ <h2 id='retrieve-current-user'>Retrieve current user</h2>
-- No result, because I don&#39;t know what to do with &quot;ruby&quot;
</code></pre>
<h2 id='update-current-user'>Update current user</h2>
-<pre><code></code></pre>
+<pre><code>POST /user
+PATCH /user</code></pre>
<p class='alert'>Requires authentication</p>
<p>To update your user profile data, you can <code>PUT</code> (or <code>PATCH</code>) some the <a href="#user">user</a> attributes you want modified.</p>
@@ -271,28 +269,28 @@ <h2 id='update-current-user'>Update current user</h2>
&quot;created_at&quot;: &quot;2008-02-11T18:44:09Z&quot;,
&quot;blog&quot;: &quot;blog.theamazingrando.com&quot;,
&quot;hireable&quot;: false,
- &quot;public_gists&quot;: 323,
+ &quot;collaborators&quot;: 3,
+ &quot;public_repos&quot;: 83,
&quot;followers&quot;: 37,
- &quot;bio&quot;: &quot;The GitHub API Dude&quot;,
&quot;gravatar_id&quot;: &quot;d587890d0fcf8f45724baa8b1bfe1bf4&quot;,
+ &quot;bio&quot;: &quot;The GitHub API Dude&quot;,
+ &quot;public_gists&quot;: 323,
&quot;total_private_repos&quot;: 5,
- &quot;private_gists&quot;: 103,
- &quot;collaborators&quot;: 3,
&quot;disk_usage&quot;: 57572,
- &quot;owned_private_repos&quot;: 5,
- &quot;public_repos&quot;: 83,
+ &quot;private_gists&quot;: 103,
&quot;following&quot;: 1,
&quot;company&quot;: &quot;GitHub&quot;,
&quot;location&quot;: &quot;Boulder, CO&quot;,
- &quot;avatar_url&quot;: &quot;https://secure.gravatar.com/avatar/d587890d0fcf8f45724baa8b1bfe1bf4?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png&quot;,
+ &quot;owned_private_repos&quot;: 5,
&quot;plan&quot;: {
- &quot;private_repos&quot;: 300,
&quot;collaborators&quot;: 100,
+ &quot;private_repos&quot;: 300,
&quot;name&quot;: &quot;giga&quot;,
&quot;space&quot;: 62914560
},
&quot;name&quot;: &quot;Paul Sadauskas&quot;,
&quot;url&quot;: &quot;https://api.github.com/users/paul&quot;,
+ &quot;avatar_url&quot;: &quot;https://secure.gravatar.com/avatar/d587890d0fcf8f45724baa8b1bfe1bf4?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png&quot;,
&quot;id&quot;: 184,
&quot;login&quot;: &quot;paul&quot;
}
@@ -308,24 +306,24 @@ <h2 id='fetch-user-by-login'>Fetch user by login</h2>
https://api.github.com/users/paul
{
+ &quot;public_gists&quot;: 323,
&quot;html_url&quot;: &quot;https://github.com/paul&quot;,
&quot;type&quot;: &quot;User&quot;,
&quot;email&quot;: &quot;psadauskas@gmail.com&quot;,
- &quot;hireable&quot;: false,
&quot;created_at&quot;: &quot;2008-02-11T18:44:09Z&quot;,
- &quot;blog&quot;: &quot;blog.theamazingrando.com&quot;,
- &quot;public_repos&quot;: 83,
&quot;bio&quot;: &quot;The GitHub API Dude&quot;,
&quot;followers&quot;: 37,
+ &quot;blog&quot;: &quot;blog.theamazingrando.com&quot;,
&quot;gravatar_id&quot;: &quot;d587890d0fcf8f45724baa8b1bfe1bf4&quot;,
+ &quot;public_repos&quot;: 83,
&quot;following&quot;: 1,
&quot;company&quot;: &quot;GitHub&quot;,
&quot;location&quot;: &quot;Boulder, CO&quot;,
&quot;name&quot;: &quot;Paul Sadauskas&quot;,
&quot;url&quot;: &quot;https://api.github.com/users/paul&quot;,
&quot;avatar_url&quot;: &quot;https://secure.gravatar.com/avatar/d587890d0fcf8f45724baa8b1bfe1bf4?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png&quot;,
&quot;id&quot;: 184,
- &quot;public_gists&quot;: 323,
+ &quot;hireable&quot;: false,
&quot;login&quot;: &quot;paul&quot;
}
Oops, something went wrong.

0 comments on commit efaf6ac

Please sign in to comment.