Skip to content

Commit 82fec82

Browse files
authored
RS: Add dry_run option for Redis ACL REST API to reference & 7.8.4 release notes (#1011)
* DOC-4685 RS: Add dry_run option to redis_acl REST API reference * DOC-4685 DOC-4629 RS: Add dry_run option for redis_acl REST API to 7.8.4 release notes
1 parent 07b897d commit 82fec82

File tree

2 files changed

+35
-1
lines changed

2 files changed

+35
-1
lines changed

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,17 @@ PUT /redis_acls/17
183183
| Host | cnm.cluster.fqdn | Domain name |
184184
| Accept | application/json | Accepted media type |
185185

186+
#### Query parameters
187+
188+
| Field | Type | Description |
189+
|---------|------|---------------|
190+
| dry_run | | Validate the updated [Redis ACL object]({{< relref "/operate/rs/references/rest-api/objects/redis_acl" >}}) but don't apply the update. |
191+
192+
#### URL parameters
193+
194+
| Field | Type | Description |
195+
|-------|------|-------------|
196+
| uid | integer | The Redis ACL's unique ID. |
186197

187198
#### Request body
188199

@@ -258,6 +269,11 @@ POST /redis_acls
258269
| Host | cnm.cluster.fqdn | Domain name |
259270
| Accept | application/json | Accepted media type |
260271

272+
#### Query parameters
273+
274+
| Field | Type | Description |
275+
|---------|------|---------------|
276+
| dry_run | | Validate the new [Redis ACL object]({{< relref "/operate/rs/references/rest-api/objects/redis_acl" >}}) but don't apply the update. |
261277

262278
#### Request body
263279

content/operate/rs/release-notes/rs-7-8-releases/rs-7-8-4-18.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ categories:
66
- operate
77
- rs
88
compatibleOSSVersion: Redis 7.4.0
9-
description: Certificate-based authentication for the REST API.
9+
description: Certificate-based authentication for the REST API. Dry run option to validate Redis ACL REST API requests.
1010
linkTitle: 7.8.4-18 (December 2024)
1111
weight: 88
1212
aliases: /operate/rs/release-notes/rs-7-8-releases/rs-7-8-4-tba/
@@ -20,6 +20,8 @@ This version offers:
2020

2121
- Certificate-based authentication for the REST API
2222

23+
- Dry run option to validate Redis ACL REST API requests
24+
2325
## New in this release
2426

2527
### New features
@@ -74,6 +76,22 @@ This version offers:
7476

7577
- Certificate-based authentication is not implemented for the Cluster Manager UI.
7678

79+
### Enhancements
80+
81+
- If you create or update a Redis ACL using the REST API, you can use the `dry_run` query parameter to validate the request without actually applying the update.
82+
83+
- [Create Redis ACL]({{<relref "/operate/rs/references/rest-api/requests/redis_acls#post-redis_acl">}}) example request:
84+
85+
```sh
86+
POST /v1/redis_acls?dry_run
87+
```
88+
89+
- [Update Redis ACL]({{<relref "/operate/rs/references/rest-api/requests/redis_acls#put-redis_acl">}}) example request:
90+
91+
```sh
92+
PUT /v1/redis_acls/<uid>?dry_run
93+
```
94+
7795
### Redis database versions
7896

7997
Redis Software version 7.8.4 includes three Redis database versions: 7.4, 7.2, and 6.2.

0 commit comments

Comments
 (0)