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