Skip to content
This repository was archived by the owner on Oct 17, 2022. It is now read-only.

Commit edb7e88

Browse files
committed
Update _config endpoint documentation to reflect new location
1 parent afcb3a2 commit edb7e88

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

src/api/server/configuration.rst

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ Configuration
1919
The CouchDB Server Configuration API provide an interface to query and update
2020
the various configuration values within a running CouchDB instance.
2121

22-
``/_config``
23-
============
22+
``/_node/{node-name}/_config``
23+
==============================
2424

25-
.. http:get:: /_config
25+
.. http:get:: /_node/{node-name}/_config
2626
:synopsis: Obtains a list of the entire server configuration
2727

2828
Returns the entire CouchDB server configuration as a JSON structure. The
@@ -40,7 +40,7 @@ the various configuration values within a running CouchDB instance.
4040

4141
.. code-block:: http
4242
43-
GET /_config HTTP/1.1
43+
GET /_node/nonode@nohost/_config HTTP/1.1
4444
Accept: application/json
4545
Host: localhost:5984
4646
@@ -152,12 +152,15 @@ the various configuration values within a running CouchDB instance.
152152
}
153153
}
154154
155+
.. versionchanged: 2.0.0 The config endpoint from ``/_config`` to
156+
``/_node/{node-name}/_config``.
157+
155158
.. _api/config/section:
156159

157-
``/_config/section``
158-
====================
160+
``_node/{node-name}/_config/section``
161+
=====================================
159162

160-
.. http:get:: /_config/{section}
163+
.. http:get:: /_node/{node-name}/_config/{section}
161164
:synopsis: Returns all the configuration values for the specified section
162165

163166
Gets the configuration structure for a single section.
@@ -174,7 +177,7 @@ the various configuration values within a running CouchDB instance.
174177

175178
.. code-block:: http
176179
177-
GET /_config/httpd HTTP/1.1
180+
GET /_node/nonode@nohost/_config/httpd HTTP/1.1
178181
Accept: application/json
179182
Host: localhost:5984
180183
@@ -203,10 +206,10 @@ the various configuration values within a running CouchDB instance.
203206
204207
.. _api/config/section/key:
205208

206-
``/_config/section/key``
207-
========================
209+
``/_node/node/_config/section/key``
210+
===================================
208211

209-
.. http:get:: /_config/{section}/{key}
212+
.. http:get:: /_node/{node-name}/_config/{section}/{key}
210213
:synopsis: Returns a specific section/configuration value
211214

212215
Gets a single configuration value from within a specific configuration
@@ -225,7 +228,7 @@ the various configuration values within a running CouchDB instance.
225228

226229
.. code-block:: http
227230
228-
GET /_config/log/level HTTP/1.1
231+
GET /_node/nonode@nohost/_config/log/level HTTP/1.1
229232
Accept: application/json
230233
Host: localhost:5984
231234
@@ -247,7 +250,7 @@ the various configuration values within a running CouchDB instance.
247250
or numeric value, or an array or object. Some client environments may
248251
not parse simple strings or numeric values as valid JSON.
249252

250-
.. http:put:: /_config/{section}/{key}
253+
.. http:put:: /_node/{node-name}/_config/{section}/{key}
251254
:synopsis: Sets the specified configuration value
252255

253256
Updates a configuration value. The new value should be supplied in the
@@ -271,7 +274,7 @@ the various configuration values within a running CouchDB instance.
271274

272275
.. code-block:: http
273276
274-
PUT /_config/log/level HTTP/1.1
277+
PUT /_node/nonode@nohost/_config/log/level HTTP/1.1
275278
Accept: application/json
276279
Content-Length: 7
277280
Content-Type: application/json
@@ -292,7 +295,7 @@ the various configuration values within a running CouchDB instance.
292295
293296
"debug"
294297
295-
.. http:delete:: /_config/{section}/{key}
298+
.. http:delete:: /_node/{node-name}/_config/{section}/{key}
296299
:synopsis: Removes the current setting
297300

298301
Deletes a configuration value. The returned JSON will be the value of the
@@ -312,7 +315,7 @@ the various configuration values within a running CouchDB instance.
312315

313316
.. code-block:: http
314317
315-
DELETE /_config/log/level HTTP/1.1
318+
DELETE /_node/nonode@nohost/_config/log/level HTTP/1.1
316319
Accept: application/json
317320
Host: localhost:5984
318321

0 commit comments

Comments
 (0)