Commit graph

1616 commits

Author SHA1 Message Date
Ivan Lazar Miljenovic
9d10fe13dd Use 3rd-level headings
For some reason, 2nd-level headings are used for introductions and for
each API endpoint, but then it immediately jumps to 4th-level
headings.

Instead, promote everything that's 4th-level to 3rd-level.
2017-10-11 10:48:22 +11:00
Alp Mestanogullari
f960d97256 Merge pull request #829 from ivan-m/multiple-content-types
servant-docs: configurable rendering for multiple content types
2017-10-09 08:13:29 +02:00
Ivan Lazar Miljenovic
b3e35fbc79 Make sure tutorial can build 2017-10-09 13:22:54 +11:00
Ivan Lazar Miljenovic
dc40badb7c Add motivating example for markdownWith to tutorial 2017-10-06 13:38:37 +11:00
Ivan Lazar Miljenovic
02821e326a Update sample servant-docs output in tutorial
Not all of this is due to the changes in multiple content-type
handling.
2017-10-06 13:21:20 +11:00
Ivan Lazar Miljenovic
ed3ace3066 Handle request/response bodies with empty titles 2017-10-06 13:19:04 +11:00
Ivan Lazar Miljenovic
a21beadf86 Continuing fix to build on 7.8.4 2017-10-06 13:03:27 +11:00
Ivan Lazar Miljenovic
0160f9c6d9 Update ChangeLog 2017-10-06 11:14:03 +11:00
Ivan Lazar Miljenovic
ddcb3560e0 Better haddocks for new documentation 2017-10-06 11:13:57 +11:00
Ivan Lazar Miljenovic
a693648044 A better name for ApiOptions
It's more about how rendering happens than options for the API.
2017-10-06 10:59:00 +11:00
Ivan Lazar Miljenovic
e3c1c2b464 Fix building on GHC 7.8.4 2017-10-06 10:58:00 +11:00
Ivan Lazar Miljenovic
354bee8d32 Remove unused uncurry3 function 2017-10-06 10:54:55 +11:00
Ivan Lazar Miljenovic
09896b5f39 Group mime-types together, and control how many get displayed
Closes #815
2017-10-05 16:29:43 +11:00
Ivan Lazar Miljenovic
41d75b4de8 Combine rendering of code samples for request/response bodies
This does mean that the "Example" portion for reqeust bodies is lost
though.
2017-10-05 16:29:43 +11:00
Ivan Lazar Miljenovic
4f8df0ebe2 Make sure code blocks are indented in markdown documentation
This relies on the behaviour of pandoc, and as such may not apply to
other Markdown renderers.

Before this change, you would have something like:

> - Example: `application/json`
>
> ```javascript
> "HELLO, HASKELLER"
> ```

When converting this to HTML, PDF, etc. the code block is _not_
contained within the bullet point.

With this change, the generated markdown looks like:

> - Example: `application/json`
>
>     ```javascript
> "HELLO, HASKELLER"
>     ```

With pandoc at least, this effectively indents the entire code block
to be under the bullet point, which is the intended effect.

Note that the code itself is _not_ indented (which might break other
Markdown renderers) as to do so would require splitting on newlines,
which may have unintended consequences when dealing with generated
values (may contain `\r\n`, etc.).
2017-10-05 16:29:43 +11:00
Ivan Lazar Miljenovic
061bf7a5b1 Add markdown type for text/xml
As it's an alternative mime-type for XML
2017-10-05 16:29:43 +11:00
Julian Arni
63d8f6c0f3 Merge pull request #822 from limaner2002/issue-821
Fix issue #821
2017-10-02 09:30:11 -07:00
Oleg Grenrus
6e431d59f2 Merge pull request #824 from phadej/hoist-server-docs
Update docs related to hoistServer
2017-10-02 09:27:37 +03:00
Oleg Grenrus
15cc4f55dd Update docs related to hoistServer 2017-10-01 20:24:22 +03:00
Joshua McCartney
3fedbd097a Fix issue #821 2017-09-28 19:15:53 -04:00
Alp Mestanogullari
4a6edd7864 Merge pull request #813 from ivan-m/response-content-type
List content type with response examples
2017-09-25 10:38:02 +02:00
Ivan Lazar Miljenovic
81184df3d4 List content type with response examples 2017-09-22 14:12:13 +10:00
Julian Arni
28fe7a0d0f Merge pull request #803 from haskell-servant/pr800
Factor out servant-client-core
2017-09-18 13:51:55 -04:00
Alp Mestanogullari
885808cd3b Merge pull request #806 from vaibhavsagar/fix-typo
typo in servant-server/src/Servant/Server/Internal.hs
2017-09-17 14:15:02 +02:00
Vaibhav Sagar
1a10972904 Update servant-server/src/Servant/Server/Internal.hs
s/taylor/tailor
2017-09-17 11:40:12 +08:00
Julian K. Arni
1a67d93c60 Use own throw/catch 2017-09-15 14:57:03 -04:00
Julian K. Arni
49d5067e22 Review fixes 2017-09-15 09:15:46 -04:00
Julian K. Arni
4e9c342c4e Review fixes 2017-09-14 13:21:53 -04:00
Julian K. Arni
30528a8198 Parametrize Request 2017-09-14 13:17:19 -04:00
Julian K. Arni
65c2cbb6a9 Fix 7.8.4 IsList Sequence issue
And other minor 7.8.4 issues.
2017-09-14 11:23:42 -04:00
Julian K. Arni
83fd4acf21 Add Build_doctests to servant-server 2017-09-14 10:02:32 -04:00
Julian K. Arni
39ad465695 Ghc 8.2 fixes 2017-09-14 09:54:46 -04:00
Julian K. Arni
da8337809b Documentation fixes 2017-09-14 09:54:13 -04:00
Julian K. Arni
d6aee29be1 Fix readme list 2017-09-14 09:54:13 -04:00
Julian K. Arni
257c3d4081 Readme for servant-client-core 2017-09-14 09:54:13 -04:00
Julian K. Arni
e8b9814168 Documentation and Reexport module 2017-09-14 09:54:13 -04:00
Julian K. Arni
6be78e0b38 Documentation 2017-09-14 09:54:13 -04:00
Julian K. Arni
ffbfa42a14 Tests now pass 2017-09-14 09:54:13 -04:00
Julian K. Arni
5bd9d253ce Almost compiling test 2017-09-14 09:54:13 -04:00
Julian K. Arni
75ea91c34d Fix some tests 2017-09-14 09:54:13 -04:00
Julian K. Arni
6995e39427 Move BaseUrlSpec 2017-09-14 09:54:13 -04:00
Julian K. Arni
f44ab3d083 Cleanup 2017-09-14 09:54:13 -04:00
Julian K. Arni
05db359296 Compiling HttpClient 2017-09-14 09:54:13 -04:00
Julian K. Arni
01f344dfbb Compiling servant-client-core 2017-09-14 09:54:13 -04:00
Julian K. Arni
35599d8b38 More reorganization 2017-09-14 09:54:13 -04:00
Julian K. Arni
95fac329a6 Rewrite servant-client.
This commit begins the reorganization of the servant-client project
    so as to allow multiple backends, and also begins some much-needed
    refactoring of the servant-client code.
2017-09-14 09:54:13 -04:00
Arnaud Bailly
b592b51ed8 provide convenience functions for ClientM-based clients 2017-09-14 09:54:13 -04:00
Arnaud Bailly
7480076c91 cleanup compiler's warnings 2017-09-14 09:54:13 -04:00
Arnaud Bailly
5e2c48b08f expose client runner as a typeclass with base implementation #798
* defined a typeclass abstracting the execution of a query
* provide ClientM-based instances for this typeclass
* changed signature of client and clientWithRoute to add proxy for
  context
* updated tests
2017-09-14 09:54:13 -04:00
Arnaud Bailly
175c9532f1 [wip] expose client runner as a typeclass 2017-09-14 09:54:13 -04:00