summaryrefslogtreecommitdiff
path: root/apps
diff options
context:
space:
mode:
authorfranck cuny <franck@lumberjaph.net>2010-10-14 13:30:56 +0200
committerfranck cuny <franck@lumberjaph.net>2010-10-14 13:30:56 +0200
commit3c05849a282bac0ef6b085266534916acffcfc6d (patch)
tree38948b6c63c9dbb3c9d10bf75a0ee0a49d882079 /apps
parentadd perl script to validate a specification (diff)
downloadapi-description-3c05849a282bac0ef6b085266534916acffcfc6d.tar.gz
update all description to reflect recent changes in specifications
Diffstat (limited to 'apps')
-rw-r--r--apps/couchdb.json96
-rw-r--r--apps/presque.json140
2 files changed, 138 insertions, 98 deletions
diff --git a/apps/couchdb.json b/apps/couchdb.json
index d1ca4a5..118f516 100644
--- a/apps/couchdb.json
+++ b/apps/couchdb.json
@@ -1,68 +1,80 @@
{
- "version" : "0.1",
+ "version" : "0.2",
"methods" : {
"create_document_without_id" : {
- "required" : [
- "database"
- ],
+ "params" : {
+ "required" : [
+ "database"
+ ]
+ },
"path" : "/:database",
"method" : "POST"
},
"get_all_documents" : {
- "params" : [
- "descending",
- "startkey",
- "endkey",
- "limit",
- "include_docs"
- ],
- "required" : [
- "database"
- ],
+ "params" : {
+ "required" : [
+ "database"
+ ],
+ "optional" : [
+ "descending",
+ "startkey",
+ "endkey",
+ "limit",
+ "include_docs"
+ ]
+ },
"path" : "/:database/_all_docs",
"method" : "GET"
},
"create_document_with_id" : {
- "required" : [
- "database",
- "doc_id"
- ],
+ "params" : {
+ "required" : [
+ "database",
+ "doc_id"
+ ]
+ },
"path" : "/:database/:doc_id",
"method" : "POST"
},
"get_document" : {
- "params" : [
- "rev",
- "revs"
- ],
- "required" : [
- "database",
- "doc_id"
- ],
+ "params" : {
+ "required" : [
+ "database",
+ "doc_id"
+ ],
+ "optional" : [
+ "rev",
+ "revs"
+ ]
+ },
"path" : "/:database/:doc_id",
"method" : "GET"
},
"get_all_documents_by_seq" : {
- "params" : [
- "startkey",
- "endkey",
- "limit",
- "include_docs"
- ],
- "required" : [
- "database"
- ],
+ "params" : {
+ "required" : [
+ "database"
+ ],
+ "optional" : [
+ "startkey",
+ "endkey",
+ "limit",
+ "include_docs"
+ ]
+ },
"path" : "/:database/_all_docs_by_seq",
"method" : "GET"
},
"delete_document" : {
- "params" : [
- "rev"
- ],
- "required" : [
- "database",
- "doc_id"
- ],
+ "params" : {
+ "required" : [
+ "database",
+ "doc_id"
+ ],
+ "optional" : [
+ "rev"
+ ]
+ },
"path" : "/:database/:doc_id",
"method" : "DELETE"
}
diff --git a/apps/presque.json b/apps/presque.json
index 3287cd0..4e82cf6 100644
--- a/apps/presque.json
+++ b/apps/presque.json
@@ -1,13 +1,12 @@
{
- "format" : [
- "json"
- ],
- "version" : "0.1",
+ "version" : "0.2",
"methods" : {
"fetch_job" : {
- "required" : [
- "queue_name"
- ],
+ "params" : {
+ "required" : [
+ "queue_name"
+ ]
+ },
"expected" : [
"200"
],
@@ -15,41 +14,51 @@
"method" : "GET"
},
"queue_size" : {
- "required" : [
- "queue_name"
- ],
+ "params" : {
+ "required" : [
+ "queue_name"
+ ]
+ },
"path" : "/status/:queue_name",
"method" : "GET"
},
"reset_queue" : {
- "required" : [
- "queue_name"
- ],
+ "params" : {
+ "required" : [
+ "queue_name"
+ ]
+ },
"path" : "/q/:queue_name",
"method" : "DELETE"
},
"worker_stats" : {
- "params" : [
- "worker_id"
- ],
+ "params" : {
+ "optional:" : [
+ "worker_id"
+ ]
+ },
"path" : "/w/",
"method" : "GET"
},
"unregister_worker" : {
- "required" : [
- "queue_name"
- ],
+ "params" : {
+ "required" : [
+ "queue_name"
+ ]
+ },
"path" : "/w/:queue_name",
"method" : "DELETE"
},
"create_job" : {
- "params" : [
- "delayed",
- "uniq"
- ],
- "required" : [
- "queue_name"
- ],
+ "params" : {
+ "required" : [
+ "queue_name"
+ ],
+ "optional" : [
+ "delayed",
+ "uniq"
+ ]
+ },
"path" : "/q/:queue_name",
"method" : "POST"
},
@@ -58,40 +67,50 @@
"method" : "GET"
},
"failed_job" : {
- "required" : [
- "queue_name"
- ],
+ "params" : {
+ "required" : [
+ "queue_name"
+ ]
+ },
"path" : "/q/:queue_name",
"method" : "PUT"
},
"register_worker" : {
- "required" : [
- "queue_name"
- ],
+ "params" : {
+ "required" : [
+ "queue_name"
+ ]
+ },
"path" : "/w/:queue_name",
"method" : "POST"
},
"queue_stats" : {
- "required" : [
- "queue_name"
- ],
+ "params" : {
+ "optional" : [
+ "queue_name"
+ ]
+ },
"path" : "/w/",
"method" : "GET"
},
"change_queue_status" : {
- "required" : [
- "queue_name"
- ],
+ "params" : {
+ "required" : [
+ "queue_name"
+ ]
+ },
"path" : "/control/:queue_name",
"method" : "POST"
},
"fetch_jobs" : {
- "params" : [
- "batch_size"
- ],
- "required" : [
- "queue_name"
- ],
+ "params" : {
+ "required" : [
+ "queue_name"
+ ],
+ "optional" : [
+ "batch_size"
+ ]
+ },
"expected" : [
"200"
],
@@ -99,30 +118,39 @@
"method" : "GET"
},
"queue_info" : {
- "required" : [
- "queue_name"
- ],
+ "params" : {
+ "required" : [
+ "queue_name"
+ ]
+ },
"path" : "/j/:queue_name",
"method" : "GET"
},
"create_jobs" : {
- "params" : [
- "delayed"
- ],
- "required" : [
- "queue_name"
- ],
+ "params" : {
+ "required" : [
+ "queue_name"
+ ],
+ "optional" : [
+ "delayed"
+ ]
+ },
"path" : "/q/:queue_name",
"method" : "POST"
},
"queue_status" : {
- "required" : [
- "queue_name"
- ],
+ "params" : {
+ "required" : [
+ "queue_name"
+ ]
+ },
"path" : "/control/:queue_name",
"method" : "GET"
}
},
+ "api_format" : [
+ "json"
+ ],
"name" : "Presque",
"author" : [
"franck cuny <franck@lumberjaph.net>"