Commit graph

212 commits

Author SHA1 Message Date
Alp Mestanogullari
5d30010312 add reference to servant-flatten 2018-03-21 10:23:33 +01:00
Jan Hrček
e9113111d6 Add link to cookbook example of basic auth (#752) 2018-03-21 04:48:01 +01:00
Manu S Ajith
6a410dcd07
Fix some typos in docs
Signed-off-by: Manu S Ajith <neo@codingarena.in>
2018-03-13 03:21:56 +05:30
Alp Mestanogullari
6ed48b742c
Fix typo in tutorial 2018-02-15 09:59:21 +01:00
Oleg Grenrus
c55b778d8e Bump lower bound of http-types >= 0.12
- WIP: pending http-api-data release
- TODO: remove MIN_VERSION_http_types
- There have been 3 major releases of http-types:
  - 0.10 change name of variable
  - 0.11 lowercase escaped URIs
  - 0.12 uppercase escaped URIs
- It's easier for us to support only latest, migration from 0.9/0.10 to 0.12
  is trivial for the downstream. 0.11 may cause semantic (non-type-error) breakage somewhere.

Also allow lens-4.16, remove MIN_VERSION_http_types conditionals, and
update `stack.yaml`
2018-01-30 11:29:25 +02:00
Michal Rus
e4bd07a907 Support http-client’s CookieJar in servant-client 2018-01-26 18:45:52 +02:00
Oleg Grenrus
f9963d32ff Bump lower bounds in rest of packages 2018-01-25 17:17:35 +02:00
Oleg Grenrus
98a12c328b Reinstate cookbook testing to CI 2018-01-18 00:21:13 +02:00
Oleg Grenrus
2dc48f0684
Merge pull request #885 from phadej/travis-2018-01-05
Regenerate .travis.yml
2018-01-05 12:11:08 +02:00
Oleg Grenrus
816b7115f9 Regenerate .travis.yml 2018-01-05 10:33:10 +02:00
Alp Mestanogullari
0147f4b5c7
Merge pull request #882 from ilya-murzinov/docs-another-monad
Added new cookbook recipe for using custom monad
2017-12-29 12:51:44 +01:00
Ilya Murzinov
f1911f390d Added new cookbook recipe for using custom monad 2017-12-29 13:22:32 +03:00
Alp Mestanogullari
bba8cecf9f
Merge pull request #875 from kakkun61/improve-authentication-docs
Improve authentication docs
2017-12-28 15:01:51 +01:00
Oleg Grenrus
68bc41b41d
Merge pull request #867 from haskell-servant/cookbook
[Docs] Cookbook
2017-12-27 14:11:52 +02:00
Alp Mestanogullari
8e0cb615ad cookbook projects: add (lower) bounds for non servant deps 2017-12-27 01:33:12 +01:00
Kazuki Okamoto
4b9d60ca8d fix compilation error: move import declaration and add cookie to dependencies 2017-12-13 16:52:44 +09:00
Alp Mestanogullari
40c1315097 elide some of the servant README in file upload example output 2017-12-12 19:57:21 +01:00
gbaz
7edd35c9f0 docs for streaming (#852)
* docs for new streaming related combinators
2017-12-11 21:32:17 +01:00
Oleg Grenrus
ccf0056f64 Regenerate .travis.yml 2017-12-10 14:27:40 +02:00
Alp Mestanogullari
c5f2b9e175 add https recipe, add (future) github links at the end of all recipes 2017-12-08 23:44:48 +01:00
Alp Mestanogullari
6075700ebc add a recipe about 'structuring APIs' in general 2017-12-08 23:44:48 +01:00
Alp Mestanogullari
5ac6de8277 add file upload recipe 2017-12-08 23:44:48 +01:00
Alp Mestanogullari
6dc9d04e60 build cookbook projects in CI 2017-12-08 23:44:47 +01:00
defanor
b8c6c0b7c7 Add a cookbook recipe for JWT and basic authentication combination (#871) 2017-12-08 23:44:47 +01:00
Alp Mestanogullari
e2314aa059 add cookbook recipe for using a PostgreSQL connection pool 2017-12-08 23:44:38 +01:00
Alp Mestanogullari
8543e00aaa add a cookbook recipe for sqlite. cabalized cookbook examples. 2017-12-08 23:44:38 +01:00
Alp Mestanogullari
606a4a6f69 add a cookbook section to docs, with a first 'recipe' about basic auth 2017-12-05 18:09:41 +01:00
Oleg Grenrus
f8fb618efe Fix formatting in doc/examples.md 2017-11-06 13:08:29 +02:00
Cies Breijs
bd71022979 Update examples.md 2017-11-06 13:06:14 +02:00
Oleg Grenrus
018f0e082e Bump versions and update changelogs.
The changelog for `servant` contains changes across core packages,
as we release them as a suite.

Also added links to the GitHub master as we might update entries
for old versions, as changelogs are written by humans.
2017-11-06 11:24:48 +02:00
Oleg Grenrus
2d6bf5055b Improve .cabal files
- Add build-tool-depends, so new-build can use hspec-discover
- Add mtl bounds in tutorial (and dependency on mtl-compact)
- Add extra-source-files to tutorial, so it's buildable from sdist
2017-10-23 08:58:39 +03:00
Ryan James Spencer
ff5502f4f7 Replace User with Account in Generalized Authentication section (#757)
* Change `User` to `Account` in Generalized Authentication section
2017-10-17 14:31: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
Oleg Grenrus
15cc4f55dd Update docs related to hoistServer 2017-10-01 20:24:22 +03:00
Julian K. Arni
da8337809b Documentation fixes 2017-09-14 09:54:13 -04:00
Oleg Grenrus
c46dd1aff9 Bump servant-docs version to 0.11 2017-07-24 10:54:11 +03:00
JoeMShanahan
e6c492ab2c Add hackage link to the cookie package 2017-07-17 11:18:13 +01:00
JoeMShanahan
2c0aa36ae9 Reword comment so that it actually makes sense! 2017-07-17 10:51:08 +01:00
JoeMShanahan
160cda2602 Explicitly state that we're adding a dependency here 2017-07-17 10:14:42 +01:00
JoeMShanahan
c24096be16 Bring back the comment 2017-07-17 10:09:51 +01:00
Joe Shanahan
400bd564dc Look inside cookies instead of just the header 2017-07-17 09:18:34 +01:00
Chris Martin
fbf870ac8a typo: "philosophy" 2017-06-20 11:42:08 -04:00
Oleg Grenrus
ec930ac9a8 Release 0.11 2017-05-24 08:02:56 +03:00
shak-mar
76703e5b80 Fix typo in ApiType.lhs 2017-05-19 15:02:10 +02:00
David Turner
8b993b9d11 Changes to docs as suggested 2017-05-17 08:24:04 +00:00
David Turner
aa3716b6aa Tidy up tutorial 2017-05-17 05:50:38 +00:00
David Turner
0bbc4f98a4 Rename EmptyAPIClient to EmptyClient 2017-05-16 16:00:15 +00:00
David Turner
f5d9983381 Rename emptyAPIServer to emptyServer 2017-05-16 15:59:41 +00:00
David Turner
fa3f1869f2 Add EmptyForeignAPI and instance HasForeign ... EmptyAPI 2017-05-16 10:07:30 +00:00
David Turner
2cfa71891b Add instance HasDocs EmptyAPI 2017-05-16 10:07:15 +00:00
David Turner
a87067a6c1 Actually, serve this one so it's useful in the Docs tutorial 2017-05-16 10:07:12 +00:00
David Turner
4c64c13af0 Add EmptyAPIClient and instance HasClient EmptyAPI 2017-05-16 10:06:48 +00:00
David Turner
94483d586c Add instance HasServer EmptyAPI 2017-05-16 10:06:25 +00:00
David Turner
8a16f47fba Add EmptyAPI example (no prose yet) 2017-05-16 10:06:23 +00:00
David Turner
b81fbe445d Renumber again to make room for the EmptyAPI example 2017-05-16 10:06:16 +00:00
David Turner
e8c7158600 Renumber APIs in the tutorial to be in order 2017-05-16 10:06:00 +00:00
Alexander Vieth
6389134423 Change to ServerT Raw m = Tagged m Application
For uniformity of Enter.

Previously, `ServerT Raw m ~ Application`. Seems reasonable, but has the
unfortunate consequence of making `Enter` useless for `Raw` routes.
With this change `Tagged m Application` is retagged by `Enter`.
2017-05-15 19:54:43 +03:00
Nick B
fa422bb298 Docs: Updated wording as per PR comments. 2017-04-11 08:34:57 +01:00
Nick B
45a7bb1b73 Improve Client docs
* Use suggestion in #606 to document pattern matching client behaviour better
 * Helpful suggestion of reading in order in the index
 * A couple of extra internal links
 * Fox some typos / punctuation.

Fixes #606
2017-04-07 21:02:57 +01:00
Nick B
3115b57145 Use newer release of Pygments
* Includes [Haskell types fix by @teh](https://bitbucket.org/birkenfeld/pygments-main/pull-requests/685/two-haskell-fixes/diff)
 * Local docs build then exhibit proper Haskell highlighting including type literals etc

 Fixes #359
2017-03-11 14:53:48 +00:00
Oleg Grenrus
29f94a6440 Briefly correct ExceptT mentions into Handler (#693) 2017-01-30 15:45:13 +02:00
Christian Takle
cdda7bcf8d Make type consistent with whats written on line 20 (#688)
Make type consistent with whats written on line 20
2017-01-29 20:59:41 +02:00
Oleg Grenrus
93df8d22df Bump version to 0.10 2017-01-26 20:10:01 +02:00
Arash Rouhani
a425c3ae43 tutorial: Update type of BaseUrl to real type
I got confused to why there was one more argument passed to
constructor than the type takes. Turns out the docs were just a bit out
of date.
2017-01-25 09:53:54 +07:00
Arash Rouhani
e26f123555 tutorial: Make "Position" type consistent
I think this change was just overlooked in
https://github.com/haskell-servant/servant/pull/355

Without this change, running the server from Server.lhs and client from
Client.lhs will result in something like

    decodeError = "Error in $: The key \"x\" was not found
2017-01-25 09:53:54 +07:00
Alp Mestanogullari
c655c6e474 tutorial fix 2017-01-17 14:14:46 +02:00
Alp Mestanogullari
8efabed5c6 Revamp static file serving module.
Instead of only exposing 'serveDirectory', which picks a specific static file
serving strategy (file server settings), we now expose 4 different variants each
corresponding to an variant of StaticSettings in wai-app-static.

In addition to these, we expose a more flexible 'serveDirectoryWith' function
which allows the user to specify some arbitrary StaticSettings, if the 4
existing variants do not cover a user's needs.
2017-01-17 14:14:46 +02:00
Oleg Grenrus
d5e73bf577 Make servant buildable with cabal new-build 2017-01-16 11:03:06 +02:00
Oleg Grenrus
34166ae749 Update tutorial (NT changes) 2016-11-16 08:29:36 +02:00
Julian K. Arni
4fd31a60fb Bump version.
To 0.9.1.1
2016-10-27 13:25:27 +02:00
Julian K. Arni
9e809a0756 Bump version.
To 0.9.1.
2016-10-26 17:35:57 +02:00
Julian K. Arni
5e09493aa6 Add more documentation about response headers to tutorial. 2016-10-26 17:17:34 +02:00
Ruben Moor
f352f3b136 Update Authentication.lhs 2016-10-14 11:09:46 -04:00
Julian K. Arni
3ddf225cec Bump version.
To 0.9.0.1.
2016-10-09 22:52:49 +02:00
Sönke Hahn
bc1a3e7faa bump version 2016-09-17 11:47:57 -04:00
Christian Klinger
7a7f7d7cf5 changed ClientM to be a Reader of ClientEnv 2016-09-08 00:17:13 +02:00
Julian K. Arni
bf824a3889 Bump version to 0.8.1 2016-09-02 13:09:47 -03:00
Cornelius Diekmann
47eed38ee6 Fixed typo: s/real/realm/
Actually, I'm just trying to learn servant and I'm reading the doc for the first time. But this just looks like a typo to me.
2016-09-02 16:38:03 +02:00
Julian K. Arni
b22e4e72f9 Review fixes 2016-08-17 13:37:34 -03:00
Julian K. Arni
7aa550aa05 Make Javascript tutorial compile. 2016-08-17 13:37:34 -03:00
freezeboy
9e71fde756 Fixing typo in Javascript.lhs 2016-08-17 13:37:34 -03:00
Julian K. Arni
95d077f586 Add more JS documentation.
Contributed by freezeboy in PR #11 -
    https://github.com/haskell-servant/haskell-servant.github.io/pull/11/files
2016-08-17 13:37:34 -03:00
Sönke Hahn
4ccfce2331 docs: bump Sphinx version 2016-08-15 13:52:14 +02:00
Sönke Hahn
ecfa78d222 doc: add a tip about how to serve on / 2016-07-15 19:31:16 +02:00
Sönke Hahn
8eb412ff23 bump version 2016-07-10 17:21:36 +02:00
Arian van Putten
d782ef19f7 Fix a warning that the test suite gave 2016-07-10 16:59:54 +02:00
Sönke Hahn
0f1e5475b9 doc: add two more examples for servant projects 2016-07-03 11:53:20 +08:00
Christopher League
69d3e7355a Fix minor typo in tutorial 2016-05-24 23:11:54 -04:00
Julian Arni
ff40b327bc Merge pull request #504 from haskell-servant/jkarni/doc-fixes
Doc fixes
2016-05-12 09:53:35 +02:00
Julian K. Arni
aed6f7b910 Review fix 2016-05-11 10:17:24 +02:00
Sönke Hahn
d8a4cce691 version bump 2016-05-11 12:09:25 +08:00
Julian K. Arni
e0ba34372e Remove link to 0.4 version of tutorial.
Stackage has 0.5 already, and the 0.4 version has numerous mistakes.
2016-05-10 13:39:01 +02:00
Julian K. Arni
efbe6fd498 Use NoContent and fix content-type lists in docs. 2016-05-10 13:21:34 +02:00
Arian van Putten
fd26721feb Merge pull request #479 from rubenmoor/patch-1
Update examples.md: diener-monad
2016-04-29 11:24:01 +02:00
Sönke Hahn
e0216781b0 set the homepage to readthedocs 2016-04-22 14:12:21 +08:00
Sönke Hahn
b26bbfccda travis: enable -Wall -Werror 2016-04-21 13:06:10 +08:00
Ruben Moor
07f10aaf5e typos 2016-04-20 16:07:02 +02:00
Ruben Moor
292d49408a fixed formatting 2016-04-20 16:04:51 +02:00