DOC-6829 Add preemptive Spring Data Redis JSON docs [PARKED]#3611
Open
andy-stark-redis wants to merge 1 commit into
Open
DOC-6829 Add preemptive Spring Data Redis JSON docs [PARKED]#3611andy-stark-redis wants to merge 1 commit into
andy-stark-redis wants to merge 1 commit into
Conversation
Document the new template-layer JSON API from the in-progress SDR PR spring-projects/spring-data-redis#3390 ahead of its release. The page lives under content/integrate/spring-framework-cache/, which despite the directory name is the Spring Data Redis section (LinkTitle "Spring Data Redis"), alongside the cache and geo-failover recipes. The non-obvious call: no per-client split. RedisJsonTemplate/JsonOperations is client-agnostic and identical whether Jedis or Lettuce backs the connection — the clients diverge only in internal converters/path types below the API surface, with full feature parity. So one set of examples serves both. Examples are inline java (not runnable TCE snippets) because the feature isn't in the client example repos yet, and a bannerText flags the API as unreleased and subject to change. Learned: SDR JSON template API is unified across Jedis/Lettuce; docs based on an unmerged PR Directive: keep the JSON examples client-agnostic — do not split into Jedis vs Lettuce variants Recheck: when spring-data-redis#3390 merges and ships — re-verify method signatures, bean/serializer wiring, and convert examples to runnable TCE doctests Gaps: code examples untested; signatures and API shape read from an in-progress, still-reviewed diff Ticket: DOC-6829 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
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.
Summary
Preemptively documents the new template-layer JSON API in Spring Data Redis (DOC-6829), ahead of its upstream release. Adds a new recipe page under the Spring Data Redis section and links it from the section index.
content/integrate/spring-framework-cache/json.mdcontent/integrate/spring-framework-cache/_index.mdWarning
This PR is parked — do not merge. The docs are written against an unreleased, still-under-review upstream PR (spring-data-redis#3390). Merge only after the feature ships and the manifest below has been reconciled (see
/pickup).Park manifest
Ticket: DOC-6829
Parked at: 2026-07-10
Trigger to pick up: upstream PR spring-data-redis#3390 is merged and included in a released
spring-data-redisversion.Labels:
parked,do not merge yetPinned sources (state observed at park time)
e35714beca1c1ac46f0cb8a325ac95b9e6199d0f, basemain, milestone: none (no target version), updated 2026-07-08To diff on pickup:
gh api repos/spring-projects/spring-data-redis/pulls/3390and comparemerged/head.sha/milestoneagainst the snapshot above; re-readJsonOperations.java,RedisJsonTemplate, andJacksonRedisJsonSerializerat the released tag.Observed API shape the page assumes (LOW confidence — synthesized from an in-progress diff)
RedisJsonTemplate:value(key),array(key),string(key),bool(key)..path("$.jsonpath")chaining;set/setIfAbsent/get/paths.append,length,indexOf,trim. String:append,length. Boolean:toggle. Document:mergeWith.RedisJsonTemplate+JacksonRedisJsonSerializer(Type.class)over the existingRedisConnectionFactory.Re-check checklist (work these on pickup)
get(K key)→JsonResultvs fluentvalue(key).get();paths()vspath();append(Object...)vsappend(String)). Verify every signature on the page against released source. (highest risk)RedisJsonTemplatesetters andJacksonRedisJsonSerializerconstructor are guessed; confirm the real configuration.opsForJson()— not present in the diff at park time; SDR conventionally exposesopsForX(). If added before release, lead the page with it as the idiomatic entry point.{version}placeholder in the Maven/Gradle snippets with the first release that includes JSON support.BoundJsonOperations— explicitly deferred in the PR. If it lands before GA, add a bound-operations section.mergeWithnaming — may ship asmerge.javablocks to tested TCE (clients-example) doctests once the feature reaches the client example repos.main; re-run link checks; confirmrelreftargets and thebannerTextnote are still valid.On pickup, then
Update the docs to reconcile, remove the
bannerTextwarning, drop theparked/do not merge yetlabels, run/reflect(record what actually changed vs predicted) and/finalize(the durable squash — deferred until now on purpose so these re-check notes survive).🤖 Generated with Claude Code
Note
Low Risk
Documentation-only changes with no runtime impact; API examples may drift until the upstream feature ships and the parked PR is reconciled.
Overview
Adds preemptive documentation for the unreleased Spring Data Redis template JSON API (DOC-6829), with a prominent banner noting the content tracks spring-data-redis#3390 and may change before GA.
A new recipe page
json.mdunder Spring Data Redis covers requirements (Redis JSON, Lettuce/Jedis, Jackson), Maven/Gradle setup with a{version}placeholder,RedisJsonTemplate/JacksonRedisJsonSerializerbean wiring, and fluent examples for whole-documentvalue()ops, JSON path updates,array()/string()/bool()helpers, andmergeWith(), with links to existing JSON/path/command docs.The section
_index.mdgains a third bullet linking to the new page alongside cache and geo-failover recipes.Reviewed by Cursor Bugbot for commit 2d36ad2. Bugbot is set up for automated code reviews on this repo. Configure here.