forked from github/develop.github.com
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
221 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| ## Secret Network API ## | ||
|
|
||
| This API is sort of an outlier. It is only available in JSON and does not follow the rest of the routing rules. It is the API used by our Network Graph and provides a lot of useful information that may be useful. | ||
|
|
||
| ### Network Meta ### | ||
|
|
||
| $ curl http://github.com/schacon/simplegit/network_meta | jsonpretty | ||
| { | ||
| "focus": 78, | ||
| "nethash": "fa8fe264b926cdebaab36420b6501bd74402a6ff", | ||
| "dates": [ | ||
| "2008-03-15", | ||
| "2008-03-15", | ||
| "2008-03-17", | ||
| "2008-03-17", | ||
| ... | ||
| "2009-02-15", | ||
| "2009-02-15", | ||
| "2009-03-19" | ||
| ], | ||
| "users": [ | ||
| { | ||
| "name": "schacon", | ||
| "repo": "simplegit", | ||
| "heads": [ { "name": "master", | ||
| "id": "96476742093b8a53947564b16a691349dad846e5" } ] | ||
| }, | ||
| { | ||
| "name": "tamtam", | ||
| "repo": "tam_repo", | ||
| "heads": [ { "name": "master", | ||
| "id": "8bf4aeae935422e7bdbb30660b4f3642728a1397" } ] | ||
| } | ||
| ], | ||
| "blocks": [ | ||
| { "name": "schacon", "start": 0, "count": 3 }, | ||
| { "name": "tamtam", "start": 3, "count": 1 }, | ||
| ] | ||
| } | ||
|
|
||
| ### Network Data ### | ||
|
|
||
| To get network data, you'll need to provide the 'nethash' parameter that you get from the network\_meta call so the data is always consistent. To get network data, call the network\_data\_chunk URI with the given nethash to get the first 100 commits by branch. | ||
|
|
||
| $ curl http://github.com/schacon/simplegit/network_data_chunk?nethash=fa8fe264b926cdebaab36420b6501bd74402a6ff | ||
| {"commits"=> | ||
| [{"message"=>"first commit", | ||
| "time"=>0, | ||
| "parents"=>[], | ||
| "date"=>"2008-03-15 10:31:28", | ||
| "author"=>"Scott Chacon", | ||
| "id"=>"a11bef06a3f659402fe7563abf99ad00de2209e6", | ||
| "space"=>1, | ||
| "gravatar"=>"9375a9529679f1b42b567a640d775e7d", | ||
| "login"=>"schacon"}, | ||
| {"message"=>"my second commit, which is better than the first", | ||
| "time"=>1, | ||
| "parents"=>[["a11bef06a3f659402fe7563abf99ad00de2209e6", 0, 1]], | ||
| "date"=>"2008-03-15 16:40:33", | ||
| "author"=>"Scott Chacon", | ||
| "id"=>"0576fac355dd17e39fd2671b010e36299f713b4d", | ||
| "space"=>1, | ||
| "gravatar"=>"9375a9529679f1b42b567a640d775e7d", | ||
| "login"=>"schacon"}, | ||
| .. (bunch more) .. | ||
|
|
||
| You can also give it a start and end range, based on the position of the dates in the network\_meta output. This is how the network graph operates, requesting the chunks that you want to view at a time rather than all the data. If you need more than the last 100, you'll need to request ranges of more data. | ||
|
|
||
| $ curl 'http://github.com/schacon/simplegit/network_data_chunk? | ||
| nethash=fa8fe264b926cdebaab36420b6501bd74402a6ff&start=1&end=2' | ||
| { | ||
| "commits": [ | ||
| { | ||
| "message": "my second commit, which is better than the first", | ||
| "time": 1, | ||
| "parents": [ | ||
| [ | ||
| "a11bef06a3f659402fe7563abf99ad00de2209e6", | ||
| 0, | ||
| 1 | ||
| ] | ||
| ], | ||
| "date": "2008-03-15 16:40:33", | ||
| "author": "Scott Chacon", | ||
| "id": "0576fac355dd17e39fd2671b010e36299f713b4d", | ||
| "space": 1, | ||
| "gravatar": "9375a9529679f1b42b567a640d775e7d", | ||
| "login": "schacon" | ||
| }, | ||
| { | ||
| "message": "changed the verison number", | ||
| "time": 2, | ||
| "parents": [ | ||
| [ | ||
| "0576fac355dd17e39fd2671b010e36299f713b4d", | ||
| 1, | ||
| 1 | ||
| ] | ||
| ], | ||
| "date": "2008-03-17 21:52:11", | ||
| "author": "Scott Chacon", | ||
| "id": "0c8a9ec46029a4e92a428cb98c9693f09f69a3ff", | ||
| "space": 1, | ||
| "gravatar": "9375a9529679f1b42b567a640d775e7d", | ||
| "login": "schacon" | ||
| } | ||
| ] | ||
| } | ||