git.iko.soy/typeable/swagger2
on v1.2.1 help sign in
typeable/swagger2/CHANGELOG.md
120 lines 5.6 kB history raw
11.2.1
2---
4* Minor change:
5 * Change `_SwaggerItemsPrimitive` type from a `Prism'` to a more restrictive `Review`-like `Optic'`.
7* Fixes:
8 * Fix build for GHC 8.0-rc1.
101.2
11---
12* Minor changes (see [#36](https://github.com/GetShopTV/swagger2/pull/36)):
13 * Change default `ToSchema` instance for unit data types (i.e. types with one nullable constructor like `data Unit = Unit`):
14 now these types are treated like sum types with only one alternative;
15 * Add generic `ToParamSchema` instance for unit data types;
16 * Add `items: []` to schema for `()` (making it a valid schema).
18* Fixes:
19 * Do not omit `items: []` from `Schema` JSON;
20 * Do not generate unused definitions for nested `newtype`s (see [#38](https://github.com/GetShopTV/swagger2/pull/38)).
221.1.1
23---
24* Fixes:
25 * `CollectionFormat Param` -> `CollectionFormat ParamOtherSchema`;
26 this change was necessary after putting `CollectionFormat` to `SwaggerItems`.
281.1
29---
30* Major changes:
31 * Put `CollectionFormat` in one place (see [`3cc860d`](https://github.com/GetShopTV/swagger2/commit/3cc860dd3f002ab984f4d0e4ce1d1799f985832e)).
33* Minor changes:
34 * Use Swagger formats for `Int32`, `Int64`, `Float`, `Double`, `Day` and `ZonedTime` (see [#32](https://github.com/GetShopTV/swagger2/pull/32));
35 * Export `HeaderName`, `TagName`, `HttpStatusCode` type synonyms;
36 * Add `ToParamSchema` instances for `[a]`, `Set a` and `HashSet a`;
37 * Add `Monoid` instances for `Header` and `Example`.
39* Fixes:
40 * Use overwrite strategy for `HashMap` `SwaggerMonoid` instances by default.
421.0
43---
44* Major changes:
45 * Add `Data` and `Typeable` instances for `Data.Swagger` types;
46 * Merge `ParamType`/`ItemsType`/`SchemaType` into `SwaggerType` GADT;
47 * Merge collection format types into `CollectionFormat` GADT;
48 * Introduce `SwaggerItems` GADT, replacing `Items` and `SchemaItems` in `ParamSchema` (see [#24](https://github.com/GetShopTV/swagger2/pull/24));
49 * Move type, format and items fields to `ParamSchema` (former `SchemaComon`);
50 * Prepend reference path automatically (see [commit 49d1fad](https://github.com/GetShopTV/swagger2/commit/49d1fadd2100644e70c442667180d0d73e107a5f))
51 and thus remove `"#/definitions/"` from user code, leaving much clearer `Reference "Name"`;
52 * Change `Data.Swagger.Schema` (see [#19](https://github.com/GetShopTV/swagger2/pull/19)):
53 * Change the only method of `ToSchema` to `declareNamedSchema` which should produce a `NamedSchema`
54 along with a list of schema definitions used to produce it;
55 * Add `declareSchema`, `declareSchemaRef`;
56 * Replace `genericTo*` helpers with `genericDeclare*` helpers;
57 * Add `paramSchemaTo[Named]Schema` helpers to facilitate code reuse for primitive schemas;
58 * Add helpers for inlining `Schema` references dynamically (see [#23](https://github.com/GetShopTV/swagger2/pull/23));
59 * Add `ToParamSchema` class (see [#17](https://github.com/GetShopTV/swagger2/pull/17)) with
60 * generic default implementation and
61 * instances for some base types compliant with `http-api-data` instances;
62 * Add `Data.Swagger.Declare` module with
63 * `DeclareT` monad transformer;
64 * `MonadDeclare` type class;
65 * various helpers;
66 * Rename parameter-related types:
67 * `Parameter` -> `Param`;
68 * `ParameterSchema` -> `ParamAnySchema`;
69 * `ParameterOtherSchema` -> `ParamOtherSchema`;
70 * `ParameterLocation` -> `ParamLocation`;
71 * `SchemaCommon` -> `ParamSchema`;
72 * `parameter*` fields renamed to `param*` fields;
73 * `schemaCommon*` fields renamed to `paramSchema*` fields;
74 * `HasSchemaCommon` -> `HasParamSchema`.
76* Minor changes:
77 * Replace TH-generated JSON instances with `Generic`-based (see [#25](https://github.com/GetShopTV/swagger2/pull/25));
78 * Drop `template-haskell` dependency;
79 * Omit empty array/object properties from `toJSON` output ([#22](https://github.com/GetShopTV/swagger2/pull/22));
80 * Remove `minLength` property from schemas for `time` types;
81 * Move `SchemaOptions` to `Data.Swagger.SchemaOptions`;
82 * Remove `useReferences` from `SchemaOptions` (see [#23](https://github.com/GetShopTV/swagger2/pull/23));
83 * Place all internal submodules under `Data.Swagger.Internal`;
84 * Better documentation (see [#26](https://github.com/GetShopTV/swagger2/pull/26)).
860.4.1
87---
88* Fixes:
89 * Use `PackageImports` for `Data.HashSet` to avoid test failure on stackage (see [#15](https://github.com/GetShopTV/swagger2/issues/15));
90 * 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));
91 * Switch to Cabal-based multi GHC Travis config.
930.4
94---
95* Remove `Swagger`/`swagger` prefixes;
96* Add `ToSchema` type class with default generic implementation;
97* Add configurable generic `ToSchema` helpers;
98* Add `doctest` test suite;
99* Fixes:
100 * Fix `HasSchemaCommon` instance for `Schema`;
101 * Change `minimum`, `maximum` and `multipleOf` properties to be any number,
102 not necessarily an integer;
103 * Fix all warnings.
1050.3
106---
107* Fixes:
108 * Fix `SwaggerMonoid Text` instance;
109 * Wrap `Bool` in `Maybe` everywhere;
110 * These changes make all `Data.Swagger` `Monoid` instances obey monoid laws
111 (previously right identity law was broken by some instances).
1130.2
114---
115* Add `Data.Swagger.Lens`;
116* Support references;
117* Fixes:
118 * Fix `FromJSON SwaggerHost` instance;
119 * Add missing `Maybe`s for field types;
120 * Decode petstore `swagger.json` successfully.