git.iko.soy/typeable/swagger2
on v2.5 help sign in
typeable/swagger2/CHANGELOG.md
305 lines 13 kB history raw
12.5
2---
4Highlights:
5- Add instance for `TimeOfDay` (see [#196]( https://github.com/GetShopTV/swagger2/pull/196 ));
6- Add support for [`optics`](https://hackage.haskell.org/package/optics) (see [#200]( https://github.com/GetShopTV/swagger2/pull/200 ));
7- Slightly better validation errors (see [#195]( https://github.com/GetShopTV/swagger2/pull/195 ));
9Fixes and minor changes:
10- Minor cleanup (see [#194]( https://github.com/GetShopTV/swagger2/pull/194 ));
11- Allow base-4.13 and other GHC-8.8 related stuff (see [#198]( https://github.com/GetShopTV/swagger2/pull/198 ));
12- Fix `stack.yaml` (see [#201]( https://github.com/GetShopTV/swagger2/pull/201 ));
142.4
15---
17- Allow hashable-1.3, semigroups-0.19, network-3.1, time-1.9, generics-sop-0.5
18- Tags aren't sorted
19 (see [#165](https://github.com/GetShopTV/swagger2/issues/165))
20- Schema type is optional
21 (see [#138](https://github.com/GetShopTV/swagger2/issues/138), [#164](https://github.com/GetShopTV/swagger2/pull/164))
22- Take concrete 'Proxy' as argument
23 (see [#180](https://github.com/GetShopTV/swagger2/pull/180))
24- GHC-8.8 preparations
262.3.1.1
27-------
29- Allow `network-3.0`
312.3.1
32-----
34- Add a quickcheck generator for aeson Values that match a swagger schema
35 (see [#162](https://github.com/GetShopTV/swagger2/pull/162))
36- Add `ToParamSchema` instance for `SetCookie`
37 (see [#173](https://github.com/GetShopTV/swagger2/pull/173))
38- Make nullary schemas valid
39 (see [#168](https://github.com/GetShopTV/swagger2/pull/168))
412.3.0.1
42-------
44- Support GHC-8.6
462.3
47---
49Major changes:
51- Add support for `additionalProperties` with `Bool` value (see [#159](https://github.com/GetShopTV/swagger2/pull/159));
52- Add `ToSchema` `Object` instance (for aeson's `Object`) (see [`d72466a`](https://github.com/GetShopTV/swagger2/commit/d72466a));
54Dependencies and CI:
56- Aeson 1.4 (see [#158](https://github.com/GetShopTV/swagger2/pull/158));
57- Update .travis.yml (see [#160](https://github.com/GetShopTV/swagger2/pull/160));
58- Allow network 2.7 (see [#155](https://github.com/GetShopTV/swagger2/pull/155));
59- Allow lens-4.17 (see [#161](https://github.com/GetShopTV/swagger2/pull/161));
612.2.2
62-----
64* Add `ToSchema Version` instance
65* Use base-compat-batteries (0.10)
66* PVP bounds
682.2.1
69-----
71* Add `Semigroup` instances
72* GHC-8.4 compatibility
73* `Schema (NonEmpty a) instance (see [#141](https://github.com/GetShopTV/swagger2/pull/141))
74* Fix optional property for unary records (see [#142](https://github.com/GetShopTV/swagger2/issues/142))
75* Add `fromAesonOptions` helper (see [#146](https://github.com/GetShopTV/swagger2/issues/139))
76* Fix non-termination when using `datatypeNameModifier` with recursive data types (see [#132](https://github.com/GetShopTV/swagger2/issues/132))
782.2
79---
81* Treat unknown properties as validation errors in `validateToJSON` (see [#126](https://github.com/GetShopTV/swagger2/pull/126));
82* Add `validateJSON` and `validateJSONWithPatternChecker` to validate JSON `Value` against `Schema` without classes (see [#126](https://github.com/GetShopTV/swagger2/pull/126));
83* Add more `Schema` helpers (see [#126](https://github.com/GetShopTV/swagger2/pull/126)):
84 * `genericNameSchema` — to give a custom schema `Generic`-based name;
85 * `genericDeclareNamedSchemaNewtype` — to derive `NamedSchema` for `newtype`s;
86 * `declareSchemaBoundedEnumKeyMapping` — to derive more specific `Schema` for maps with `Bounded` `Enum` keys;
87* Add a few tests with invalid `Schema`.
892.1.6
90-----
92* Add `ToParamSchema` and `ToSchema` instances for `Fixed` (see [#121](https://github.com/GetShopTV/swagger2/pull/121)) and `Natural` (see [#123](https://github.com/GetShopTV/swagger2/pull/123));
93* Fix instance for `NominalDiffTime` (see [#121](https://github.com/GetShopTV/swagger2/pull/121));
94* Fix build for `aeson-1.2.2.0` (see [#125](https://github.com/GetShopTV/swagger2/pull/125)).
962.1.5
97-----
99* Type error by default when deriving Generic-based instances for mixed sum types (see [#118](https://github.com/GetShopTV/swagger2/pull/118));
100* Adjust `allOf` to accept referenced schemas (see [#119](https://github.com/GetShopTV/swagger2/issues/119));
101* Add instances for `Identity` (see [#116](https://github.com/GetShopTV/swagger2/pull/116));
102* Add Gitter chat badge (see [#114](https://github.com/GetShopTV/swagger2/pull/114)).
1042.1.4.1
105-------
107* GHC-8.2 support (see [#95](https://github.com/GetShopTV/swagger2/issues/95), [#106](https://github.com/GetShopTV/swagger2/pull/106) and [#108](https://github.com/GetShopTV/swagger2/pull/108));
108* Documentation corrections (see [#105](https://github.com/GetShopTV/swagger2/pull/105));
109* Allow `generics-sop-0.3` (see [#102](https://github.com/GetShopTV/swagger2/pull/102));
110* Fix `ToSchema` example in docs (see [#104](https://github.com/GetShopTV/swagger2/pull/104)).
1122.1.4
113-----
115* Add `liftDeclare` (see [#100](https://github.com/GetShopTV/swagger2/pull/100));
116* Add `MonadDeclare` instances for all monad transformers (see [#100](https://github.com/GetShopTV/swagger2/pull/100)).
1182.1.3
119-----
121* Add [`UUID`](http://hackage.haskell.org/package/uuid-types/docs/Data-UUID-Types.html#t:UUID) instances (see [#81](https://github.com/GetShopTV/swagger2/pull/81)).
122* Add [`TypeError`](https://hackage.haskell.org/package/base-4.9.0.0/docs/GHC-TypeLits.html#g:4) `ToSchema` and `ToParamSchema ByteString` instances (see [#78](https://github.com/GetShopTV/swagger2/pull/78))
123* Improve documentation for generic sum type instance derivation (see [#75](https://github.com/GetShopTV/swagger2/pull/75))
124* Compile warning free (see [#82](https://github.com/GetShopTV/swagger2/pull/82))
1262.1.2.1
127-------
129* Bug fix previous release
1312.1.2
132---
134* Minor changes:
135 * Support `aeson-1.0.0.0` (see [#70](https://github.com/GetShopTV/swagger2/pull/70)).
1372.1.1
138---
140* Minor changes:
141 * Proper `Schema` examples for `Char`, `Day`, `LocalTime`, `ZonedTime` and `UTCTime`.
1432.1
144---
146* Major changes:
147 * Use `InsOrdHashMap` to preserve insertion order for endpoints and definitions (see [#56](https://github.com/GetShopTV/swagger2/pull/56));
148 * Add support for GHC 8.0 (see [#65](https://github.com/GetShopTV/swagger2/pull/65)).
1502.0.2
151---
153* Fixes:
154 * Fix `additionalProperties` to allow references;
155 * Fix `ToSchema` instances for `Map` and `HashMap` (prevent infinite recursion for recursive values).
1572.0.1
158---
160* Fixes:
161 * Re-export `Pattern` synonym from `Data.Swagger`;
162 * Documentation fixes.
1642.0
165---
167* Major changes:
168 * GHC 7.8 support (see [#49](https://github.com/GetShopTV/swagger2/pull/49));
169 * Switch to classy field lenses (see [#41](https://github.com/GetShopTV/swagger2/pull/41));
170 * Add `Data.Swagger.Schema.Validation` (see [#18](https://github.com/GetShopTV/swagger2/pull/18));
171 * Add `Data.Swagger.Operation` with helpers (see [#50](https://github.com/GetShopTV/swagger2/pull/50));
172 * Add `IsString` instances for some types (see [#47](https://github.com/GetShopTV/swagger2/pull/47));
173 * Add helpers to sketch `Schema` from JSON (see [#48](https://github.com/GetShopTV/swagger2/pull/48)).
175* Minor changes:
176 * Make `NamedSchema` a `data` rather than `type` (see [#42](https://github.com/GetShopTV/swagger2/pull/42));
177 * Change `Definitions` to `Definitions Schema`;
178 * Add schema templates for `"binary"`, `"byte"` and `"password"` formats (see [63ed597](https://github.com/GetShopTV/swagger2/commit/63ed59736dc4f942f0e2a7d668d7cee513fa9eaf));
179 * Add `Monoid` instance for `Contact`;
180 * Change `tags` to be `Set` rather than list.
182* Fixes:
183 * Fix schema for `()` and nullary constructors (see [ab65c4a](https://github.com/GetShopTV/swagger2/commit/ab65c4a48253c34f8a88221a53dc97bf5e6e8d29));
184 * Fix `Operation` `FromJSON` instance to allow missing `tags` and `parameters` properties.
1861.2.1
187---
189* Minor changes:
190 * Change `_SwaggerItemsPrimitive` type from a `Prism'` to a more restrictive `Review`-like `Optic'`.
192* Fixes:
193 * Fix build for GHC 8.0-rc1.
1951.2
196---
197* Minor changes (see [#36](https://github.com/GetShopTV/swagger2/pull/36)):
198 * Change default `ToSchema` instance for unit data types (i.e. types with one nullable constructor like `data Unit = Unit`):
199 now these types are treated like sum types with only one alternative;
200 * Add generic `ToParamSchema` instance for unit data types;
201 * Add `items: []` to schema for `()` (making it a valid schema).
203* Fixes:
204 * Do not omit `items: []` from `Schema` JSON;
205 * Do not generate unused definitions for nested `newtype`s (see [#38](https://github.com/GetShopTV/swagger2/pull/38)).
2071.1.1
208---
209* Fixes:
210 * `CollectionFormat Param` -> `CollectionFormat ParamOtherSchema`;
211 this change was necessary after putting `CollectionFormat` to `SwaggerItems`.
2131.1
214---
215* Major changes:
216 * Put `CollectionFormat` in one place (see [`3cc860d`](https://github.com/GetShopTV/swagger2/commit/3cc860dd3f002ab984f4d0e4ce1d1799f985832e)).
218* Minor changes:
219 * Use Swagger formats for `Int32`, `Int64`, `Float`, `Double`, `Day` and `ZonedTime` (see [#32](https://github.com/GetShopTV/swagger2/pull/32));
220 * Export `HeaderName`, `TagName`, `HttpStatusCode` type synonyms;
221 * Add `ToParamSchema` instances for `[a]`, `Set a` and `HashSet a`;
222 * Add `Monoid` instances for `Header` and `Example`.
224* Fixes:
225 * Use overwrite strategy for `HashMap` `SwaggerMonoid` instances by default.
2271.0
228---
229* Major changes:
230 * Add `Data` and `Typeable` instances for `Data.Swagger` types;
231 * Merge `ParamType`/`ItemsType`/`SchemaType` into `SwaggerType` GADT;
232 * Merge collection format types into `CollectionFormat` GADT;
233 * Introduce `SwaggerItems` GADT, replacing `Items` and `SchemaItems` in `ParamSchema` (see [#24](https://github.com/GetShopTV/swagger2/pull/24));
234 * Move type, format and items fields to `ParamSchema` (former `SchemaComon`);
235 * Prepend reference path automatically (see [commit 49d1fad](https://github.com/GetShopTV/swagger2/commit/49d1fadd2100644e70c442667180d0d73e107a5f))
236 and thus remove `"#/definitions/"` from user code, leaving much clearer `Reference "Name"`;
237 * Change `Data.Swagger.Schema` (see [#19](https://github.com/GetShopTV/swagger2/pull/19)):
238 * Change the only method of `ToSchema` to `declareNamedSchema` which should produce a `NamedSchema`
239 along with a list of schema definitions used to produce it;
240 * Add `declareSchema`, `declareSchemaRef`;
241 * Replace `genericTo*` helpers with `genericDeclare*` helpers;
242 * Add `paramSchemaTo[Named]Schema` helpers to facilitate code reuse for primitive schemas;
243 * Add helpers for inlining `Schema` references dynamically (see [#23](https://github.com/GetShopTV/swagger2/pull/23));
244 * Add `ToParamSchema` class (see [#17](https://github.com/GetShopTV/swagger2/pull/17)) with
245 * generic default implementation and
246 * instances for some base types compliant with `http-api-data` instances;
247 * Add `Data.Swagger.Declare` module with
248 * `DeclareT` monad transformer;
249 * `MonadDeclare` type class;
250 * various helpers;
251 * Rename parameter-related types:
252 * `Parameter` -> `Param`;
253 * `ParameterSchema` -> `ParamAnySchema`;
254 * `ParameterOtherSchema` -> `ParamOtherSchema`;
255 * `ParameterLocation` -> `ParamLocation`;
256 * `SchemaCommon` -> `ParamSchema`;
257 * `parameter*` fields renamed to `param*` fields;
258 * `schemaCommon*` fields renamed to `paramSchema*` fields;
259 * `HasSchemaCommon` -> `HasParamSchema`.
261* Minor changes:
262 * Replace TH-generated JSON instances with `Generic`-based (see [#25](https://github.com/GetShopTV/swagger2/pull/25));
263 * Drop `template-haskell` dependency;
264 * Omit empty array/object properties from `toJSON` output ([#22](https://github.com/GetShopTV/swagger2/pull/22));
265 * Remove `minLength` property from schemas for `time` types;
266 * Move `SchemaOptions` to `Data.Swagger.SchemaOptions`;
267 * Remove `useReferences` from `SchemaOptions` (see [#23](https://github.com/GetShopTV/swagger2/pull/23));
268 * Place all internal submodules under `Data.Swagger.Internal`;
269 * Better documentation (see [#26](https://github.com/GetShopTV/swagger2/pull/26)).
2710.4.1
272---
273* Fixes:
274 * Use `PackageImports` for `Data.HashSet` to avoid test failure on stackage (see [#15](https://github.com/GetShopTV/swagger2/issues/15));
275 * Add an upper version bound for `aeson` due to `aeson-0.10.0.0` bug (see [bos/aeson#293](https://github.com/bos/aeson/issues/293));
276 * Switch to Cabal-based multi GHC Travis config.
2780.4
279---
280* Remove `Swagger`/`swagger` prefixes;
281* Add `ToSchema` type class with default generic implementation;
282* Add configurable generic `ToSchema` helpers;
283* Add `doctest` test suite;
284* Fixes:
285 * Fix `HasSchemaCommon` instance for `Schema`;
286 * Change `minimum`, `maximum` and `multipleOf` properties to be any number,
287 not necessarily an integer;
288 * Fix all warnings.
2900.3
291---
292* Fixes:
293 * Fix `SwaggerMonoid Text` instance;
294 * Wrap `Bool` in `Maybe` everywhere;
295 * These changes make all `Data.Swagger` `Monoid` instances obey monoid laws
296 (previously right identity law was broken by some instances).
2980.2
299---
300* Add `Data.Swagger.Lens`;
301* Support references;
302* Fixes:
303 * Fix `FromJSON SwaggerHost` instance;
304 * Add missing `Maybe`s for field types;
305 * Decode petstore `swagger.json` successfully.