haskell-servant/servant

Idea Symbolic Names for HTTP Status codes

Open

#628 geöffnet am 27. Okt. 2016

Auf GitHub ansehen
 (9 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Haskell (422 Forks)batch import
enhancementhelp wantedservant-api

Repository-Metriken

Stars
 (1.953 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 5h 49m) (2 gemergte PRs in 30 T)

Beschreibung

I had a thought, currently to express a http status code you have to remember the number, would it be possible to have a named type for them. So instead of having the number 304 in my code I could ahve the value 'NotModified' which esp for some of the more unusual status codes would be very helpful in making code more readable.

For example if I see that something should return 415 I probably will have to look up what that means but if I see UnsupportedMediaType it is self documenting.

Contributor Guide

Research-Richtung
Überprüfen Sie die Issue Kommentare (9 Kommentare) auf frühere Diskussionen oder Vorschläge. Die Hauptaufgabe besteht darin, einen Haskell Datentyp für HTTP Statuscodes mit symbolischen Namen (z. B. NotModified, UnsupportedMediaType) zu definieren. Ziehen Sie den vorhandenen Status Typ des 'http types' Pakets als Referenz in Betracht. Implementieren Sie den Typ in der Servant Bibliothek und stellen Sie Nutzungsbeispiele in der Dokumentation bereit. Da das Issue aus dem Jahr 2016 stammt und keine kürzlichen Aktivitäten aufweist, koordinieren Sie mit den Maintainern, um den Ansatz zu bestätigen und die Übereinstimmung mit dem Projektdesign sicherzustellen.
Tech Stack
Keine
Domain
backend
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
HaskellServant
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60