Skip to content

RS: Updated sharding descriptions in BDB REST API object reference#3485

Merged
rrelledge merged 1 commit into
mainfrom
DOC-6742
Jun 11, 2026
Merged

RS: Updated sharding descriptions in BDB REST API object reference#3485
rrelledge merged 1 commit into
mainfrom
DOC-6742

Conversation

@rrelledge

@rrelledge rrelledge commented Jun 11, 2026

Copy link
Copy Markdown
Collaborator

Fixes #3481


Note

Low Risk
Documentation-only edits to REST API field descriptions; no runtime or API behavior changes in this diff.

Overview
Updates the BDB REST API object reference across RS doc trees (7.4, 7.8, 7.22, and the unversioned operate/rs page) so sharding fields match current product behavior.

oss_sharding is no longer described as an OSS hashing alternative to shard_key_regex; it is documented as a future-use flag that should not be changed. sharding now states that when cluster mode is enabled, hashing rules must come from shard_key_regex only, dropping the previous “either oss_sharding or shard_key_regex” wording. Minor formatting on the default value text (default: false) is aligned in those rows.

Reviewed by Cursor Bugbot for commit 1d13c8a. Bugbot is set up for automated code reviews on this repo. Configure here.

@rrelledge rrelledge requested review from a team and yoavredis June 11, 2026 15:25
@rrelledge rrelledge self-assigned this Jun 11, 2026
@rrelledge rrelledge added the rs Redis Software label Jun 11, 2026
@github-actions

github-actions Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

DOC-6742

@jit-ci

jit-ci Bot commented Jun 11, 2026

Copy link
Copy Markdown

🛡️ Jit Security Scan Results

CRITICAL HIGH MEDIUM

✅ No security findings were detected in this PR


Security scan by Jit

@dwdougherty dwdougherty left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@rrelledge rrelledge merged commit 46a09d7 into main Jun 11, 2026
76 checks passed
@rrelledge rrelledge deleted the DOC-6742 branch June 11, 2026 16:18
EliShteinman added a commit to EliShteinman/docs that referenced this pull request Jun 11, 2026
Marks the oss_sharding BDB field as reserved; shard hashing rules now come only from shard_key_regex.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

rs Redis Software

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feedback: BDB object

2 participants