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