haskell-servant / haskell-servant/servant-swagger

How to define a custom example for a parameter?

Open
#142 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Haskell
Stars
123
Forks
34
PR merge metrics
No merged PRs in 30d

Description

Like definining ToSample in servant-docs. (Actually, I'm not sure what is the relation between servant-swagger and servant-docs, but defining ToSample won't change the default example in servant-swagger)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by comparing how custom ToSample definitions work in servant-docs with the current behavior of servant-swagger. Clarify how the two projects should relate for parameter examples and identify the relevant example-generation entry point. Done means a custom ToSample definition changes the default example produced by servant-swagger.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.