git.iko.soy/typeable/swagger2
on master help sign in
Add TypeError for ToParamSchema ByteString instances
commit9fa029ed584431bc452b02a586c2eb8efa07e523 authorNickolay Kudasov <nickolay.kudasov@gmail.com> dateSun 4 Sep 2016, 12:11 (10 years ago) parent91de35c
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#include "overlapping-compat.h"
1316module Data.Swagger.Internal.ParamSchema where
1417
@@ -35,6 +38,13 @@ import Data.Swagger.Internal
3538import Data.Swagger.Lens
3639import Data.Swagger.SchemaOptions
3740
41+#if __GLASGOW_HASKELL__ < 800
42+#else
43+import qualified Data.ByteString as BS
44+import qualified Data.ByteString.Lazy as BSL
45+import GHC.TypeLits (TypeError, ErrorMessage(..))
46+#endif
47+
3848-- | Default schema for binary data (any sequence of octets).
3949binaryParamSchema :: ParamSchema t
4050binaryParamSchema = mempty
@@ -188,6 +198,18 @@ instance ToParamSchema T.Text where
188198instance ToParamSchema TL.Text where
189199 toParamSchema _ = toParamSchema (Proxy :: Proxy String)
190200
201+#if __GLASGOW_HASKELL__ < 800
202+#else
203+type family ToParamSchemaByteStringError bs where
204+ ToParamSchemaByteStringError bs = TypeError
205+ ( Text "Impossible to have an instance " :<>: ShowType (ToParamSchema bs) :<>: Text "."
206+ :$$: Text "Please, use a newtype wrapper around " :<>: ShowType bs :<>: Text " instead."
207+ :$$: Text "Consider using byteParamSchema or binaryParamSchema templates." )
208+
209+instance ToParamSchemaByteStringError BS.ByteString => ToParamSchema BS.ByteString where toParamSchema = error "impossible"
210+instance ToParamSchemaByteStringError BSL.ByteString => ToParamSchema BSL.ByteString where toParamSchema = error "impossible"
211+#endif
212+
191213instance ToParamSchema All where toParamSchema _ = toParamSchema (Proxy :: Proxy Bool)
192214instance ToParamSchema Any where toParamSchema _ = toParamSchema (Proxy :: Proxy Bool)
193215instance ToParamSchema a => ToParamSchema (Sum a) where toParamSchema _ = toParamSchema (Proxy :: Proxy a)