Skip to content

fix(properties): correct topic property name in kafka_batch_max_bytes reference #1775

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Feediver1 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(properties): correct topic property name in kafka_batch_max_bytes reference #1775

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs-data/property-overrides.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1205,9 +1205,9 @@
},
"kafka_batch_max_bytes": {
"related_topics": [
"xref:reference:properties/topic-properties.adoc[`message.max.bytes`]"
"xref:reference:properties/topic-properties.adoc[`max.message.bytes`]"
],
"description": "The default maximum batch size for topics if the topic property xref:reference:properties/topic-properties.adoc[`message.max.bytes`] is not set. If the batch is compressed, the limit applies to the compressed batch size.",
"description": "The default maximum batch size for topics if the topic property xref:reference:properties/topic-properties.adoc[`max.message.bytes`] is not set. If the batch is compressed, the limit applies to the compressed batch size.",
Comment on lines 1207 to +1210

@coderabbitai coderabbitai Bot Jul 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Missing anchor in max.message.bytes xref — link won't jump to the property.

The new xref xref:reference:properties/topic-properties.adoc[max.message.bytes] points to the top of topic-properties.adoc instead of the specific property section. Elsewhere in this same file, references to this property consistently include the anchor, e.g. kafka_max_message_size_upper_limit_bytes uses xref:reference:properties/topic-properties.adoc#max-message-bytes[max.message.bytes]. Apply the same anchor here for both the related_topics entry and the inline reference in description.

🔗 Proposed fix to add the missing anchor 
     "related_topics": [
-        "xref:reference:properties/topic-properties.adoc[`max.message.bytes`]"
+        "xref:reference:properties/topic-properties.adoc#max-message-bytes[`max.message.bytes`]"
     ],
-    "description": "The default maximum batch size for topics if the topic property xref:reference:properties/topic-properties.adoc[`max.message.bytes`] is not set. If the batch is compressed, the limit applies to the compressed batch size.",
+    "description": "The default maximum batch size for topics if the topic property xref:reference:properties/topic-properties.adoc#max-message-bytes[`max.message.bytes`] is not set. If the batch is compressed, the limit applies to the compressed batch size.",
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
"related_topics": [
"xref:reference:properties/topic-properties.adoc[`message.max.bytes`]"
"xref:reference:properties/topic-properties.adoc[`max.message.bytes`]"
],
"description": "The default maximum batch size for topics if the topic property xref:reference:properties/topic-properties.adoc[`message.max.bytes`] is not set. If the batch is compressed, the limit applies to the compressed batch size.",
"description": "The default maximum batch size for topics if the topic property xref:reference:properties/topic-properties.adoc[`max.message.bytes`] is not set. If the batch is compressed, the limit applies to the compressed batch size.",
"related_topics": [
"xref:reference:properties/topic-properties.adoc#max-message-bytes[`max.message.bytes`]"
],
"description": "The default maximum batch size for topics if the topic property xref:reference:properties/topic-properties.adoc#max-message-bytes[`max.message.bytes`] is not set. If the batch is compressed, the limit applies to the compressed batch size.",
🤖 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 `@docs-data/property-overrides.json` around lines 1207 - 1210, The xref for
max.message.bytes in both related_topics and description is missing the anchor,
so it points to the top of topic-properties.adoc instead of the property
section. Update the references in property-overrides.json to match the existing
pattern used elsewhere in this file by adding the max-message-bytes anchor to
the xref. Use the related_topics entry and the description text as the places to
fix, keeping the same reference target format as the other max.message.bytes
links.

"config_scope": "cluster"
},
"kafka_connection_rate_limit_overrides": {
Expand Down
4 changes: 2 additions & 2 deletions modules/reference/attachments/redpanda-properties-v26.1.10.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7817,7 +7817,7 @@
"config_scope": "cluster",
"default": 1048576,
"defined_in": "src/v/config/configuration.cc",
"description": "The default maximum batch size for topics if the topic property xref:reference:properties/topic-properties.adoc[`message.max.bytes`] is not set. If the batch is compressed, the limit applies to the compressed batch size.",
"description": "The default maximum batch size for topics if the topic property xref:reference:properties/topic-properties.adoc[`max.message.bytes`] is not set. If the batch is compressed, the limit applies to the compressed batch size.",
"is_deprecated": false,
"is_enterprise": false,
"maximum": 4294967295,
Expand All @@ -7826,7 +7826,7 @@
"needs_restart": false,
"nullable": false,
"related_topics": [
"xref:reference:properties/topic-properties.adoc[`message.max.bytes`]"
"xref:reference:properties/topic-properties.adoc[`max.message.bytes`]"
],
"type": "integer",
"visibility": "tunable"
Expand Down
4 changes: 2 additions & 2 deletions modules/reference/partials/properties/cluster-properties.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9600,7 +9600,7 @@ endif::[]

=== kafka_batch_max_bytes

The default maximum batch size for topics if the topic property xref:reference:properties/topic-properties.adoc[`message.max.bytes`] is not set. If the batch is compressed, the limit applies to the compressed batch size.
The default maximum batch size for topics if the topic property xref:reference:properties/topic-properties.adoc[`max.message.bytes`] is not set. If the batch is compressed, the limit applies to the compressed batch size.

[cols="1s,2a"]
|===
Expand Down Expand Up @@ -9643,7 +9643,7 @@ ifndef::env-cloud[]
endif::[]

| Related topics
|xref:reference:properties/topic-properties.adoc[`message.max.bytes`]
|xref:reference:properties/topic-properties.adoc[`max.message.bytes`]

|===

Expand Down
Loading