Skip to content

JSON.OBJKEYS: Update description and return values#2973

Open
LiorKogan wants to merge 27 commits intomainfrom
LiorKogan-patch-1
Open

JSON.OBJKEYS: Update description and return values#2973
LiorKogan wants to merge 27 commits intomainfrom
LiorKogan-patch-1

Conversation

@LiorKogan
Copy link
Copy Markdown
Member

@LiorKogan LiorKogan commented Apr 2, 2026

Clarify behavior of key and path arguments in JSON documentation.


Note

Low Risk
Low risk documentation-only change that updates the described behavior for JSONPath vs legacy paths and related return/error cases.

Overview
Updates the JSON.OBJKEYS documentation to describe the command as returning JSON object key names for all matches of a path expression, and adds a note distinguishing Redis keys from JSON object keys.

Clarifies key/path argument semantics by explicitly defining JSONPath vs legacy path inputs (including defaults and match behavior), and rewrites the RESP2/RESP3 return information to spell out differing null/empty-array/simple-error outcomes for each path type. Also refreshes cross-links (adds JSON.OBJLEN, JSONPath/topic links).

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

Clarify behavior of key and path arguments in JSON documentation.
@LiorKogan LiorKogan changed the title Update return values Update JSON return values Apr 2, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 2, 2026

@jit-ci
Copy link
Copy Markdown

jit-ci bot commented Apr 2, 2026

🛡️ Jit Security Scan Results

CRITICAL HIGH MEDIUM

✅ No security findings were detected in this PR


Security scan by Jit

Clarify return values for key existence and path matches.
@LiorKogan LiorKogan changed the title Update JSON return values JSON.OBJKEYS: Update JSON return values Apr 2, 2026
@LiorKogan LiorKogan changed the title JSON.OBJKEYS: Update JSON return values JSON.OBJKEYS: Update return values Apr 2, 2026
@LiorKogan LiorKogan changed the title JSON.OBJKEYS: Update return values JSON.OBJKEYS: Update description and return values Apr 2, 2026
@LiorKogan LiorKogan requested a review from dwdougherty April 2, 2026 15:51
@dwdougherty dwdougherty self-assigned this Apr 2, 2026
@dwdougherty dwdougherty added cmds oss Redis Open Source labels Apr 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cmds oss Redis Open Source

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants