Skip to content

JSON.OBJKEYS: Update description and return values#2973

Merged
dwdougherty merged 28 commits intomainfrom
LiorKogan-patch-1
Apr 6, 2026
Merged

JSON.OBJKEYS: Update description and return values#2973
dwdougherty merged 28 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 clarifying JSON.OBJKEYS argument and return behavior; no runtime code is modified.

Overview
Updates the JSON.OBJKEYS docs to clarify that the command returns object key names for all matches of a given path expression, with explicit distinction between JSONPath vs legacy path syntax (including default path behavior).

Expands the return-value specification for both RESP2/RESP3 to describe differences in errors vs nil vs empty arrays across JSONPath/legacy modes, and adds a note distinguishing Redis keys from JSON object keys plus new related links (JSONPath, JSON.OBJLEN).

Reviewed by Cursor Bugbot for commit a2df9da. 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
Copy link
Copy Markdown
Collaborator

@dwdougherty dwdougherty left a comment

Choose a reason for hiding this comment

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

Thank you, @LiorKogan! I tidied up the return values section per the commit comment (above). Approved. I'll go ahead and merge.

@dwdougherty dwdougherty merged commit 657196c into main Apr 6, 2026
5 checks passed
@dwdougherty dwdougherty deleted the LiorKogan-patch-1 branch April 6, 2026 16:17
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