git.iko.soy/typeable/swagger2
on v2.4 help sign in
typeable/swagger2/CHANGELOG.md
292 lines 13 kB history raw
12.4
2---
4- Allow hashable-1.3, semigroups-0.19, network-3.1, time-1.9, generics-sop-0.5
5- Tags aren't sorted
6 (see [#165](https://github.com/GetShopTV/swagger2/issues/165))
7- Schema type is optional
8 (see [#138](https://github.com/GetShopTV/swagger2/issues/138), [#164](https://github.com/GetShopTV/swagger2/pull/164))
9- Take concrete 'Proxy' as argument
10 (see [#180](https://github.com/GetShopTV/swagger2/pull/180))
11- GHC-8.8 preparations
132.3.1.1
14-------
16- Allow `network-3.0`
182.3.1
19-----
21- Add a quickcheck generator for aeson Values that match a swagger schema
22 (see [#162](https://github.com/GetShopTV/swagger2/pull/162))
23- Add `ToParamSchema` instance for `SetCookie`
24 (see [#173](https://github.com/GetShopTV/swagger2/pull/173))
25- Make nullary schemas valid
26 (see [#168](https://github.com/GetShopTV/swagger2/pull/168))
282.3.0.1
29-------
31- Support GHC-8.6
332.3
34---
36Major changes:
38- Add support for `additionalProperties` with `Bool` value (see [#159](https://github.com/GetShopTV/swagger2/pull/159));
39- Add `ToSchema` `Object` instance (for aeson's `Object`) (see [`d72466a`](https://github.com/GetShopTV/swagger2/commit/d72466a));
41Dependencies and CI:
43- Aeson 1.4 (see [#158](https://github.com/GetShopTV/swagger2/pull/158));
44- Update .travis.yml (see [#160](https://github.com/GetShopTV/swagger2/pull/160));
45- Allow network 2.7 (see [#155](https://github.com/GetShopTV/swagger2/pull/155));
46- Allow lens-4.17 (see [#161](https://github.com/GetShopTV/swagger2/pull/161));
482.2.2
49-----
51* Add `ToSchema Version` instance
52* Use base-compat-batteries (0.10)
53* PVP bounds
552.2.1
56-----
58* Add `Semigroup` instances
59* GHC-8.4 compatibility
60* `Schema (NonEmpty a) instance (see [#141](https://github.com/GetShopTV/swagger2/pull/141))
61* Fix optional property for unary records (see [#142](https://github.com/GetShopTV/swagger2/issues/142))
62* Add `fromAesonOptions` helper (see [#146](https://github.com/GetShopTV/swagger2/issues/139))
63* Fix non-termination when using `datatypeNameModifier` with recursive data types (see [#132](https://github.com/GetShopTV/swagger2/issues/132))
652.2
66---
68* Treat unknown properties as validation errors in `validateToJSON` (see [#126](https://github.com/GetShopTV/swagger2/pull/126));
69* Add `validateJSON` and `validateJSONWithPatternChecker` to validate JSON `Value` against `Schema` without classes (see [#126](https://github.com/GetShopTV/swagger2/pull/126));
70* Add more `Schema` helpers (see [#126](https://github.com/GetShopTV/swagger2/pull/126)):
71 * `genericNameSchema` — to give a custom schema `Generic`-based name;
72 * `genericDeclareNamedSchemaNewtype` — to derive `NamedSchema` for `newtype`s;
73 * `declareSchemaBoundedEnumKeyMapping` — to derive more specific `Schema` for maps with `Bounded` `Enum` keys;
74* Add a few tests with invalid `Schema`.
762.1.6
77-----
79* 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));
80* Fix instance for `NominalDiffTime` (see [#121](https://github.com/GetShopTV/swagger2/pull/121));
81* Fix build for `aeson-1.2.2.0` (see [#125](https://github.com/GetShopTV/swagger2/pull/125)).
832.1.5
84-----
86* Type error by default when deriving Generic-based instances for mixed sum types (see [#118](https://github.com/GetShopTV/swagger2/pull/118));
87* Adjust `allOf` to accept referenced schemas (see [#119](https://github.com/GetShopTV/swagger2/issues/119));
88* Add instances for `Identity` (see [#116](https://github.com/GetShopTV/swagger2/pull/116));
89* Add Gitter chat badge (see [#114](https://github.com/GetShopTV/swagger2/pull/114)).
912.1.4.1
92-------
94* 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));
95* Documentation corrections (see [#105](https://github.com/GetShopTV/swagger2/pull/105));
96* Allow `generics-sop-0.3` (see [#102](https://github.com/GetShopTV/swagger2/pull/102));
97* Fix `ToSchema` example in docs (see [#104](https://github.com/GetShopTV/swagger2/pull/104)).
992.1.4
100-----
102* Add `liftDeclare` (see [#100](https://github.com/GetShopTV/swagger2/pull/100));
103* Add `MonadDeclare` instances for all monad transformers (see [#100](https://github.com/GetShopTV/swagger2/pull/100)).
1052.1.3
106-----
108* 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)).
109* 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))
110* Improve documentation for generic sum type instance derivation (see [#75](https://github.com/GetShopTV/swagger2/pull/75))
111* Compile warning free (see [#82](https://github.com/GetShopTV/swagger2/pull/82))
1132.1.2.1
114-------
116* Bug fix previous release
1182.1.2
119---
121* Minor changes:
122 * Support `aeson-1.0.0.0` (see [#70](https://github.com/GetShopTV/swagger2/pull/70)).
1242.1.1
125---
127* Minor changes:
128 * Proper `Schema` examples for `Char`, `Day`, `LocalTime`, `ZonedTime` and `UTCTime`.
1302.1
131---
133* Major changes:
134 * Use `InsOrdHashMap` to preserve insertion order for endpoints and definitions (see [#56](https://github.com/GetShopTV/swagger2/pull/56));
135 * Add support for GHC 8.0 (see [#65](https://github.com/GetShopTV/swagger2/pull/65)).
1372.0.2
138---
140* Fixes:
141 * Fix `additionalProperties` to allow references;
142 * Fix `ToSchema` instances for `Map` and `HashMap` (prevent infinite recursion for recursive values).
1442.0.1
145---
147* Fixes:
148 * Re-export `Pattern` synonym from `Data.Swagger`;
149 * Documentation fixes.
1512.0
152---
154* Major changes:
155 * GHC 7.8 support (see [#49](https://github.com/GetShopTV/swagger2/pull/49));
156 * Switch to classy field lenses (see [#41](https://github.com/GetShopTV/swagger2/pull/41));
157 * Add `Data.Swagger.Schema.Validation` (see [#18](https://github.com/GetShopTV/swagger2/pull/18));
158 * Add `Data.Swagger.Operation` with helpers (see [#50](https://github.com/GetShopTV/swagger2/pull/50));
159 * Add `IsString` instances for some types (see [#47](https://github.com/GetShopTV/swagger2/pull/47));
160 * Add helpers to sketch `Schema` from JSON (see [#48](https://github.com/GetShopTV/swagger2/pull/48)).
162* Minor changes:
163 * Make `NamedSchema` a `data` rather than `type` (see [#42](https://github.com/GetShopTV/swagger2/pull/42));
164 * Change `Definitions` to `Definitions Schema`;
165 * Add schema templates for `"binary"`, `"byte"` and `"password"` formats (see [63ed597](https://github.com/GetShopTV/swagger2/commit/63ed59736dc4f942f0e2a7d668d7cee513fa9eaf));
166 * Add `Monoid` instance for `Contact`;
167 * Change `tags` to be `Set` rather than list.
169* Fixes:
170 * Fix schema for `()` and nullary constructors (see [ab65c4a](https://github.com/GetShopTV/swagger2/commit/ab65c4a48253c34f8a88221a53dc97bf5e6e8d29));
171 * Fix `Operation` `FromJSON` instance to allow missing `tags` and `parameters` properties.
1731.2.1
174---
176* Minor changes:
177 * Change `_SwaggerItemsPrimitive` type from a `Prism'` to a more restrictive `Review`-like `Optic'`.
179* Fixes:
180 * Fix build for GHC 8.0-rc1.
1821.2
183---
184* Minor changes (see [#36](https://github.com/GetShopTV/swagger2/pull/36)):
185 * Change default `ToSchema` instance for unit data types (i.e. types with one nullable constructor like `data Unit = Unit`):
186 now these types are treated like sum types with only one alternative;
187 * Add generic `ToParamSchema` instance for unit data types;
188 * Add `items: []` to schema for `()` (making it a valid schema).
190* Fixes:
191 * Do not omit `items: []` from `Schema` JSON;
192 * Do not generate unused definitions for nested `newtype`s (see [#38](https://github.com/GetShopTV/swagger2/pull/38)).
1941.1.1
195---
196* Fixes:
197 * `CollectionFormat Param` -> `CollectionFormat ParamOtherSchema`;
198 this change was necessary after putting `CollectionFormat` to `SwaggerItems`.
2001.1
201---
202* Major changes:
203 * Put `CollectionFormat` in one place (see [`3cc860d`](https://github.com/GetShopTV/swagger2/commit/3cc860dd3f002ab984f4d0e4ce1d1799f985832e)).
205* Minor changes:
206 * Use Swagger formats for `Int32`, `Int64`, `Float`, `Double`, `Day` and `ZonedTime` (see [#32](https://github.com/GetShopTV/swagger2/pull/32));
207 * Export `HeaderName`, `TagName`, `HttpStatusCode` type synonyms;
208 * Add `ToParamSchema` instances for `[a]`, `Set a` and `HashSet a`;
209 * Add `Monoid` instances for `Header` and `Example`.
211* Fixes:
212 * Use overwrite strategy for `HashMap` `SwaggerMonoid` instances by default.
2141.0
215---
216* Major changes:
217 * Add `Data` and `Typeable` instances for `Data.Swagger` types;
218 * Merge `ParamType`/`ItemsType`/`SchemaType` into `SwaggerType` GADT;
219 * Merge collection format types into `CollectionFormat` GADT;
220 * Introduce `SwaggerItems` GADT, replacing `Items` and `SchemaItems` in `ParamSchema` (see [#24](https://github.com/GetShopTV/swagger2/pull/24));
221 * Move type, format and items fields to `ParamSchema` (former `SchemaComon`);
222 * Prepend reference path automatically (see [commit 49d1fad](https://github.com/GetShopTV/swagger2/commit/49d1fadd2100644e70c442667180d0d73e107a5f))
223 and thus remove `"#/definitions/"` from user code, leaving much clearer `Reference "Name"`;
224 * Change `Data.Swagger.Schema` (see [#19](https://github.com/GetShopTV/swagger2/pull/19)):
225 * Change the only method of `ToSchema` to `declareNamedSchema` which should produce a `NamedSchema`
226 along with a list of schema definitions used to produce it;
227 * Add `declareSchema`, `declareSchemaRef`;
228 * Replace `genericTo*` helpers with `genericDeclare*` helpers;
229 * Add `paramSchemaTo[Named]Schema` helpers to facilitate code reuse for primitive schemas;
230 * Add helpers for inlining `Schema` references dynamically (see [#23](https://github.com/GetShopTV/swagger2/pull/23));
231 * Add `ToParamSchema` class (see [#17](https://github.com/GetShopTV/swagger2/pull/17)) with
232 * generic default implementation and
233 * instances for some base types compliant with `http-api-data` instances;
234 * Add `Data.Swagger.Declare` module with
235 * `DeclareT` monad transformer;
236 * `MonadDeclare` type class;
237 * various helpers;
238 * Rename parameter-related types:
239 * `Parameter` -> `Param`;
240 * `ParameterSchema` -> `ParamAnySchema`;
241 * `ParameterOtherSchema` -> `ParamOtherSchema`;
242 * `ParameterLocation` -> `ParamLocation`;
243 * `SchemaCommon` -> `ParamSchema`;
244 * `parameter*` fields renamed to `param*` fields;
245 * `schemaCommon*` fields renamed to `paramSchema*` fields;
246 * `HasSchemaCommon` -> `HasParamSchema`.
248* Minor changes:
249 * Replace TH-generated JSON instances with `Generic`-based (see [#25](https://github.com/GetShopTV/swagger2/pull/25));
250 * Drop `template-haskell` dependency;
251 * Omit empty array/object properties from `toJSON` output ([#22](https://github.com/GetShopTV/swagger2/pull/22));
252 * Remove `minLength` property from schemas for `time` types;
253 * Move `SchemaOptions` to `Data.Swagger.SchemaOptions`;
254 * Remove `useReferences` from `SchemaOptions` (see [#23](https://github.com/GetShopTV/swagger2/pull/23));
255 * Place all internal submodules under `Data.Swagger.Internal`;
256 * Better documentation (see [#26](https://github.com/GetShopTV/swagger2/pull/26)).
2580.4.1
259---
260* Fixes:
261 * Use `PackageImports` for `Data.HashSet` to avoid test failure on stackage (see [#15](https://github.com/GetShopTV/swagger2/issues/15));
262 * 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));
263 * Switch to Cabal-based multi GHC Travis config.
2650.4
266---
267* Remove `Swagger`/`swagger` prefixes;
268* Add `ToSchema` type class with default generic implementation;
269* Add configurable generic `ToSchema` helpers;
270* Add `doctest` test suite;
271* Fixes:
272 * Fix `HasSchemaCommon` instance for `Schema`;
273 * Change `minimum`, `maximum` and `multipleOf` properties to be any number,
274 not necessarily an integer;
275 * Fix all warnings.
2770.3
278---
279* Fixes:
280 * Fix `SwaggerMonoid Text` instance;
281 * Wrap `Bool` in `Maybe` everywhere;
282 * These changes make all `Data.Swagger` `Monoid` instances obey monoid laws
283 (previously right identity law was broken by some instances).
2850.2
286---
287* Add `Data.Swagger.Lens`;
288* Support references;
289* Fixes:
290 * Fix `FromJSON SwaggerHost` instance;
291 * Add missing `Maybe`s for field types;
292 * Decode petstore `swagger.json` successfully.