Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

751 lines (744 sloc) 18.84 kb
{
"base_url" : "http://github.com/api/v2/",
"version" : "0.4",
"methods" : {
"user_search" : {
"path" : "/:format/user/search/:search",
"method" : "GET",
"required_params" : [
"format",
"search"
]
},
"get_info" : {
"path" : "/:format/user/show/:username",
"method" : "GET",
"required_params" : [
"format",
"username"
]
},
"get_profile" : {
"path" : "/:format/user/show",
"method" : "GET",
"required_params" : [
"format"
],
"authentication" : true
},
"update_profile" : {
"path" : "/:format/user/show/:username",
"method" : "POST",
"form-data" : {
"values[name]" : ":name",
"values[email]" : ":email",
"values[blog]" : ":blog",
"values[company]" : ":company",
"values[location]" : ":location"
},
"required_params" : [
"format",
"username"
],
"optional_params" : [
"name",
"email",
"blog",
"company",
"location"
],
"authentication" : true
},
"list_following" : {
"path" : "/:format/user/show/:user/following",
"method" : "GET",
"required_params" : [
"format",
"user"
]
},
"list_followers" : {
"path" : "/:format/user/show/:user/followers",
"method" : "GET",
"required_params" : [
"format",
"user"
]
},
"follow" : {
"path" : "/:format/user/follow/:user",
"method" : "POST",
"required_params" : [
"format",
"user"
],
"authentication" : true
},
"unfollow" : {
"path" : "/:format/user/unfollow/:user",
"method" : "POST",
"required_params" : [
"format",
"user"
],
"authentication" : true
},
"list_watched_repos" : {
"path" : "/:format/repos/watched/:user",
"method" : "GET",
"required_params" : [
"format",
"user"
]
},
"list_keys" : {
"path" : "/:format/user/keys",
"method" : "GET",
"required_params" : [
"format"
],
"authentication" : true
},
"add_key" : {
"path" : "/:format/user/key/add",
"method" : "POST",
"form-data" : {
"title" : ":title",
"key" : ":key"
},
"required_params" : [
"format",
"title",
"key"
],
"authentication" : true
},
"remove_key" : {
"path" : "/:format/user/key/remove",
"method" : "POST",
"form-data" : {
"id" : ":id"
},
"required_params" : [
"format",
"id"
],
"authentication" : true
},
"list_emails" : {
"path" : "/:format/user/emails",
"method" : "GET",
"required_params" : [
"format"
],
"authentication" : true
},
"add_email" : {
"path" : "/:format/user/email/add",
"method" : "POST",
"form-data" : {
"email" : ":email"
},
"required_params" : [
"format",
"email"
],
"authentication" : true
},
"remove_email" : {
"path" : "/:format/user/email/remove",
"method" : "POST",
"form-data" : {
"email" : ":email"
},
"required_params" : [
"format",
"email"
],
"authentication" : true
},
"issue_search" : {
"path" : "/:format/issues/search/:user/:repo/:state/:search_term",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo",
"state",
"search_term"
]
},
"list_issues" : {
"path" : "/:format/issues/list/:user/:repo/:state",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo",
"state"
]
},
"list_issues_by_label" : {
"path" : "/:format/issues/list/:user/:repo/label/:label",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo",
"label"
]
},
"get_issue_info" : {
"path" : "/:format/issues/show/:user/:repo/:number",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo",
"number"
]
},
"list_comments" : {
"path" : "/:format/issues/comments/:user/:repo/:number",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo",
"number"
]
},
"open" : {
"path" : "/:format/issues/open/:user/:repo",
"method" : "POST",
"form-data" : {
"title" : ":title",
"body" : ":body"
},
"required_params" : [
"format",
"user",
"repo"
],
"optional_params" : [
"title",
"body"
],
"authentication" : true
},
"close" : {
"path" : "/:format/issues/close/:user/:repo",
"method" : "POST",
"required_params" : [
"format",
"user",
"repo",
"number"
],
"authentication" : true
},
"reopen" : {
"path" : "/:format/issues/reopen/:user/:repo",
"method" : "POST",
"required_params" : [
"format",
"user",
"repo",
"number"
],
"authentication" : true
},
"update_issue" : {
"path" : "/:format/issues/edit/:user/:repo/:number",
"method" : "POST",
"form-data" : {
"title" : ":title",
"body" : ":body"
},
"required_params" : [
"format",
"user",
"repo",
"number"
],
"optional_params" : [
"title",
"body"
],
"authentication" : true
},
"list_labels" : {
"path" : "/:format/issues/labels/:user/:repo",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo"
]
},
"add_label" : {
"path" : "/:format/issues/label/add/:user/:repo/:label/:number",
"method" : "POST",
"required_params" : [
"format",
"user",
"repo",
"label",
"number"
],
"authentication" : true
},
"remove_label" : {
"path" : "/:format/issues/label/remove/:user/:repo/:label/:number",
"method" : "POST",
"required_params" : [
"format",
"user",
"repo",
"label",
"number"
],
"authentication" : true
},
"add_comment" : {
"path" : "/:format/issues/comment/:user/:repo/:number",
"method" : "POST",
"form-data" : {
"comment" : ":comment"
},
"required_params" : [
"format",
"user",
"repo",
"number",
"comment"
],
"authentication" : true
},
"get_gist_info" : {
"base_url" : "http://gist.github.com/api/v1/",
"path" : "/:format/:gist_id",
"method" : "GET",
"required_params" : [
"format",
"gist_id"
]
},
"get_gist_content" : {
"base_url" : "http://gist.github.com/",
"path" : "/raw/:gist_id/:filename",
"method" : "GET",
"required_params" : [
"gist_id",
"filename"
]
},
"list_gists" : {
"base_url" : "http://gist.github.com/api/v1/",
"path" : "/:format/gists/:login",
"method" : "GET",
"required_params" : [
"format",
"login"
]
},
"get_network_meta" : {
"path" : "/:user/:repo/network_meta",
"method" : "GET",
"required_params" : [
"user",
"repo"
]
},
"list_network_data" : {
"path" : "/:user/:repo/network_data_chunk",
"method" : "GET",
"required_params" : [
"user",
"repo",
"nethash"
],
"optional_params" : [
"start",
"end"
]
},
"repo_search" : {
"path" : "/:format/repos/search/:q",
"method" : "GET",
"required_params" : [
"format",
"q"
],
"optional_params" : [
"start_page",
"language"
]
},
"get_repo_info" : {
"path" : "/:format/repos/:user/:repo",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo"
]
},
"update_repo" : {
"path" : "/:format/repos/show/:user/:repo",
"method" : "POST",
"form-data" : {
"values[description]" : ":description",
"values[homepage]" : ":homepage",
"values[has_wiki]" : ":has_wiki",
"values[has_issues]" : ":has_issues",
"values[has_download]" : ":has_download"
},
"required_params" : [
"format",
"user",
"repo"
],
"optional_params" : [
"description",
"homepage",
"has_wiki",
"has_issues",
"has_download"
],
"authentication" : true
},
"list_repos" : {
"path" : "/:format/repos/show/:user",
"method" : "GET",
"required_params" : [
"format",
"user"
]
},
"watch" : {
"path" : "/:format/repos/watch/:user/:repo",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo"
],
"authentication" : true
},
"unwatch" : {
"path" : "/:format/repos/unwatch/:user/:repo",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo"
],
"authentication" : true
},
"fork" : {
"path" : "/:format/repos/fork/:user/:repo",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo"
],
"authentication" : true
},
"create_repo" : {
"path" : "/:format/repos/create",
"method" : "POST",
"form-data" : {
"name" : ":name",
"description" : ":description",
"homepage" : ":homepage",
"public" : ":public"
},
"required_params" : [
"format",
"name"
],
"optional_params" : [
"description",
"homepage",
"public"
],
"authentication" : true
},
"delete_repo" : {
"path" : "/:format/repos/delete/:user/:repo",
"method" : "POST",
"required_params" : [
"format",
"user",
"repo"
],
"authentication" : true
},
"set_private" : {
"path" : "/:format/repos/set/private/:user/:repo",
"method" : "POST",
"required_params" : [
"format",
"user",
"repo"
],
"authentication" : true
},
"set_public" : {
"path" : "/:format/repos/set/public/:user/:repo",
"method" : "POST",
"required_params" : [
"format",
"user",
"repo"
],
"authentication" : true
},
"list_repo_keys" : {
"path" : "/:format/repos/keys/:user/:repo",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo"
],
"authentication" : true
},
"add_repo_key" : {
"path" : "/:format/repos/key/:user/:repo/add",
"method" : "POST",
"form-data" : {
"title" : ":title",
"key" : ":key"
},
"required_params" : [
"format",
"user",
"repo",
"title",
"key"
],
"authentication" : true
},
"remove_repo_key" : {
"path" : "/:format/repos/key/:user/:repo/remove",
"method" : "POST",
"form-data" : {
"id" : ":id"
},
"required_params" : [
"format",
"user",
"repo",
"id"
],
"authentication" : true
},
"list_collaborators" : {
"path" : "/:format/repos/show/:user/:repo/collaborators",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo"
],
"authentication" : true
},
"add_collaborator" : {
"path" : "/:format/repos/collaborators/:user/:repo/add/:collaborator",
"method" : "POST",
"required_params" : [
"format",
"user",
"repo",
"collaborator"
],
"authentication" : true
},
"remove_collaborator" : {
"path" : "/:format/repos/collaborators/:user/:repo/remove/:collaborator",
"method" : "POST",
"required_params" : [
"format",
"user",
"repo",
"collaborator"
],
"authentication" : true
},
"list_pushable" : {
"path" : "/:format/repos/pushable",
"method" : "GET",
"required_params" : [
"format"
],
"authentication" : true
},
"list_contributors" : {
"path" : "/:format/repos/show/:user/:repo/contributors",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo"
]
},
"list_anon_contributors" : {
"path" : "/:format/repos/show/:user/:repo/contributors/anon",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo"
]
},
"list_watchers" : {
"path" : "/:format/repos/show/:user/:repo/watchers",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo"
]
},
"list_network" : {
"path" : "/:format/repos/show/:user/:repo/network",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo"
]
},
"list_languages" : {
"path" : "/:format/repos/show/:user/:repo/languages",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo"
]
},
"list_tags" : {
"path" : "/:format/repos/show/:user/:repo/tags",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo"
]
},
"list_branches" : {
"path" : "/:format/repos/show/:user/:repo/branches",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo"
]
},
"list_commits" : {
"path" : "/:format/commits/list/:user/:repo/:branch",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo",
"branch"
]
},
"list_file_commits" : {
"path" : "/:format/commits/list/:user/:repo/:branch/:path",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo",
"branch",
"path"
]
},
"get_commit_info" : {
"path" : "/:format/commits/show/:user/:repo/:sha",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo",
"sha"
]
},
"list_tree" : {
"path" : "/:format/tree/show/:user/:repo/:tree_sha",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo",
"tree_sha"
]
},
"get_blob" : {
"path" : "/:format/blob/show/:user/:repo/:tree_sha/:path",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo",
"tree_sha",
"path"
],
"optional_params" : [
"meta"
]
},
"list_blobs" : {
"path" : "/:format/blob/all/:user/:repo/:tree_sha",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo",
"sha"
]
},
"list_full_blobs" : {
"path" : "/:format/blob/full/:user/:repo/:tree_sha",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo",
"tree_sha"
]
},
"list_full_tree" : {
"path" : "/:format/tree/full/:user/:repo/:tree_sha",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo",
"tree_sha"
]
},
"get_raw_blob" : {
"path" : "/:format/blob/show/:user/:repo/:sha",
"method" : "GET",
"required_params" : [
"format",
"user",
"repo",
"sha"
]
}
},
"expected_status" : [ 200 ],
"name" : "GitHub",
"authority" : "http://github.com/SPORE",
"meta" : {
"documentation" : "http://develop.github.com/"
}
}
Jump to Line
Something went wrong with that request. Please try again.