haskell-servant/servant

Implement a "CaptureSome" combinator

Open

#962 geöffnet am 23. Mai 2018

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Haskell (422 Forks)batch import
enhancementhelp wanted

Repository-Metriken

Stars
 (1.953 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 23h 44m) (4 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Untersuche, wie bestehende Kombinatoren wie Capture und CaptureAll in Servant implementiert sind (z. B. in Modulen wie Servant.API.Capture). Verstehe die typlevel Mechanismen, die für das URL Parsing verwendet werden. Schlage ein Design für CaptureSome vor, das ein oder mehrere Pfadsegmente erfasst, ähnlich wie CaptureAll, aber mit einem Minimum von einem Segment. Berücksichtige Abwärtskompatibilität und bestehende Nutzungsmuster.
Tech Stack
Keine
Domain
apibackend
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
4
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
3-5 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
HaskellServant basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
15