akka/akka-http

Document consuming multipart entities

Open

#807 opened on Jan 23, 2017

View on GitHub
 (8 comments) (0 reactions) (0 assignees)Scala (598 forks)batch import
3 - in progresshackathonhelp wantedt:docs

Repository metrics

Stars
 (1,311 stars)
PR merge metrics
 (Avg merge 1d 10h) (2 merged PRs in 30d)

Description

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 direction
Review the current documentation for multipart handling in both server and client APIs, then add sections covering Unmarshal usage, Multipart subclasses, stream of streams nature of parts, and head of line blocking considerations.
Tech stack
None
Domain
backend
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75