Changelog for swagger2-2.1.3
2.1.3
- Add
UUIDinstances (see #81). - Add
TypeErrorToSchemaandToParamSchema ByteStringinstances (see #78) - Improve documentation for generic sum type instance derivation (see #75)
- Compile warning free (see #82)
2.1.2.1
- Bug fix previous release
2.1.2
- Minor changes:
- Support
aeson-1.0.0.0(see #70).
- Support
2.1.1
- Minor changes:
- Proper
Schemaexamples forChar,Day,LocalTime,ZonedTimeandUTCTime.
- Proper
2.1
- Major changes:
2.0.2
- Fixes:
- Fix
additionalPropertiesto allow references; - Fix
ToSchemainstances forMapandHashMap(prevent infinite recursion for recursive values).
- Fix
2.0.1
- Fixes:
- Re-export
Patternsynonym fromData.Swagger; - Documentation fixes.
- Re-export
2.0
-
Major changes:
-
Minor changes:
-
Fixes:
- Fix schema for
()and nullary constructors (see ab65c4a); - Fix
OperationFromJSONinstance to allow missingtagsandparametersproperties.
- Fix schema for
1.2.1
-
Minor changes:
- Change
_SwaggerItemsPrimitivetype from aPrism'to a more restrictiveReview-likeOptic'.
- Change
-
Fixes:
- Fix build for GHC 8.0-rc1.
1.2
-
Minor changes (see #36):
- Change default
ToSchemainstance for unit data types (i.e. types with one nullable constructor likedata Unit = Unit): now these types are treated like sum types with only one alternative; - Add generic
ToParamSchemainstance for unit data types; - Add
items: []to schema for()(making it a valid schema).
- Change default
-
Fixes:
- Do not omit
items: []fromSchemaJSON; - Do not generate unused definitions for nested
newtypes (see #38).
- Do not omit
1.1.1
- Fixes:
CollectionFormat Param->CollectionFormat ParamOtherSchema; this change was necessary after puttingCollectionFormattoSwaggerItems.
1.1
-
Major changes:
- Put
CollectionFormatin one place (see3cc860d).
- Put
-
Minor changes:
- Use Swagger formats for
Int32,Int64,Float,Double,DayandZonedTime(see #32); - Export
HeaderName,TagName,HttpStatusCodetype synonyms; - Add
ToParamSchemainstances for[a],Set aandHashSet a; - Add
Monoidinstances forHeaderandExample.
- Use Swagger formats for
-
Fixes:
- Use overwrite strategy for
HashMapSwaggerMonoidinstances by default.
- Use overwrite strategy for
1.0
-
Major changes:
- Add
DataandTypeableinstances forData.Swaggertypes; - Merge
ParamType/ItemsType/SchemaTypeintoSwaggerTypeGADT; - Merge collection format types into
CollectionFormatGADT; - Introduce
SwaggerItemsGADT, replacingItemsandSchemaItemsinParamSchema(see #24); - Move type, format and items fields to
ParamSchema(formerSchemaComon); - Prepend reference path automatically (see commit 49d1fad)
and thus remove
"#/definitions/"from user code, leaving much clearerReference "Name"; - Change
Data.Swagger.Schema(see #19):- Change the only method of
ToSchematodeclareNamedSchemawhich should produce aNamedSchemaalong with a list of schema definitions used to produce it; - Add
declareSchema,declareSchemaRef; - Replace
genericTo*helpers withgenericDeclare*helpers; - Add
paramSchemaTo[Named]Schemahelpers to facilitate code reuse for primitive schemas; - Add helpers for inlining
Schemareferences dynamically (see #23);
- Change the only method of
- Add
ToParamSchemaclass (see #17) with- generic default implementation and
- instances for some base types compliant with
http-api-datainstances;
- Add
Data.Swagger.Declaremodule withDeclareTmonad transformer;MonadDeclaretype class;- various helpers;
- Rename parameter-related types:
Parameter->Param;ParameterSchema->ParamAnySchema;ParameterOtherSchema->ParamOtherSchema;ParameterLocation->ParamLocation;SchemaCommon->ParamSchema;parameter*fields renamed toparam*fields;schemaCommon*fields renamed toparamSchema*fields;HasSchemaCommon->HasParamSchema.
- Add
-
Minor changes:
- Replace TH-generated JSON instances with
Generic-based (see #25); - Drop
template-haskelldependency; - Omit empty array/object properties from
toJSONoutput (#22); - Remove
minLengthproperty from schemas fortimetypes; - Move
SchemaOptionstoData.Swagger.SchemaOptions; - Remove
useReferencesfromSchemaOptions(see #23); - Place all internal submodules under
Data.Swagger.Internal; - Better documentation (see #26).
- Replace TH-generated JSON instances with
0.4.1
- Fixes:
- Use
PackageImportsforData.HashSetto avoid test failure on stackage (see #15); - Add an upper version bound for
aesondue toaeson-0.10.0.0bug (see bos/aeson#293); - Switch to Cabal-based multi GHC Travis config.
- Use
0.4
- Remove
Swagger/swaggerprefixes; - Add
ToSchematype class with default generic implementation; - Add configurable generic
ToSchemahelpers; - Add
doctesttest suite; - Fixes:
- Fix
HasSchemaCommoninstance forSchema; - Change
minimum,maximumandmultipleOfproperties to be any number, not necessarily an integer; - Fix all warnings.
- Fix
0.3
- Fixes:
- Fix
SwaggerMonoid Textinstance; - Wrap
BoolinMaybeeverywhere; - These changes make all
Data.SwaggerMonoidinstances obey monoid laws (previously right identity law was broken by some instances).
- Fix
0.2
- Add
Data.Swagger.Lens; - Support references;
- Fixes:
- Fix
FromJSON SwaggerHostinstance; - Add missing
Maybes for field types; - Decode petstore
swagger.jsonsuccessfully.
- Fix