git.iko.soy/typeable/openapi3
on master help sign in
Add TypeError for ToParamSchema ByteString instances
commit429e8bcfefc54f474617c5a76bcd55a2c96ae8bc authorNickolay Kudasov <nickolay.kudasov@gmail.com> dateSun 4 Sep 2016, 12:11 (10 years ago) parentda4c8d8
1 file changed+22
src/Data/Swagger/Internal/ParamSchema.hs+22
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#if __GLASGOW_HASKELL__ >= 800
1316-- Generic a is redundant in ToParamSchema a default imple
1417{-# OPTIONS_GHC -Wno-redundant-constraints #-}
@@ -40,6 +43,13 @@ import Data.Swagger.Internal
4043import Data.Swagger.Lens
4144import Data.Swagger.SchemaOptions
4245
46+#if __GLASGOW_HASKELL__ < 800
47+#else
48+import qualified Data.ByteString as BS
49+import qualified Data.ByteString.Lazy as BSL
50+import GHC.TypeLits (TypeError, ErrorMessage(..))
51+#endif
52+
4353-- | Default schema for binary data (any sequence of octets).
4454binaryParamSchema :: ParamSchema t
4555binaryParamSchema = mempty
@@ -193,6 +203,18 @@ instance ToParamSchema T.Text where
193203instance ToParamSchema TL.Text where
194204 toParamSchema _ = toParamSchema (Proxy :: Proxy String)
195205
206+#if __GLASGOW_HASKELL__ < 800
207+#else
208+type family ToParamSchemaByteStringError bs where
209+ ToParamSchemaByteStringError bs = TypeError
210+ ( Text "Impossible to have an instance " :<>: ShowType (ToParamSchema bs) :<>: Text "."
211+ :$$: Text "Please, use a newtype wrapper around " :<>: ShowType bs :<>: Text " instead."
212+ :$$: Text "Consider using byteParamSchema or binaryParamSchema templates." )
213+
214+instance ToParamSchemaByteStringError BS.ByteString => ToParamSchema BS.ByteString where toParamSchema = error "impossible"
215+instance ToParamSchemaByteStringError BSL.ByteString => ToParamSchema BSL.ByteString where toParamSchema = error "impossible"
216+#endif
217+
196218instance ToParamSchema All where toParamSchema _ = toParamSchema (Proxy :: Proxy Bool)
197219instance ToParamSchema Any where toParamSchema _ = toParamSchema (Proxy :: Proxy Bool)
198220instance ToParamSchema a => ToParamSchema (Sum a) where toParamSchema _ = toParamSchema (Proxy :: Proxy a)