diff options
| author | Chris Wanstrath <chris@ozmm.org> | 2010-06-02 16:43:59 -0700 |
|---|---|---|
| committer | Chris Wanstrath <chris@ozmm.org> | 2010-06-02 16:43:59 -0700 |
| commit | 3dfaa3f9be94500fa1439d996b226f31a878f629 (patch) | |
| tree | 89d443c0524a4c997801569f161e3d5bbfc9e005 | |
| parent | 019df02ceff95c808bb20aef4a52d2a5c22d6bec (diff) | |
tweak api guide
| -rw-r--r-- | _posts/2010-01-16-api.markdown | 33 |
1 files changed, 1 insertions, 32 deletions
diff --git a/_posts/2010-01-16-api.markdown b/_posts/2010-01-16-api.markdown index 77820dc..051812f 100644 --- a/_posts/2010-01-16-api.markdown +++ b/_posts/2010-01-16-api.markdown @@ -4,38 +4,7 @@ title: GitHub API categories: other --- -__This page is for version 1 of the API. While this API still works, it has been replaced. We highly recommend you use the [new version](http://develop.github.com/).__ - -The API -======= - -Request will follow a common URL pattern: - - http://github.com/api/v1/:format/:username/:repository/:type/:object - -* Acceptable formats: json, xml, yaml - -* Acceptable types: commits, commit - -Grabbing all recent commits: - - $ curl -i http://github.com/api/v1/xml/caged/gitnub/commits/master | less - -Grabbing a single commit: - - $ curl -i http://github.com/api/v1/json/defunkt/github-gem/commit/c26d4ce9807ecf57d3f9eefe19ae64e75bcaaa8b | less - -Repository search: - - $ curl -i http://github.com/api/v1/xml/search/merb | less - -You can also grab a user's info, including a list of his repositories (Using [token authentication](http://github.com/blog/170-token-authentication) will enable listing of private repositories.): - - $ curl -i http://github.com/api/v1/json/defunkt | less - -With JSON requests, you can have the result passed to a callback method of your choice: - - $ curl -i http://github.com/api/v1/json/defunkt?callback=myCallbackMethod | less +The GitHub API is documented at <http://develop.github.com> Projects using the API ====================== |