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/08/21 18:38:17 UTC
[50/50] git commit: updated
refs/heads/1781-reorganize-and-improve-docs to 360107b
Remove API tables in favor of reference index.
Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/360107ba
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/360107ba
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/360107ba
Branch: refs/heads/1781-reorganize-and-improve-docs
Commit: 360107ba0ec45d7d2b56f34faa6101e15fb93c98
Parents: 6cc2f4b
Author: Alexander Shorin <kx...@apache.org>
Authored: Wed Aug 21 20:36:45 2013 +0400
Committer: Alexander Shorin <kx...@apache.org>
Committed: Wed Aug 21 20:36:45 2013 +0400
----------------------------------------------------------------------
share/doc/src/api/database/index.rst | 65 -------------------------
share/doc/src/api/document/index.rst | 28 -----------
share/doc/src/api/server/authn.rst | 13 -----
share/doc/src/api/server/configuration.rst | 18 -------
share/doc/src/api/server/index.rst | 47 ------------------
5 files changed, 171 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/couchdb/blob/360107ba/share/doc/src/api/database/index.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/database/index.rst b/share/doc/src/api/database/index.rst
index 92361e3..2441fd4 100644
--- a/share/doc/src/api/database/index.rst
+++ b/share/doc/src/api/database/index.rst
@@ -19,71 +19,6 @@ Database Methods
The Database methods provide an interface to an entire database withing
CouchDB. These are database, rather than document, level requests.
-A list of the available methods and URL paths are provided below:
-
-+--------+-------------------------+-------------------------------------------+
-| Method | Path | Description |
-+========+=========================+===========================================+
-| HEAD | /db | Checks database existence |
-+--------+-------------------------+-------------------------------------------+
-| GET | /db | Returns database information |
-+--------+-------------------------+-------------------------------------------+
-| PUT | /db | Create a new database |
-+--------+-------------------------+-------------------------------------------+
-| DELETE | /db | Delete an existing database |
-+--------+-------------------------+-------------------------------------------+
-| GET | /db/_all_docs | Returns a built-in view of all documents |
-| | | in this database |
-+--------+-------------------------+-------------------------------------------+
-| POST | /db/_all_docs | Returns certain rows from the built-in |
-| | | view of all documents |
-+--------+-------------------------+-------------------------------------------+
-| POST | /db/_bulk_docs | Insert multiple documents in to the |
-| | | database in a single request |
-+--------+-------------------------+-------------------------------------------+
-| GET | /db/_changes | Returns changes for the given database |
-+--------+-------------------------+-------------------------------------------+
-| POST | /db/_compact | Starts a compaction for the database |
-+--------+-------------------------+-------------------------------------------+
-| POST | /db/_compact/design-doc | Starts a compaction for all the views in |
-| | | the selected design document |
-+--------+-------------------------+-------------------------------------------+
-| POST | /db/_ensure_full_commit | Makes sure all uncommitted changes are |
-| | | written and synchronized to the disk |
-+--------+-------------------------+-------------------------------------------+
-| POST | /db/_missing_revs | Given a list of document revisions, |
-| | | returns the document revisions that do not|
-| | | exist in the database |
-+--------+-------------------------+-------------------------------------------+
-| POST | /db/_purge | Purge some historical documents entirely |
-| | | from database history |
-+--------+-------------------------+-------------------------------------------+
-| POST | /db/_revs_diff | Given a list of document revisions, |
-| | | returns differences between the given |
-| | | revisions and ones that are in the |
-| | | database |
-+--------+-------------------------+-------------------------------------------+
-| GET | /db/_revs_limit | Gets the limit of historical revisions to |
-| | | store for a single document in the |
-| | | database |
-+--------+-------------------------+-------------------------------------------+
-| PUT | /db/_revs_limit | Sets the limit of historical revisions to |
-| | | store for a single document in the |
-| | | database |
-+--------+-------------------------+-------------------------------------------+
-| GET | /db/_security | Returns the special security object for |
-| | | the database |
-+--------+-------------------------+-------------------------------------------+
-| PUT | /db/_security | Sets the special security object for the |
-| | | database |
-+--------+-------------------------+-------------------------------------------+
-| POST | /db/_temp_view | Execute a given view function for all |
-| | | documents and return the result |
-+--------+-------------------------+-------------------------------------------+
-| POST | /db/_view_cleanup | Removes view files that are not used by |
-| | | any design document |
-+--------+-------------------------+-------------------------------------------+
-
For all the database methods, the database name within the URL path
should be the database name that you wish to perform the operation on.
For example, to obtain the meta information for the database
http://git-wip-us.apache.org/repos/asf/couchdb/blob/360107ba/share/doc/src/api/document/index.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/document/index.rst b/share/doc/src/api/document/index.rst
index 778e807..8c0460c 100644
--- a/share/doc/src/api/document/index.rst
+++ b/share/doc/src/api/document/index.rst
@@ -20,34 +20,6 @@ Document Methods
The CouchDB API Server Document methods detail how to create, read,
update and delete documents within a database.
-A list of the available methods and URL paths are provided below:
-
-+--------+-------------------------+-------------------------------------------+
-| Method | Path | Description |
-+========+=========================+===========================================+
-| POST | /db | Create a new document |
-+--------+-------------------------+-------------------------------------------+
-| GET | /db/doc | Returns the latest revision of the |
-| | | document |
-+--------+-------------------------+-------------------------------------------+
-| HEAD | /db/doc | Returns bare information in the HTTP |
-| | | Headers for the document |
-+--------+-------------------------+-------------------------------------------+
-| PUT | /db/doc | Inserts a new document, or new version |
-| | | of an existing document |
-+--------+-------------------------+-------------------------------------------+
-| DELETE | /db/doc | Deletes the document |
-+--------+-------------------------+-------------------------------------------+
-| COPY | /db/doc | Copies the document |
-+--------+-------------------------+-------------------------------------------+
-| GET | /db/doc/attachment | Gets the attachment of a document |
-+--------+-------------------------+-------------------------------------------+
-| PUT | /db/doc/attachment | Adds an attachment of a document |
-+--------+-------------------------+-------------------------------------------+
-| DELETE | /db/doc/attachment | Deletes an attachment of a document |
-+--------+-------------------------+-------------------------------------------+
-
-
.. toctree::
common
http://git-wip-us.apache.org/repos/asf/couchdb/blob/360107ba/share/doc/src/api/server/authn.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/server/authn.rst b/share/doc/src/api/server/authn.rst
index bdf75af..0b44920 100644
--- a/share/doc/src/api/server/authn.rst
+++ b/share/doc/src/api/server/authn.rst
@@ -19,19 +19,6 @@ Authentication Methods
The CouchDB Authentication methods provide an interface for obtaining
session and authorization data.
-A list of the available methods and URL paths are provided below:
-
-+--------+-------------------------+-------------------------------------------+
-| Method | Path | Description |
-+========+=========================+===========================================+
-| GET | /_session | Returns cookie based login user |
-| | | information |
-+--------+-------------------------+-------------------------------------------+
-| POST | /_session | Do cookie based user login |
-+--------+-------------------------+-------------------------------------------+
-| DELETE | /_session | Logout cookie based user |
-+--------+-------------------------+-------------------------------------------+
-
.. note:: We're also strongly recommend you to
:ref:`setup SSL <config/ssl>` to improve all authentication methods security.
http://git-wip-us.apache.org/repos/asf/couchdb/blob/360107ba/share/doc/src/api/server/configuration.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/server/configuration.rst b/share/doc/src/api/server/configuration.rst
index b27d341..41270dd 100644
--- a/share/doc/src/api/server/configuration.rst
+++ b/share/doc/src/api/server/configuration.rst
@@ -20,24 +20,6 @@ The CouchDB API Server Configuration Methods provide an interface to
query and update the various configuration values within a running
CouchDB instance.
-A list of the available methods and URL paths are provided below:
-
-+--------+-------------------------+-------------------------------------------+
-| Method | Path | Description |
-+========+=========================+===========================================+
-| GET | /_config | Obtain a list of the entire server |
-| | | configuration |
-+--------+-------------------------+-------------------------------------------+
-| GET | /_config/section | Get all the configuration values for the |
-| | | specified section |
-+--------+-------------------------+-------------------------------------------+
-| GET | /_config/section/key | Get a specific section/configuration value|
-+--------+-------------------------+-------------------------------------------+
-| PUT | /_config/section/key | Set the specified configuration value |
-+--------+-------------------------+-------------------------------------------+
-| DELETE | /_config/section/key | Delete the current setting |
-+--------+-------------------------+-------------------------------------------+
-
``/_config``
============
http://git-wip-us.apache.org/repos/asf/couchdb/blob/360107ba/share/doc/src/api/server/index.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/server/index.rst b/share/doc/src/api/server/index.rst
index fb3229f..1151bea 100644
--- a/share/doc/src/api/server/index.rst
+++ b/share/doc/src/api/server/index.rst
@@ -21,53 +21,6 @@ The CouchDB server interface provides the basic interface to a
CouchDB server for obtaining CouchDB information and getting and setting
configuration information.
-A list of the available methods and URL paths are provided below:
-
-+--------+-------------------------+-------------------------------------------+
-| Method | Path | Description |
-+========+=========================+===========================================+
-| GET | / | Get the welcome message and version |
-| | | information |
-+--------+-------------------------+-------------------------------------------+
-| GET | /_active_tasks | Obtain a list of the tasks running in the|
-| | | server |
-+--------+-------------------------+-------------------------------------------+
-| GET | /_all_dbs | Get a list of all the DBs |
-+--------+-------------------------+-------------------------------------------+
-| GET | /_config | Obtain a list of the entire server |
-| | | configuration |
-+--------+-------------------------+-------------------------------------------+
-| GET | /_config/section | Get all the configuration values for the |
-| | | specified section |
-+--------+-------------------------+-------------------------------------------+
-| GET | /_config/section/key | Get a specific section/config value |
-+--------+-------------------------+-------------------------------------------+
-| PUT | /_config/section/key | Set the specified configuration value |
-+--------+-------------------------+-------------------------------------------+
-| DELETE | /_config/section/key | Delete the current setting |
-+--------+-------------------------+-------------------------------------------+
-| GET | /_log | Return the server log file |
-+--------+-------------------------+-------------------------------------------+
-| POST | /_replicate | Set or cancel replication |
-+--------+-------------------------+-------------------------------------------+
-| POST | /_restart | Restart the server |
-+--------+-------------------------+-------------------------------------------+
-| GET | /_session | Returns cookie based login user |
-| | | information |
-+--------+-------------------------+-------------------------------------------+
-| POST | /_session | Do cookie based user login |
-+--------+-------------------------+-------------------------------------------+
-| DELETE | /_session | Logout cookie based user |
-+--------+-------------------------+-------------------------------------------+
-| GET | /_stats | Return server statistics |
-+--------+-------------------------+-------------------------------------------+
-| GET | /_utils | CouchDB administration interface (Futon) |
-+--------+-------------------------+-------------------------------------------+
-| GET | /_uuids | Get generated UUIDs from the server |
-+--------+-------------------------+-------------------------------------------+
-| GET | /favicon.ico | Get the site icon |
-+--------+-------------------------+-------------------------------------------+
-
.. toctree::
common