about summary refs log tree commit diff
diff options
context:
space:
mode:
authorFrancois Perrad <francois.perrad@gadz.org>2010-10-22 20:25:42 +0200
committerFrancois Perrad <francois.perrad@gadz.org>2010-10-22 20:25:42 +0200
commitc77fe8638bc1f4fb94cdbbc1f084199b9afdaf92 (patch)
tree7be29740fe0b9c036a820cfe54a7aa794aa4bbc3
parentuse Pod::Usage (diff)
downloadapi-description-c77fe8638bc1f4fb94cdbbc1f084199b9afdaf92.tar.gz
modularized version of github API
-rw-r--r--services/github/repository.json85
-rw-r--r--services/github/user.json111
2 files changed, 196 insertions, 0 deletions
diff --git a/services/github/repository.json b/services/github/repository.json
new file mode 100644
index 0000000..78d17b4
--- /dev/null
+++ b/services/github/repository.json
@@ -0,0 +1,85 @@
+{
+   "base_url" : "http://github.com/api/v2/",
+   "version" : "0.2",
+   "methods" : {
+      "unwatch_repo" : {
+         "required_params" : [
+            "format",
+            "user",
+            "repo"
+         ],
+         "path" : "/:format/repos/unwatch/:user/:repo",
+         "method" : "GET",
+         "authentication" : true
+      },
+      "repos_info" : {
+         "required_params" : [
+            "format",
+            "user",
+            "repo"
+         ],
+         "path" : "/:format/repos/:user/:repo",
+         "method" : "GET"
+      },
+      "fork_repos" : {
+         "required_params" : [
+            "format",
+            "user",
+            "repo"
+         ],
+         "path" : "/:format/repos/fork/:user/:repo",
+         "method" : "GET",
+         "authentication" : true
+      },
+      "list_all_repos" : {
+         "required_params" : [
+            "format",
+            "user",
+            "repo"
+         ],
+         "path" : "/:format/repos/show/:user",
+         "method" : "GET"
+      },
+      "repos_search" : {
+         "required_params" : [
+            "format",
+            "q"
+         ],
+         "path" : "/:format/repos/search/:q",
+         "method" : "GET"
+      },
+      "watch_repo" : {
+         "required_params" : [
+            "format",
+            "user",
+            "repo"
+         ],
+         "path" : "/:format/repos/watch/:user/:repo",
+         "method" : "GET",
+         "authentication" : true
+      },
+      "create_repo" : {
+         "required_params" : [
+            "format"
+         ],
+         "path" : "/:format/repos/create",
+         "method" : "POST",
+         "authentication" : true
+      },
+      "set_repo_info" : {
+         "required_params" : [
+            "format",
+            "user",
+            "repo"
+         ],
+         "path" : "/:format/repos/show/:user/:repo",
+         "method" : "POST",
+         "authentication" : true
+      }
+   },
+   "name" : "GitHub",
+   "authority" : "http://github.com/SPORE",
+   "meta" : {
+      "documentation" : "http://develop.github.com/"
+   }
+}
diff --git a/services/github/user.json b/services/github/user.json
new file mode 100644
index 0000000..98a488c
--- /dev/null
+++ b/services/github/user.json
@@ -0,0 +1,111 @@
+{
+   "base_url" : "http://github.com/api/v2/",
+   "version" : "0.2",
+   "methods" : {
+      "user_search" : {
+         "required_params" : [
+            "format",
+            "search"
+         ],
+         "path" : "/:format/user/search/:search",
+         "method" : "GET"
+      },
+      "user_information" : {
+         "required_params" : [
+            "username",
+            "format"
+         ],
+         "path" : "/:format/user/show/:username",
+         "method" : "GET"
+      },
+      "my_information" : {
+         "required_params" : [
+            "username",
+            "format"
+         ],
+         "path" : "/:format/user/show/:username",
+         "method" : "GET",
+         "authentication" : true
+      },
+      "update_profile" : {
+         "required_params" : [
+            "username",
+            "format"
+         ],
+         "path" : "/:format/user/show/:username",
+         "method" : "POST",
+         "authentication" : true
+      },
+      "follow" : {
+         "required_params" : [
+            "user",
+            "format"
+         ],
+         "path" : "/:format/user/follow/:user",
+         "method" : "POST",
+         "authentication" : true
+      },
+      "unfollow" : {
+         "required_params" : [
+            "user",
+            "format"
+         ],
+         "path" : "/:format/user/unfollow/:user",
+         "method" : "POST",
+         "authentication" : true
+      },
+      "list_public_keys" : {
+         "required_params" : [
+            "format"
+         ],
+         "path" : "/:format/user/keys",
+         "method" : "GET",
+         "authentication" : true
+      },
+      "add_public_key" : {
+         "required_params" : [
+            "format"
+         ],
+         "path" : "/:format/user/key/add",
+         "method" : "POST",
+         "authentication" : true
+      },
+      "del_public_key" : {
+         "required_params" : [
+            "format"
+         ],
+         "path" : "/:format/user/key/remove",
+         "method" : "POST",
+         "authentication" : true
+      },
+      "user_following" : {
+         "required_params" : [
+            "user",
+            "format"
+         ],
+         "path" : "/:format/user/show/:user/following",
+         "method" : "GET"
+      },
+      "watched_repos" : {
+         "required_params" : [
+            "format",
+            "user"
+         ],
+         "path" : "/:format/user/watched/:user",
+         "method" : "GET"
+      },
+      "user_followers" : {
+         "required_params" : [
+            "user",
+            "format"
+         ],
+         "path" : "/:format/user/show/:user/followers",
+         "method" : "GET"
+      }
+   },
+   "name" : "GitHub",
+   "authority" : "http://github.com/SPORE",
+   "meta" : {
+      "documentation" : "http://develop.github.com/"
+   }
+}