summaryrefslogtreecommitdiff
path: root/services/ihackernews.json
diff options
context:
space:
mode:
authorfranck cuny <franck@lumberjaph.net>2010-10-17 17:33:55 +0200
committerfranck cuny <franck@lumberjaph.net>2010-10-17 17:33:55 +0200
commit8d4761846e852d1147b982ca6c4d0199ee5746cf (patch)
tree29b5d1b4ec5f10ff1641063f1e2968dc6b61206c /services/ihackernews.json
parentupdate all description to reflect recent changes in specifications (diff)
downloadapi-description-8d4761846e852d1147b982ca6c4d0199ee5746cf.tar.gz
update description to current specification
Diffstat (limited to 'services/ihackernews.json')
-rw-r--r--services/ihackernews.json74
1 files changed, 30 insertions, 44 deletions
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/"
}