[PR] Clarify JsonFraming object-only behavior [pekko]

["He-Pin (via GitHub)" <gi...@apache.org>]

He-Pin opened a new pull request, #3320:
URL: https://github.com/apache/pekko/pull/3320

   ### Motivation
   `JsonFraming.objectScanner` only 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
   - Clarify that the brace-counting operator emits objects and does not validate their contents.
   - Document the supported array-of-objects and object-only JSON Lines/NDJSON inputs, unsupported top-level values, and BOM handling.
   - Keep Scala DSL, Java DSL, and internal parser documentation in sync and link nested JSON use cases to Pekko Connectors.
   
   ### Result
   Users can distinguish object framing from general-purpose JSON parsing and choose the appropriate API without changing runtime behavior.
   
   ### Tests
   - Not run - docs only
   - `sbt "stream / Compile / doc"` (passed; existing unrelated Scaladoc warnings remain)
   - `sbt -Dpekko.genjavadoc.enabled=true Javaunidoc/doc` (passed)
   - `sbt checkCodeStyle` (passed)
   - `sbt +headerCheckAll` (passed)
   - `git diff --check` (passed)
   
   ### References
   Fixes #3244


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org

Re: [PR] Clarify JsonFraming object-only behavior [pekko]

["He-Pin (via GitHub)" <gi...@apache.org>]

He-Pin merged PR #3320:
URL: https://github.com/apache/pekko/pull/3320


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org