git.iko.soy/typeable/openapi3
on 3.0.0.1 help sign in
typeable/openapi3/CHANGELOG.md
320 lines 14 kB history raw
12.6.1
2-----
4- More GHC-8.10 related cleanup, tighten lower bound on some dependencies.
5 (see [#216]( https://github.com/GetShopTV/swagger2/pull/216 ));
6- Add "format" field for uint32 and uint64
7 (see [#215]( https://github.com/GetShopTV/swagger2/pull/215 ));
92.6
10---
12- GHC 8.10 support (see [#210]( https://github.com/GetShopTV/swagger2/pull/210 ));
13- Move `aeson-pretty` to other dependencies (see [#206]( https://github.com/GetShopTV/swagger2/pull/206 ));
14- Merge OAuth2 scopes (see [#151]( https://github.com/GetShopTV/swagger2/pull/151 ));
162.5
17---
19Highlights:
20- Add instance for `TimeOfDay` (see [#196]( https://github.com/GetShopTV/swagger2/pull/196 ));
21- Add support for [`optics`](https://hackage.haskell.org/package/optics) (see [#200]( https://github.com/GetShopTV/swagger2/pull/200 ));
22- Slightly better validation errors (see [#195]( https://github.com/GetShopTV/swagger2/pull/195 ));
24Fixes and minor changes:
25- Minor cleanup (see [#194]( https://github.com/GetShopTV/swagger2/pull/194 ));
26- Allow base-4.13 and other GHC-8.8 related stuff (see [#198]( https://github.com/GetShopTV/swagger2/pull/198 ));
27- Fix `stack.yaml` (see [#201]( https://github.com/GetShopTV/swagger2/pull/201 ));
292.4
30---
32- Allow hashable-1.3, semigroups-0.19, network-3.1, time-1.9, generics-sop-0.5
33- Tags aren't sorted
34 (see [#165](https://github.com/GetShopTV/swagger2/issues/165))
35- Schema type is optional
36 (see [#138](https://github.com/GetShopTV/swagger2/issues/138), [#164](https://github.com/GetShopTV/swagger2/pull/164))
37- Take concrete 'Proxy' as argument
38 (see [#180](https://github.com/GetShopTV/swagger2/pull/180))
39- GHC-8.8 preparations
412.3.1.1
42-------
44- Allow `network-3.0`
462.3.1
47-----
49- Add a quickcheck generator for aeson Values that match a swagger schema
50 (see [#162](https://github.com/GetShopTV/swagger2/pull/162))
51- Add `ToParamSchema` instance for `SetCookie`
52 (see [#173](https://github.com/GetShopTV/swagger2/pull/173))
53- Make nullary schemas valid
54 (see [#168](https://github.com/GetShopTV/swagger2/pull/168))
562.3.0.1
57-------
59- Support GHC-8.6
612.3
62---
64Major changes:
66- Add support for `additionalProperties` with `Bool` value (see [#159](https://github.com/GetShopTV/swagger2/pull/159));
67- Add `ToSchema` `Object` instance (for aeson's `Object`) (see [`d72466a`](https://github.com/GetShopTV/swagger2/commit/d72466a));
69Dependencies and CI:
71- Aeson 1.4 (see [#158](https://github.com/GetShopTV/swagger2/pull/158));
72- Update .travis.yml (see [#160](https://github.com/GetShopTV/swagger2/pull/160));
73- Allow network 2.7 (see [#155](https://github.com/GetShopTV/swagger2/pull/155));
74- Allow lens-4.17 (see [#161](https://github.com/GetShopTV/swagger2/pull/161));
762.2.2
77-----
79* Add `ToSchema Version` instance
80* Use base-compat-batteries (0.10)
81* PVP bounds
832.2.1
84-----
86* Add `Semigroup` instances
87* GHC-8.4 compatibility
88* `Schema (NonEmpty a) instance (see [#141](https://github.com/GetShopTV/swagger2/pull/141))
89* Fix optional property for unary records (see [#142](https://github.com/GetShopTV/swagger2/issues/142))
90* Add `fromAesonOptions` helper (see [#146](https://github.com/GetShopTV/swagger2/issues/139))
91* Fix non-termination when using `datatypeNameModifier` with recursive data types (see [#132](https://github.com/GetShopTV/swagger2/issues/132))
932.2
94---
96* Treat unknown properties as validation errors in `validateToJSON` (see [#126](https://github.com/GetShopTV/swagger2/pull/126));
97* Add `validateJSON` and `validateJSONWithPatternChecker` to validate JSON `Value` against `Schema` without classes (see [#126](https://github.com/GetShopTV/swagger2/pull/126));
98* Add more `Schema` helpers (see [#126](https://github.com/GetShopTV/swagger2/pull/126)):
99 * `genericNameSchema` — to give a custom schema `Generic`-based name;
100 * `genericDeclareNamedSchemaNewtype` — to derive `NamedSchema` for `newtype`s;
101 * `declareSchemaBoundedEnumKeyMapping` — to derive more specific `Schema` for maps with `Bounded` `Enum` keys;
102* Add a few tests with invalid `Schema`.
1042.1.6
105-----
107* 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));
108* Fix instance for `NominalDiffTime` (see [#121](https://github.com/GetShopTV/swagger2/pull/121));
109* Fix build for `aeson-1.2.2.0` (see [#125](https://github.com/GetShopTV/swagger2/pull/125)).
1112.1.5
112-----
114* Type error by default when deriving Generic-based instances for mixed sum types (see [#118](https://github.com/GetShopTV/swagger2/pull/118));
115* Adjust `allOf` to accept referenced schemas (see [#119](https://github.com/GetShopTV/swagger2/issues/119));
116* Add instances for `Identity` (see [#116](https://github.com/GetShopTV/swagger2/pull/116));
117* Add Gitter chat badge (see [#114](https://github.com/GetShopTV/swagger2/pull/114)).
1192.1.4.1
120-------
122* 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));
123* Documentation corrections (see [#105](https://github.com/GetShopTV/swagger2/pull/105));
124* Allow `generics-sop-0.3` (see [#102](https://github.com/GetShopTV/swagger2/pull/102));
125* Fix `ToSchema` example in docs (see [#104](https://github.com/GetShopTV/swagger2/pull/104)).
1272.1.4
128-----
130* Add `liftDeclare` (see [#100](https://github.com/GetShopTV/swagger2/pull/100));
131* Add `MonadDeclare` instances for all monad transformers (see [#100](https://github.com/GetShopTV/swagger2/pull/100)).
1332.1.3
134-----
136* 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)).
137* 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))
138* Improve documentation for generic sum type instance derivation (see [#75](https://github.com/GetShopTV/swagger2/pull/75))
139* Compile warning free (see [#82](https://github.com/GetShopTV/swagger2/pull/82))
1412.1.2.1
142-------
144* Bug fix previous release
1462.1.2
147---
149* Minor changes:
150 * Support `aeson-1.0.0.0` (see [#70](https://github.com/GetShopTV/swagger2/pull/70)).
1522.1.1
153---
155* Minor changes:
156 * Proper `Schema` examples for `Char`, `Day`, `LocalTime`, `ZonedTime` and `UTCTime`.
1582.1
159---
161* Major changes:
162 * Use `InsOrdHashMap` to preserve insertion order for endpoints and definitions (see [#56](https://github.com/GetShopTV/swagger2/pull/56));
163 * Add support for GHC 8.0 (see [#65](https://github.com/GetShopTV/swagger2/pull/65)).
1652.0.2
166---
168* Fixes:
169 * Fix `additionalProperties` to allow references;
170 * Fix `ToSchema` instances for `Map` and `HashMap` (prevent infinite recursion for recursive values).
1722.0.1
173---
175* Fixes:
176 * Re-export `Pattern` synonym from `Data.Swagger`;
177 * Documentation fixes.
1792.0
180---
182* Major changes:
183 * GHC 7.8 support (see [#49](https://github.com/GetShopTV/swagger2/pull/49));
184 * Switch to classy field lenses (see [#41](https://github.com/GetShopTV/swagger2/pull/41));
185 * Add `Data.Swagger.Schema.Validation` (see [#18](https://github.com/GetShopTV/swagger2/pull/18));
186 * Add `Data.Swagger.Operation` with helpers (see [#50](https://github.com/GetShopTV/swagger2/pull/50));
187 * Add `IsString` instances for some types (see [#47](https://github.com/GetShopTV/swagger2/pull/47));
188 * Add helpers to sketch `Schema` from JSON (see [#48](https://github.com/GetShopTV/swagger2/pull/48)).
190* Minor changes:
191 * Make `NamedSchema` a `data` rather than `type` (see [#42](https://github.com/GetShopTV/swagger2/pull/42));
192 * Change `Definitions` to `Definitions Schema`;
193 * Add schema templates for `"binary"`, `"byte"` and `"password"` formats (see [63ed597](https://github.com/GetShopTV/swagger2/commit/63ed59736dc4f942f0e2a7d668d7cee513fa9eaf));
194 * Add `Monoid` instance for `Contact`;
195 * Change `tags` to be `Set` rather than list.
197* Fixes:
198 * Fix schema for `()` and nullary constructors (see [ab65c4a](https://github.com/GetShopTV/swagger2/commit/ab65c4a48253c34f8a88221a53dc97bf5e6e8d29));
199 * Fix `Operation` `FromJSON` instance to allow missing `tags` and `parameters` properties.
2011.2.1
202---
204* Minor changes:
205 * Change `_SwaggerItemsPrimitive` type from a `Prism'` to a more restrictive `Review`-like `Optic'`.
207* Fixes:
208 * Fix build for GHC 8.0-rc1.
2101.2
211---
212* Minor changes (see [#36](https://github.com/GetShopTV/swagger2/pull/36)):
213 * Change default `ToSchema` instance for unit data types (i.e. types with one nullable constructor like `data Unit = Unit`):
214 now these types are treated like sum types with only one alternative;
215 * Add generic `ToParamSchema` instance for unit data types;
216 * Add `items: []` to schema for `()` (making it a valid schema).
218* Fixes:
219 * Do not omit `items: []` from `Schema` JSON;
220 * Do not generate unused definitions for nested `newtype`s (see [#38](https://github.com/GetShopTV/swagger2/pull/38)).
2221.1.1
223---
224* Fixes:
225 * `CollectionFormat Param` -> `CollectionFormat ParamOtherSchema`;
226 this change was necessary after putting `CollectionFormat` to `SwaggerItems`.
2281.1
229---
230* Major changes:
231 * Put `CollectionFormat` in one place (see [`3cc860d`](https://github.com/GetShopTV/swagger2/commit/3cc860dd3f002ab984f4d0e4ce1d1799f985832e)).
233* Minor changes:
234 * Use Swagger formats for `Int32`, `Int64`, `Float`, `Double`, `Day` and `ZonedTime` (see [#32](https://github.com/GetShopTV/swagger2/pull/32));
235 * Export `HeaderName`, `TagName`, `HttpStatusCode` type synonyms;
236 * Add `ToParamSchema` instances for `[a]`, `Set a` and `HashSet a`;
237 * Add `Monoid` instances for `Header` and `Example`.
239* Fixes:
240 * Use overwrite strategy for `HashMap` `SwaggerMonoid` instances by default.
2421.0
243---
244* Major changes:
245 * Add `Data` and `Typeable` instances for `Data.Swagger` types;
246 * Merge `ParamType`/`ItemsType`/`SchemaType` into `SwaggerType` GADT;
247 * Merge collection format types into `CollectionFormat` GADT;
248 * Introduce `SwaggerItems` GADT, replacing `Items` and `SchemaItems` in `ParamSchema` (see [#24](https://github.com/GetShopTV/swagger2/pull/24));
249 * Move type, format and items fields to `ParamSchema` (former `SchemaComon`);
250 * Prepend reference path automatically (see [commit 49d1fad](https://github.com/GetShopTV/swagger2/commit/49d1fadd2100644e70c442667180d0d73e107a5f))
251 and thus remove `"#/definitions/"` from user code, leaving much clearer `Reference "Name"`;
252 * Change `Data.Swagger.Schema` (see [#19](https://github.com/GetShopTV/swagger2/pull/19)):
253 * Change the only method of `ToSchema` to `declareNamedSchema` which should produce a `NamedSchema`
254 along with a list of schema definitions used to produce it;
255 * Add `declareSchema`, `declareSchemaRef`;
256 * Replace `genericTo*` helpers with `genericDeclare*` helpers;
257 * Add `paramSchemaTo[Named]Schema` helpers to facilitate code reuse for primitive schemas;
258 * Add helpers for inlining `Schema` references dynamically (see [#23](https://github.com/GetShopTV/swagger2/pull/23));
259 * Add `ToParamSchema` class (see [#17](https://github.com/GetShopTV/swagger2/pull/17)) with
260 * generic default implementation and
261 * instances for some base types compliant with `http-api-data` instances;
262 * Add `Data.Swagger.Declare` module with
263 * `DeclareT` monad transformer;
264 * `MonadDeclare` type class;
265 * various helpers;
266 * Rename parameter-related types:
267 * `Parameter` -> `Param`;
268 * `ParameterSchema` -> `ParamAnySchema`;
269 * `ParameterOtherSchema` -> `ParamOtherSchema`;
270 * `ParameterLocation` -> `ParamLocation`;
271 * `SchemaCommon` -> `ParamSchema`;
272 * `parameter*` fields renamed to `param*` fields;
273 * `schemaCommon*` fields renamed to `paramSchema*` fields;
274 * `HasSchemaCommon` -> `HasParamSchema`.
276* Minor changes:
277 * Replace TH-generated JSON instances with `Generic`-based (see [#25](https://github.com/GetShopTV/swagger2/pull/25));
278 * Drop `template-haskell` dependency;
279 * Omit empty array/object properties from `toJSON` output ([#22](https://github.com/GetShopTV/swagger2/pull/22));
280 * Remove `minLength` property from schemas for `time` types;
281 * Move `SchemaOptions` to `Data.Swagger.SchemaOptions`;
282 * Remove `useReferences` from `SchemaOptions` (see [#23](https://github.com/GetShopTV/swagger2/pull/23));
283 * Place all internal submodules under `Data.Swagger.Internal`;
284 * Better documentation (see [#26](https://github.com/GetShopTV/swagger2/pull/26)).
2860.4.1
287---
288* Fixes:
289 * Use `PackageImports` for `Data.HashSet` to avoid test failure on stackage (see [#15](https://github.com/GetShopTV/swagger2/issues/15));
290 * 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));
291 * Switch to Cabal-based multi GHC Travis config.
2930.4
294---
295* Remove `Swagger`/`swagger` prefixes;
296* Add `ToSchema` type class with default generic implementation;
297* Add configurable generic `ToSchema` helpers;
298* Add `doctest` test suite;
299* Fixes:
300 * Fix `HasSchemaCommon` instance for `Schema`;
301 * Change `minimum`, `maximum` and `multipleOf` properties to be any number,
302 not necessarily an integer;
303 * Fix all warnings.
3050.3
306---
307* Fixes:
308 * Fix `SwaggerMonoid Text` instance;
309 * Wrap `Bool` in `Maybe` everywhere;
310 * These changes make all `Data.Swagger` `Monoid` instances obey monoid laws
311 (previously right identity law was broken by some instances).
3130.2
314---
315* Add `Data.Swagger.Lens`;
316* Support references;
317* Fixes:
318 * Fix `FromJSON SwaggerHost` instance;
319 * Add missing `Maybe`s for field types;
320 * Decode petstore `swagger.json` successfully.