-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Derive swagger instances from highjson specs
--   
--   Derive swagger instances from highjson specs
@package highjson-swagger
@version 0.4.0.0

module Data.HighJson.Swagger

-- | Automatically generate a <a>NamedSchema</a> from a <a>HighSpec</a>
makeDeclareNamedSchema :: (AllHave ToSchema ts, AllHave ToJSON ts, IsValidSwaggerType ty ts) => HighSpec k ty ts -> f k -> DeclM NamedSchema

-- | Automatically generate a <a>NamedSchema</a> from a <a>HighSpec</a>
--   while optionally providing an example value
makeDeclareNamedSchema' :: (AllHave ToSchema ts, AllHave ToJSON ts, IsValidSwaggerType ty ts) => HighSpec k ty ts -> Maybe k -> f k -> DeclM NamedSchema
type DeclM = Declare (Definitions Schema)

-- | Not all valid Haskell types have a valid swagger mapping. Simple
--   records are fine, but sum types should be either "real" Enums or every
--   option must contain a value. For more information see the swagger2
--   haskell package.
