git.iko.soy/typeable/swagger2
on percent-encoding-2.3.1.1 help sign in
typeable/swagger2/CHANGELOG.md
279 lines 12 kB history raw
12.3.1.1
2-------
3- Allow `network-3.0`
52.3.1
6-----
8- Add a quickcheck generator for aeson Values that match a swagger schema
9 (see [#162](https://github.com/GetShopTV/swagger2/pull/162))
10- Add `ToParamSchema` instance for `SetCookie`
11 (see [#173](https://github.com/GetShopTV/swagger2/pull/173))
12- Make nullary schemas valid
13 (see [#168](https://github.com/GetShopTV/swagger2/pull/168))
152.3.0.1
16-------
18- Support GHC-8.6
202.3
21---
23Major changes:
25- Add support for `additionalProperties` with `Bool` value (see [#159](https://github.com/GetShopTV/swagger2/pull/159));
26- Add `ToSchema` `Object` instance (for aeson's `Object`) (see [`d72466a`](https://github.com/GetShopTV/swagger2/commit/d72466a));
28Dependencies and CI:
30- Aeson 1.4 (see [#158](https://github.com/GetShopTV/swagger2/pull/158));
31- Update .travis.yml (see [#160](https://github.com/GetShopTV/swagger2/pull/160));
32- Allow network 2.7 (see [#155](https://github.com/GetShopTV/swagger2/pull/155));
33- Allow lens-4.17 (see [#161](https://github.com/GetShopTV/swagger2/pull/161));
352.2.2
36-----
38* Add `ToSchema Version` instance
39* Use base-compat-batteries (0.10)
40* PVP bounds
422.2.1
43-----
45* Add `Semigroup` instances
46* GHC-8.4 compatibility
47* `Schema (NonEmpty a) instance (see [#141](https://github.com/GetShopTV/swagger2/pull/141))
48* Fix optional property for unary records (see [#142](https://github.com/GetShopTV/swagger2/issues/142))
49* Add `fromAesonOptions` helper (see [#146](https://github.com/GetShopTV/swagger2/issues/139))
50* Fix non-termination when using `datatypeNameModifier` with recursive data types (see [#132](https://github.com/GetShopTV/swagger2/issues/132))
522.2
53---
55* Treat unknown properties as validation errors in `validateToJSON` (see [#126](https://github.com/GetShopTV/swagger2/pull/126));
56* Add `validateJSON` and `validateJSONWithPatternChecker` to validate JSON `Value` against `Schema` without classes (see [#126](https://github.com/GetShopTV/swagger2/pull/126));
57* Add more `Schema` helpers (see [#126](https://github.com/GetShopTV/swagger2/pull/126)):
58 * `genericNameSchema` — to give a custom schema `Generic`-based name;
59 * `genericDeclareNamedSchemaNewtype` — to derive `NamedSchema` for `newtype`s;
60 * `declareSchemaBoundedEnumKeyMapping` — to derive more specific `Schema` for maps with `Bounded` `Enum` keys;
61* Add a few tests with invalid `Schema`.
632.1.6
64-----
66* Add `ToParamSchema` and `ToSchema` instances for `Fixed` (see [#121](https://github.com/GetShopTV/swagger2/pull/121)) and `Natural` (see [#123](https://github.com/GetShopTV/swagger2/pull/123));
67* Fix instance for `NominalDiffTime` (see [#121](https://github.com/GetShopTV/swagger2/pull/121));
68* Fix build for `aeson-1.2.2.0` (see [#125](https://github.com/GetShopTV/swagger2/pull/125)).
702.1.5
71-----
73* Type error by default when deriving Generic-based instances for mixed sum types (see [#118](https://github.com/GetShopTV/swagger2/pull/118));
74* Adjust `allOf` to accept referenced schemas (see [#119](https://github.com/GetShopTV/swagger2/issues/119));
75* Add instances for `Identity` (see [#116](https://github.com/GetShopTV/swagger2/pull/116));
76* Add Gitter chat badge (see [#114](https://github.com/GetShopTV/swagger2/pull/114)).
782.1.4.1
79-------
81* GHC-8.2 support (see [#95](https://github.com/GetShopTV/swagger2/issues/95), [#106](https://github.com/GetShopTV/swagger2/pull/106) and [#108](https://github.com/GetShopTV/swagger2/pull/108));
82* Documentation corrections (see [#105](https://github.com/GetShopTV/swagger2/pull/105));
83* Allow `generics-sop-0.3` (see [#102](https://github.com/GetShopTV/swagger2/pull/102));
84* Fix `ToSchema` example in docs (see [#104](https://github.com/GetShopTV/swagger2/pull/104)).
862.1.4
87-----
89* Add `liftDeclare` (see [#100](https://github.com/GetShopTV/swagger2/pull/100));
90* Add `MonadDeclare` instances for all monad transformers (see [#100](https://github.com/GetShopTV/swagger2/pull/100)).
922.1.3
93-----
95* Add [`UUID`](http://hackage.haskell.org/package/uuid-types/docs/Data-UUID-Types.html#t:UUID) instances (see [#81](https://github.com/GetShopTV/swagger2/pull/81)).
96* Add [`TypeError`](https://hackage.haskell.org/package/base-4.9.0.0/docs/GHC-TypeLits.html#g:4) `ToSchema` and `ToParamSchema ByteString` instances (see [#78](https://github.com/GetShopTV/swagger2/pull/78))
97* Improve documentation for generic sum type instance derivation (see [#75](https://github.com/GetShopTV/swagger2/pull/75))
98* Compile warning free (see [#82](https://github.com/GetShopTV/swagger2/pull/82))
1002.1.2.1
101-------
103* Bug fix previous release
1052.1.2
106---
108* Minor changes:
109 * Support `aeson-1.0.0.0` (see [#70](https://github.com/GetShopTV/swagger2/pull/70)).
1112.1.1
112---
114* Minor changes:
115 * Proper `Schema` examples for `Char`, `Day`, `LocalTime`, `ZonedTime` and `UTCTime`.
1172.1
118---
120* Major changes:
121 * Use `InsOrdHashMap` to preserve insertion order for endpoints and definitions (see [#56](https://github.com/GetShopTV/swagger2/pull/56));
122 * Add support for GHC 8.0 (see [#65](https://github.com/GetShopTV/swagger2/pull/65)).
1242.0.2
125---
127* Fixes:
128 * Fix `additionalProperties` to allow references;
129 * Fix `ToSchema` instances for `Map` and `HashMap` (prevent infinite recursion for recursive values).
1312.0.1
132---
134* Fixes:
135 * Re-export `Pattern` synonym from `Data.Swagger`;
136 * Documentation fixes.
1382.0
139---
141* Major changes:
142 * GHC 7.8 support (see [#49](https://github.com/GetShopTV/swagger2/pull/49));
143 * Switch to classy field lenses (see [#41](https://github.com/GetShopTV/swagger2/pull/41));
144 * Add `Data.Swagger.Schema.Validation` (see [#18](https://github.com/GetShopTV/swagger2/pull/18));
145 * Add `Data.Swagger.Operation` with helpers (see [#50](https://github.com/GetShopTV/swagger2/pull/50));
146 * Add `IsString` instances for some types (see [#47](https://github.com/GetShopTV/swagger2/pull/47));
147 * Add helpers to sketch `Schema` from JSON (see [#48](https://github.com/GetShopTV/swagger2/pull/48)).
149* Minor changes:
150 * Make `NamedSchema` a `data` rather than `type` (see [#42](https://github.com/GetShopTV/swagger2/pull/42));
151 * Change `Definitions` to `Definitions Schema`;
152 * Add schema templates for `"binary"`, `"byte"` and `"password"` formats (see [63ed597](https://github.com/GetShopTV/swagger2/commit/63ed59736dc4f942f0e2a7d668d7cee513fa9eaf));
153 * Add `Monoid` instance for `Contact`;
154 * Change `tags` to be `Set` rather than list.
156* Fixes:
157 * Fix schema for `()` and nullary constructors (see [ab65c4a](https://github.com/GetShopTV/swagger2/commit/ab65c4a48253c34f8a88221a53dc97bf5e6e8d29));
158 * Fix `Operation` `FromJSON` instance to allow missing `tags` and `parameters` properties.
1601.2.1
161---
163* Minor changes:
164 * Change `_SwaggerItemsPrimitive` type from a `Prism'` to a more restrictive `Review`-like `Optic'`.
166* Fixes:
167 * Fix build for GHC 8.0-rc1.
1691.2
170---
171* Minor changes (see [#36](https://github.com/GetShopTV/swagger2/pull/36)):
172 * Change default `ToSchema` instance for unit data types (i.e. types with one nullable constructor like `data Unit = Unit`):
173 now these types are treated like sum types with only one alternative;
174 * Add generic `ToParamSchema` instance for unit data types;
175 * Add `items: []` to schema for `()` (making it a valid schema).
177* Fixes:
178 * Do not omit `items: []` from `Schema` JSON;
179 * Do not generate unused definitions for nested `newtype`s (see [#38](https://github.com/GetShopTV/swagger2/pull/38)).
1811.1.1
182---
183* Fixes:
184 * `CollectionFormat Param` -> `CollectionFormat ParamOtherSchema`;
185 this change was necessary after putting `CollectionFormat` to `SwaggerItems`.
1871.1
188---
189* Major changes:
190 * Put `CollectionFormat` in one place (see [`3cc860d`](https://github.com/GetShopTV/swagger2/commit/3cc860dd3f002ab984f4d0e4ce1d1799f985832e)).
192* Minor changes:
193 * Use Swagger formats for `Int32`, `Int64`, `Float`, `Double`, `Day` and `ZonedTime` (see [#32](https://github.com/GetShopTV/swagger2/pull/32));
194 * Export `HeaderName`, `TagName`, `HttpStatusCode` type synonyms;
195 * Add `ToParamSchema` instances for `[a]`, `Set a` and `HashSet a`;
196 * Add `Monoid` instances for `Header` and `Example`.
198* Fixes:
199 * Use overwrite strategy for `HashMap` `SwaggerMonoid` instances by default.
2011.0
202---
203* Major changes:
204 * Add `Data` and `Typeable` instances for `Data.Swagger` types;
205 * Merge `ParamType`/`ItemsType`/`SchemaType` into `SwaggerType` GADT;
206 * Merge collection format types into `CollectionFormat` GADT;
207 * Introduce `SwaggerItems` GADT, replacing `Items` and `SchemaItems` in `ParamSchema` (see [#24](https://github.com/GetShopTV/swagger2/pull/24));
208 * Move type, format and items fields to `ParamSchema` (former `SchemaComon`);
209 * Prepend reference path automatically (see [commit 49d1fad](https://github.com/GetShopTV/swagger2/commit/49d1fadd2100644e70c442667180d0d73e107a5f))
210 and thus remove `"#/definitions/"` from user code, leaving much clearer `Reference "Name"`;
211 * Change `Data.Swagger.Schema` (see [#19](https://github.com/GetShopTV/swagger2/pull/19)):
212 * Change the only method of `ToSchema` to `declareNamedSchema` which should produce a `NamedSchema`
213 along with a list of schema definitions used to produce it;
214 * Add `declareSchema`, `declareSchemaRef`;
215 * Replace `genericTo*` helpers with `genericDeclare*` helpers;
216 * Add `paramSchemaTo[Named]Schema` helpers to facilitate code reuse for primitive schemas;
217 * Add helpers for inlining `Schema` references dynamically (see [#23](https://github.com/GetShopTV/swagger2/pull/23));
218 * Add `ToParamSchema` class (see [#17](https://github.com/GetShopTV/swagger2/pull/17)) with
219 * generic default implementation and
220 * instances for some base types compliant with `http-api-data` instances;
221 * Add `Data.Swagger.Declare` module with
222 * `DeclareT` monad transformer;
223 * `MonadDeclare` type class;
224 * various helpers;
225 * Rename parameter-related types:
226 * `Parameter` -> `Param`;
227 * `ParameterSchema` -> `ParamAnySchema`;
228 * `ParameterOtherSchema` -> `ParamOtherSchema`;
229 * `ParameterLocation` -> `ParamLocation`;
230 * `SchemaCommon` -> `ParamSchema`;
231 * `parameter*` fields renamed to `param*` fields;
232 * `schemaCommon*` fields renamed to `paramSchema*` fields;
233 * `HasSchemaCommon` -> `HasParamSchema`.
235* Minor changes:
236 * Replace TH-generated JSON instances with `Generic`-based (see [#25](https://github.com/GetShopTV/swagger2/pull/25));
237 * Drop `template-haskell` dependency;
238 * Omit empty array/object properties from `toJSON` output ([#22](https://github.com/GetShopTV/swagger2/pull/22));
239 * Remove `minLength` property from schemas for `time` types;
240 * Move `SchemaOptions` to `Data.Swagger.SchemaOptions`;
241 * Remove `useReferences` from `SchemaOptions` (see [#23](https://github.com/GetShopTV/swagger2/pull/23));
242 * Place all internal submodules under `Data.Swagger.Internal`;
243 * Better documentation (see [#26](https://github.com/GetShopTV/swagger2/pull/26)).
2450.4.1
246---
247* Fixes:
248 * Use `PackageImports` for `Data.HashSet` to avoid test failure on stackage (see [#15](https://github.com/GetShopTV/swagger2/issues/15));
249 * 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));
250 * Switch to Cabal-based multi GHC Travis config.
2520.4
253---
254* Remove `Swagger`/`swagger` prefixes;
255* Add `ToSchema` type class with default generic implementation;
256* Add configurable generic `ToSchema` helpers;
257* Add `doctest` test suite;
258* Fixes:
259 * Fix `HasSchemaCommon` instance for `Schema`;
260 * Change `minimum`, `maximum` and `multipleOf` properties to be any number,
261 not necessarily an integer;
262 * Fix all warnings.
2640.3
265---
266* Fixes:
267 * Fix `SwaggerMonoid Text` instance;
268 * Wrap `Bool` in `Maybe` everywhere;
269 * These changes make all `Data.Swagger` `Monoid` instances obey monoid laws
270 (previously right identity law was broken by some instances).
2720.2
273---
274* Add `Data.Swagger.Lens`;
275* Support references;
276* Fixes:
277 * Fix `FromJSON SwaggerHost` instance;
278 * Add missing `Maybe`s for field types;
279 * Decode petstore `swagger.json` successfully.