[DOCS-39462]-Use Schema Registry in the README producer example - #2324
Open
Jamie Gillenwater (jgillenwater) wants to merge 2 commits into
Open
Jamie Gillenwater (jgillenwater) wants to merge 2 commits into
Jamie Gillenwater (jgillenwater) wants to merge 2 commits into
Conversation
Replace the raw-bytes first producer example in the README with a JSONSerializer-based one, so the first example a reader copies registers and validates a schema instead of producing unstructured bytes. Points to the JSON Schema pip extra, the Schema Registry Integration section, and examples/json_producer.py for a fuller runnable version. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Jamie Gillenwater (jgillenwater)
requested a review
from Robert Yokota (rayokota)
August 10, 2026 17:49
|
🎉 All Contributor License Agreements have been signed. Ready to merge. |
Jamie Gillenwater (jgillenwater)
requested review from
Vahid Fereydouny (fereydunk) and
jmathai-confluent
August 10, 2026 17:55
Jamie Gillenwater (jgillenwater)
marked this pull request as ready for review
August 10, 2026 17:55
Jamie Gillenwater (jgillenwater)
requested review from
a team and
Matthew Seal (MSeal)
as code owners
August 10, 2026 17:55
Apply the repo's black config (line-length 120, skip-string-normalization) to the basic producer example: two blank lines around delivery_report and a reflowed docstring. No functional change. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
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
1 participant
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
JSONSerializer.StringSerializerfor the key and aSerializationContextfor the value, matching the pattern inexamples/json_producer.py.confluent-kafka[json,schemaregistry]extra, and linking to the Schema Registry Integration section and the fullerexamples/json_producer.py.Addresses DOCS-39462: the first example a developer copies sets the default. Producing raw bytes leads to data-quality issues, broken consumers, and ungovernable data, so the README's first-run example should use Schema Registry. This is one of five coordinated PRs across librdkafka, confluent-kafka-python, confluent-kafka-go, confluent-kafka-dotnet, and confluent-kafka-javascript.
Verification
py_compile.