Commit graph

38 commits

Author SHA1 Message Date
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
dba8689acd Remove redundant dependencies 2015-02-19 12:53:14 +11:00
Thomas Sutton
6d85885b42 Add content types to the example 2015-02-19 12:48:23 +11:00
Thomas Sutton
3c14343b88 Add content-type params to type constructors 2015-02-19 10:59:24 +11:00
Christian Marie
2ea8a48eff Merge pull request #9 from anchor/wip-notes
Add DocIntro and DocNote types to allow extra docs
2015-01-30 16:06:31 +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
Julian Arni
ec3bebee69 Merge pull request #7 from dlarsson/master
Support for matrix parameters
2015-01-27 03:16:30 +01: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
d603431498 Merge branch 'master' of https://github.com/dlarsson/servant-docs 2015-01-15 11:05:02 +01: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
Daniel Larsson
d81704abc7 Added support for matrix parameters 2015-01-06 14:30:01 +01:00
Daniel Larsson
330e9abcaa Merged in 0.3 2015-01-06 14:29:37 +01:00
Alp Mestanogullari
44efc7ff20 bump version 2015-01-04 17:18:40 +01:00
Alp Mestanogullari
b7591dd7e0 mention servant-pandoc in the readme 2015-01-04 17:18:12 +01:00
Alp Mestanogullari
923a75afef add a changelog 2015-01-04 17:17:57 +01:00
Alp Mestanogullari
07472ccb7a update the example to show off multiple-responses 2015-01-04 16:53:02 +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
Alp Mestanogullari
b93ff6c21c Merge pull request #5 from mpickering/patch-1
Expose "headers" lens
2015-01-03 17:20:17 +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
Alp Mestanogullari
174a4253fe Merge pull request #4 from paf31/slashes
Add missing slash character in generated docs.
2015-01-02 19:35:01 +01:00
Phil Freeman
43f9aa78c0 Represent path as [String] 2015-01-02 10:06:34 -08:00
Daniel Larsson
6f10662887 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-01 23:42:06 +01:00
Alp Mestanogullari
f670667904 Merge pull request #3 from paf31/ignore
Add .gitignore file which ignore sandbox files
2015-01-01 15:41:27 +01:00
Phil Freeman
42fc048dfc Add missing slash character in generated docs. 2014-12-31 17:19:35 -08:00
Phil Freeman
17569a31b6 Add .gitignore file which ignore sandbox files 2014-12-31 17:18:23 -08:00
Julian Arni
87b7c8e376 Merge pull request #1 from haskell-servant/jkarni/encodePretty
Switch to encodePretty in sampleByteString.
2014-12-20 22:09:28 +01: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
2261521002 polish up cabal file, add README and output of the example 2014-12-08 11:25:52 +01:00
Alp Mestanogullari
d517bfa69c travis: buidl with ghc 7.8 and clone servant from git before building 2014-12-02 17:49:25 +01:00
Alp Mestanogullari
426c59078c add travis file 2014-12-02 17:25:52 +01:00
Alp Mestanogullari
4dafc4efb4 add LICENSE files to all projects 2014-12-01 16:38:43 +01:00
Alp Mestanogullari
d39d1f1d0a fix travis script... 2014-12-01 16:29:42 +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