akka/akka-http

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

Offen

#895 geöffnet am 23.02.2017

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Scala (598 Forks)batch import
1 - triagedhelp wantedt:docs

Repository-Metriken

Stars
 (1.311 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 1T 10h) (2 gemergte PRs in 30 T)

Beschreibung

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

Research-Richtung
Das Issue fordert eine Klarstellung der Dokumentation für EntityStreamingSupport. Es deutet an, dass EntityStreamingSupport nur für das Streamen diskreter Elemente wie JSON Arrays oder CSV Einträge benötigt wird, während Low Level Byte Streams direkt mit `complete(HttpEntity(contentType, byteStringSource))` gesendet werden können. Untersuchen Sie die Dokumentationsdateien im akka http Repository, wahrscheinlich im Verzeichnis 'docs', und finden Sie die Stelle, an der EntityStreamingSupport erklärt wird. Fügen Sie einen Hinweis hinzu, um seinen Zweck vom Senden von Roh Byte Streams zu unterscheiden. Das Issue verweist auf eine Gitter Diskussion mit @ktoso, die weiteren Kontext liefern könnte.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Akka HTTPScala basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80