akka/akka-http

Clarify directive complete reponse body rendering

Open

#1,303 opened on Jul 25, 2017

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Scala (598 forks)batch import
1 - triagedhelp wantedt:docst:http:server:dsl

Repository metrics

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

Description

Issue by matheuslima Thursday Aug 11, 2016 at 00:18 GMT Originally opened as https://github.com/akka/akka/issues/21177

Actually, if we call complete passing only StatusCode as parameter, the reponse will have the StatusCode.toString as body. This is not documented. For example:

complete(StatusCodes.OK)

will render a response with status code 200 and body "OK"

Contributor guide

Research direction
Examine the source code of the 'complete' directive and the implicit marshaller for StatusCode to understand the current behavior, then update the documentation accordingly.
Tech stack
scala
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Scala
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90