haskell-servant/servant

Generic api type fold: unify servant-foreign and servant-docs

Open

#833 opened on Oct 9, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Haskell (422 forks)batch import
enhancementhelp wantedservant-docsservant-foreign

Repository metrics

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

Description

it seems that servant-foreign and servant-docs are moving into same direction of collecting a lot of information about api type. I wonder if they can be unified in the longer run. They are simple "folds" as the esult type is independent of endpoints (not true with servant-client e.g.), a bit how Foldable and Traversable are related.

I wonder if we can provide single but extensible GADT? to give common parts of servant-foreign and servant-docs.

Contributor guide

Research direction
Analyze the current implementations of servant foreign and servant docs to identify common patterns and propose a unified GADT for API type folds.
Tech stack
None
Domain
backend
Issue type
Research
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-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.
Mostly clear
Prerequisites
HaskellServant
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30