Clarify JsonFraming object-only behavior#3320
Open
He-Pin wants to merge 1 commit into
Open
Conversation
Motivation: JsonFraming.objectScanner documentation could be read as supporting arbitrary top-level JSON values even though it only frames objects. Modification: Clarify the object-only contract in Scala, Java, and internal docs, document NDJSON and BOM boundaries, and link nested JSON users to Pekko Connectors. Result: Users can distinguish object framing from general-purpose JSON parsing and choose the appropriate API. Tests: - Not run - docs only - sbt "stream / Compile / doc" (passed) - sbt -Dpekko.genjavadoc.enabled=true Javaunidoc/doc (passed) - sbt checkCodeStyle (passed) - sbt +headerCheckAll (passed) - git diff --check (passed) References: Fixes apache#3244
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.
Motivation
JsonFraming.objectScanneronly frames JSON objects, but its API documentation described valid JSON chunks and top-level arrays without explicitly stating that non-object values and a leading UTF-8 BOM are unsupported. This made the intended contract unclear in #3244.Modification
Result
Users can distinguish object framing from general-purpose JSON parsing and choose the appropriate API without changing runtime behavior.
References
Fixes #3244