Schema Registry contexts: SerDes client support via URL prefix (DOC-2397, DOC-2304) - #1850
Open
Feediver1 wants to merge 2 commits into
Open
Schema Registry contexts: SerDes client support via URL prefix (DOC-2397, DOC-2304)#1850Feediver1 wants to merge 2 commits into
Feediver1 wants to merge 2 commits into
Conversation
…ix (DOC-2397, DOC-2304) - Add "Use contexts with SerDes clients" section: URL-prefix pattern, endpoint coverage, automatic ID-lookup scoping, name normalization, ACL behavior, and the silent-failure gotcha when qualified parsing is inactive - Update client integration table: Non-Java SerDes now supported via URL prefix (was "Not supported / workaround"); Java no longer requires ContextNameStrategy - Cloud (DOC-2304): BYOC/Dedicated text updated from "contact support to enable" to enabled-by-default with opt-out - Fix subject audit grep: affected names start with ':.' not '.' - Version-condition the "set the property first" instruction on the API page (26.2 default is true) - Add 26.2 release-notes entry Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
📝 WalkthroughWalkthroughThe documentation now describes Schema Registry contexts as enabled by default in Redpanda v26.2 and env-cloud deployments, with version-specific configuration guidance for earlier or opted-out deployments. It documents context-scoped URL prefixes for Schema Registry and SerDes clients, updates Java and non-Java integration status, clarifies schema ID lookup behavior, and adds URL validation, troubleshooting, upgrade-audit, and cloud configuration guidance. Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Feediver1
commented
Jul 29, 2026
Feediver1
commented
Jul 29, 2026
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
![coderabbitai[bot]](https://cdn.github.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@modules/manage/pages/schema-reg/schema-reg-contexts.adoc`:
- Around line 745-752: Revise the diagnostic guidance around the /contexts curl
check so a response of ["." ] is not presented as proof that qualified subject
parsing is disabled. In the schema-registry troubleshooting section, instruct
readers to verify the relevant configuration and restart state directly, or
register a probe schema in a non-default context before interpreting the result.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 2597342c-fed0-4b89-9525-526d65504e84
📒 Files selected for processing (3)
modules/get-started/pages/release-notes/redpanda.adocmodules/manage/pages/schema-reg/schema-reg-api.adocmodules/manage/pages/schema-reg/schema-reg-contexts.adoc
Comment on lines
+745
to
+752
| To confirm, check whether the registry lists only the default context while clients are using qualified subjects or context URLs: | ||
|
|
||
| [source,bash] | ||
| ---- | ||
| curl -s http://localhost:8081/contexts | ||
| ---- | ||
|
|
||
| If the response is `["."]`, qualified subject parsing is not active. |
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Do not treat ["."] as proof that parsing is disabled.
Because contexts are listed only after a schema is registered, an enabled cluster with no non-default schemas also returns ["."]. Check the configuration and restart state directly, or register a probe schema in a non-default context before using this result diagnostically.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@modules/manage/pages/schema-reg/schema-reg-contexts.adoc` around lines 745 -
752, Revise the diagnostic guidance around the /contexts curl check so a
response of ["." ] is not presented as proof that qualified subject parsing is
disabled. In the schema-registry troubleshooting section, instruct readers to
verify the relevant configuration and restart state directly, or register a
probe schema in a non-default context before interpreting the result.
mattschumpert
approved these changes
Jul 29, 2026
|
|
||
| ifndef::env-cloud[] | ||
| To use contexts, first set the `schema_registry_enable_qualified_subjects` cluster configuration property to `true`, then restart the brokers. See xref:manage:schema-reg/schema-reg-contexts.adoc[] for setup instructions. | ||
| In Redpanda v26.2 and later, contexts are enabled by default. In earlier versions, first set the `schema_registry_enable_qualified_subjects` cluster configuration property to `true`, then restart the brokers. See xref:manage:schema-reg/schema-reg-contexts.adoc[] for setup instructions. |
There was a problem hiding this comment.
@pgellert what is the behavior though on upgrade from 26.2. Does it flip to on, or in 26.2 it is only enabled by default in NEW cluster?
|
|
||
| ifdef::env-cloud[] | ||
| NOTE: On BYOC and Dedicated clusters, contact Redpanda support or use the cluster configuration API to enable `schema_registry_enable_qualified_subjects`. This property requires a broker restart. | ||
| NOTE: On BYOC and Dedicated clusters, Schema Registry contexts are enabled by default. To opt out, use the cluster configuration API or contact Redpanda support to set `schema_registry_enable_qualified_subjects` to `false`. This property requires a broker restart. |
There was a problem hiding this comment.
Same question here @pgellert . cc @Feediver1
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
2 participants
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
Documents the v26.2 SerDes support for Schema Registry contexts: any SerDes client, in any language, can target a context by pointing
schema.registry.urlat a/contexts/{context}URL prefix — no client-side context support needed.Covers both tickets in one PR since both affected pages are single-sourced into cloud-docs:
Changes
schema-reg-contexts.adoc(single-sourced)[#serdes-clients]section: URL-prefix pattern with client config example, endpoint families covered, automatic schema-ID-lookup scoping, prefix/qualified-subject equivalence example, context-name normalization rules, ACL behavior, and an IMPORTANT callout for the silent-failure mode (qualified parsing inactive →/contexts/requests silently store literal subjects)ContextNameStrategyGET /contextsquick checkgrep '^\.'→grep '^:\.'(both occurrences). Only names starting with:.are affected by the breaking change;.foostays literal. The old pattern missed affected subjects and false-positived unaffected ones.schema-reg-api.adoc(single-sourced)true); cloud variant updated to enabled-by-defaultrelease-notes/redpanda.adocCompanion cloud-docs PR (What's New entry): redpanda-data/cloud-docs#654 — merge this PR first (the What's New entry links the
#serdes-clientsanchor, which reaches cloud-docs through the single-source include).Verification
service.ccat v26.1.7, absent at v26.1.6 (hence the "26.1.7 and later" version note)🤖 Generated with Claude Code
Preview pages