haskell-servant/servant

Idea Symbolic Names for HTTP Status codes

Open

#628 opened on Oct 27, 2016

View on GitHub
 (9 comments) (1 reaction) (0 assignees)Haskell (422 forks)batch import
enhancementhelp wantedservant-api

Repository metrics

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

Description

I had a thought, currently to express a http status code you have to remember the number, would it be possible to have a named type for them. So instead of having the number 304 in my code I could ahve the value 'NotModified' which esp for some of the more unusual status codes would be very helpful in making code more readable.

For example if I see that something should return 415 I probably will have to look up what that means but if I see UnsupportedMediaType it is self documenting.

Contributor guide

Research direction
Investigate how to introduce a new type for HTTP status codes in Servant, possibly using a sum type or smart constructors, and ensure compatibility with existing API types.
Tech stack
None
Domain
backend
Issue type
Feature
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-2 days
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.
60