Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RS: Add dry_run option for Redis ACL REST API to reference & 7.8.4 release notes #1011

Merged
merged 2 commits into from
Dec 23, 2024
+35 −1
Merged

RS: Add dry_run option for Redis ACL REST API to reference & 7.8.4 release notes #1011

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d16dc2
DOC-4685 RS: Add dry_run option to redis_acl REST API reference
rrelledge Dec 23, 2024
05941d0
DOC-4685 DOC-4629 RS: Add dry_run option for redis_acl REST API to 7.…
rrelledge Dec 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions content/operate/rs/references/rest-api/requests/redis_acls/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,17 @@ PUT /redis_acls/17
| Host | cnm.cluster.fqdn | Domain name |
| Accept | application/json | Accepted media type |

#### Query parameters

| Field | Type | Description |
|---------|------|---------------|
| dry_run | | Validate the updated [Redis ACL object]({{< relref "/operate/rs/references/rest-api/objects/redis_acl" >}}) but don't apply the update. |

#### URL parameters

| Field | Type | Description |
|-------|------|-------------|
| uid | integer | The Redis ACL's unique ID. |

#### Request body

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

#### Query parameters

| Field | Type | Description |
|---------|------|---------------|
| dry_run | | Validate the new [Redis ACL object]({{< relref "/operate/rs/references/rest-api/objects/redis_acl" >}}) but don't apply the update. |

#### Request body

Expand Down
20 changes: 19 additions & 1 deletion content/operate/rs/release-notes/rs-7-8-releases/rs-7-8-4-18.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ categories:
- operate
- rs
compatibleOSSVersion: Redis 7.4.0
description: Certificate-based authentication for the REST API.
description: Certificate-based authentication for the REST API. Dry run option to validate Redis ACL REST API requests.
linkTitle: 7.8.4-18 (December 2024)
weight: 88
aliases: /operate/rs/release-notes/rs-7-8-releases/rs-7-8-4-tba/
Expand All @@ -20,6 +20,8 @@ This version offers:

- Certificate-based authentication for the REST API

- Dry run option to validate Redis ACL REST API requests

## New in this release

### New features
Expand Down Expand Up @@ -74,6 +76,22 @@ This version offers:

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

### Enhancements

- 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.

- [Create Redis ACL]({{<relref "/operate/rs/references/rest-api/requests/redis_acls#post-redis_acl">}}) example request:

```sh
POST /v1/redis_acls?dry_run
```

- [Update Redis ACL]({{<relref "/operate/rs/references/rest-api/requests/redis_acls#put-redis_acl">}}) example request:

```sh
PUT /v1/redis_acls/<uid>?dry_run
```

### Redis database versions

Redis Software version 7.8.4 includes three Redis database versions: 7.4, 7.2, and 6.2.
Expand Down
Loading