Skip to content

docs: outputs: kafka-rest-proxy: gemeral doc update and cleanup#2437

Merged
eschabell merged 1 commit into
fluent:masterfrom
eschabell:erics_out_kafka_rest_proxy_updates
Mar 18, 2026
Merged

docs: outputs: kafka-rest-proxy: gemeral doc update and cleanup#2437
eschabell merged 1 commit into
fluent:masterfrom
eschabell:erics_out_kafka_rest_proxy_updates

Conversation

@eschabell
Copy link
Copy Markdown
Collaborator

@eschabell eschabell commented Mar 17, 2026

  • Sort configuration parameters table alphabetically
  • Lowercase all Key column entries
  • Fix default column header capitalization
  • Fix partition default: _none_-1
  • Fix include_tag_key default: Offfalse
  • Add missing params: url_path, avro_http_header
  • Fix time_key description: remove Time_Key Title_Case reference

Applies to #2412

Summary by CodeRabbit

  • Documentation
    • Standardized Kafka REST Proxy configuration parameter documentation with consistent naming conventions
    • Added new configuration options including avro HTTP header support
    • Updated default values across parameters
    • Configuration parameter format has been updated for consistency

  - Sort configuration parameters table alphabetically
  - Lowercase all Key column entries
  - Fix `default` column header capitalization
  - Fix `partition` default: `_none_` → `-1`
  - Fix `include_tag_key` default: `Off` → `false`
  - Add missing params: `url_path`, `avro_http_header`
  - Fix `time_key` description: remove `Time_Key` Title_Case reference

  Applies to fluent#2412

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell self-assigned this Mar 17, 2026
@eschabell eschabell requested a review from a team as a code owner March 17, 2026 19:21
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0 labels Mar 17, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 17, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 46b6d8d2-b548-4c2e-b833-33e7b72963a5

📥 Commits

Reviewing files that changed from the base of the PR and between 9691fb1 and 6e8a20c.

📒 Files selected for processing (1)
  • pipeline/outputs/kafka-rest-proxy.md

📝 Walkthrough

Walkthrough

Documentation update to the Kafka REST Proxy configuration guide standardizing parameter naming conventions from CamelCase to lowercase snake_case, introducing new parameters like avro_http_header, and updating default values to reflect current configuration options.

Changes

Cohort / File(s) Summary
Kafka REST Proxy Documentation
pipeline/outputs/kafka-rest-proxy.md
Standardized parameter naming from CamelCase (e.g., Host, Port, Topic) to lowercase snake_case (e.g., host, port, topic). Added new parameters including avro_http_header and expanded configuration options. Updated default values (e.g., partition from _none_ to -1, include_tag_key from Off to false). Capitalized table header from "default" to "Default".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Suggested reviewers

  • cosmo0920
  • patrick-stephens

Poem

🐰 Hop along, dear parameters so fine,
From CamelCase heights to snake_case line,
With avro_http_header now in the fold,
Our config's more tidy, consistent, and bold! 🎉

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title mentions 'general doc update and cleanup' which broadly aligns with the changes (documentation updates, parameter table reorganization, and default value corrections), but contains a typo ('gemeral' instead of 'general') and is somewhat vague about the specific changes made.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

CodeRabbit can approve the review once all CodeRabbit's comments are resolved.

Enable the reviews.request_changes_workflow setting to automatically approve the review once all CodeRabbit's comments are resolved.

@eschabell
Copy link
Copy Markdown
Collaborator Author

@cosmo0920 and @patrick-stephens ready for review!

@eschabell eschabell merged commit 5954fdd into fluent:master Mar 18, 2026
8 checks passed
@eschabell eschabell deleted the erics_out_kafka_rest_proxy_updates branch March 18, 2026 11:17
@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Mar 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants