git.iko.soy/typeable/servant
on bump-ci help sign in
typeable/servant/servant-docs/CHANGELOG.md
126 lines 4.5 kB history raw
1[The latest version of this document is on GitHub.](https://github.com/haskell-servant/servant/blob/master/servant-docs/CHANGELOG.md)
2[Changelog for `servant` package contains significant entries for all core packages.](https://github.com/haskell-servant/servant/blob/master/servant/CHANGELOG.md)
40.11.5
5----
8- Add NoContentVerb [#1028](https://github.com/haskell-servant/servant/issues/1028) [#1219](https://github.com/haskell-servant/servant/pull/1219) [#1228](https://github.com/haskell-servant/servant/pull/1228)
10 The `NoContent` API endpoints should now use `NoContentVerb` combinator.
11 The API type changes are usually of the kind
13 ```diff
14 - :<|> PostNoContent '[JSON] NoContent
15 + :<|> PostNoContent
16 ```
18 i.e. one doesn't need to specify the content-type anymore. There is no content.
20- `Capture` can be `Lenient` [#1155](https://github.com/haskell-servant/servant/issues/1155) [#1156](https://github.com/haskell-servant/servant/pull/1156)
22 You can specify a lenient capture as
24 ```haskell
25 :<|> "capture-lenient" :> Capture' '[Lenient] "foo" Int :> GET
26 ```
28 which will make the capture always succeed. Handlers will be of the
29 type `Either String CapturedType`, where `Left err` represents
30 the possible parse failure.
32- *servant-docs* Merge documentation from duplicate routes [#1240](https://github.com/haskell-servant/servant/issues/1240) [#1241](https://github.com/haskell-servant/servant/pull/1241)
34 Servant supports defining the same route multiple times with different
35 content-types and result-types, but servant-docs was only documenting
36 the first of copy of such duplicated routes. It now combines the
37 documentation from all the copies.
39 Unfortunately, it is not yet possible for the documentation to specify
40 multiple status codes.
42- *servant-docs* Prevent race-conditions in testing [#1194](https://github.com/haskell-servant/servant/pull/1194)
440.11.4
45------
47- Drop dependency on `control-monad-omega` in favor of `Data.Universe.Helpers` from `universe-base`.
490.11.3
50------
52- Support `servant-0.15`
53 - Instances for 'Stream' and 'StreamBody'
550.11.2
56------
58* Allow `servant-0.13`:
59 - Doesn't have instances for streaming.
60 - Servant.API.Modifiers extra information isn't used.
620.11.1
63------
65* Export `DocAuthentication` and related lenses.
66* Make `defAction`'s documentation visible in Haddock documentation.
67* Add a markdown header for the Headers an endpoint is sensitive to.
68* Document the HTTP Method the parameters of an endpoint belong to
69 (rather than assuming `GET` for all of them).
70* Content type of sample response body is also displayed.
71* Can now customise various aspects of how the document is produced
72 using `markdownWith` and `RenderingOptions`:
73 - How many content-types for each example are shown
74 - Whether notes should be grouped together under their own header.
760.11
77----
79* changed the type of `rqbody`.
810.10
82----
84There are no changes. Released as a part of `servant` suite.
860.7.1
87-----
89* Support GHC 8.0
910.7
92---
94* Use `throwError` instead of `throwE` in documentation
960.5
97----
99* Support for the `HttpVersion`, `IsSecure`, `RemoteHost` and `Vault` combinators
100* Support maximum samples setting with new `DocOptions` type (used by `docsWithOptions` and `docsWith`)
101* Remove redundant second parameter of ToSample
102* Add Generic-based default implementation for `ToSample` class
103* Add more `ToSamples` instances: `Bool`, `Ordering`, tuples (up to 7), `[]`, `Maybe`, `Either`, `Const`, `ZipList` and some monoids
104* Move `toSample` out of `ToSample` class
105* Add a few helper functions to define `toSamples`
106* Remove matrix params.
107* Added support for Basic authentication
1090.4
110---
111* `Delete` now is like `Get`, `Post`, `Put`, and `Patch` and returns a response body
112* Allow for extra information to be added to the docs
113* Support content-type aware combinators of *servant-0.4*
114* Render endpoints in a canonical order (https://github.com/haskell-servant/servant-docs/pull/15)
115* Remove ToJSON superclass from ToSample
116* Split out Internal module
117* Add support for response headers
118* Allow `ToSample` to return a different type than it's arguments
119* Add Proxy argument to `ToSample`
1210.3
122---
124* Add the ability to display multiple responses, with some accompanying `Text` to describe the context in which we get the corresponding JSON.
125* Expose the `headers` lens
126* Represent an endpoint's path as `[String]` (previously `String`), fixing a corner case where the leading `/` would be missing.