Commit graph

29 commits

Author SHA1 Message Date
Matthias Fischmann
68fee749c4 Remove dead code. 2015-02-24 11:01:34 +01:00
Matthias Fischmann
f11d5207e4 Dropped orphan instance for MediaType (now available upstream). 2015-02-24 08:54:14 +01:00
Matthias Fischmann
1fef813a3b Render entpoints in canonical order. 2015-02-23 11:33:44 +01:00
Christian Marie
055655618f Merge remote-tracking branch 'origin/master' into wip-note-api 2015-02-23 10:47:28 +11:00
Christian Marie
53d3f6db80 Rename safeInfo to extraInfo 2015-02-23 09:56:23 +11:00
Thomas Sutton
fc5802fe7f Show, rather than convert, media types 2015-02-23 09:38:19 +11:00
Thomas Sutton
02c4adfd18 Simplify SupportedTypes instances 2015-02-20 08:05:37 +11:00
Thomas Sutton
8087fae18b amr renamed allMimeRender 2015-02-20 08:03:11 +11:00
Thomas Sutton
0daa8d27a5 Add list of supported content types to documentation 2015-02-19 15:29:04 +11:00
Thomas Sutton
f303f6176a Simplify encoding code slightly more 2015-02-19 13:19:29 +11:00
Thomas Sutton
d62c61224b Simplify encoding code slightly 2015-02-19 13:15:33 +11:00
Thomas Sutton
508b9f9791 Generate docs with samples encoded in all types
Request and response body documentation now includes sample values
encoded in all supported media types.
2015-02-19 12:55:11 +11:00
Thomas Sutton
3c14343b88 Add content-type params to type constructors 2015-02-19 10:59:24 +11:00
Christian Marie
b935f28185 Improve documentation.
I also slipped a change into the Matrix Paramters section markdown generation,
there is one less (superfluous) newline there now.
2015-02-18 12:49:08 +11:00
Christian Marie
a008e08dd1 Add initial mockup of general extra info API 2015-02-07 15:23:54 +11:00
Christian Marie
dd34ba0d92 Merge remote-tracking branch 'upstream/master' into wip-notes
Conflicts:
	src/Servant/Docs.hs
2015-01-30 16:02:44 +11:00
Christian Marie
b85a90c4f5 Add docsWithIntros function, update documentation 2015-01-30 15:47:26 +11:00
Christian Marie
aa64d7a0bf Add DocIntro and DocNote types to allow extra docs
This commit provides a way for a user to add information to either the
beginning of the output, and for a HasDoc instance to add extra sections to an
endpoint.

See example/greet.hs for usage of the Intro type.
2015-01-23 14:31:45 +11:00
Daniel Larsson
c4f7735de8 Added support for matrix parameters 2015-01-15 11:04:20 +01:00
Daniel Larsson
62f8a7f090 Initial support for matrix parameters. Not complete, not sure how to document them yet, since documentation is focused on endpoints, not individual path fragments. 2015-01-15 11:04:20 +01:00
Alp Mestanogullari
71142b08d4 fix build error 2015-01-04 16:44:23 +01:00
Alp Mestanogullari
0edde415bd first shot (doesn't build though) at multiple responses in the docs 2015-01-04 16:38:50 +01:00
Matthew Pickering
e333ed5ff6 Expose "headers" lens
All other lenses for `Action` are exposed. Without it, it is impossible to access the headers field.
2015-01-03 16:11:09 +00:00
Phil Freeman
43f9aa78c0 Represent path as [String] 2015-01-02 10:06:34 -08:00
Phil Freeman
42fc048dfc Add missing slash character in generated docs. 2014-12-31 17:19:35 -08:00
Julian K. Arni
3898c19afe Switch to encodePretty in sampleByteString. 2014-12-20 21:58:07 +01:00
Alp Mestanogullari
2d2c46ea12 adapt to the servant/servant-server split 2014-12-10 16:43:43 +01:00
Alp Mestanogullari
d831cf944f add docs support for Header 2014-12-08 13:07:34 +01:00
Alp Mestanogullari
7fa44d3769 first shot at splitting servant into servant, servant-client and servant-docs 2014-11-27 18:28:01 +01:00