You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by kx...@apache.org on 2013/09/28 13:09:47 UTC
[2/9] git commit: updated refs/heads/1781-reorganize-and-improve-docs
to 5522488
Normalize API path's params names.
Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/d282c828
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/d282c828
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/d282c828
Branch: refs/heads/1781-reorganize-and-improve-docs
Commit: d282c828ab61b8822c0dfc27b370b32977ce0ccd
Parents: a00c6a4
Author: Alexander Shorin <kx...@apache.org>
Authored: Sat Sep 28 09:22:21 2013 +0400
Committer: Alexander Shorin <kx...@apache.org>
Committed: Sat Sep 28 09:22:21 2013 +0400
----------------------------------------------------------------------
share/doc/src/api/ddoc/common.rst | 24 ++++++++++++------------
share/doc/src/api/ddoc/rewrites.rst | 4 ++--
share/doc/src/api/ddoc/views.rst | 12 ++++++------
share/doc/src/api/local.rst | 8 ++++----
4 files changed, 24 insertions(+), 24 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/couchdb/blob/d282c828/share/doc/src/api/ddoc/common.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/ddoc/common.rst b/share/doc/src/api/ddoc/common.rst
index 1e5b183..79c7357 100644
--- a/share/doc/src/api/ddoc/common.rst
+++ b/share/doc/src/api/ddoc/common.rst
@@ -16,7 +16,7 @@
``/db/_design/design-doc``
==========================
-.. http:head:: /{db}/_design/{ddocname}
+.. http:head:: /{db}/_design/{ddoc}
Returns the HTTP Headers containing a minimal amount of information
about the specified design document.
@@ -26,7 +26,7 @@
:http:head:`/{db}/{docid}`
-.. http:get:: /{db}/_design/{ddocname}
+.. http:get:: /{db}/_design/{ddoc}
Returns design document with the specified design document` from the specified
database. Unless you request a specific revision, the latest revision of the
@@ -37,7 +37,7 @@
:http:get:`/{db}/{docid}`
-.. http:put:: /{db}/_design/{ddocname}
+.. http:put:: /{db}/_design/{ddoc}
The :http:method:`PUT` method creates a new named design document, or creates
a new revision of the existing design document.
@@ -67,7 +67,7 @@
:http:put:`/{db}/{docid}`
-.. http:delete:: /{db}/_design/{ddocname}
+.. http:delete:: /{db}/_design/{ddoc}
Deletes the specified document from the database. You must supply the
current (latest) revision, either by using the ``rev`` parameter to
@@ -77,7 +77,7 @@
:http:delete:`/{db}/{docid}`
-.. http:copy:: /{db}/_design/{ddocname}
+.. http:copy:: /{db}/_design/{ddoc}
The :http:method:`COPY` (which is non-standard HTTP) copies an existing
design document to a new or existing one.
@@ -97,7 +97,7 @@
``/db/_design/design-doc/attachment``
=====================================
-.. http:head:: /{db}/_design/{ddocname}/{attname}
+.. http:head:: /{db}/_design/{ddoc}/{attname}
Returns the HTTP headers containing a minimal amount of information
about the specified attachment.
@@ -106,7 +106,7 @@
:http:head:`/{db}/{docid}/{attname}`
-.. http:get:: /{db}/_design/{ddocname}/{attname}
+.. http:get:: /{db}/_design/{ddoc}/{attname}
Returns the file attachment associated with the design document.
The raw data of the associated attachment is returned (just as if you were
@@ -116,7 +116,7 @@
:http:get:`/{db}/{docid}/{attname}`
-.. http:put:: /{db}/_design/{ddocname}/{attname}
+.. http:put:: /{db}/_design/{ddoc}/{attname}
Uploads the supplied content as an attachment to the specified design
document. The attachment name provided must be a URL encoded string.
@@ -125,7 +125,7 @@
:http:put:`/{db}/{docid}/{attname}`
-.. http:delete:: /{db}/_design/{ddocname}/{attname}
+.. http:delete:: /{db}/_design/{ddoc}/{attname}
Deletes the attachment of the specified design document.
@@ -139,14 +139,14 @@
``/db/_design/design-doc/_info``
================================
-.. http:get:: /{db}/_design/{ddocname}/_info
+.. http:get:: /{db}/_design/{ddoc}/_info
Obtains information about the specified design document, including the index,
index size and current status of the design document and associated
index information.
:param db: Database name
- :param ddocname: Design document name
+ :param ddoc: Design document name
:<header Accept: - :mimetype:`application/json`
- :mimetype:`text/plain`
:>header Content-Type: - :mimetype:`application/json`
@@ -196,7 +196,7 @@
View Index Information
----------------------
-The response from :http:get:`/{db}/_design/{ddocname}/_info` contains
+The response from :http:get:`/{db}/_design/{ddoc}/_info` contains
``view_index`` (*object*) field with the next structure:
* **compact_running** (*boolean*): Indicates whether a compaction routine
http://git-wip-us.apache.org/repos/asf/couchdb/blob/d282c828/share/doc/src/api/ddoc/rewrites.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/ddoc/rewrites.rst b/share/doc/src/api/ddoc/rewrites.rst
index 3bcf6b4..61eebed 100644
--- a/share/doc/src/api/ddoc/rewrites.rst
+++ b/share/doc/src/api/ddoc/rewrites.rst
@@ -16,7 +16,7 @@
``/db/_design/design-doc/_rewrite/path``
========================================
-.. http:any:: /{db}/_design/{ddocname}/_rewrite/{path}
+.. http:any:: /{db}/_design/{ddoc}/_rewrite/{path}
Rewrites the specified path by rules defined in the specified design document.
@@ -85,5 +85,5 @@
are depended on endpoint to which url will be rewrited.
:param db: Database name
- :param ddocname: Design document name
+ :param ddoc: Design document name
:param path: URL path to rewrite
http://git-wip-us.apache.org/repos/asf/couchdb/blob/d282c828/share/doc/src/api/ddoc/views.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/ddoc/views.rst b/share/doc/src/api/ddoc/views.rst
index ade789c..7834539 100644
--- a/share/doc/src/api/ddoc/views.rst
+++ b/share/doc/src/api/ddoc/views.rst
@@ -16,13 +16,13 @@
``/db/_design/design-doc/_view/view-name``
==========================================
-.. http:get:: /{db}/_design/{ddocname}/_view/{viewname}
+.. http:get:: /{db}/_design/{ddoc}/_view/{view}
Executes the specified view function from the specified design document.
:param db: Database name
- :param ddocname: Design document name
- :param viewname: View function name
+ :param ddoc: Design document name
+ :param view: View function name
:<header Accept: - :mimetype:`application/json`
- :mimetype:`text/plain`
@@ -123,14 +123,14 @@
}
-.. http:post:: /{db}/_design/{ddocname}/_view/{viewname}
+.. http:post:: /{db}/_design/{ddoc}/_view/{view}
Executes the specified view function from the specified design document.
- Unlike the :http:get:`/{db}/_design/{ddocname}/_view/{viewname}` method
+ Unlike the :http:get:`/{db}/_design/{ddoc}/_view/{view}` method
for accessing views, the :http:method:`POST` method supports the specification
of explicit keys to be retrieved from the view results. The remainder of the
:http:method:`POST` view functionality is identical to the
- :http:get:`/{db}/_design/{ddocname}/_view/{viewname}` API.
+ :http:get:`/{db}/_design/{ddoc}/_view/{view}` API.
**Request**:
http://git-wip-us.apache.org/repos/asf/couchdb/blob/d282c828/share/doc/src/api/local.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/local.rst b/share/doc/src/api/local.rst
index 83a64cf..0fb6d6c 100644
--- a/share/doc/src/api/local.rst
+++ b/share/doc/src/api/local.rst
@@ -55,25 +55,25 @@ A list of the available methods and URL paths are provided below:
``/db/_local/id``
========================
-.. http:get:: /{db}/_local/{id}
+.. http:get:: /{db}/_local/{docid}
Gets the specified local document. The semantics are identical to
accessing a standard document in the specified database, except that the
document is not replicated. See :http:get:`/{db}/{docid}`.
-.. http:put:: /{db}/_local/{id}
+.. http:put:: /{db}/_local/{docid}
Stores the specified local document. The semantics are identical to
storing a standard document in the specified database, except that the
document is not replicated. See :http:put:`/{db}/{docid}`.
-.. http:delete:: /{db}/_local/{id}
+.. http:delete:: /{db}/_local/{docid}
Deletes the specified local document. The semantics are identical to
deleting a standard document in the specified database, except that the
document is not replicated. See :http:delete:`/{db}/{docid}`.
-.. http:copy:: /{db}/_local/{id}
+.. http:copy:: /{db}/_local/{docid}
Copies the specified local document. The semantics are identical to
copying a standard document in the specified database, except that the