JSON.OBJKEYS: Update description and return values#2973
Open
JSON.OBJKEYS: Update description and return values#2973
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.
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 that updates the described behavior for JSONPath vs legacy paths and related return/error cases.
Overview
Updates the
JSON.OBJKEYSdocumentation 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/pathargument semantics by explicitly defining JSONPath vs legacy path inputs (including defaults and match behavior), and rewrites the RESP2/RESP3 return information to spell out differingnull/empty-array/simple-error outcomes for each path type. Also refreshes cross-links (addsJSON.OBJLEN, JSONPath/topic links).Reviewed by Cursor Bugbot for commit 7aef3c3. Bugbot is set up for automated code reviews on this repo. Configure here.