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