git.iko.soy/typeable/swagger2
on v1.0 help sign in
typeable/swagger2/CHANGELOG.md
79 lines 4.0 kB history raw
11.0
2---
3* Major changes:
4 * Add `Data` and `Typeable` instances for `Data.Swagger` types;
5 * Merge `ParamType`/`ItemsType`/`SchemaType` into `SwaggerType` GADT;
6 * Merge collection format types into `CollectionFormat` GADT;
7 * Introduce `SwaggerItems` GADT, replacing `Items` and `SchemaItems` in `ParamSchema` (see [#24](https://github.com/GetShopTV/swagger2/pull/24));
8 * Move type, format and items fields to `ParamSchema` (former `SchemaComon`);
9 * Prepend reference path automatically (see [commit 49d1fad](https://github.com/GetShopTV/swagger2/commit/49d1fadd2100644e70c442667180d0d73e107a5f))
10 and thus remove `"#/definitions/"` from user code, leaving much clearer `Reference "Name"`;
11 * Change `Data.Swagger.Schema` (see [#19](https://github.com/GetShopTV/swagger2/pull/19)):
12 * Change the only method of `ToSchema` to `declareNamedSchema` which should produce a `NamedSchema`
13 along with a list of schema definitions used to produce it;
14 * Add `declareSchema`, `declareSchemaRef`;
15 * Replace `genericTo*` helpers with `genericDeclare*` helpers;
16 * Add `paramSchemaTo[Named]Schema` helpers to facilitate code reuse for primitive schemas;
17 * Add helpers for inlining `Schema` references dynamically (see [#23](https://github.com/GetShopTV/swagger2/pull/23));
18 * Add `ToParamSchema` class (see [#17](https://github.com/GetShopTV/swagger2/pull/17)) with
19 * generic default implementation and
20 * instances for some base types compliant with `http-api-data` instances;
21 * Add `Data.Swagger.Declare` module with
22 * `DeclareT` monad transformer;
23 * `MonadDeclare` type class;
24 * various helpers;
25 * Rename parameter-related types:
26 * `Parameter` -> `Param`;
27 * `ParameterSchema` -> `ParamAnySchema`;
28 * `ParameterOtherSchema` -> `ParamOtherSchema`;
29 * `ParameterLocation` -> `ParamLocation`;
30 * `SchemaCommon` -> `ParamSchema`;
31 * `parameter*` fields renamed to `param*` fields;
32 * `schemaCommon*` fields renamed to `paramSchema*` fields;
33 * `HasSchemaCommon` -> `HasParamSchema`.
35* Minor changes:
36 * Replace TH-generated JSON instances with `Generic`-based (see [#25](https://github.com/GetShopTV/swagger2/pull/25));
37 * Drop `template-haskell` dependency;
38 * Omit empty array/object properties from `toJSON` output ([#22](https://github.com/GetShopTV/swagger2/pull/22));
39 * Remove `minLength` property from schemas for `time` types;
40 * Move `SchemaOptions` to `Data.Swagger.SchemaOptions`;
41 * Remove `useReferences` from `SchemaOptions` (see [#23](https://github.com/GetShopTV/swagger2/pull/23));
42 * Place all internal submodules under `Data.Swagger.Internal`;
43 * Better documentation (see [#26](https://github.com/GetShopTV/swagger2/pull/26)).
450.4.1
46---
47* Fixes:
48 * Use `PackageImports` for `Data.HashSet` to avoid test failure on stackage (see [#15](https://github.com/GetShopTV/swagger2/issues/15));
49 * 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));
50 * Switch to Cabal-based multi GHC Travis config.
520.4
53---
54* Remove `Swagger`/`swagger` prefixes;
55* Add `ToSchema` type class with default generic implementation;
56* Add configurable generic `ToSchema` helpers;
57* Add `doctest` test suite;
58* Fixes:
59 * Fix `HasSchemaCommon` instance for `Schema`;
60 * Change `minimum`, `maximum` and `multipleOf` properties to be any number,
61 not necessarily an integer;
62 * Fix all warnings.
640.3
65---
66* Fixes:
67 * Fix `SwaggerMonoid Text` instance;
68 * Wrap `Bool` in `Maybe` everywhere;
69 * These changes make all `Data.Swagger` `Monoid` instances obey monoid laws
70 (previously right identity law was broken by some instances).
720.2
73---
74* Add `Data.Swagger.Lens`;
75* Support references;
76* Fixes:
77 * Fix `FromJSON SwaggerHost` instance;
78 * Add missing `Maybe`s for field types;
79 * Decode petstore `swagger.json` successfully.