Skip to content

Commit 71f62be

Browse files
committed
DOC-5663 RS: Added extended query parameter to GET database requests reference
1 parent caa2cbf commit 71f62be

File tree

1 file changed

+20
-2
lines changed
  • content/operate/rs/references/rest-api/requests/bdbs

1 file changed

+20
-2
lines changed

content/operate/rs/references/rest-api/requests/bdbs/_index.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,20 @@ Get all databases in the cluster.
3838

3939
### Request {#get-all-request}
4040

41-
#### Example HTTP request
41+
#### Example HTTP requests
42+
43+
The following request returns the unique IDs and names of all databases:
4244

4345
```sh
4446
GET /v1/bdbs?fields=uid,name
4547
```
4648

49+
The following request returns all fields for the databases, including configuration fields for modules like search, probabilistic, and timeseries:
50+
51+
```sh
52+
GET /v1/bdbs?extended=true
53+
```
54+
4755
#### Headers
4856

4957
| Key | Value |
@@ -56,6 +64,7 @@ GET /v1/bdbs?fields=uid,name
5664
| Field | Type | Description |
5765
|-------|------|-------------|
5866
| fields | string | Comma-separated list of field names to return (by default all fields are returned). (optional) |
67+
| extended | boolean | If true, includes configuration fields for modules, such as search, timeseries, and probabilistic, in the response. If the `extended` query parameter is not included in the request, module configuration fields do not appear in the response. (optional) |
5968

6069
### Response {#get-all-response}
6170

@@ -128,12 +137,20 @@ Get a single database.
128137

129138
### Request {#get-request}
130139

131-
#### Example HTTP request
140+
#### Example HTTP requests
141+
142+
The following request returns all fields for the specified database, except for module configuration fields:
132143

133144
```sh
134145
GET /v1/bdbs/1
135146
```
136147

148+
The following request returns all fields for the specified database, including configuration fields for modules like search, probabilistic, and timeseries:
149+
150+
```sh
151+
GET /v1/bdbs/1?extended=true
152+
```
153+
137154
#### Headers
138155

139156
| Key | Value |
@@ -154,6 +171,7 @@ GET /v1/bdbs/1
154171
| Field | Type | Description |
155172
|-------|------|-------------|
156173
| fields | string | Comma-separated list of field names to return (by default all fields are returned). (optional) |
174+
| extended | boolean | If true, includes configuration fields for modules, such as search, timeseries, and probabilistic, in the response. If the `extended` query parameter is not included in the request, module configuration fields do not appear in the response. (optional) |
157175

158176
### Response {#get-response}
159177

0 commit comments

Comments
 (0)