Skip to content

Commit 0763dc3

Browse files
authored
RS: Add v1 prefixes to REST API reference examples (#1251)
* DOC-4939 RS: Added missing v1 prefixes to REST API reference examples * DOC-4939 RS: Copied missing v1 prefixes to REST API reference examples in 7.4 versioned docs * DOC-4939 RS: Added more missing v1 prefixes to REST API reference * DOC-4939 Copied changes from PR #1103 to 7.4 version of optimize shards placement REST API reference
1 parent 5a787b6 commit 0763dc3

File tree

174 files changed

+352
-352
lines changed

Some content is hidden

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

174 files changed

+352
-352
lines changed

content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,14 +64,14 @@ An API object that represents a managed database in the cluster.
6464
| created_time | string; The date and time the database was created (read-only) |
6565
| data_internode_encryption | boolean; Should the data plane internode communication for this database be encrypted |
6666
| data_persistence | Database on-disk persistence policy. For snapshot persistence, a [snapshot_policy]({{< relref "/operate/rs/references/rest-api/objects/bdb/snapshot_policy" >}}) must be provided<br />Values:<br />**'disabled'** <br />'snapshot'<br />'aof' |
67-
| dataset_import_sources | [complex object]({{< relref "/operate/rs/references/rest-api/objects/bdb/dataset_import_sources" >}}); Array of source file location description objects to import from when performing an import action. This is write-only and cannot be read after set. <br />Call GET /jsonschema to retrieve the object's structure. |
67+
| dataset_import_sources | [complex object]({{< relref "/operate/rs/references/rest-api/objects/bdb/dataset_import_sources" >}}); Array of source file location description objects to import from when performing an import action. This is write-only and cannot be read after set. <br />Call `GET /v1/jsonschema` to retrieve the object's structure. |
6868
| db_conns_auditing | boolean; Enables/deactivates [database connection auditing]({{< relref "/operate/rs/security/audit-events" >}}) |
6969
| default_user | boolean (default:&nbsp;true); Allow/disallow a default user to connect |
7070
| disabled_commands | string (default: ); Redis commands which are disabled in db |
7171
| dns_address_master | string; Database private address endpoint FQDN (read-only) (deprecated as of Redis Enterprise v4.3.3) |
7272
| email_alerts | boolean (default:&nbsp;false); Send email alerts for this DB |
7373
| endpoint | string; Latest bound endpoint. Used when reconfiguring an endpoint via update |
74-
| endpoint_ip | complex object; External IP addresses of node hosting the BDB's endpoint. `GET`&nbsp;`/jsonschema` to retrieve the object's structure. (read-only) (deprecated as of Redis Enterprise v4.3.3) |
74+
| endpoint_ip | complex object; External IP addresses of node hosting the BDB's endpoint. `GET /v1/jsonschema` to retrieve the object's structure. (read-only) (deprecated as of Redis Enterprise v4.3.3) |
7575
| endpoint_node | integer; Node UID hosting the BDB's endpoint (read-only) (deprecated as of Redis Enterprise v4.3.3) |
7676
| endpoints | array; List of database access endpoints (read-only)<br />**uid**: Unique identification of this source<br />**dns_name**: Endpoint’s DNS name<br />**port**: Endpoint’s TCP port number<br />**addr**: Endpoint’s accessible addresses<br />**proxy_policy**: The policy used for proxy binding to the endpoint<br />**exclude_proxies**: List of proxies to exclude<br />**include_proxies**: List of proxies to include<br />**addr_type**: Indicates if the endpoint is based on internal or external IPs<br /><span class="break-all">**oss_cluster_api_preferred_ip_type**</span>: Indicates preferred IP type in the OSS cluster API: internal/external<br /><span class="break-all">**oss_cluster_api_preferred_endpoint_type**</span>: Indicates preferred endpoint type in the OSS cluster API: ip/hostname |
7777
| enforce_client_authentication | Require authentication of client certificates for SSL connections to the database. If set to 'enabled', a certificate should be provided in either authentication_ssl_client_certs or authentication_ssl_crdt_certs<br />Values:<br />**'enabled'** <br />'disabled' |

content/operate/rs/7.4/references/rest-api/permissions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ url: '/operate/rs/7.4/references/rest-api/permissions/'
1414

1515
Some Redis Enterprise [REST API requests]({{< relref "/operate/rs/references/rest-api/requests" >}}) may require the user to have specific permissions.
1616

17-
Administrators can assign a predefined role to a user with the [Cluster Manager UI]({{< relref "/operate/rs/security/access-control/create-users" >}}) or a [<nobr>`PUT /users/{uid}`</nobr> API request]({{< relref "/operate/rs/references/rest-api/requests/users#put-user" >}}) to grant necessary permissions to them.
17+
Administrators can assign a predefined role to a user with the [Cluster Manager UI]({{< relref "/operate/rs/security/access-control/create-users" >}}) or a [<nobr>`PUT /v1/users/{uid}`</nobr> API request]({{< relref "/operate/rs/references/rest-api/requests/users#put-user" >}}) to grant necessary permissions to them.
1818

1919
## Roles
2020

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

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

3939
```
40-
GET /actions
40+
GET /v1/actions
4141
```
4242

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

109109
```
110-
GET /actions/{uid}
110+
GET /v1/actions/{uid}
111111
```
112112

113113
#### URL parameters

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

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

3737
```
38-
GET /actions/bdb/1
38+
GET /v1/actions/bdb/1
3939
```
4040

4141
#### URL parameters

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

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

134134
```sh
135-
GET /bdbs/1
135+
GET /v1/bdbs/1
136136
```
137137

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

203203
```sh
204-
PUT /bdbs/1
204+
PUT /v1/bdbs/1
205205
```
206206

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

311311
```sh
312-
PUT /bdbs/1/reset_admin_pass
312+
PUT /v1/bdbs/1/reset_admin_pass
313313
```
314314
The above request resets the admin password after updating the database.
315315

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

428428
```sh
429-
POST /bdbs
429+
POST /v1/bdbs
430430
```
431431

432432
#### Headers
@@ -628,7 +628,7 @@ Delete an active database.
628628
#### Example HTTP request
629629

630630
```sh
631-
DELETE /bdbs/1
631+
DELETE /v1/bdbs/1
632632
```
633633
#### Headers
634634

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

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

3737
```sh
38-
PUT /bdbs/1/actions/backup_reset_status
38+
PUT /v1/bdbs/1/actions/backup_reset_status
3939
```
4040

4141
#### Headers

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Initiate a database export.
3535
#### Example HTTP request
3636

3737
```sh
38-
POST /bdbs/1/actions/export
38+
POST /v1/bdbs/1/actions/export
3939
```
4040

4141
#### Headers
@@ -59,7 +59,7 @@ The request body should contain a JSON object with the following export paramete
5959

6060
| Field | Type | Description |
6161
|-------|------|-------------|
62-
| export_location | [backup_location/export_location]({{< relref "/operate/rs/references/rest-api/objects/bdb/backup_location" >}}) object | Details for the export destination. Call [`GET /jsonschema`]({{< relref "/operate/rs/references/rest-api/requests/jsonschema#get-jsonschema" >}}) on the bdb object and review the `backup_location` field to retrieve the object's structure. |
62+
| export_location | [backup_location/export_location]({{< relref "/operate/rs/references/rest-api/objects/bdb/backup_location" >}}) object | Details for the export destination. Call [`GET /v1/jsonschema`]({{< relref "/operate/rs/references/rest-api/requests/jsonschema#get-jsonschema" >}}) on the bdb object and review the `backup_location` field to retrieve the object's structure. |
6363
| email_notification | boolean | Enable/disable an email notification on export failure/ completion. (optional) |
6464

6565
##### Example JSON body

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

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

3535
```sh
36-
PUT /bdbs/1/actions/export_reset_status
36+
PUT /v1/bdbs/1/actions/export_reset_status
3737
```
3838

3939
#### Request headers

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Initiate a manual import process.
3535
#### Example HTTP request
3636

3737
```sh
38-
POST /bdbs/1/actions/import
38+
POST /v1/bdbs/1/actions/import
3939
```
4040

4141
#### Headers
@@ -58,7 +58,7 @@ The request _may_ contain a subset of the [BDB JSON object]({{< relref "/operate
5858

5959
| Field | Type | Description |
6060
|-------|------|-------------|
61-
| dataset_import_sources | array of [dataset_import_sources]({{< relref "/operate/rs/references/rest-api/objects/bdb/dataset_import_sources" >}}) objects | Details for the import sources. Call [`GET /jsonschema`]({{< relref "/operate/rs/references/rest-api/requests/jsonschema#get-jsonschema" >}}) on the bdb object and review the `dataset_import_sources` field to retrieve the object's structure. |
61+
| dataset_import_sources | array of [dataset_import_sources]({{< relref "/operate/rs/references/rest-api/objects/bdb/dataset_import_sources" >}}) objects | Details for the import sources. Call [`GET /v1/jsonschema`]({{< relref "/operate/rs/references/rest-api/requests/jsonschema#get-jsonschema" >}}) on the bdb object and review the `dataset_import_sources` field to retrieve the object's structure. |
6262
| email_notification | boolean | Enable/disable an email notification on import failure/ completion. (optional) |
6363

6464
{{<note>}}

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

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

3535
```sh
36-
PUT /bdbs/1/actions/import_reset_status
36+
PUT /v1/bdbs/1/actions/import_reset_status
3737
```
3838

3939

0 commit comments

Comments
 (0)