git.iko.soy/typeable/servant
on the-great-unification help sign in
typeable/servant/servant-docs/CHANGELOG.md
166 lines 5.1 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.12
5----
7### Significant changes
9- Generate sample cURL requests
10 ([#1401](https://github.com/haskell-servant/servant/pull/1401/files)).
11 Breaking change: requires sample header values to be supplied with `headers`.
130.11.9
14------
16### Significant changes
18- Use Capture Description if available (#1423).
20### Other changes
22- Support GHC-9.0.1.
23- Bump `bytestring` and `lens` dependencies.
250.11.8
26------
28### Significant changes
30- Support `Fragment` combinator.
320.11.7
33------
35### Significant changes
37- Add instance for ToSample NonEmpty
39### Other changes
41- Bump "tested-with" ghc versions
42- Fix servant-docs code sample in README
440.11.5
45----
48- 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)
50 The `NoContent` API endpoints should now use `NoContentVerb` combinator.
51 The API type changes are usually of the kind
53 ```diff
54 - :<|> PostNoContent '[JSON] NoContent
55 + :<|> PostNoContent
56 ```
58 i.e. one doesn't need to specify the content-type anymore. There is no content.
60- `Capture` can be `Lenient` [#1155](https://github.com/haskell-servant/servant/issues/1155) [#1156](https://github.com/haskell-servant/servant/pull/1156)
62 You can specify a lenient capture as
64 ```haskell
65 :<|> "capture-lenient" :> Capture' '[Lenient] "foo" Int :> GET
66 ```
68 which will make the capture always succeed. Handlers will be of the
69 type `Either String CapturedType`, where `Left err` represents
70 the possible parse failure.
72- *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)
74 Servant supports defining the same route multiple times with different
75 content-types and result-types, but servant-docs was only documenting
76 the first of copy of such duplicated routes. It now combines the
77 documentation from all the copies.
79 Unfortunately, it is not yet possible for the documentation to specify
80 multiple status codes.
82- *servant-docs* Prevent race-conditions in testing [#1194](https://github.com/haskell-servant/servant/pull/1194)
840.11.4
85------
87- Drop dependency on `control-monad-omega` in favor of `Data.Universe.Helpers` from `universe-base`.
890.11.3
90------
92- Support `servant-0.15`
93 - Instances for 'Stream' and 'StreamBody'
950.11.2
96------
98* Allow `servant-0.13`:
99 - Doesn't have instances for streaming.
100 - Servant.API.Modifiers extra information isn't used.
1020.11.1
103------
105* Export `DocAuthentication` and related lenses.
106* Make `defAction`'s documentation visible in Haddock documentation.
107* Add a markdown header for the Headers an endpoint is sensitive to.
108* Document the HTTP Method the parameters of an endpoint belong to
109 (rather than assuming `GET` for all of them).
110* Content type of sample response body is also displayed.
111* Can now customise various aspects of how the document is produced
112 using `markdownWith` and `RenderingOptions`:
113 - How many content-types for each example are shown
114 - Whether notes should be grouped together under their own header.
1160.11
117----
119* changed the type of `rqbody`.
1210.10
122----
124There are no changes. Released as a part of `servant` suite.
1260.7.1
127-----
129* Support GHC 8.0
1310.7
132---
134* Use `throwError` instead of `throwE` in documentation
1360.5
137----
139* Support for the `HttpVersion`, `IsSecure`, `RemoteHost` and `Vault` combinators
140* Support maximum samples setting with new `DocOptions` type (used by `docsWithOptions` and `docsWith`)
141* Remove redundant second parameter of ToSample
142* Add Generic-based default implementation for `ToSample` class
143* Add more `ToSamples` instances: `Bool`, `Ordering`, tuples (up to 7), `[]`, `Maybe`, `Either`, `Const`, `ZipList` and some monoids
144* Move `toSample` out of `ToSample` class
145* Add a few helper functions to define `toSamples`
146* Remove matrix params.
147* Added support for Basic authentication
1490.4
150---
151* `Delete` now is like `Get`, `Post`, `Put`, and `Patch` and returns a response body
152* Allow for extra information to be added to the docs
153* Support content-type aware combinators of *servant-0.4*
154* Render endpoints in a canonical order (https://github.com/haskell-servant/servant-docs/pull/15)
155* Remove ToJSON superclass from ToSample
156* Split out Internal module
157* Add support for response headers
158* Allow `ToSample` to return a different type than it's arguments
159* Add Proxy argument to `ToSample`
1610.3
162---
164* Add the ability to display multiple responses, with some accompanying `Text` to describe the context in which we get the corresponding JSON.
165* Expose the `headers` lens
166* Represent an endpoint's path as `[String]` (previously `String`), fixing a corner case where the leading `/` would be missing.