akka/akka-http

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

Aberta

#895 aberto em 23 de fev. de 2017

Ver no GitHubGuia do colaborador
 (1 comentário) (0 reação) (0 responsável)Scala (598 forks)batch import
1 - triagedhelp wantedt:docs

Métricas do repositório

Stars
 (1.311 estrelas)
Métricas de merge de PR
 (Mesclagem média 1d 10h) (2 fundiu PRs em 30d)

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

Guia do colaborador

Direção de pesquisa
A questão solicita a clarificação da documentação para EntityStreamingSupport. Ela sugere que o EntityStreamingSupport é necessário apenas para o streaming de elementos discretos, como arrays JSON ou entradas CSV, enquanto fluxos de bytes de baixo nível podem ser enviados diretamente usando `complete(HttpEntity(contentType, byteStringSource))`. Procure nos arquivos de documentação no repositório akka http, provavelmente no diretório 'docs', e encontre onde o EntityStreamingSupport é explicado. Adicione uma nota para distinguir seu propósito do envio de fluxos de bytes brutos. A questão referencia uma discussão no Gitter com @ktoso, que pode fornecer mais contexto.
Pilha de tecnologia
None
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Akka HTTPScala basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80