haskell-servant/servant

servant-server tutorial (or cookbook?): Add Raw example that's not about static file serving

Open

#1144 opened on Mar 6, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Haskell (1,953 stars) (422 forks)batch import
documentationdocumentation:cookbookhelp wantedservant-servertutorial

Description

For example, a problem that came up on the #servant IRC channel: dynamic/conditional reverse proxy-ing, passing along the entire request as is when the condition is satisfied, responding with something else otherwise.

Contributor guide

Tech stack
None
Domain
backenddocumentation
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.
mostly clear
Prerequisites
Haskellservant framework
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Examine the existing servant server documentation and cookbook, particularly the Raw endpoint examples. The issue asks for a non static file serving example, such as dynamic reverse proxying. Review the servant source code for Raw type definitions and usage patterns. Consider creating a new example file in the doc/cookbook directory, following the structure of existing examples. No linked PRs or comments provide further guidance.