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