akka/akka-http

Document consuming multipart entities

Offen

#807 geöffnet am 23.01.2017

Auf GitHub ansehenContributor Guide
 (8 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Scala (598 Forks)batch import
3 - in progresshackathonhelp wantedt:docs

Repository-Metriken

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

Beschreibung

Not only for the server-side (i.e. for consuming file-uploads) but also for the client-side where servers may return multipart/byteranges or other multipart datastructures.

Information it should contain:

  • how to use Unmarshal(response / entity).to[Multipart.General]
  • other subclasses of Multipart
  • explain stream-of-streams nature of Multipart.parts and Multipart.BodyPart.entity.dataBytes
  • note about head-of-line blocking: the data of a part needs to be read fully before a new part will be dispatched. Just filtering parts can deadlock a stream.

Contributor Guide

Research-Richtung
Überprüfen Sie die aktuelle Dokumentation zur Multipart Verarbeitung sowohl auf der Server als auch auf der Client Seite und fügen Sie Abschnitte hinzu, die die Verwendung von Unmarshal, Unterklassen von Multipart, die Stream of Streams Natur von Teilen und Überlegungen zum Head of Line Blocking abdecken.
Tech Stack
Keine
Domain
backend
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
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75