git.iko.soy/servant
on type-errors help sign in
servant/servant-docs/CHANGELOG.md
157 lines 4.9 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.9
5------
7### Significant changes
9- Use Capture Description if available (#1423).
11### Other changes
13- Support GHC-9.0.1.
14- Bump `bytestring` and `lens` dependencies.
160.11.8
17------
19### Significant changes
21- Support `Fragment` combinator.
230.11.7
24------
26### Significant changes
28- Add instance for ToSample NonEmpty
30### Other changes
32- Bump "tested-with" ghc versions
33- Fix servant-docs code sample in README
350.11.5
36----
39- 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)
41 The `NoContent` API endpoints should now use `NoContentVerb` combinator.
42 The API type changes are usually of the kind
44 ```diff
45 - :<|> PostNoContent '[JSON] NoContent
46 + :<|> PostNoContent
47 ```
49 i.e. one doesn't need to specify the content-type anymore. There is no content.
51- `Capture` can be `Lenient` [#1155](https://github.com/haskell-servant/servant/issues/1155) [#1156](https://github.com/haskell-servant/servant/pull/1156)
53 You can specify a lenient capture as
55 ```haskell
56 :<|> "capture-lenient" :> Capture' '[Lenient] "foo" Int :> GET
57 ```
59 which will make the capture always succeed. Handlers will be of the
60 type `Either String CapturedType`, where `Left err` represents
61 the possible parse failure.
63- *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)
65 Servant supports defining the same route multiple times with different
66 content-types and result-types, but servant-docs was only documenting
67 the first of copy of such duplicated routes. It now combines the
68 documentation from all the copies.
70 Unfortunately, it is not yet possible for the documentation to specify
71 multiple status codes.
73- *servant-docs* Prevent race-conditions in testing [#1194](https://github.com/haskell-servant/servant/pull/1194)
750.11.4
76------
78- Drop dependency on `control-monad-omega` in favor of `Data.Universe.Helpers` from `universe-base`.
800.11.3
81------
83- Support `servant-0.15`
84 - Instances for 'Stream' and 'StreamBody'
860.11.2
87------
89* Allow `servant-0.13`:
90 - Doesn't have instances for streaming.
91 - Servant.API.Modifiers extra information isn't used.
930.11.1
94------
96* Export `DocAuthentication` and related lenses.
97* Make `defAction`'s documentation visible in Haddock documentation.
98* Add a markdown header for the Headers an endpoint is sensitive to.
99* Document the HTTP Method the parameters of an endpoint belong to
100 (rather than assuming `GET` for all of them).
101* Content type of sample response body is also displayed.
102* Can now customise various aspects of how the document is produced
103 using `markdownWith` and `RenderingOptions`:
104 - How many content-types for each example are shown
105 - Whether notes should be grouped together under their own header.
1070.11
108----
110* changed the type of `rqbody`.
1120.10
113----
115There are no changes. Released as a part of `servant` suite.
1170.7.1
118-----
120* Support GHC 8.0
1220.7
123---
125* Use `throwError` instead of `throwE` in documentation
1270.5
128----
130* Support for the `HttpVersion`, `IsSecure`, `RemoteHost` and `Vault` combinators
131* Support maximum samples setting with new `DocOptions` type (used by `docsWithOptions` and `docsWith`)
132* Remove redundant second parameter of ToSample
133* Add Generic-based default implementation for `ToSample` class
134* Add more `ToSamples` instances: `Bool`, `Ordering`, tuples (up to 7), `[]`, `Maybe`, `Either`, `Const`, `ZipList` and some monoids
135* Move `toSample` out of `ToSample` class
136* Add a few helper functions to define `toSamples`
137* Remove matrix params.
138* Added support for Basic authentication
1400.4
141---
142* `Delete` now is like `Get`, `Post`, `Put`, and `Patch` and returns a response body
143* Allow for extra information to be added to the docs
144* Support content-type aware combinators of *servant-0.4*
145* Render endpoints in a canonical order (https://github.com/haskell-servant/servant-docs/pull/15)
146* Remove ToJSON superclass from ToSample
147* Split out Internal module
148* Add support for response headers
149* Allow `ToSample` to return a different type than it's arguments
150* Add Proxy argument to `ToSample`
1520.3
153---
155* Add the ability to display multiple responses, with some accompanying `Text` to describe the context in which we get the corresponding JSON.
156* Expose the `headers` lens
157* Represent an endpoint's path as `[String]` (previously `String`), fixing a corner case where the leading `/` would be missing.