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

Commit 103da04

Browse files
flimzynickva
authored andcommitted
Update _config endpoint documentation to reflect new location
1 parent c7f8645 commit 103da04

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
@@ -153,12 +153,15 @@ the various configuration values within a running CouchDB instance.
153153
}
154154
}
155155
156+
.. versionchanged: 2.0.0 The config endpoint from ``/_config`` to
157+
``/_node/{node-name}/_config``.
158+
156159
.. _api/config/section:
157160

158-
``/_config/section``
159-
====================
161+
``_node/{node-name}/_config/section``
162+
=====================================
160163

161-
.. http:get:: /_config/{section}
164+
.. http:get:: /_node/{node-name}/_config/{section}
162165
:synopsis: Returns all the configuration values for the specified section
163166

164167
Gets the configuration structure for a single section.
@@ -175,7 +178,7 @@ the various configuration values within a running CouchDB instance.
175178

176179
.. code-block:: http
177180
178-
GET /_config/httpd HTTP/1.1
181+
GET /_node/nonode@nohost/_config/httpd HTTP/1.1
179182
Accept: application/json
180183
Host: localhost:5984
181184
@@ -204,10 +207,10 @@ the various configuration values within a running CouchDB instance.
204207
205208
.. _api/config/section/key:
206209

207-
``/_config/section/key``
208-
========================
210+
``/_node/node/_config/section/key``
211+
===================================
209212

210-
.. http:get:: /_config/{section}/{key}
213+
.. http:get:: /_node/{node-name}/_config/{section}/{key}
211214
:synopsis: Returns a specific section/configuration value
212215

213216
Gets a single configuration value from within a specific configuration
@@ -226,7 +229,7 @@ the various configuration values within a running CouchDB instance.
226229

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

251-
.. http:put:: /_config/{section}/{key}
254+
.. http:put:: /_node/{node-name}/_config/{section}/{key}
252255
:synopsis: Sets the specified configuration value
253256

254257
Updates a configuration value. The new value should be supplied in the
@@ -272,7 +275,7 @@ the various configuration values within a running CouchDB instance.
272275

273276
.. code-block:: http
274277
275-
PUT /_config/log/level HTTP/1.1
278+
PUT /_node/nonode@nohost/_config/log/level HTTP/1.1
276279
Accept: application/json
277280
Content-Length: 7
278281
Content-Type: application/json
@@ -293,7 +296,7 @@ the various configuration values within a running CouchDB instance.
293296
294297
"debug"
295298
296-
.. http:delete:: /_config/{section}/{key}
299+
.. http:delete:: /_node/{node-name}/_config/{section}/{key}
297300
:synopsis: Removes the current setting
298301

299302
Deletes a configuration value. The returned JSON will be the value of the
@@ -313,7 +316,7 @@ the various configuration values within a running CouchDB instance.
313316

314317
.. code-block:: http
315318
316-
DELETE /_config/log/level HTTP/1.1
319+
DELETE /_node/nonode@nohost/_config/log/level HTTP/1.1
317320
Accept: application/json
318321
Host: localhost:5984
319322

0 commit comments

Comments
 (0)