[couchdb-documentation] 01/01: Document changed /_restart behaviour

[wo...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

wohali pushed a commit to branch 231-remove-restart
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git

commit 451d0da76e0d295792e434f04ee36dce52a6753c
Author: Joan Touzet <jo...@atypical.net>
AuthorDate: Sat Mar 17 01:15:24 2018 -0400

    Document changed /_restart behaviour
---
 src/api/server/common.rst    | 47 +-------------------------------------------
 src/config/http-handlers.rst |  2 +-
 src/intro/security.rst       |  3 ++-
 3 files changed, 4 insertions(+), 48 deletions(-)

diff --git a/src/api/server/common.rst b/src/api/server/common.rst
index e0c0963..163736a 100644
--- a/src/api/server/common.rst
+++ b/src/api/server/common.rst
@@ -214,7 +214,7 @@
 ``/_cluster_setup``
 ===================
 
-.. versionadded: 2.0
+.. versionadded:: 2.0
 .. http:get:: /_cluster_setup
     :synopsis: Return the status of the cluster setup wizard
 
@@ -1200,51 +1200,6 @@ error.
             "target": "http://adm:*****@localhost:15984/cdyno-0000002/"
         }
 
-.. _api/server/restart:
-
-=============
-``/_restart``
-=============
-
-.. http:post:: /_restart
-    :synopsis: Restarts the server
-
-    Restarts the CouchDB instance. You must be authenticated as a user with
-    administration privileges for this to work.
-
-    :<header Accept: - :mimetype:`application/json`
-                     - :mimetype:`text/plain`
-    :<header Content-Type: :mimetype:`application/json`
-    :>header Content-Type: - :mimetype:`application/json`
-                           - :mimetype:`text/plain; charset=utf-8`
-    :code 202: Server goes to restart (there is no guarantee that it will be
-      alive after)
-    :code 401: CouchDB Server Administrator privileges required
-    :code 415: Bad request`s :header:`Content-Type`
-
-    **Request**:
-
-    .. code-block:: http
-
-        POST /_restart HTTP/1.1
-        Accept: application/json
-        Host: localhost:5984
-
-    **Response**:
-
-    .. code-block:: http
-
-        HTTP/1.1 202 Accepted
-        Cache-Control: must-revalidate
-        Content-Length: 12
-        Content-Type: application/json
-        Date: Sat, 10 Aug 2013 11:33:50 GMT
-        Server: CouchDB (Erlang/OTP)
-
-        {
-            "ok": true
-        }
-
 .. _api/server/stats:
 
 ===========
diff --git a/src/config/http-handlers.rst b/src/config/http-handlers.rst
index a4ab5dd..426b168 100644
--- a/src/config/http-handlers.rst
+++ b/src/config/http-handlers.rst
@@ -82,7 +82,7 @@ Global HTTP Handlers
 
     .. config:option:: _restart
 
-        ::
+        Provides an API to restart CouchDB (only on the node-local port).
 
             [httpd_global_handlers]
             _restart = {couch_httpd_misc_handlers, handle_restart_req}
diff --git a/src/intro/security.rst b/src/intro/security.rst
index 5cbf7f6..432c211 100644
--- a/src/intro/security.rst
+++ b/src/intro/security.rst
@@ -70,7 +70,8 @@ identification for certain requests:
   </{db}/_design/{ddoc}>`)
 - Triggering compaction (:post:`POST /database/_compact </{db}/_compact>`)
 - Reading the task status list (:get:`GET /_active_tasks </_active_tasks>`)
-- Restarting the server (:post:`POST /_restart </_restart>`)
+- Restarting the server on the node-local port
+  (:post:`POST /_restart </_restart>`)
 - Reading the active configuration
   (:get:`GET /_node/{node-name}/_config </_config>`)
 - Updating the active configuration

-- 
To stop receiving notification emails like this one, please contact
wohali@apache.org.