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 (1,953 stars) (422 forks)batch import
enhancementhelp wantedservant-docsservant-foreign

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

Tech stack
None
Domain
apidocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
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.
needs investigation
Prerequisites
understanding of Haskell GADTsfamiliarity with servant library internalsknowledge of servant foreign and servant docs
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
15
Research direction
Explore the current implementations of servant foreign and servant docs to identify common patterns and differences. Look at the types and folds used in each. Consider designing a generic GADT that can capture the shared information. Review related issues and discussions in the repository.