master...d695efe · typeable/openapi3

git.iko.soy/typeable/openapi3

on d695efe help sign in

openapi3.cabal+5−5

since splitsnapshots

unifiedsplit

@@ -66,21 +66,20 @@ library

67 build-depends:

68 mtl >=2.2.2 && <2.3

69− , text >=1.2.3.1 && <1.3

69+ , text >=1.2.3.0 && <1.3

71 -- other dependencies

72 build-depends:

73− base-compat-batteries >=0.11.1 && <0.12

73+ base-compat-batteries >=0.10.5 && <0.12

74 , aeson >=1.4.2.0 && <1.6

75 , aeson-pretty >=0.8.7 && <0.9

76 -- cookie 0.4.3 is needed by GHC 7.8 due to time>=1.4 constraint

77 , cookie >=0.4.3 && <0.5

78− , generics-sop >=0.5.1.0 && <0.6

78+ , generics-sop >=0.4.0.1 && <0.6

79 , hashable >=1.2.7.0 && <1.4

80− , http-media >=0.8.0.0 && <0.9

80+ , http-media >=0.7.1.3 && <0.9

81 , insert-ordered-containers >=0.2.3 && <0.3

82 , lens >=4.16.1 && <4.20

83− , network >=2.6.3.5 && <3.2

84 , optics-core >=0.2 && <0.4

83 , optics-core >=0.2 && <0.4

85 , optics-th >=0.2 && <0.4

84 , optics-th >=0.2 && <0.4

86 , scientific >=0.3.6.2 && <0.4

85 , scientific >=0.3.6.2 && <0.4

@@ -88,6 +87,7 @@ library

88 , uuid-types >=1.0.3 && <1.1

87 , uuid-types >=1.0.3 && <1.1

89 , vector >=0.12.0.1 && <0.13

88 , vector >=0.12.0.1 && <0.13

90 , QuickCheck >=2.10.1 && <2.15

89 , QuickCheck >=2.10.1 && <2.15

90+ , generic-arbitrary >=0.1 && <0.2

92 default-language: Haskell2010

src/Data/OpenApi.hs+3

@@ -94,6 +94,9 @@ module Data.OpenApi (

94 SecurityDefinitions(..),

95 SecurityRequirement(..),

97+ -- ** Http Scheme

98+ HttpScheme(..),

99+

97 -- *** API key

100 -- *** API key

98 ApiKeyParams(..),

101 ApiKeyParams(..),

99 ApiKeyLocation(..),

102 ApiKeyLocation(..),

src/Data/OpenApi/Internal.hs+36−5

@@ -39,8 +39,8 @@ import Data.Text.Encoding (encodeUtf8)

39import GHC.Generics (Generic)

40import Network.HTTP.Media (MediaType, mainType, parameters, parseAccept, subType, (//),

41 (/:))

42−import Network.Socket (HostName, PortNumber)

43import Text.Read (readMaybe)

42import Text.Read (readMaybe)

43+import Test.QuickCheck.Arbitrary.Generic

45import Data.HashMap.Strict.InsOrd (InsOrdHashMap)

46import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap

@@ -774,6 +774,20 @@ data Header = Header

774 , _headerSchema :: Maybe (Referenced Schema)

775 } deriving (Eq, Show, Generic, Data, Typeable)

776

777+-- | According to RFC7235

778+data HttpScheme

779+ = Basic

780+ | Bearer

781+ | Digest

782+ | HOBA

783+ | Mutual

784+ | Negotiate

785+ | OAuth

786+ | SCRAM_SHA_1

787+ | SCRAM_SHA_256

788+ | Vapid

789+ deriving (Eq, Show, Generic, Data, Typeable)

790+

777-- | The location of the API key.

791-- | The location of the API key.

778data ApiKeyLocation

792data ApiKeyLocation

779 = ApiKeyQuery

793 = ApiKeyQuery

@@ -839,7 +853,7 @@ data OAuth2Flows = OAuth2Flows

839 } deriving (Eq, Show, Generic, Data, Typeable)

853 } deriving (Eq, Show, Generic, Data, Typeable)

840

854

841data SecuritySchemeType

855data SecuritySchemeType

842− = SecuritySchemeHttp

856+ = SecuritySchemeHttp HttpScheme

843 | SecuritySchemeApiKey ApiKeyParams

857 | SecuritySchemeApiKey ApiKeyParams

844 | SecuritySchemeOAuth2 OAuth2Flows

858 | SecuritySchemeOAuth2 OAuth2Flows

845 | SecuritySchemeOpenIdConnect URL

859 | SecuritySchemeOpenIdConnect URL

@@ -1127,6 +1141,13 @@ instance ToJSON License where

1127instance ToJSON ServerVariable where

1141instance ToJSON ServerVariable where

1128 toJSON = genericToJSON (jsonPrefix "ServerVariable")

1142 toJSON = genericToJSON (jsonPrefix "ServerVariable")

1129

1143

1144+instance ToJSON HttpScheme where

1145+ toJSON scheme = case scheme of

1146+ SCRAM_SHA_1 -> "SCRAM-SHA-1"

1147+ SCRAM_SHA_256 -> "SCRAM-SHA-256"

1148+ Vapid -> "vapid"

1149+ other -> genericToJSON defaultOptions other

1150+

1130instance ToJSON ApiKeyLocation where

1151instance ToJSON ApiKeyLocation where

1131 toJSON = genericToJSON (jsonPrefix "ApiKey")

1152 toJSON = genericToJSON (jsonPrefix "ApiKey")

1132

1153

@@ -1182,6 +1203,13 @@ instance FromJSON License where

1182instance FromJSON ServerVariable where

1203instance FromJSON ServerVariable where

1183 parseJSON = genericParseJSON (jsonPrefix "ServerVariable")

1204 parseJSON = genericParseJSON (jsonPrefix "ServerVariable")

1184

1205

1206+instance FromJSON HttpScheme where

1207+ parseJSON = withText "HttpScheme" $ \txt -> case txt of

1208+ "SCRAM-SHA-1" -> pure SCRAM_SHA_1

1209+ "SCRAM-SHA-256" -> pure SCRAM_SHA_256

1210+ "vapid" -> pure Vapid

1211+ _ -> genericParseJSON defaultOptions $ String txt

1212+

1185instance FromJSON ApiKeyLocation where

1213instance FromJSON ApiKeyLocation where

1186 parseJSON = genericParseJSON (jsonPrefix "ApiKey")

1214 parseJSON = genericParseJSON (jsonPrefix "ApiKey")

1187

1215

@@ -1229,8 +1257,8 @@ instance ToJSON OAuth2Flows where

1229 toEncoding = sopSwaggerGenericToEncoding

1257 toEncoding = sopSwaggerGenericToEncoding

1230

1258

1231instance ToJSON SecuritySchemeType where

1259instance ToJSON SecuritySchemeType where

1232− toJSON SecuritySchemeHttp

1260+ toJSON (SecuritySchemeHttp scheme)

1233− = object [ "type" .= ("http" :: Text) ]

1261+ = object [ "type" .= ("http" :: Text), "scheme" .= toJSON scheme ]

1234 toJSON (SecuritySchemeApiKey params)

1262 toJSON (SecuritySchemeApiKey params)

1235 = toJSON params

1263 = toJSON params

1236 <+> object [ "type" .= ("apiKey" :: Text) ]

1264 <+> object [ "type" .= ("apiKey" :: Text) ]

@@ -1379,7 +1407,7 @@ instance FromJSON SecuritySchemeType where

1379 parseJSON js@(Object o) = do

1407 parseJSON js@(Object o) = do

1380 (t :: Text) <- o .: "type"

1408 (t :: Text) <- o .: "type"

1381 case t of

1409 case t of

1382− "http" -> pure SecuritySchemeHttp

1410+ "http" -> SecuritySchemeHttp <$> o .: "scheme"

1383 "apiKey" -> SecuritySchemeApiKey <$> parseJSON js

1411 "apiKey" -> SecuritySchemeApiKey <$> parseJSON js

1384 "oauth2" -> SecuritySchemeOAuth2 <$> (o .: "flows")

1412 "oauth2" -> SecuritySchemeOAuth2 <$> (o .: "flows")

1385 "openIdConnect" -> SecuritySchemeOpenIdConnect <$> (o .: "openIdConnectUrl")

1413 "openIdConnect" -> SecuritySchemeOpenIdConnect <$> (o .: "openIdConnectUrl")

@@ -1550,3 +1578,6 @@ instance AesonDefaultValue MimeList where defaultValue = Just mempty

1550instance AesonDefaultValue Info

1578instance AesonDefaultValue Info

1551instance AesonDefaultValue ParamLocation

1579instance AesonDefaultValue ParamLocation

1552instance AesonDefaultValue Link

1580instance AesonDefaultValue Link

1581+

1582+instance Arbitrary HttpScheme where

1583+ arbitrary = genericArbitrary

src/Data/OpenApi/Internal/AesonUtils.hs+28−3

@@ -1,3 +1,4 @@

1+{-# LANGUAGE CPP #-}

1{-# LANGUAGE DataKinds #-}

2{-# LANGUAGE DataKinds #-}

2{-# LANGUAGE FlexibleContexts #-}

3{-# LANGUAGE FlexibleContexts #-}

3{-# LANGUAGE GADTs #-}

4{-# LANGUAGE GADTs #-}

@@ -137,7 +138,15 @@ sopSwaggerGenericToJSON'

137 -> DatatypeInfo '[xs]

138 -> DatatypeInfo '[xs]

138 -> POP Maybe '[xs]

139 -> POP Maybe '[xs]

139 -> [Pair]

140 -> [Pair]

141+sopSwaggerGenericToJSON'

142+ opts

143+ (SOP (Z fields))

144+#if MIN_VERSION_generics_sop(0,5,0)

140−sopSwaggerGenericToJSON' opts (SOP (Z fields)) (ADT _ _ (Record _ fieldsInfo :* Nil) _) (POP (defs :* Nil)) =

145+ (ADT _ _ (Record _ fieldsInfo :* Nil) _)

146+#else

147+ (ADT _ _ (Record _ fieldsInfo :* Nil))

148+#endif

149+ (POP (defs :* Nil)) =

141 sopSwaggerGenericToJSON'' opts fields fieldsInfo defs

150 sopSwaggerGenericToJSON'' opts fields fieldsInfo defs

142sopSwaggerGenericToJSON' _ _ _ _ = error "sopSwaggerGenericToJSON: unsupported type"

151sopSwaggerGenericToJSON' _ _ _ _ = error "sopSwaggerGenericToJSON: unsupported type"

143

152

@@ -210,7 +219,15 @@ sopSwaggerGenericParseJSON'

210 -> DatatypeInfo '[xs]

219 -> DatatypeInfo '[xs]

211 -> POP Maybe '[xs]

220 -> POP Maybe '[xs]

212 -> Parser (SOP I '[xs])

221 -> Parser (SOP I '[xs])

213−sopSwaggerGenericParseJSON' opts obj (ADT _ _ (Record _ fieldsInfo :* Nil) _) (POP (defs :* Nil)) =

222+sopSwaggerGenericParseJSON'

223+ opts

224+ obj

225+#if MIN_VERSION_generics_sop(0,5,0)

226+ (ADT _ _ (Record _ fieldsInfo :* Nil) _)

227+#else

228+ (ADT _ _ (Record _ fieldsInfo :* Nil))

229+#endif

230+ (POP (defs :* Nil)) =

214 SOP . Z <$> sopSwaggerGenericParseJSON'' opts obj fieldsInfo defs

231 SOP . Z <$> sopSwaggerGenericParseJSON'' opts obj fieldsInfo defs

215sopSwaggerGenericParseJSON' _ _ _ _ = error "sopSwaggerGenericParseJSON: unsupported type"

232sopSwaggerGenericParseJSON' _ _ _ _ = error "sopSwaggerGenericParseJSON: unsupported type"

216

233

@@ -277,7 +294,15 @@ sopSwaggerGenericToEncoding'

277 -> DatatypeInfo '[xs]

294 -> DatatypeInfo '[xs]

278 -> POP Maybe '[xs]

295 -> POP Maybe '[xs]

279 -> Series

296 -> Series

280−sopSwaggerGenericToEncoding' opts (SOP (Z fields)) (ADT _ _ (Record _ fieldsInfo :* Nil) _) (POP (defs :* Nil)) =

297+sopSwaggerGenericToEncoding'

298+ opts

299+ (SOP (Z fields))

300+#if MIN_VERSION_generics_sop(0,5,0)

301+ (ADT _ _ (Record _ fieldsInfo :* Nil) _)

302+#else

303+ (ADT _ _ (Record _ fieldsInfo :* Nil))

304+#endif

305+ (POP (defs :* Nil)) =

281 sopSwaggerGenericToEncoding'' opts fields fieldsInfo defs

306 sopSwaggerGenericToEncoding'' opts fields fieldsInfo defs

282sopSwaggerGenericToEncoding' _ _ _ _ = error "sopSwaggerGenericToEncoding: unsupported type"

307sopSwaggerGenericToEncoding' _ _ _ _ = error "sopSwaggerGenericToEncoding: unsupported type"

283

308

test/Data/OpenApiSpec.hs+12−2

@@ -13,9 +13,11 @@ import Data.Aeson

13import Data.Aeson.QQ.Simple

14import Data.HashMap.Strict (HashMap)

15import qualified Data.HashSet.InsOrd as InsOrdHS

16+import Data.Proxy

16import Data.Text (Text)

17import Data.Text (Text)

18import Data.OpenApi

19import Data.OpenApi

20+import Data.OpenApi.Internal

19import SpecCommon

21import SpecCommon

20import Test.Hspec hiding (example)

22import Test.Hspec hiding (example)

@@ -45,6 +47,7 @@ spec = do

45 fromJSON petstoreExampleJSON `shouldSatisfy` (\x -> case x of Success (_ :: OpenApi) -> True; _ -> False)

47 fromJSON petstoreExampleJSON `shouldSatisfy` (\x -> case x of Success (_ :: OpenApi) -> True; _ -> False)

46 it "roundtrips: fmap toJSON . fromJSON" $ do

48 it "roundtrips: fmap toJSON . fromJSON" $ do

47 (toJSON :: OpenApi -> Value) <$> fromJSON petstoreExampleJSON `shouldBe` Success petstoreExampleJSON

49 (toJSON :: OpenApi -> Value) <$> fromJSON petstoreExampleJSON `shouldBe` Success petstoreExampleJSON

50+ testJsonIdempotency (Proxy :: Proxy HttpScheme)

49main :: IO ()

52main :: IO ()

50main = hspec spec

53main = hspec spec

@@ -456,7 +459,10 @@ securityDefinitionsExample = SecurityDefinitions

456 , _oAuth2Scopes =

459 , _oAuth2Scopes =

457 [ ("write:pets", "modify pets in your account")

460 [ ("write:pets", "modify pets in your account")

458 , ("read:pets", "read your pets") ] } )

461 , ("read:pets", "read your pets") ] } )

459− , _securitySchemeDescription = Nothing }) ]

462+ , _securitySchemeDescription = Nothing })

463+ , ("basic", SecurityScheme

464+ { _securitySchemeType = SecuritySchemeHttp Basic

465+ , _securitySchemeDescription = Nothing })]

460

466

461securityDefinitionsExampleJSON :: Value

467securityDefinitionsExampleJSON :: Value

462securityDefinitionsExampleJSON = [aesonQQ|

468securityDefinitionsExampleJSON = [aesonQQ|

@@ -477,7 +483,11 @@ securityDefinitionsExampleJSON = [aesonQQ|

477 "authorizationUrl": "http://swagger.io/api/oauth/dialog"

483 "authorizationUrl": "http://swagger.io/api/oauth/dialog"

478 }

484 }

479 }

485 }

480− }

486+ },

487+ "basic": {

488+ "type": "http",

489+ "scheme": "Basic"

490+ }

481}

491}

482

492

483|]

493|]

test/SpecCommon.hs+11

@@ -4,9 +4,12 @@ import Data.Aeson

4import Data.ByteString.Builder (toLazyByteString)

5import qualified Data.Foldable as F

6import qualified Data.HashMap.Strict as HashMap

7+import Data.Proxy

8+import Data.Typeable

7import qualified Data.Vector as Vector

9import qualified Data.Vector as Vector

9import Test.Hspec

11import Test.Hspec

12+import Test.QuickCheck (Arbitrary, property)

11isSubJSON :: Value -> Value -> Bool

14isSubJSON :: Value -> Value -> Bool

12isSubJSON Null _ = True

15isSubJSON Null _ = True

@@ -28,3 +31,11 @@ x <=> js = do

28 eitherDecode (encode $ toJSON x) `shouldBe` Right x

31 eitherDecode (encode $ toJSON x) `shouldBe` Right x

29 it "roundtrips with toEncoding" $ do

32 it "roundtrips with toEncoding" $ do

30 eitherDecode (toLazyByteString $ fromEncoding $ toEncoding x) `shouldBe` Right x

33 eitherDecode (toLazyByteString $ fromEncoding $ toEncoding x) `shouldBe` Right x

34+

35+testJsonIdempotency :: (Eq a, Show a, Arbitrary a, FromJSON a, ToJSON a, Typeable a, HasCallStack) =>

36+ Proxy a -> Spec

37+testJsonIdempotency px = describe (show ty) $ do

38+ it "roundtrips: decode . encode" $ property $ \x ->

39+ decode (encode x) == Just (x `asProxyTypeOf` px)

40+ where

41+ ty = typeOf $ undefined `asProxyTypeOf` px