Draft
Conversation
First draft
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughA new documentation page for Schema Registry contexts was added to the Redpanda documentation. The page explains contexts as isolated namespaces for organizing schemas and subjects, including qualified subject syntax, fallback resolution order for configuration settings (subject → context → global → built-in defaults), schema reference resolution, enablement via cluster properties with version-specific defaults, configuration at context and subject scopes, HTTP endpoints, rpk command usage patterns, ACL behavior with resource types and prefix grants, updated metrics with context labels, upgrade considerations when enabling qualified subjects, and troubleshooting guidance. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
modules/manage/pages/schema-reg/schema-reg-contexts.adoc (1)
374-383: Use auto-title xrefs instead of hard-coded link textPrefer
xref:...[]with empty brackets so link labels stay in sync with target page titles and reduce maintenance drift.Based on learnings: “AsciiDoc linking: prefer using xref links with empty brackets (e.g., xref:section/target.adoc[]) … Avoid hard-coding link text.”
Also applies to: 572-581
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/manage/pages/schema-reg/schema-reg-contexts.adoc` around lines 374 - 383, Replace each hard-coded xref label in the listed links (e.g., xref:reference:rpk/rpk-registry/rpk-registry-schema-create.adoc[rpk registry schema create], xref:reference:rpk/rpk-registry/rpk-registry-schema-list.adoc[rpk registry schema list], xref:reference:rpk/rpk-registry/rpk-registry-schema-get.adoc[rpk registry schema get], xref:reference:rpk/rpk-registry/rpk-registry-schema-check-compatibility.adoc[rpk registry schema check-compatibility], xref:reference:rpk/rpk-registry/rpk-registry-compatibility-level-get.adoc[rpk registry compatibility-level get], xref:reference:rpk/rpk-registry/rpk-registry-compatibility-level-set.adoc[rpk registry compatibility-level set], xref:reference:rpk/rpk-registry/rpk-registry-mode-get.adoc[rpk registry mode get], xref:reference:rpk/rpk-registry/rpk-registry-mode-set.adoc[rpk registry mode set], xref:reference:rpk/rpk-registry/rpk-registry-subject-delete.adoc[rpk registry subject delete], xref:reference:rpk/rpk-registry/rpk-registry-subject-list.adoc[rpk registry subject list]) to use empty-bracket auto-title xrefs (e.g., xref:reference:rpk/rpk-registry/rpk-registry-schema-create.adoc[]) so the link labels derive from the target page titles; apply the same change to the other similar block referenced in the comment (lines 572-581).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@modules/manage/pages/schema-reg/schema-reg-contexts.adoc`:
- Line 1: The page "Schema Registry Contexts"
(modules/manage/pages/schema-reg/schema-reg-contexts.adoc) is not linked in the
Site nav; update the navigation by adding a new entry under the existing "Schema
Registry" tree in modules/ROOT/nav.adoc that points to this page (use the same
title "Schema Registry Contexts" or a consistent label) so the page appears in
the sidebar; ensure the new nav item is placed within the Schema Registry
section block and follows the surrounding nav entry formatting and ordering.
- Around line 41-49: The docs disagree about the default for
schema_registry_enable_qualified_subjects (26.1 false vs 26.2 true) — update the
schema-reg-contexts.adoc text and the cluster-properties reference so they
consistently show versioned defaults or explicitly state the version scope;
specifically, change the paragraph that mentions "defaults to false in 26.1 and
true in 26.2" to match the authoritative source (cluster-properties) or add a
clear version note indicating the default per version, and apply the same
clarification to the duplicate mention around lines 303–305 so both places
consistently reference schema_registry_enable_qualified_subjects with the same
versioned guidance.
---
Nitpick comments:
In `@modules/manage/pages/schema-reg/schema-reg-contexts.adoc`:
- Around line 374-383: Replace each hard-coded xref label in the listed links
(e.g., xref:reference:rpk/rpk-registry/rpk-registry-schema-create.adoc[rpk
registry schema create],
xref:reference:rpk/rpk-registry/rpk-registry-schema-list.adoc[rpk registry
schema list], xref:reference:rpk/rpk-registry/rpk-registry-schema-get.adoc[rpk
registry schema get],
xref:reference:rpk/rpk-registry/rpk-registry-schema-check-compatibility.adoc[rpk
registry schema check-compatibility],
xref:reference:rpk/rpk-registry/rpk-registry-compatibility-level-get.adoc[rpk
registry compatibility-level get],
xref:reference:rpk/rpk-registry/rpk-registry-compatibility-level-set.adoc[rpk
registry compatibility-level set],
xref:reference:rpk/rpk-registry/rpk-registry-mode-get.adoc[rpk registry mode
get], xref:reference:rpk/rpk-registry/rpk-registry-mode-set.adoc[rpk registry
mode set], xref:reference:rpk/rpk-registry/rpk-registry-subject-delete.adoc[rpk
registry subject delete],
xref:reference:rpk/rpk-registry/rpk-registry-subject-list.adoc[rpk registry
subject list]) to use empty-bracket auto-title xrefs (e.g.,
xref:reference:rpk/rpk-registry/rpk-registry-schema-create.adoc[]) so the link
labels derive from the target page titles; apply the same change to the other
similar block referenced in the comment (lines 572-581).
🪄 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: c449cefb-0206-4296-8e68-0242ce9e07b5
📒 Files selected for processing (1)
modules/manage/pages/schema-reg/schema-reg-contexts.adoc
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Feediver1
commented
Apr 7, 2026
Feediver1
commented
Apr 7, 2026
Feediver1
commented
Apr 7, 2026
Feediver1
commented
Apr 7, 2026
Feediver1
commented
Apr 7, 2026
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Feediver1
commented
Apr 7, 2026
Feediver1
commented
Apr 7, 2026
Feediver1
commented
Apr 7, 2026
Feediver1
commented
Apr 7, 2026
Feediver1
commented
Apr 7, 2026
Feediver1
commented
Apr 7, 2026
Feediver1
commented
Apr 7, 2026
Feediver1
commented
Apr 7, 2026
Feediver1
commented
Apr 7, 2026
Feediver1
commented
Apr 7, 2026
Feediver1
commented
Apr 7, 2026
Feediver1
commented
Apr 7, 2026
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Feediver1
commented
Apr 8, 2026
Feediver1
commented
Apr 8, 2026
Feediver1
commented
Apr 8, 2026
Feediver1
commented
Apr 8, 2026
Feediver1
commented
Apr 8, 2026
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Feediver1
commented
Apr 9, 2026
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Feediver1
commented
Apr 9, 2026
|
|
||
| *Cause*: This is a known limitation of the `referencedby` endpoint. It returns bare schema IDs with no context metadata. When references span contexts, the returned IDs are ambiguous. | ||
|
|
||
| *Resolution*: There is no workaround in 26.1. To identify which schema an ID belongs to, try resolving the ID against each relevant context using `GET /schemas/ids/{id}?subject=:<context>:<subject>`. |
Contributor
Author
There was a problem hiding this comment.
Suggested change
| *Resolution*: There is no workaround in 26.1. To identify which schema an ID belongs to, try resolving the ID against each relevant context using `GET /schemas/ids/{id}?subject=:<context>:<subject>`. | |
| *Resolution*: There is no workaround. To identify which schema an ID belongs to, try resolving the ID against each relevant context using `GET /schemas/ids/{id}?subject=:<context>:<subject>`. |
Feediver1
commented
Apr 9, 2026
Feediver1
commented
Apr 9, 2026
Comment on lines
+366
to
+368
| | Default (26.1) | `false` | ||
| | Default (26.2) | `true` | ||
| | Removed in | 26.3 (always enabled) |
Contributor
Author
There was a problem hiding this comment.
Suggested change
| | Default (26.1) | `false` | |
| | Default (26.2) | `true` | |
| | Removed in | 26.3 (always enabled) | |
| | Default (v26.1) | `false` |
Feediver1
commented
Apr 9, 2026
|
|
||
| If affected subjects are found, rename them before enabling the property, or plan to re-register them under the reinterpreted context structure after enabling. | ||
|
|
||
| In 26.2, if you need additional time to migrate, you can temporarily set `schema_registry_enable_qualified_subjects` to `false` to restore literal behavior while you complete the migration. This option is removed in 26.3, after which contexts are always enabled. |
Contributor
Author
There was a problem hiding this comment.
Suggested change
| In 26.2, if you need additional time to migrate, you can temporarily set `schema_registry_enable_qualified_subjects` to `false` to restore literal behavior while you complete the migration. This option is removed in 26.3, after which contexts are always enabled. |
Feediver1
commented
Apr 9, 2026
Feediver1
commented
Apr 10, 2026
Feediver1
commented
Apr 10, 2026
Feediver1
commented
Apr 10, 2026
Feediver1
commented
Apr 10, 2026
Feediver1
commented
Apr 10, 2026
Feediver1
commented
Apr 10, 2026
Feediver1
commented
Apr 10, 2026
Feediver1
commented
Apr 10, 2026
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Feediver1
commented
Apr 10, 2026
|
|
||
| Schema Registry contexts are namespaces that isolate schemas, subjects, and configuration from one another within a single Schema Registry instance. | ||
| Each context maintains its own schema ID counter, mode settings, and compatibility settings. | ||
| Unqualified subjects continue to work unchanged in the implicit default context. |
Contributor
Author
There was a problem hiding this comment.
Suggested change
| Unqualified subjects continue to work unchanged in the implicit default context. | |
| Existing schemas will simply continue to work: unqualified subjects remain in the implicit default context |
Feediver1
commented
Apr 10, 2026
Feediver1
commented
Apr 10, 2026
Feediver1
commented
Apr 10, 2026
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Add // tag::single-source[] and // end::single-source[] to schema-reg-contexts.adoc so cloud-docs can include the body content via the established single-sourcing pattern. Update local-antora-playbook.yml to reference the cloud-docs PR branch for Netlify preview. Must revert to 'main' before merge. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
5 tasks
micheleRP
reviewed
Apr 10, 2026
| Each context maintains its own schema ID counter, mode settings, and compatibility settings. | ||
| Unqualified subjects continue to work unchanged in the implicit default context. | ||
|
|
||
| Schema Registry contexts is compatible with the Confluent Schema Registry Contexts API and requires no enterprise license. |
Contributor
There was a problem hiding this comment.
Suggested change
| Schema Registry contexts is compatible with the Confluent Schema Registry Contexts API and requires no enterprise license. | |
| Schema Registry contexts is compatible with the Confluent Schema Registry Contexts API. |
Removing since we don't note things that don't require an enterprise license. Plus it's cleaner for single sourcing into Cloud
micheleRP
reviewed
Apr 10, 2026
| Before using Schema Registry contexts, ensure that: | ||
|
|
||
| * You are running Redpanda v26.1 or later. | ||
| * The `schema_registry_enable_qualified_subjects` cluster configuration property is set to `true`. |
Contributor
There was a problem hiding this comment.
I think this (schema_registry_enable_qualified_subjects) should be conditionalized out for Cloud and replaced with the Note about this property you have later in the file!
micheleRP
reviewed
Apr 10, 2026
| ---- | ||
| endif::env-cloud[] | ||
|
|
||
| == rpk commands |
Contributor
There was a problem hiding this comment.
this heading isn't rendering properly
micheleRP
reviewed
Apr 10, 2026
|
|
||
| For the full metrics reference, see xref:reference:public-metrics-reference.adoc[]. | ||
|
|
||
| == Upgrade considerations |
Contributor
There was a problem hiding this comment.
I think this section should probably be conditionalized out for Cloud
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.
Resolves https://redpandadata.atlassian.net/browse/DOC-1996
Description
Review deadline:
Page previews
Checks