git.iko.soy/typeable/servant
on typo help sign in
typeable/servant/servant-docs/CHANGELOG.md
145 lines 4.7 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.8
5------
7### Significant changes
9- Support `Fragment` combinator.
110.11.7
12------
14### Significant changes
16- Add instance for ToSample NonEmpty
18### Other changes
20- Bump "tested-with" ghc versions
21- Fix servant-docs code sample in README
230.11.5
24----
27- 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)
29 The `NoContent` API endpoints should now use `NoContentVerb` combinator.
30 The API type changes are usually of the kind
32 ```diff
33 - :<|> PostNoContent '[JSON] NoContent
34 + :<|> PostNoContent
35 ```
37 i.e. one doesn't need to specify the content-type anymore. There is no content.
39- `Capture` can be `Lenient` [#1155](https://github.com/haskell-servant/servant/issues/1155) [#1156](https://github.com/haskell-servant/servant/pull/1156)
41 You can specify a lenient capture as
43 ```haskell
44 :<|> "capture-lenient" :> Capture' '[Lenient] "foo" Int :> GET
45 ```
47 which will make the capture always succeed. Handlers will be of the
48 type `Either String CapturedType`, where `Left err` represents
49 the possible parse failure.
51- *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)
53 Servant supports defining the same route multiple times with different
54 content-types and result-types, but servant-docs was only documenting
55 the first of copy of such duplicated routes. It now combines the
56 documentation from all the copies.
58 Unfortunately, it is not yet possible for the documentation to specify
59 multiple status codes.
61- *servant-docs* Prevent race-conditions in testing [#1194](https://github.com/haskell-servant/servant/pull/1194)
630.11.4
64------
66- Drop dependency on `control-monad-omega` in favor of `Data.Universe.Helpers` from `universe-base`.
680.11.3
69------
71- Support `servant-0.15`
72 - Instances for 'Stream' and 'StreamBody'
740.11.2
75------
77* Allow `servant-0.13`:
78 - Doesn't have instances for streaming.
79 - Servant.API.Modifiers extra information isn't used.
810.11.1
82------
84* Export `DocAuthentication` and related lenses.
85* Make `defAction`'s documentation visible in Haddock documentation.
86* Add a markdown header for the Headers an endpoint is sensitive to.
87* Document the HTTP Method the parameters of an endpoint belong to
88 (rather than assuming `GET` for all of them).
89* Content type of sample response body is also displayed.
90* Can now customise various aspects of how the document is produced
91 using `markdownWith` and `RenderingOptions`:
92 - How many content-types for each example are shown
93 - Whether notes should be grouped together under their own header.
950.11
96----
98* changed the type of `rqbody`.
1000.10
101----
103There are no changes. Released as a part of `servant` suite.
1050.7.1
106-----
108* Support GHC 8.0
1100.7
111---
113* Use `throwError` instead of `throwE` in documentation
1150.5
116----
118* Support for the `HttpVersion`, `IsSecure`, `RemoteHost` and `Vault` combinators
119* Support maximum samples setting with new `DocOptions` type (used by `docsWithOptions` and `docsWith`)
120* Remove redundant second parameter of ToSample
121* Add Generic-based default implementation for `ToSample` class
122* Add more `ToSamples` instances: `Bool`, `Ordering`, tuples (up to 7), `[]`, `Maybe`, `Either`, `Const`, `ZipList` and some monoids
123* Move `toSample` out of `ToSample` class
124* Add a few helper functions to define `toSamples`
125* Remove matrix params.
126* Added support for Basic authentication
1280.4
129---
130* `Delete` now is like `Get`, `Post`, `Put`, and `Patch` and returns a response body
131* Allow for extra information to be added to the docs
132* Support content-type aware combinators of *servant-0.4*
133* Render endpoints in a canonical order (https://github.com/haskell-servant/servant-docs/pull/15)
134* Remove ToJSON superclass from ToSample
135* Split out Internal module
136* Add support for response headers
137* Allow `ToSample` to return a different type than it's arguments
138* Add Proxy argument to `ToSample`
1400.3
141---
143* Add the ability to display multiple responses, with some accompanying `Text` to describe the context in which we get the corresponding JSON.
144* Expose the `headers` lens
145* Represent an endpoint's path as `[String]` (previously `String`), fixing a corner case where the leading `/` would be missing.