akka/akka-http

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

Ouverte

#895 ouverte le 23 févr. 2017

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée)Scala (598 forks)batch import
1 - triagedhelp wantedt:docs

Métriques du dépôt

Stars
 (1 311 étoiles)
Métriques de merge PR
 (Merge moyen 1j 10h) (2 PRs mergées en 30 j)

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))

Guide contributeur

Direction de recherche
Le problème demande de clarifier la documentation pour EntityStreamingSupport. Il suggère qu'EntityStreamingSupport n'est nécessaire que pour le streaming d'éléments discrets comme des tableaux JSON ou des entrées CSV, tandis que les flux d'octets de bas niveau peuvent être envoyés directement en utilisant `complete(HttpEntity(contentType, byteStringSource))`. Examinez les fichiers de documentation dans le dépôt akka http, probablement dans le répertoire 'docs', et trouvez où EntityStreamingSupport est expliqué. Ajoutez une note pour distinguer son objectif de l'envoi de flux d'octets bruts. Le problème fait référence à une discussion sur Gitter avec @ktoso, qui pourrait fournir plus de contexte.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Akka HTTPScala basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80