auto-docs: Update RPCN connector docs#428
Open
vbotbuildovich wants to merge 1 commit into
Open
Conversation
Auto-generated by workflow run 25913553346
vbotbuildovich
added
auto-docs
documentation
✅ Deploy Preview for redpanda-connect ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
📝 WalkthroughWalkthroughThis PR updates the Redpanda Connect documentation site to release version 4.92.0. The release introduces six new Kafka producer configuration fields ( Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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)
docs-data/connect-4.92.0.json (1)
36570-36694: 💤 Low valueOptional: Case-sensitivity edge case in component linter.
The field-level linter for
acksperforms case-insensitive validation (this.string().lowercase()), but the component-level linter at Line 36694 compares the raw value:this.acks.or("all") != "all". If a user setsacks: "ALL", it passes field validation but would fail the idempotent_write check.Since documented options are lowercase and defaults work correctly, this is unlikely to cause issues in practice. Consider verifying if the underlying system normalizes values before component-level validation runs.
🤖 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/connect-4.92.0.json` around lines 36570 - 36694, The component-level linter compares a raw acks value (`this.acks.or("all") != "all"`) which can mismatch the field-level case-insensitive check (`this.string().lowercase()`); update the component linter to normalize before comparing—e.g. use `this.acks.or("all").lowercase() != "all"` (or otherwise call the same normalization function) in the root linter expression so values like "ALL" are treated equivalently to "all" when evaluating `idempotent_write` requirements.
🤖 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/components/attachments/connect-4.92.0.json`:
- Line 36730: The object-level linter compares this.acks.or("all") to "all"
case-sensitively, causing mismatches for values like "ALL"; update the "linter"
expression so it normalizes the acks value (e.g., lowercasing) before the
idempotency check and any other acks comparisons, and then use the normalized
value in the condition that references this.idempotent_write and this.acks (the
expression containing this.idempotent_write == true && this.acks.or("all") !=
"all"); apply the same normalization wherever acks is compared in this file (and
the other noted ranges).
In `@modules/get-started/pages/whats-new.adoc`:
- Around line 118-119: The table entry for record_delivery_timeout is truncated;
update the description for the record_delivery_timeout field to be a complete
sentence mentioning the unit (milliseconds) and clarifying when it is evaluated
(e.g., "record_delivery_timeout — timeout in ms; evaluated before writing a
request or after receiving a produce response"). Edit the whats-new.adoc entry
for record_delivery_timeout to replace the incomplete "ms`" fragment with the
full explanatory sentence so the release notes table reads clearly.
---
Nitpick comments:
In `@docs-data/connect-4.92.0.json`:
- Around line 36570-36694: The component-level linter compares a raw acks value
(`this.acks.or("all") != "all"`) which can mismatch the field-level
case-insensitive check (`this.string().lowercase()`); update the component
linter to normalize before comparing—e.g. use `this.acks.or("all").lowercase()
!= "all"` (or otherwise call the same normalization function) in the root linter
expression so values like "ALL" are treated equivalently to "all" when
evaluating `idempotent_write` requirements.
🪄 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: 892f9a07-2b2f-49d4-a551-52eb7f807e59
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (18)
antora.ymldocs-data/connect-4.92.0.jsondocs-data/connect-diff-4.90.3_to_4.91.0.jsondocs-data/connect-diff-4.91.0_to_4.92.0.jsonmodules/components/attachments/connect-4.92.0.jsonmodules/components/examples/advanced/outputs/kafka_franz.yamlmodules/components/examples/advanced/outputs/ockam_kafka.yamlmodules/components/examples/advanced/outputs/redpanda.yamlmodules/components/examples/advanced/outputs/redpanda_migrator.yamlmodules/components/examples/advanced/tracers/redpanda.yamlmodules/components/examples/common/outputs/ockam_kafka.yamlmodules/components/partials/fields/inputs/oracledb_cdc.adocmodules/components/partials/fields/outputs/kafka_franz.adocmodules/components/partials/fields/outputs/ockam_kafka.adocmodules/components/partials/fields/outputs/redpanda.adocmodules/components/partials/fields/outputs/redpanda_migrator.adocmodules/components/partials/fields/tracers/redpanda.adocmodules/get-started/pages/whats-new.adoc
💤 Files with no reviewable changes (1)
- docs-data/connect-diff-4.90.3_to_4.91.0.json
| } | ||
| ], | ||
| "linter": "root = match {\n this.partitioner == \"manual\" && this.partition.or(\"\") == \"\" => \"a partition must be specified when the partitioner is set to manual\"\n this.partitioner != \"manual\" && this.partition.or(\"\") != \"\" => \"a partition cannot be specified unless the partitioner is set to manual\"\n this.timestamp.or(\"\") != \"\" && this.timestamp_ms.or(\"\") != \"\" => \"both timestamp and timestamp_ms cannot be specified simultaneously\"\n}" | ||
| "linter": "root = match {\n this.partitioner == \"manual\" && this.partition.or(\"\") == \"\" => \"a partition must be specified when the partitioner is set to manual\"\n this.partitioner != \"manual\" && this.partition.or(\"\") != \"\" => \"a partition cannot be specified unless the partitioner is set to manual\"\n this.timestamp.or(\"\") != \"\" && this.timestamp_ms.or(\"\") != \"\" => \"both timestamp and timestamp_ms cannot be specified simultaneously\"\n this.idempotent_write == true && this.acks.or(\"all\") != \"all\" => \"idempotent_write requires acks to be set to all\"\n}" |
Contributor
There was a problem hiding this comment.
Normalize acks before the idempotency guard comparison.
The field-level validator accepts case-insensitive values, but these object-level checks are case-sensitive, so values like ALL can pass one check and fail the other.
🔧 Proposed fix
- this.idempotent_write == true && this.acks.or("all") != "all" => "idempotent_write requires acks to be set to all"
+ this.idempotent_write == true && this.acks.or("all").string().lowercase() != "all" => "idempotent_write requires acks to be set to all"Also applies to: 43988-43988, 44203-44203
🤖 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/components/attachments/connect-4.92.0.json` at line 36730, The
object-level linter compares this.acks.or("all") to "all" case-sensitively,
causing mismatches for values like "ALL"; update the "linter" expression so it
normalizes the acks value (e.g., lowercasing) before the idempotency check and
any other acks comparisons, and then use the normalized value in the condition
that references this.idempotent_write and this.acks (the expression containing
this.idempotent_write == true && this.acks.or("all") != "all"); apply the same
normalization wherever acks is compared in this file (and the other noted
ranges).
Comment on lines
+118
to
+119
| |record_delivery_timeout | ||
| |ms`. This is evaluated before writing a request or after a produce response. |
Contributor
There was a problem hiding this comment.
Fix truncated record_delivery_timeout description text.
Line 119 starts mid-sentence (`ms``), so the field description is incomplete and unclear in the release notes table.
✏️ Proposed patch
|record_delivery_timeout
-|ms`. This is evaluated before writing a request or after a produce response.
+|The maximum time a record may be retained by the client before failing (`0` disables the timeout). This is evaluated before writing a request or after a produce response.📝 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
| |record_delivery_timeout | |
| |ms`. This is evaluated before writing a request or after a produce response. | |
| |record_delivery_timeout | |
| |The maximum time a record may be retained by the client before failing (`0` disables the timeout). This is evaluated before writing a request or after a produce response. |
🤖 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/get-started/pages/whats-new.adoc` around lines 118 - 119, The table
entry for record_delivery_timeout is truncated; update the description for the
record_delivery_timeout field to be a complete sentence mentioning the unit
(milliseconds) and clarifying when it is evaluated (e.g.,
"record_delivery_timeout — timeout in ms; evaluated before writing a request or
after receiving a produce response"). Edit the whats-new.adoc entry for
record_delivery_timeout to replace the incomplete "ms`" fragment with the full
explanatory sentence so the release notes table reads clearly.
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.
Redpanda Connect Documentation Update
OSS Version: 4.91.0 → 4.92.0
Cloud Version: 4.92.0
Summary
📝 Action Items for Writers
Detailed Changes (click to expand)
New Fields
config/redpanda:
acksmax_buffered_recordsmax_buffered_bytesmax_in_flight_requestsrecord_retriesrecord_delivery_timeoutoutputs/kafka_franz:
acksmax_buffered_recordsmax_buffered_bytesmax_in_flight_requestsrecord_retriesrecord_delivery_timeoutoutputs/redpanda:
acksmax_buffered_recordsmax_buffered_bytesmax_in_flight_requestsrecord_retriesrecord_delivery_timeoutoutputs/redpanda_migrator:
acksmax_buffered_recordsmax_buffered_bytesmax_in_flight_requestsrecord_retriesrecord_delivery_timeouttracers/redpanda:
acksmax_buffered_recordsmax_buffered_bytesmax_in_flight_requestsrecord_retriesrecord_delivery_timeout🔍 Cloud Support Gap Analysis
74 connectors available in OSS but not in cloud:
buffers:
caches:
inputs:
outputs:
processors:
metrics:
tracers:
bloblang-functions:
Generated: 2026-05-15T10:46:53.537Z
📚 Review Guide
For help reviewing this content, see our Review Guide.
🤖 Generation Details
25913553346workflow_dispatch2026-05-15 10:47:10 UTC24📋 Generation Output (last 200 lines)
Full logs available in workflow run
This PR was automatically generated. Please review the changes and merge when ready.