diff options
author | franck cuny <franck@lumberjaph.net> | 2010-10-17 17:33:55 +0200 |
---|---|---|
committer | franck cuny <franck@lumberjaph.net> | 2010-10-17 17:33:55 +0200 |
commit | 8d4761846e852d1147b982ca6c4d0199ee5746cf (patch) | |
tree | 29b5d1b4ec5f10ff1641063f1e2968dc6b61206c | |
parent | update all description to reflect recent changes in specifications (diff) | |
download | api-description-8d4761846e852d1147b982ca6c4d0199ee5746cf.tar.gz |
update description to current specification
-rw-r--r-- | apps/couchdb.json | 100 | ||||
-rw-r--r-- | apps/presque.json | 142 | ||||
-rw-r--r-- | services/backtweet.json | 58 | ||||
-rw-r--r-- | services/backtype.json | 106 | ||||
-rw-r--r-- | services/github.json | 210 | ||||
-rw-r--r-- | services/ihackernews.json | 74 | ||||
-rw-r--r-- | services/twitter.json | 202 |
7 files changed, 376 insertions, 516 deletions
diff --git a/apps/couchdb.json b/apps/couchdb.json index 118f516..f68529f 100644 --- a/apps/couchdb.json +++ b/apps/couchdb.json @@ -2,90 +2,76 @@ "version" : "0.2", "methods" : { "create_document_without_id" : { - "params" : { - "required" : [ - "database" - ] - }, + "required_params" : [ + "database" + ], "path" : "/:database", "method" : "POST" }, "get_all_documents" : { - "params" : { - "required" : [ - "database" - ], - "optional" : [ - "descending", - "startkey", - "endkey", - "limit", - "include_docs" - ] - }, + "required_params" : [ + "database" + ], + "optional_params" : [ + "descending", + "startkey", + "endkey", + "limit", + "include_docs" + ], "path" : "/:database/_all_docs", "method" : "GET" }, "create_document_with_id" : { - "params" : { - "required" : [ - "database", - "doc_id" - ] - }, + "required_params" : [ + "database", + "doc_id" + ], "path" : "/:database/:doc_id", "method" : "POST" }, "get_document" : { - "params" : { - "required" : [ - "database", - "doc_id" - ], - "optional" : [ - "rev", - "revs" - ] - }, + "required_params" : [ + "database", + "doc_id" + ], + "optional_params" : [ + "rev", + "revs" + ], "path" : "/:database/:doc_id", "method" : "GET" }, "get_all_documents_by_seq" : { - "params" : { - "required" : [ - "database" - ], - "optional" : [ - "startkey", - "endkey", - "limit", - "include_docs" - ] - }, + "required_params" : [ + "database" + ], + "optional_params" : [ + "startkey", + "endkey", + "limit", + "include_docs" + ], "path" : "/:database/_all_docs_by_seq", "method" : "GET" }, "delete_document" : { - "params" : { - "required" : [ - "database", - "doc_id" - ], - "optional" : [ - "rev" - ] - }, + "required_params" : [ + "database", + "doc_id" + ], + "optional_params" : [ + "rev" + ], "path" : "/:database/:doc_id", "method" : "DELETE" } }, - "api_format" : [ + "formats" : [ "json" ], "name" : "CouchDB", - "author" : [ - "franck cuny <franck@lumberjaph.net>" - ], + "authority" : "GITHUB:franckcuny", "meta" : { "documentation" : "http://wiki.apache.org/couchdb/HTTP_Document_API" } diff --git a/apps/presque.json b/apps/presque.json index 4e82cf6..4a5333f 100644 --- a/apps/presque.json +++ b/apps/presque.json @@ -2,63 +2,51 @@ "version" : "0.2", "methods" : { "fetch_job" : { - "params" : { - "required" : [ - "queue_name" - ] - }, - "expected" : [ + "required_params" : [ + "queue_name" + ], + "expected_status" : [ "200" ], "path" : "/q/:queue_name", "method" : "GET" }, "queue_size" : { - "params" : { - "required" : [ - "queue_name" - ] - }, + "required_params" : [ + "queue_name" + ], "path" : "/status/:queue_name", "method" : "GET" }, "reset_queue" : { - "params" : { - "required" : [ - "queue_name" - ] - }, + "required_params" : [ + "queue_name" + ], "path" : "/q/:queue_name", "method" : "DELETE" }, "worker_stats" : { - "params" : { - "optional:" : [ - "worker_id" - ] - }, + "optional_params" : [ + "worker_id" + ], "path" : "/w/", "method" : "GET" }, "unregister_worker" : { - "params" : { - "required" : [ - "queue_name" - ] - }, + "required_params" : [ + "queue_name" + ], "path" : "/w/:queue_name", "method" : "DELETE" }, "create_job" : { - "params" : { - "required" : [ - "queue_name" - ], - "optional" : [ - "delayed", - "uniq" - ] - }, + "required_params" : [ + "queue_name" + ], + "optional_params" : [ + "delayed", + "uniq" + ], "path" : "/q/:queue_name", "method" : "POST" }, @@ -67,92 +55,74 @@ "method" : "GET" }, "failed_job" : { - "params" : { - "required" : [ - "queue_name" - ] - }, + "required_params" : [ + "queue_name" + ], "path" : "/q/:queue_name", "method" : "PUT" }, "register_worker" : { - "params" : { - "required" : [ - "queue_name" - ] - }, + "required_params" : [ + "queue_name" + ], "path" : "/w/:queue_name", "method" : "POST" }, "queue_stats" : { - "params" : { - "optional" : [ - "queue_name" - ] - }, + "optional_params" : [ + "queue_name" + ], "path" : "/w/", "method" : "GET" }, "change_queue_status" : { - "params" : { - "required" : [ - "queue_name" - ] - }, + "required_params" : [ + "queue_name" + ], "path" : "/control/:queue_name", "method" : "POST" }, "fetch_jobs" : { - "params" : { - "required" : [ - "queue_name" - ], - "optional" : [ - "batch_size" - ] - }, - "expected" : [ + "required_params" : [ + "queue_name" + ], + "optional_params" : [ + "batch_size" + ], + "expected_status" : [ "200" ], "path" : "/q/:queue_name", "method" : "GET" }, "queue_info" : { - "params" : { - "required" : [ - "queue_name" - ] - }, + "required_params" : [ + "queue_name" + ], "path" : "/j/:queue_name", "method" : "GET" }, "create_jobs" : { - "params" : { - "required" : [ - "queue_name" - ], - "optional" : [ - "delayed" - ] - }, + "required_params" : [ + "queue_name" + ], + "optional_params" : [ + "delayed" + ], "path" : "/q/:queue_name", "method" : "POST" }, "queue_status" : { - "params" : { - "required" : [ - "queue_name" - ] - }, + "required_params" : [ + "queue_name" + ], "path" : "/control/:queue_name", "method" : "GET" } }, - "api_format" : [ + "formats" : [ "json" ], "name" : "Presque", - "author" : [ - "franck cuny <franck@lumberjaph.net>" - ] + "authority" : "GITHUB:franckcuny" } diff --git a/services/backtweet.json b/services/backtweet.json index 6c8b237..4605f0b 100644 --- a/services/backtweet.json +++ b/services/backtweet.json @@ -1,49 +1,43 @@ { - "api_base_url" : "http://api.backtype.com", + "base_url" : "http://api.backtype.com", "version" : "0.2", "methods" : { "tweets_by_url" : { - "params" : { - "optinal" : [ - "itemsperpage", - "start", - "end" - ], - "required" : [ - "q", - "key" - ] - }, - "expected" : [ + "optional_params" : [ + "itemsperpage", + "start", + "end" + ], + "required_params" : [ + "q", + "key" + ], + "expected_status" : [ "200" ], "path" : "/tweets/search/links", "method" : "GET" }, "stats_by_url" : { - "params" : { - "required" : [ - "q", - "key" - ], - "optional" : [ - "batch" - ] - }, - "expected" : [ + "required_params" : [ + "q", + "key" + ], + "optional_params" : [ + "batch" + ], + "expected_status" : [ "200" ], "path" : "/tweetcount", "method" : "GET" }, "good_tweets_by_url" : { - "params" : { - "required" : [ - "q", - "key" - ] - }, - "expected" : [ + "required_params" : [ + "q", + "key" + ], + "expected_status" : [ "200" ], "path" : "/goodtweets", @@ -51,9 +45,7 @@ } }, "name" : "Backtweet", - "author" : [ - "franck cuny <franck@lumberjaph.net>" - ], + "authority" : "GITHUB:franckcuny", "meta" : { "documentation" : "http://www.backtype.com/developers" } diff --git a/services/backtype.json b/services/backtype.json index ccbeb8f..8ed2159 100644 --- a/services/backtype.json +++ b/services/backtype.json @@ -1,94 +1,82 @@ { - "api_base_url" : "http://api.backtype.com/", + "base_url" : "http://api.backtype.com/", "version" : "0.2", "methods" : { "comments_connect" : { - "params" : { - "required" : [ - "format", - "url" - ], - "optional" : [ - "sources", - "sort", - "key" - ] - }, - "expected" : [ + "required_params" : [ + "format", + "url" + ], + "optional_params" : [ + "sources", + "sort", + "key" + ], + "expected_status" : [ "200" ], "path" : "/comments/connect.:format", "method" : "GET" }, "comments_stats_by_page" : { - "params" : { - "required" : [ - "url", - "format", - "key" - ] - }, - "expected" : [ + "required_params" : [ + "url", + "format", + "key" + ], + "expected_status" : [ "200" ], "path" : "/post/stats.:format", "method" : "GET" }, "comments_connect_stats" : { - "params" : { - "required" : [ - "format", - "url", - "key" - ] - }, - "expected" : [ + "required_params" : [ + "format", + "url", + "key" + ], + "expected_status" : [ "200" ], "path" : "/comments/connect/stats.:format", "method" : "GET" }, "comments_search" : { - "params" : { - "required" : [ - "format", - "q", - "key" - ], - "optional" : [ - "start", - "end" - ] - }, - "expected" : [ + "required_params" : [ + "format", + "q", + "key" + ], + "optional_params" : [ + "start", + "end" + ], + "expected_status" : [ "200" ], "path" : "/comments/search.:format", "method" : "GET" }, "comments_by_author_from_url" : { - "params" : { - "required" : [ - "format", - "key", - "url" - ] - }, - "expected" : [ + "required_params" : [ + "format", + "key", + "url" + ], + "expected_status" : [ "200" ], "path" : "/url/:url/comments.:format", "method" : "GET" }, "comments_by_page" : { - "params" : { - "required" : [ - "url", - "format", - "key" - ] - }, - "expected" : [ + "required_params" : [ + "url", + "format", + "key" + ], + "expected_status" : [ "200" ], "path" : "/post/comments.:format", @@ -96,9 +84,7 @@ } }, "name" : "Backtype", - "author" : [ - "franck cuny <franc@lumberjaph.net>" - ], + "authority" : "GITHUB:franckcuny", "meta" : { "documentation" : "http://www.backtype.com/developers" } diff --git a/services/github.json b/services/github.json index 2e5b161..fc84f07 100644 --- a/services/github.json +++ b/services/github.json @@ -1,226 +1,184 @@ { - "api_base_url" : "http://github.com/api/v2/", + "base_url" : "http://github.com/api/v2/", "version" : "0.2", "methods" : { "follow" : { - "params" : { - "required" : [ - "user", - "format" - ] - }, + "required_params" : [ + "user", + "format" + ], "path" : "/:format/user/follow/:user", "method" : "POST", "authentication" : true }, "user_search" : { - "params" : { - "required" : [ - "format", - "search" - ] - }, + "required_params" : [ + "format", + "search" + ], "path" : "/:format/user/search/:search", "method" : "GET" }, "unfollow" : { - "params" : { - "required" : [ - "user", - "format" - ] - }, + "required_params" : [ + "user", + "format" + ], "path" : "/:format/user/unfollow/:user", "method" : "POST", "authentication" : true }, "unwatch_repo" : { - "params" : { - "required" : [ - "format", - "user", - "repo" - ] - }, + "required_params" : [ + "format", + "user", + "repo" + ], "path" : "/:format/repos/unwatch/:user/:repo", "method" : "GET", "authentication" : true }, "user_information" : { - "params" : { - "required" : [ - "username", - "format" - ] - }, + "required_params" : [ + "username", + "format" + ], "path" : "/:format/user/show/:username", "method" : "GET" }, "list_public_keys" : { - "params" : { - "required" : [ - "format" - ] - }, + "required_params" : [ + "format" + ], "path" : "/:format/user/keys", "method" : "GET", "authentication" : true }, "repos_info" : { - "params" : { - "required" : [ - "format", - "user", - "repo" - ] - }, + "required_params" : [ + "format", + "user", + "repo" + ], "path" : "/:format/repos/:user/:repo", "method" : "GET" }, "add_public_key" : { - "params" : { - "required" : [ - "format" - ] - }, + "required_params" : [ + "format" + ], "path" : "/:format/user/key/add", "method" : "POST", "authentication" : true }, "fork_repos" : { - "params" : { - "required" : [ - "format", - "user", - "repo" - ] - }, + "required_params" : [ + "format", + "user", + "repo" + ], "path" : "/:format/repos/fork/:user/:repo", "method" : "GET", "authentication" : true }, "my_information" : { - "params" : { - "required" : [ - "username", - "format" - ] - }, + "required_params" : [ + "username", + "format" + ], "path" : "/:format/user/show/:username", "method" : "GET", "authentication" : true }, "list_all_repos" : { - "params" : { - "required" : [ - "format", - "user", - "repo" - ] - }, + "required_params" : [ + "format", + "user", + "repo" + ], "path" : "/:format/repos/show/:user", "method" : "GET" }, "repos_search" : { - "params" : { - "required" : [ - "format", - "q" - ] - }, + "required_params" : [ + "format", + "q" + ], "path" : "/:format/repos/search/:q", "method" : "GET" }, "update_profile" : { - "params" : { - "required" : [ - "username", - "format" - ] - }, + "required_params" : [ + "username", + "format" + ], "path" : "/:format/user/show/:username", "method" : "POST", "authentication" : true }, "watch_repo" : { - "params" : { - "required" : [ - "format", - "user", - "repo" - ] - }, + "required_params" : [ + "format", + "user", + "repo" + ], "path" : "/:format/repos/watch/:user/:repo", "method" : "GET", "authentication" : true }, "create_repo" : { - "params" : { - "required" : [ - "format" - ] - }, + "required_params" : [ + "format" + ], "path" : "/:format/repos/create", "method" : "POST", "authentication" : true }, "user_following" : { - "params" : { - "required" : [ - "user", - "format" - ] - }, + "required_params" : [ + "user", + "format" + ], "path" : "/:format/user/show/:user/following", "method" : "GET" }, "set_repo_info" : { - "params" : { - "required" : [ - "format", - "user", - "repo" - ] - }, + "required_params" : [ + "format", + "user", + "repo" + ], "path" : "/:format/repos/show/:user/:repo", "method" : "POST", "authentication" : true }, "watched_repos" : { - "params" : { - "required" : [ - "format", - "user" - ] - }, + "required_params" : [ + "format", + "user" + ], "path" : "/:format/user/watched/:user", "method" : "GET" }, "user_followers" : { - "params" : { - "required" : [ - "user", - "format" - ] - }, + "required_params" : [ + "user", + "format" + ], "path" : "/:format/user/show/:user/followers", "method" : "GET" }, "del_public_key" : { - "params" : { - "required" : [ - "format" - ] - }, + "required_params" : [ + "format" + ], "path" : "/:format/user/key/remove", "method" : "POST", "authentication" : true } }, "name" : "GitHub", - "author" : [ - "franck cuny <franck@lumberjaph.net>" - ], + "authority" : "GITHUB:franckcuny", "meta" : { "documentation" : "http://develop.github.com/" } diff --git a/services/ihackernews.json b/services/ihackernews.json index a63353b..52fbb3b 100644 --- a/services/ihackernews.json +++ b/services/ihackernews.json @@ -1,14 +1,12 @@ { - "api_base_url" : "api.ihackernews.com", + "base_url" : "api.ihackernews.com", "version" : "0.02", "methods" : { "askhn_posts" : { - "params" : { - "optional" : [ - "nextid" - ] - }, - "expected" : [ + "optional_params" : [ + "nextid" + ], + "expected_status" : [ "200" ], "path" : "/ask/:nextid", @@ -23,12 +21,10 @@ "method" : "POST" }, "new_posts" : { - "params" : { - "optional" : [ - "nextid" - ] - }, - "expected" : [ + "optional_params" : [ + "nextid" + ], + "expected_status" : [ "200" ], "path" : "/new/:nextid", @@ -39,64 +35,54 @@ "method" : "POST" }, "user_profile" : { - "params" : { - "required" : [ - "userid" - ] - }, - "expected" : [ + "required_params" : [ + "userid" + ], + "expected_status" : [ "200" ], "path" : "/profile/:userid", "method" : "GET" }, "retrieve_page" : { - "params" : { - "optinal" : [ - "nextid" - ] - }, - "expected" : [ + "optional_params" : [ + "nextid" + ], + "expected_status" : [ "200" ], "path" : "/page/:nextid", "method" : "GET" }, "posts_from_user" : { - "params" : { - "required" : [ - "username" - ], - "optional" : [ - "nextid" - ] - }, - "expected" : [ + "required_params" : [ + "username" + ], + "optional_params" : [ + "nextid" + ], + "expected_status" : [ "200" ], "path" : "/by/:username/:nextid", "method" : "GET" }, "comments_for_post" : { - "params" : { - "required" : [ - "id" - ] - }, - "expected" : [ + "required_params" : [ + "id" + ], + "expected_status" : [ "200" ], "path" : "/comments/:id", "method" : "GET" } }, - "api_format" : [ + "formats" : [ "json" ], "name" : "ihackernews", - "author" : [ - "franck cuny <franck@lumberjaph.net>" - ], + "authority" : "GITHUB:franckcuny", "meta" : { "documentation" : "http://api.ihackernews.com/" } diff --git a/services/twitter.json b/services/twitter.json index cc5cfd8..890cede 100644 --- a/services/twitter.json +++ b/services/twitter.json @@ -1,161 +1,143 @@ { - "api_base_url" : "http://api.twitter.com/1", + "base_url" : "http://api.twitter.com/1", "version" : "0.2", "methods" : { "retweets_of_me" : { - "params" : { - "required" : [ - "format" - ], - "optional" : [ - "since_id", - "max_id", - "count", - "page", - "trim_user", - "include_entities" - ] - }, + "required_params" : [ + "format" + ], + "optional_params" : [ + "since_id", + "max_id", + "count", + "page", + "trim_user", + "include_entities" + ], "path" : "/statuses/retweets_of_me.:format", "method" : "GET", "authentication" : true }, "friends_timeline" : { - "params" : { - "required" : [ - "format" - ], - "optional" : [ - "since_id", - "max_id", - "count", - "page", - "trim_user", - "include_rts", - "include_entities" - ] - }, + "required_params" : [ + "format" + ], + "optional_params" : [ + "since_id", + "max_id", + "count", + "page", + "trim_user", + "include_rts", + "include_entities" + ], "path" : "/statuses/friends_timeline.:format", "method" : "GET", "authentication" : true }, "user_timeline" : { - "params" : { - "required" : [ - "format" - ], - "optional" : [ - "user_id", - "screen_name", - "since_id", - "max_id", - "count", - "page", - "trim_user", - "include_rts", - "include_entities" - ] - }, + "required_params" : [ + "format" + ], + "optional_params" : [ + "user_id", + "screen_name", + "since_id", + "max_id", + "count", + "page", + "trim_user", + "include_rts", + "include_entities" + ], "path" : "/statuses/user_timeline.:format", "method" : "GET" }, "public_timeline" : { - "params" : { - "required" : [ - "format" - ], - "optional" : [ - "trim_user", - "include_entities" - ] - }, + "required_params" : [ + "format" + ], + "optional_params" : [ + "trim_user", + "include_entities" + ], "path" : "/statuses/public_timeline.:format", "method" : "GET" }, "mentions" : { - "params" : { - "required" : [ - "format" - ], - "optional" : [ - "since_id", - "max_id", - "count", - "page", - "trim_user", - "include_rts", - "include_entities" - ] - }, + "required_params" : [ + "format" + ], + "optional_params" : [ + "since_id", + "max_id", + "count", + "page", + "trim_user", + "include_rts", + "include_entities" + ], "path" : "/statuses/mentions.:format", "method" : "GET", "authentication" : true }, "home_timeline" : { - "params" : { - "params" : [ - "since_id", - "max_id", - "count", - "page", - "trim_user", - "include_entities" - ], - "required" : [ - "format" - ] - }, + "optional_params" : [ + "since_id", + "max_id", + "count", + "page", + "trim_user", + "include_entities" + ], + "required_params" : [ + "format" + ], "path" : "/statuses/home_timeline.:format", "method" : "GET", "authentication" : true }, "retweeted_by_me" : { - "params" : { - "required" : [ - "format" - ], - "optional" : [ - "since_id", - "max_id", - "count", - "page", - "trim_user", - "include_entities" - ] - }, + "required_params" : [ + "format" + ], + "optional_params" : [ + "since_id", + "max_id", + "count", + "page", + "trim_user", + "include_entities" + ], "path" : "/statuses/retweeted_by_me.:format", "method" : "GET", "authentication" : true }, "retweeted_to_me" : { - "params" : { - "required" : [ - "format" - ], - "optional" : [ - "since_id", - "max_id", - "count", - "page", - "trim_user", - "include_entities" - ] - }, + "required_params" : [ + "format" + ], + "optional_params" : [ + "since_id", + "max_id", + "count", + "page", + "trim_user", + "include_entities" + ], "path" : "/statuses/retweeted_to_me.:format", "method" : "GET", "authentication" : true } }, - "api_format" : [ + "formats" : [ "json", "rss", "xml", "atom" ], "name" : "Twitter", - "author" : [ - "franck cuny <franck@lumberjaph.net>" - ], + "authority" : "GITHUB:franckcuny", "meta" : { "documentation" : "http://dev.twitter.com/" } |