master...d256763 · typeable/swagger2

git.iko.soy/typeable/swagger2

on d256763 help sign in

3 files changed+43

since splitsnapshots

unifiedsplit

src/Data/Swagger/Internal/ParamSchema.hs+22 src/Data/Swagger/Internal/Schema.hs+20 swagger2.cabal+1

src/Data/Swagger/Internal/ParamSchema.hs+22

@@ -1,4 +1,5 @@

11{-# LANGUAGE CPP #-}

2+{-# LANGUAGE DataKinds #-}

23{-# LANGUAGE DefaultSignatures #-}

34{-# LANGUAGE FlexibleContexts #-}

45{-# LANGUAGE FlexibleInstances #-}

@@ -7,8 +8,10 @@

78{-# LANGUAGE PackageImports #-}

89{-# LANGUAGE PolyKinds #-}

910{-# LANGUAGE ScopedTypeVariables #-}

11+{-# LANGUAGE TypeFamilies #-}

1012{-# LANGUAGE TypeOperators #-}

1113{-# LANGUAGE TypeSynonymInstances #-}

14+{-# LANGUAGE UndecidableInstances #-}

1215#include "overlapping-compat.h"

1316module Data.Swagger.Internal.ParamSchema where

1417

@@ -36,6 +39,13 @@ import Data.Swagger.Internal

3639import Data.Swagger.Lens

3740import Data.Swagger.SchemaOptions

3841

42+#if __GLASGOW_HASKELL__ < 800

43+#else

44+import qualified Data.ByteString as BS

45+import qualified Data.ByteString.Lazy as BSL

46+import GHC.TypeLits (TypeError, ErrorMessage(..))

47+#endif

48+

3949-- | Default schema for binary data (any sequence of octets).

4050binaryParamSchema :: ParamSchema t

4151binaryParamSchema = mempty

@@ -189,6 +199,18 @@ instance ToParamSchema T.Text where

189199instance ToParamSchema TL.Text where

190200 toParamSchema _ = toParamSchema (Proxy :: Proxy String)

191201

202+#if __GLASGOW_HASKELL__ < 800

203+#else

204+type family ToParamSchemaByteStringError bs where

205+ ToParamSchemaByteStringError bs = TypeError

206+ ( Text "Impossible to have an instance " :<>: ShowType (ToParamSchema bs) :<>: Text "."

207+ :$$: Text "Please, use a newtype wrapper around " :<>: ShowType bs :<>: Text " instead."

208+ :$$: Text "Consider using byteParamSchema or binaryParamSchema templates." )

209+

210+instance ToParamSchemaByteStringError BS.ByteString => ToParamSchema BS.ByteString where toParamSchema = error "impossible"

211+instance ToParamSchemaByteStringError BSL.ByteString => ToParamSchema BSL.ByteString where toParamSchema = error "impossible"

212+#endif

213+

192214instance ToParamSchema All where toParamSchema _ = toParamSchema (Proxy :: Proxy Bool)

193215instance ToParamSchema Any where toParamSchema _ = toParamSchema (Proxy :: Proxy Bool)

194216instance ToParamSchema a => ToParamSchema (Sum a) where toParamSchema _ = toParamSchema (Proxy :: Proxy a)

src/Data/Swagger/Internal/Schema.hs+20

@@ -13,6 +13,7 @@

1313{-# LANGUAGE TypeFamilies #-}

1414{-# LANGUAGE TypeOperators #-}

1515{-# LANGUAGE TypeSynonymInstances #-}

16+{-# LANGUAGE UndecidableInstances #-}

1617#include "overlapping-compat.h"

1718module Data.Swagger.Internal.Schema where

1819

@@ -66,6 +67,13 @@ import Data.Swagger.SchemaOptions

6667import Data.Swagger.Lens (name, schema)

6768#endif

6869

70+#if __GLASGOW_HASKELL__ < 800

71+#else

72+import qualified Data.ByteString as BS

73+import qualified Data.ByteString.Lazy as BSL

74+import GHC.TypeLits (TypeError, ErrorMessage(..))

75+#endif

76+

6977unnamed :: Schema -> NamedSchema

7078unnamed schema = NamedSchema Nothing schema

7179

@@ -481,6 +489,18 @@ instance ToSchema UTCTime where

481489instance ToSchema T.Text where declareNamedSchema = plain . paramSchemaToSchema

482490instance ToSchema TL.Text where declareNamedSchema = plain . paramSchemaToSchema

483491

492+#if __GLASGOW_HASKELL__ < 800

493+#else

494+type family ToSchemaByteStringError bs where

495+ ToSchemaByteStringError bs = TypeError

496+ ( Text "Impossible to have an instance " :<>: ShowType (ToSchema bs) :<>: Text "."

497+ :$$: Text "Please, use a newtype wrapper around " :<>: ShowType bs :<>: Text " instead."

498+ :$$: Text "Consider using byteSchema or binarySchema templates." )

499+

500+instance ToSchemaByteStringError BS.ByteString => ToSchema BS.ByteString where declareNamedSchema = error "impossible"

501+instance ToSchemaByteStringError BSL.ByteString => ToSchema BSL.ByteString where declareNamedSchema = error "impossible"

502+#endif

503+

484504instance ToSchema IntSet where declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy (Set Int))

485505

486506-- | NOTE: This schema does not account for the uniqueness of keys.

swagger2.cabal+1

@@ -42,6 +42,7 @@ library

4242 build-depends: base >=4.7 && <4.10

4343 , base-compat >=0.6.0 && <0.10

4444 , aeson

45+ , bytestring

4546 , containers

4647 , hashable

4748 , generics-sop >=0.2 && <0.3