haskell-servant/servant

servant-client requires charset in Accept PlainText

Open

#1002 opened on Jul 2, 2018

View on GitHub
 (7 comments) (1 reaction) (0 assignees)Haskell (1,953 stars) (422 forks)batch import
enhancementhelp wantednewcomer-friendlyservant-api

Description

The current implementation is

instance Accept PlainText where
    contentType _ = "text" M.// "plain" M./: ("charset", "utf-8")

Trying to parse text/plain yields UnsupportedContentType text/plain

One API I'm calling does not specify the charset so I can't use PlainText, but this does the job:

data PT
instance Accept PT where
  contentType _ = "text" M.// "plain"

The workaround is simple, but could/should the charset be made optional?

Contributor guide

Tech stack
None
Domain
backendapi
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Haskell basicsservant library
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
The issue is about the Accept instance for PlainText requiring a charset parameter. The relevant code is likely in the servant client package, possibly in an Accept instance definition. The workaround shows a custom Accept instance without charset. The maintainers need to decide whether to make charset optional or accept both variants. Research the discussion comments and check if there is any linked PR or decision.