haskell-servant/servant

Want to add my servant example for versioned APIs and partial client implementations

Open

#605 opened on Sep 26, 2016

View on GitHub
 (13 comments) (0 reactions) (0 assignees)Haskell (422 forks)batch import
documentationhelp wanted

Repository metrics

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

Description

@fisx @soenkehahn

A few people I've spoken to didn't realize you could do a versioned API or have a partial client implementation in Servant. I didn't either, but I took a look at it with @fisx and it's quite easy. I thought it would be worth having an example project in haskell-servant and linking to it in the Servant documents. I already have a working example project with tests. If you are willing to add it I'll clean the package up and add a more documentation.

https://github.com/mchaver/example-servant-partial-client

Contributor guide

Research direction
Review the example project at https://github.com/mchaver/example servant partial client and understand how to integrate it into the servant repository as a documented example.
Tech stack
haskell
Domain
backend
Issue type
Documentation
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.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitHaskell
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75