Shape of a datatype.
Constructors
EnumerationA simple enumeration.
SumOfProductsA product or a sum of non-unit products.
MixedMixed sum type with both unit and non-unit constructors.
Moduleopenapi3-3.2.5Haskell2010
Data.OpenApi.Internal.TypeShape
- 1 type
- Packageopenapi3-3.2.5
- Exports6
- LanguageHaskell2010
- LicenceBSD-3-Clause
- SourceTypeShape.hs
A combined shape for a product type.
Equations
ProdCombine 'Mixed b = 'MixedProdCombine a 'Mixed = 'MixedProdCombine a b = 'SumOfProducts
A combined shape for a sum type.
Equations
Equations
TypeHasSimpleShape t f = GenericHasSimpleShape t f (GenericShape (Rep t))
family
type family GenericHasSimpleShape (t1 :: t) (f :: Symbol) (s :: TypeShape) :: Constraint whereEquations
GenericHasSimpleShape t2 f 'Enumeration = ()GenericHasSimpleShape t2 f 'SumOfProducts = ()GenericHasSimpleShape t2 f 'Mixed = TypeError (((((('Text"Cannot derive Generic-based Swagger Schema for "
':<>: 'ShowType t2) ':$$: ('ShowType t2 ':<>: 'Text" is a mixed sum type (has both unit and non-unit constructors)."
)) ':$$: 'Text"Swagger does not have a good representation for these types."
) ':$$: (('Text"Use "
':<>: 'Text f) ':<>: 'Text" if you want to derive schema"
)) ':$$: 'Text"that matches aeson's Generic-based toJSON,"
) ':$$: 'Text"but that's not supported by some Swagger tools."
)
Infer a TypeShape for a generic representation of a type.
Instances6GenericShape
type GenericShape (C1 c U1) = 'EnumerationDefined in openapi3-3.2.5 · Data.OpenApi.Internal.TypeShapetype GenericShape (C1 c (S1 s f)) = 'SumOfProductsDefined in openapi3-3.2.5 · Data.OpenApi.Internal.TypeShapetype GenericShape (C1 c (f :*: g)) = 'SumOfProductsDefined in openapi3-3.2.5 · Data.OpenApi.Internal.TypeShapetype GenericShape (D1 d f) = GenericShape fDefined in openapi3-3.2.5 · Data.OpenApi.Internal.TypeShapetype GenericShape (f :*: g) = ProdCombine (GenericShape f) (GenericShape g)Defined in openapi3-3.2.5 · Data.OpenApi.Internal.TypeShapetype GenericShape (f :+: g) = SumCombine (GenericShape f) (GenericShape g)Defined in openapi3-3.2.5 · Data.OpenApi.Internal.TypeShape