about summary refs log tree commit diff
diff options
context:
space:
mode:
authorfranck cuny <franck@lumberjaph.net>2011-05-29 13:55:05 +0200
committerfranck cuny <franck@lumberjaph.net>2011-05-29 13:55:05 +0200
commitd623ba261254b4fdbd4c4dba17f5bf3f2d90311f (patch)
treef18ca79e3a49d5597747194e75f418471b6d902c
parentMerge branch 'master' of github.com:SPORE/api-description (diff)
downloadapi-description-d623ba261254b4fdbd4c4dba17f5bf3f2d90311f.tar.gz
add indextank to SPORE
Signed-off-by: franck cuny <franck@lumberjaph.net>
-rw-r--r--services/indextank.json88
1 files changed, 88 insertions, 0 deletions
diff --git a/services/indextank.json b/services/indextank.json
new file mode 100644
index 0000000..5e876af
--- /dev/null
+++ b/services/indextank.json
@@ -0,0 +1,88 @@
+{
+"version":"0.1",
+"name":"IndexTank",
+"authority":"http://github.com/SPORE",
+"method":{
+  "documentation":"http://indextank.com/documentation/api"
+},
+"methods":{
+  "list_indexes":{
+    "path":"/v1/indexes",
+    "method":"GET",
+    "expected_status":[200]
+  },
+  "get_index":{
+    "path":"/v1/indexes/:name",
+    "method":"GET",
+    "expected_status":[200],
+    "required_params":["name"]
+  },
+  "create_index":{
+    "path":"/v1/indexes/:name",
+    "method":"PUT",
+    "expected_status":[201,204],
+    "required_params":["name"]
+  },
+  "delete_index":{
+    "path":"/v1/indexes/:name",
+    "method":"DELETE",
+    "expected_status":[200],
+    "required_params":["name"]
+  },
+  "add_documents":{
+    "path":"/v1/indexes/:name/docs",
+    "method":"PUT",
+    "expected_status":[200],
+    "required_params":["name"]
+  },
+  "delete_document":{
+    "path":"/v1/indexes/:name/docs",
+    "method":"DELETE",
+    "expected_status":[200],
+    "required_params":["docid", "name"]
+  },
+  "update_variables":{
+    "path":"/v1/indexes/:name/docs/variables",
+    "method":"PUT",
+    "expected_status":[200],
+    "required_params":["name"]
+  },
+  "update_categories":{
+    "path":"/v1/indexes/:name/docs/categories",
+    "method":"PUT",
+    "expected_status":[200],
+    "required_params":["name"]
+  },
+  "add_function":{
+    "path":"/v1/indexes/:name/functions/:number",
+    "method":"PUT",
+    "expected_status":[200],
+    "required_params":["name"]
+  },
+  "get_functions":{
+    "path":"/v1/indexes/:name/functions",
+    "method":"GET",
+    "expected_status":[200],
+    "required_params":["name"]
+  },
+  "delete_function":{
+    "path":"/v1/indexes/:name/functions/:number",
+    "method":"DELETE",
+    "expected_status":[200],
+    "required_params":["name"]
+  },
+  "search":{
+    "path":"/v1/indexes/:name/search",
+    "method":"GET",
+    "expected_status":[200],
+    "required_params":["name", "q"],
+    "optional_params":["start", "len", "function", "fetch", "snippet", "var", "category_filters", "filter_docvar","filter_function"]
+  },
+  "promote":{
+    "path":"/v1/indexes/:name/promote",
+    "method":"PUT",
+    "expected_status":[200],
+    "required_params":["name"]
+  }
+}
+}