JSON.OBJKEYS: Update description and return values#2973
Merged
dwdougherty merged 28 commits intomainfrom Apr 6, 2026
Merged
Conversation
Clarify behavior of key and path arguments in JSON documentation.
Contributor
🛡️ Jit Security Scan Results✅ No security findings were detected in this PR
Security scan by Jit
|
Clarify return values for key existence and path matches.
Clarified wording regarding JSONPath and legacy path expressions.
dwdougherty
approved these changes
Apr 6, 2026
Collaborator
There was a problem hiding this comment.
Thank you, @LiorKogan! I tidied up the return values section per the commit comment (above). Approved. I'll go ahead and merge.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Clarify behavior of key and path arguments in JSON documentation.
Note
Low Risk
Low risk documentation-only change clarifying
JSON.OBJKEYSargument and return behavior; no runtime code is modified.Overview
Updates the
JSON.OBJKEYSdocs 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
nilvs 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.