Skip to content

Add JsonStreamResponse documentation for 5.4#8255

Draft
dereuromark wants to merge 2 commits into5.nextfrom
5.next-json-stream-response
Draft

Add JsonStreamResponse documentation for 5.4#8255
dereuromark wants to merge 2 commits into5.nextfrom
5.next-json-stream-response

Conversation

@dereuromark
Copy link
Copy Markdown
Member

Summary

Adds documentation for the new JsonStreamResponse class being added in CakePHP 5.4.

Related implementation PR: cakephp/cakephp#19367

Changes

Migration Guide (5-4-migration-guide.md)

  • Added entry under "New Features > Http" section

Request & Response (request-response.md)

  • Added comprehensive "Streaming JSON Responses" section covering:
    • Basic usage
    • Constructor options table
    • Root wrapper
    • Envelope/metadata support
    • NDJSON format
    • Transform callbacks
    • Immutability (withStreamOptions)
    • Error handling strategy
    • ORM integration (unbuffered queries, formatter warning)

@dereuromark dereuromark marked this pull request as draft March 27, 2026 03:27
@dereuromark dereuromark added this to the 5.next milestone Mar 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant