Skip to content

Commit 2f59942

Browse files
committed
DOC-4939 RS: Added missing v1 prefixes to REST API reference examples
1 parent 0b0a84d commit 2f59942

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+175
-175
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Get the status of all actions (executing, queued, or completed) on all entities
3636
#### Example HTTP request
3737

3838
```
39-
GET /actions
39+
GET /v1/actions
4040
```
4141

4242
### Response {#get-all-response}
@@ -106,7 +106,7 @@ Get the status of a currently executing, queued, or completed action.
106106
#### Example HTTP request
107107

108108
```
109-
GET /actions/{uid}
109+
GET /v1/actions/{uid}
110110
```
111111

112112
#### URL parameters

content/operate/rs/references/rest-api/requests/actions/bdb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Get the status of all currently executing, pending, or completed state-machine-r
3434
#### Example HTTP request
3535

3636
```
37-
GET /actions/bdb/1
37+
GET /v1/actions/bdb/1
3838
```
3939

4040
#### URL parameters

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ Get a single database.
131131
#### Example HTTP request
132132

133133
```sh
134-
GET /bdbs/1
134+
GET /v1/bdbs/1
135135
```
136136

137137
#### Headers
@@ -200,7 +200,7 @@ To track this request's progress, poll the [`/actions/<action_uid>` endpoint]({{
200200
#### Example HTTP request
201201

202202
```sh
203-
PUT /bdbs/1
203+
PUT /v1/bdbs/1
204204
```
205205

206206
#### Headers
@@ -308,7 +308,7 @@ If called with the `dry_run` URL query string, the function will validate the [B
308308
#### Example HTTP request
309309

310310
```sh
311-
PUT /bdbs/1/reset_admin_pass
311+
PUT /v1/bdbs/1/reset_admin_pass
312312
```
313313
The above request resets the admin password after updating the database.
314314

@@ -425,7 +425,7 @@ The cluster will use default configuration for any missing database field. The c
425425
#### Example HTTP request
426426

427427
```sh
428-
POST /bdbs
428+
POST /v1/bdbs
429429
```
430430

431431
#### Headers
@@ -627,7 +627,7 @@ Delete an active database.
627627
#### Example HTTP request
628628

629629
```sh
630-
DELETE /bdbs/1
630+
DELETE /v1/bdbs/1
631631
```
632632
#### Headers
633633

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Resets the database's `backup_status` to idle if a backup is not in progress and
3434
#### Example HTTP request
3535

3636
```sh
37-
PUT /bdbs/1/actions/backup_reset_status
37+
PUT /v1/bdbs/1/actions/backup_reset_status
3838
```
3939

4040
#### Headers

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Initiate a database export.
3434
#### Example HTTP request
3535

3636
```sh
37-
POST /bdbs/1/actions/export
37+
POST /v1/bdbs/1/actions/export
3838
```
3939

4040
#### Headers

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Resets the database's `export_status` to idle if an export is not in progress an
3232
#### Example HTTP request
3333

3434
```sh
35-
PUT /bdbs/1/actions/export_reset_status
35+
PUT /v1/bdbs/1/actions/export_reset_status
3636
```
3737

3838
#### Request headers

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Initiate a manual import process.
3434
#### Example HTTP request
3535

3636
```sh
37-
POST /bdbs/1/actions/import
37+
POST /v1/bdbs/1/actions/import
3838
```
3939

4040
#### Headers

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Reset the database’s `import_status` to idle if a backup is not in progress an
3232
#### Example HTTP request
3333

3434
```sh
35-
PUT /bdbs/1/actions/import_reset_status
35+
PUT /v1/bdbs/1/actions/import_reset_status
3636
```
3737

3838

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ Distributes the database's shards across nodes based on the database's shard pla
3434
#### Example HTTP request
3535

3636
```sh
37-
PUT /bdbs/1/actions/rebalance
37+
PUT /v1/bdbs/1/actions/rebalance
3838
```
3939

4040
Dry-run example:
4141

4242
```sh
43-
PUT /bdbs/1/actions/rebalance?only_failovers=true&dry_run=true
43+
PUT /v1/bdbs/1/actions/rebalance?only_failovers=true&dry_run=true
4444
```
4545

4646
#### URL parameters

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Fetches the recovery plan for a database. The recovery plan provides information
3535
#### Example HTTP request
3636

3737
```sh
38-
GET /bdbs/1/actions/recover
38+
GET /v1/bdbs/1/actions/recover
3939
```
4040

4141
#### URL parameters
@@ -112,7 +112,7 @@ If the request body is empty, the database will be recovered automatically:
112112
#### Example HTTP request
113113

114114
```sh
115-
POST /bdbs/1/actions/recover
115+
POST /v1/bdbs/1/actions/recover
116116
```
117117

118118
#### Example request body

0 commit comments

Comments
 (0)