haskell-servant/servant

servant-client requires charset in Accept PlainText

Open

#1,002 opened on Jul 2, 2018

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

Repository metrics

Stars
 (1,953 stars)
PR merge metrics
 (Avg merge 5h 49m) (2 merged PRs in 30d)

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

Research direction
Investigate how Accept instances are used in servant client's content type negotiation. Consider making the charset parameter optional in the Accept instance for PlainText by using a newtype or type family that allows omitting parameters. Check existing tests and documentation for guidance.
Tech stack
haskell
Domain
backendapi
Issue type
Bug
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
Haskellservant
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70