Skip to content

DOC-6508 JSON page and examples for Rust#3098

Merged
andy-stark-redis merged 3 commits intomainfrom
DOC-6508-rust-json
Apr 27, 2026
Merged

DOC-6508 JSON page and examples for Rust#3098
andy-stark-redis merged 3 commits intomainfrom
DOC-6508-rust-json

Conversation

@andy-stark-redis
Copy link
Copy Markdown
Contributor

@andy-stark-redis andy-stark-redis commented Apr 24, 2026

Rust doesn't support Redis search yet, but a JSON example is very useful to have, so this is example is a bit different to the JSON examples for the other clients. Also added Rust examples for the JSON data type pages and added the command to API mappings for the Rust JSON commands.


Note

Low Risk
Low risk documentation/data updates that don’t affect runtime behavior; main risk is incorrect example output or API signature mismatches in the new command-to-client mappings.

Overview
Adds a new Rust client docs page, content/develop/clients/rust/json.md, documenting a simple end-to-end RedisJSON workflow (create, read nested paths, update fields, append to arrays) for both sync and async redis-rs.

Introduces new runnable Rust example sources for rust_home_json and for the json_tutorial used by the JSON data type pages (local_examples/rust-{sync,async}/dt-json.rs), covering common JSON string/number/array/object operations and JSONPath queries.

Extends multiple data/command-api-mapping/JSON.*.json files to include redis_rs_sync and redis_rs_async API signatures/params/returns for RedisJSON commands (e.g., JSON.GET, JSON.SET, array ops, object ops, numeric ops).

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

@andy-stark-redis andy-stark-redis requested a review from a team April 24, 2026 10:55
@andy-stark-redis andy-stark-redis self-assigned this Apr 24, 2026
@andy-stark-redis andy-stark-redis added the clients Client library docs label Apr 24, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 24, 2026

DOC-6508

@github-actions
Copy link
Copy Markdown
Contributor

@jit-ci
Copy link
Copy Markdown

jit-ci Bot commented Apr 24, 2026

🛡️ Jit Security Scan Results

CRITICAL HIGH MEDIUM

✅ No security findings were detected in this PR


Security scan by Jit

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.

LGTM.

@andy-stark-redis
Copy link
Copy Markdown
Contributor Author

Thanks @dwdougherty !

@andy-stark-redis andy-stark-redis merged commit a818d5c into main Apr 27, 2026
60 checks passed
@andy-stark-redis andy-stark-redis deleted the DOC-6508-rust-json branch April 27, 2026 08:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clients Client library docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants