Releases: GetShopTV/swagger2
Releases · GetShopTV/swagger2
v2.1.1
v2.1
v2.0.2
v2.0.1
v2.0
- Major changes:
- Minor changes:
- Fixes:
- Fix schema for
()
and nullary constructors (see ab65c4a); - Fix
Operation
FromJSON
instance to allow missingtags
andparameters
properties.
- Fix schema for
v1.2.1
v1.2
- Minor changes (see #36):
- Change default
ToSchema
instance 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
ToParamSchema
instance for unit data types; - Add
items: []
to schema for()
(making it a valid schema).
- Change default
- Fixes:
- Do not omit
items: []
fromSchema
JSON; - Do not generate unused definitions for nested
newtype
s (see #38).
- Do not omit
v1.1.1
v1.1
- Major changes:
- Put
CollectionFormat
in one place (see3cc860d
).
- Put
- Minor changes:
- Use Swagger formats for
Int32
,Int64
,Float
,Double
,Day
andZonedTime
(see #32); - Export
HeaderName
,TagName
,HttpStatusCode
type synonyms; - Add
ToParamSchema
instances for[a]
,Set a
andHashSet a
; - Add
Monoid
instances forHeader
andExample
.
- Use Swagger formats for
- Fixes:
- Use overwrite strategy for
HashMap
SwaggerMonoid
instances by default.
- Use overwrite strategy for
v1.0
- Major changes:
- Add
Data
andTypeable
instances forData.Swagger
types; - Merge
ParamType
/ItemsType
/SchemaType
intoSwaggerType
GADT; - Merge collection format types into
CollectionFormat
GADT; - Introduce
SwaggerItems
GADT, replacingItems
andSchemaItems
inParamSchema
(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
ToSchema
todeclareNamedSchema
which should produce aNamedSchema
along with a list of schema definitions used to produce it; - Add
declareSchema
,declareSchemaRef
; - Replace
genericTo*
helpers withgenericDeclare*
helpers; - Add
paramSchemaTo[Named]Schema
helpers to facilitate code reuse for primitive schemas; - Add helpers for inlining
Schema
references dynamically (see #23);
- Change the only method of
- Add
ToParamSchema
class (see #17) with- generic default implementation and
- instances for some base types compliant with
http-api-data
instances;
- Add
Data.Swagger.Declare
module withDeclareT
monad transformer;MonadDeclare
type 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-haskell
dependency; - Omit empty array/object properties from
toJSON
output (#22); - Remove
minLength
property from schemas fortime
types; - Move
SchemaOptions
toData.Swagger.SchemaOptions
; - Remove
useReferences
fromSchemaOptions
(see #23); - Place all internal submodules under
Data.Swagger.Internal
; - Better documentation (see #26).
- Replace TH-generated JSON instances with