akka/akka-http

Clarify difference in docs between EntityStreamingSupport for any source and low-level Source[ByteString, Any]

Open

#895 opened on Feb 23, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Scala (1,311 stars) (598 forks)batch import
1 - triagedhelp wantedt:docs

Description

As per the gitter discussion with @ktoso, it could be probably worth mentioning in the docs that EntityStreamingSupport is only needed to complete a route with a stream of "discrete elements" like for example json arrays or csv entries, while a low level byte stream could be simply sent back to the client doing something like:

complete(HttpEntity(contentType, byteStringSource))

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ScalaAkka HTTP basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
The issue requests clarifying the documentation for EntityStreamingSupport. It suggests that EntityStreamingSupport is only needed for streaming discrete elements like JSON arrays or CSV entries, while low level byte streams can be sent directly using `complete(HttpEntity(contentType, byteStringSource))`. Look into the documentation files in the akka http repository, likely under the 'docs' directory, and find where EntityStreamingSupport is explained. Add a note to distinguish its purpose from sending raw byte streams. The issue references a Gitter discussion with @ktoso, which may provide more context.
Clarify difference in docs between EntityStreamingSupport for any source and low-level Source[ByteString, Any] · akka/akka-http#895 | Good First Issue