Adds valkey-json module commands documentation to the website. #243
Conversation
This file contains 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
|
@roshkhatri is it ready to be reviewed ? |
|
Not yet |
roshkhatri
commented
Mar 31, 2025
roshkhatri
commented
Mar 31, 2025
roshkhatri
commented
Mar 31, 2025
roshkhatri
requested review from
joehu21,
hpatro and
zuiderkwast
and removed request for
joehu21
madolson
reviewed
Apr 1, 2025
commands/json.arrappend.md
Outdated
| JSON.ARRAPPEND <key> <path> <json> [json ...] | ||
| ``` | ||
|
|
||
| * key - required, Redis key of document type |
hpatro
reviewed
Apr 1, 2025
topics/data-types.md
Outdated
There was a problem hiding this comment.
JSON should be added in this file as well.
resp3_replies.json
Outdated
There was a problem hiding this comment.
JSON resp3 reply needs to be added.
zackcam
reviewed
Apr 1, 2025
hpatro
reviewed
Apr 1, 2025
resp2_replies.json
Outdated
| "JSON.ARRAPPEND": [ | ||
| "* If the path is enhanced syntax:", | ||
| " * [Array reply](../topics/protocol.md#arrays): Array of integers representing the new length of the array at each path.", | ||
| " * [Null reply](../topics/protocol.md#nulls): For each path where the value is not an array.", |
There was a problem hiding this comment.
Null reply is available in resp3, for resp2 it would be nil reply.
resp3_replies.json
Outdated
There was a problem hiding this comment.
I don't see any ValkeyModule_ReplyWithMap usage in JSON module so presume all the response are in array format. So, this looks good to me.
hpatro
approved these changes
Apr 2, 2025
|
This PR can be rebased now. The bloom changes are merged in. Also, the spellchecker needs to get addressed https://github.com/valkey-io/valkey-doc/blob/502c0995e2afdccdcd2008fbebc5b77401953d99/wordlist You can add words here ^ to ignore them |
Nikhil-Manglore
force-pushed
the
add-json-docs
branch
from
aa08875 to
95e7da0
Compare
as well Signed-off-by: zackcam <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]>
…to generate bloom man pages Signed-off-by: zackcam <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: zackcam <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]>
…creation and spelling Signed-off-by: zackcam <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: zackcam <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]>
Making changes based on review comments Co-authored-by: KarthikSubbarao <[email protected]> Signed-off-by: zackcam <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: zackcam <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Roshan Khatri <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Roshan Khatri <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Roshan Khatri <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Roshan Khatri <[email protected]> Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Nikhil Manglore <[email protected]>
Nikhil-Manglore
force-pushed
the
add-json-docs
branch
from
72f9733 to
1406333
Compare
…and return sections. Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Nikhil Manglore <[email protected]>
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.
One of the three PRs Required for module documentation to be included on the website
Related PRs:
valkey-io/valkey-json#42
Will wait for valkey-io/valkey-io.github.io#212 to het merged so we can use the framework to display documentation
We have merged the bloom changes in PR too as it depends on that, we would only review the changes related to JSON for this PR