haskell-servant/servant

Implement a "CaptureSome" combinator

Open

#962 opened on May 23, 2018

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Haskell (422 forks)batch import
enhancementhelp wanted

Repository metrics

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

Description

There exist in the wild APIs such as this:

GET /v2/<name>/manifests/<reference>
GET /v2/<name>/tags/list

where <name> comprises one or more path segments. It would be nice to be able to do something like this:

"v2" :> CaptureSome "name" [String] :> "manifests" :> Capture "reference" String :> Get ...
"v2" :> CaptureSome "name" [String] :> "tags" :> "list" :> Get ...

to support them.

Contributor guide

Research direction
Study how the existing `Capture` combinator is implemented in Servant, particularly its type level and value level components. Then design a `CaptureSome` combinator that captures one or more path segments into a list, following similar patterns. Look at existing usage of type level lists and type families in Servant's source code.
Tech stack
haskell
Domain
backendapi
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.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
HaskellServantType level programming
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30