diff options
| author | franck cuny <franck@lumberjaph.net> | 2010-10-14 13:30:56 +0200 |
|---|---|---|
| committer | franck cuny <franck@lumberjaph.net> | 2010-10-14 13:30:56 +0200 |
| commit | 3c05849a282bac0ef6b085266534916acffcfc6d (patch) | |
| tree | 38948b6c63c9dbb3c9d10bf75a0ee0a49d882079 /apps/couchdb.json | |
| parent | add perl script to validate a specification (diff) | |
| download | api-description-3c05849a282bac0ef6b085266534916acffcfc6d.tar.gz | |
update all description to reflect recent changes in specifications
Diffstat (limited to '')
| -rw-r--r-- | apps/couchdb.json | 96 |
1 files changed, 54 insertions, 42 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" } |