haskell-servant/servant

Implement a "CaptureSome" combinator

Open

#962 opened on May 23, 2018

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

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

Tech stack
None
Domain
apibackend
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
HaskellServant basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
15
Research direction
Investigate how existing combinators like Capture and CaptureAll are implemented in Servant (e.g., in modules like Servant.API.Capture). Understand the type level machinery used for URL parsing. Propose a design for CaptureSome that captures one or more path segments, similar to CaptureAll but with a minimum of one segment. Consider backwards compatibility and existing usage patterns.