Moduleopenapi3-3.2.5Haskell2010

Data.OpenApi.Internal.TypeShape

Synopsis

datadata TypeShape

Shape of a datatype.

familytype family ProdCombine (a :: TypeShape) (b :: TypeShape) :: TypeShape where

A combined shape for a product type.

familytype family SumCombine (a :: TypeShape) (b :: TypeShape) :: TypeShape where

A combined shape for a sum type.

familytype family TypeHasSimpleShape t (f :: Symbol) :: Constraint where

familytype family GenericHasSimpleShape (t1 :: t) (f :: Symbol) (s :: TypeShape) :: Constraint where

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.")

familytype family GenericShape (g :: Type -> Type) :: TypeShape

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.TypeShape
type GenericShape (C1 c (S1 s f)) = 'SumOfProductsDefined in openapi3-3.2.5 · Data.OpenApi.Internal.TypeShape
type GenericShape (C1 c (f :*: g)) = 'SumOfProductsDefined in openapi3-3.2.5 · Data.OpenApi.Internal.TypeShape
type GenericShape (D1 d f) = GenericShape fDefined in openapi3-3.2.5 · Data.OpenApi.Internal.TypeShape
type GenericShape (f :*: g) = ProdCombine (GenericShape f) (GenericShape g)Defined in openapi3-3.2.5 · Data.OpenApi.Internal.TypeShape
type GenericShape (f :+: g) = SumCombine (GenericShape f) (GenericShape g)Defined in openapi3-3.2.5 · Data.OpenApi.Internal.TypeShape