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