Return-Path: X-Original-To: apmail-couchdb-commits-archive@www.apache.org Delivered-To: apmail-couchdb-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id D282D17763 for ; Tue, 3 Feb 2015 15:13:45 +0000 (UTC) Received: (qmail 90067 invoked by uid 500); 3 Feb 2015 15:13:10 -0000 Delivered-To: apmail-couchdb-commits-archive@couchdb.apache.org Received: (qmail 89922 invoked by uid 500); 3 Feb 2015 15:13:10 -0000 Mailing-List: contact commits-help@couchdb.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@couchdb.apache.org Delivered-To: mailing list commits@couchdb.apache.org Received: (qmail 88933 invoked by uid 99); 3 Feb 2015 15:13:09 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 03 Feb 2015 15:13:09 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 1DE03E04D1; Tue, 3 Feb 2015 15:13:09 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: robertkowalski@apache.org To: commits@couchdb.apache.org Date: Tue, 03 Feb 2015 15:13:26 -0000 Message-Id: <11bb799693144d459429fd32f3f5f6b2@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [19/50] [abbrv] couchdb-mango git commit: Update README.md with finalised HTTP API endpoints Update README.md with finalised HTTP API endpoints Project: http://git-wip-us.apache.org/repos/asf/couchdb-mango/repo Commit: http://git-wip-us.apache.org/repos/asf/couchdb-mango/commit/77911e0b Tree: http://git-wip-us.apache.org/repos/asf/couchdb-mango/tree/77911e0b Diff: http://git-wip-us.apache.org/repos/asf/couchdb-mango/diff/77911e0b Branch: refs/heads/master Commit: 77911e0b4602c52f56fd32247221b2cb0c25b7f8 Parents: e9ced73 Author: Joan Touzet Authored: Mon Nov 17 09:53:35 2014 +0100 Committer: Joan Touzet Committed: Mon Nov 17 09:53:35 2014 +0100 ---------------------------------------------------------------------- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/couchdb-mango/blob/77911e0b/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index d7dadf8..382681f 100644 --- a/README.md +++ b/README.md @@ -334,12 +334,12 @@ A trivial example: ["foo", "bar", "baz"] -Alternative HTTP API -==================== +HTTP API +======== -This is quick off the top of my head from discussions today. I'm not sure if we should include the \_mango component or use \_find and \_index at the top level. These are trivial to change in the future though as long as we agree on the method and request/response bodies. +Short summary until the full documentation can be brought over. -POST /dbname/\_mango/find +POST /dbname/\_find ------------------------- Issue a query. @@ -348,21 +348,21 @@ Request body is a JSON object that has the selector and the various options like Response is streamed out like a view. -POST /dbname/\_mango/index +POST /dbname/\_index -------------------------- Request body contains the index definition. Response body is empty and the result is returned as the status code (200 OK -> created, 3something for exists). -GET /dbname/\_mango/index +GET /dbname/\_index ------------------------- Request body is empty. Response body is all of the indexes that are available for use by find. -DELETE /dbname/\_mango/index/ddocid/viewname +DELETE /dbname/\_index/ddocid/viewname -------------------------------------------- Remove the specified index.