swagger2 2.5 → 2.6

raw patch · 8 files changed

+104/−17 lines, 8 filesdep ~QuickCheckdep ~aesondep ~basePVP ok

version bump matches the API change (PVP)

Dependency ranges changed: QuickCheck, aeson, base, lens, optics-core, optics-th, template-haskell

API changes (from Hackage documentation)

Files

• CHANGELOG.md +7/−0
• src/Data/Swagger.hs +2/−1
• src/Data/Swagger/Declare.hs +0/−4
• src/Data/Swagger/Internal.hs +36/−1
• src/Data/Swagger/Internal/Schema/Validation.hs +2/−2
• src/Data/Swagger/Lens.hs +6/−0
• swagger2.cabal +8/−7
• test/Data/SwaggerSpec.hs +43/−2

@@ -1,3 +1,10 @@+2.6+---++- GHC 8.10 support (see [#210]( https://github.com/GetShopTV/swagger2/pull/210 ));+- Move `aeson-pretty` to other dependencies (see [#206]( https://github.com/GetShopTV/swagger2/pull/206 ));+- Merge OAuth2 scopes (see [#151]( https://github.com/GetShopTV/swagger2/pull/151 ));+ 2.5 --- 

@@ -89,6 +89,7 @@   SecurityScheme(..),   SecuritySchemeType(..),   SecurityRequirement(..),+  SecurityDefinitions(..),    -- *** API key   ApiKeyParams(..),@@ -279,7 +280,7 @@ -- >>> encode $ toSchema (Proxy :: Proxy Person) -- "{\"required\":[\"name\",\"age\"],\"properties\":{\"name\":{\"type\":\"string\"},\"age\":{\"type\":\"integer\"}},\"type\":\"object\"}" ----- Please note that not all valid Haskell data types will have a proper swagger schema. For example while we can derive a +-- Please note that not all valid Haskell data types will have a proper swagger schema. For example while we can derive a -- schema for basic enums like -- -- >>> data SampleEnum = ChoiceOne | ChoiceTwo deriving Generic

@@ -162,10 +162,6 @@   declare = lift . declare   look = lift look -instance MonadDeclare d m => MonadDeclare d (ListT m) where-  declare = lift . declare-  look = lift look- instance MonadDeclare d m => MonadDeclare d (MaybeT m) where   declare = lift . declare   look = lift look

@@ -117,7 +117,7 @@   , _swaggerResponses :: Definitions Response      -- | Security scheme definitions that can be used across the specification.-  , _swaggerSecurityDefinitions :: Definitions SecurityScheme+  , _swaggerSecurityDefinitions :: SecurityDefinitions      -- | A declaration of which security schemes are applied for the API as a whole.     -- The list of values describes alternative security schemes that can be used@@ -755,6 +755,22 @@   , _securitySchemeDescription :: Maybe Text   } deriving (Eq, Show, Generic, Data, Typeable) ++-- | merge scopes of two OAuth2 security schemes when their flows are identical.+-- In other case returns first security scheme+mergeSecurityScheme :: SecurityScheme -> SecurityScheme -> SecurityScheme+mergeSecurityScheme s1@(SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow1 scopes1)) desc)+                    s2@(SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow2 scopes2)) _)+  = if flow1 == flow2 then+      SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow1 (scopes1 <> scopes2))) desc+    else+      s1+mergeSecurityScheme s1 _ = s1++newtype SecurityDefinitions+  = SecurityDefinitions (Definitions SecurityScheme)+  deriving (Eq, Show, Generic, Data, Typeable)+ -- | Lists the required security schemes to execute this operation. -- The object can have multiple security schemes declared in it which are all required -- (that is, there is a logical AND between the schemes).@@ -904,6 +920,17 @@   mempty = genericMempty   mappend = (<>) +instance Semigroup SecurityScheme where+  (<>) = mergeSecurityScheme++instance Semigroup SecurityDefinitions where+  (SecurityDefinitions sd1) <> (SecurityDefinitions sd2) =+     SecurityDefinitions $ InsOrdHashMap.unionWith (<>) sd1 sd2++instance Monoid SecurityDefinitions where+  mempty = SecurityDefinitions $ InsOrdHashMap.empty+  mappend = (<>)+ -- ======================================================================= -- SwaggerMonoid helper instances -- =======================================================================@@ -918,6 +945,7 @@ instance SwaggerMonoid Response instance SwaggerMonoid ExternalDocs instance SwaggerMonoid Operation+instance SwaggerMonoid SecurityDefinitions instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)  instance SwaggerMonoid MimeList@@ -1118,6 +1146,9 @@ instance ToJSON Example where   toJSON = toJSON . Map.mapKeys show . getExample +instance ToJSON SecurityDefinitions where+  toJSON (SecurityDefinitions sd) = toJSON sd+ instance ToJSON Reference where   toJSON (Reference ref) = object [ "$ref" .= ref ] @@ -1279,6 +1310,9 @@ instance FromJSON PathItem where   parseJSON = sopSwaggerGenericParseJSON +instance FromJSON SecurityDefinitions where+  parseJSON js = SecurityDefinitions <$> parseJSON js+ instance FromJSON Reference where   parseJSON (Object o) = Reference <$> o .: "$ref"   parseJSON _ = empty@@ -1390,3 +1424,4 @@ instance AesonDefaultValue MimeList where defaultValue = Just mempty instance AesonDefaultValue Info instance AesonDefaultValue ParamLocation+instance AesonDefaultValue SecurityDefinitions where defaultValue = Just $ SecurityDefinitions mempty

@@ -22,7 +22,7 @@ -- Validate JSON values with Swagger Schema. module Data.Swagger.Internal.Schema.Validation where -import           Prelude ()+import           Prelude                             () import           Prelude.Compat  import           Control.Applicative@@ -502,7 +502,7 @@     bad -> invalid $ "expected JSON value of type " ++ showType bad  showType :: (Maybe (SwaggerType t), Value) -> String-showType (Just type_, _)     = show type_+showType (Just ty, _)        = show ty showType (Nothing, Null)     = "SwaggerNull" showType (Nothing, Bool _)   = "SwaggerBoolean" showType (Nothing, Number _) = "SwaggerNumber"

@@ -96,6 +96,12 @@ instance Ixed Operation where ix n = responses . ix n instance At   Operation where at n = responses . at n +type instance Index SecurityDefinitions = Text+type instance IxValue SecurityDefinitions = SecurityScheme++instance Ixed SecurityDefinitions where ix n = (coerced :: Lens' SecurityDefinitions (Definitions SecurityScheme)). ix n+instance At   SecurityDefinitions where at n = (coerced :: Lens' SecurityDefinitions (Definitions SecurityScheme)). at n+ instance HasParamSchema NamedSchema (ParamSchema 'SwaggerKindSchema) where paramSchema = schema.paramSchema  -- HasType instances

@@ -1,6 +1,6 @@ cabal-version:       >=1.10 name:                swagger2-version:             2.5+version:             2.6  synopsis:            Swagger 2.0 data model category:            Web, Swagger@@ -29,6 +29,7 @@    || ==8.4.4    || ==8.6.5    || ==8.8.1+   || ==8.10.1  custom-setup   setup-depends:@@ -60,11 +61,10 @@    -- GHC boot libraries   build-depends:-      base             >=4.9      && <4.14-    , aeson-pretty     >=0.8.7    && <0.9+      base             >=4.9      && <4.15     , bytestring       >=0.10.4.0 && <0.11     , containers       >=0.5.5.1  && <0.7-    , template-haskell >=2.9.0.0  && <2.16+    , template-haskell >=2.9.0.0  && <2.17     , time             >=1.4.2    && <1.10     , transformers     >=0.3.0.0  && <0.6 @@ -76,16 +76,17 @@   build-depends:       base-compat-batteries     >=0.10.4   && <0.12     , aeson                     >=1.4.2.0  && <1.5+    , aeson-pretty              >=0.8.7    && <0.9     -- cookie 0.4.3 is needed by GHC 7.8 due to time>=1.4 constraint     , cookie                    >=0.4.3    && <0.5     , generics-sop              >=0.3.2.0  && <0.6     , hashable                  >=1.2.7.0  && <1.4     , http-media                >=0.7.1.2  && <0.9     , insert-ordered-containers >=0.2.3    && <0.3-    , lens                      >=4.16.1   && <4.19+    , lens                      >=4.16.1   && <4.20     , network                   >=2.6.3.5  && <3.2-    , optics-core               >=0.2      && <0.3-    , optics-th                 >=0.2      && <0.3+    , optics-core               >=0.2      && <0.4+    , optics-th                 >=0.2      && <0.4     , scientific                >=0.3.6.2  && <0.4     , transformers-compat       >=0.3      && <0.7     , unordered-containers      >=0.2.9.0  && <0.3

@@ -43,6 +43,7 @@   describe "Parameters Definition Object" $ paramsDefinitionExample <=> paramsDefinitionExampleJSON   describe "Responses Definition Object" $ responsesDefinitionExample <=> responsesDefinitionExampleJSON   describe "Security Definitions Object" $ securityDefinitionsExample <=> securityDefinitionsExampleJSON+  describe "OAuth2 Security Definitions with merged Scope" $ oAuth2SecurityDefinitionsExample <=> oAuth2SecurityDefinitionsExampleJSON   describe "Composition Schema Example" $ compositionSchemaExample <=> compositionSchemaExampleJSON   describe "Swagger Object" $ do     context "Todo Example" $ swaggerExample <=> swaggerExampleJSON@@ -459,8 +460,8 @@ -- Responses Definition object -- ======================================================================= -securityDefinitionsExample :: HashMap Text SecurityScheme-securityDefinitionsExample =+securityDefinitionsExample :: SecurityDefinitions+securityDefinitionsExample = SecurityDefinitions   [ ("api_key", SecurityScheme       { _securitySchemeType = SecuritySchemeApiKey (ApiKeyParams "api_key" ApiKeyHeader)       , _securitySchemeDescription = Nothing })@@ -480,6 +481,46 @@     "name": "api_key",     "in": "header"   },+  "petstore_auth": {+    "type": "oauth2",+    "authorizationUrl": "http://swagger.io/api/oauth/dialog",+    "flow": "implicit",+    "scopes": {+      "write:pets": "modify pets in your account",+      "read:pets": "read your pets"+    }+  }+}+|]++oAuth2SecurityDefinitionsReadExample :: SecurityDefinitions+oAuth2SecurityDefinitionsReadExample = SecurityDefinitions+  [ ("petstore_auth", SecurityScheme+      { _securitySchemeType = SecuritySchemeOAuth2 (OAuth2Params+          { _oauth2Flow = OAuth2Implicit "http://swagger.io/api/oauth/dialog"+          , _oauth2Scopes =+              [ ("read:pets", "read your pets") ] } )+      , _securitySchemeDescription = Nothing })+  ]++oAuth2SecurityDefinitionsWriteExample :: SecurityDefinitions+oAuth2SecurityDefinitionsWriteExample = SecurityDefinitions+  [ ("petstore_auth", SecurityScheme+      { _securitySchemeType = SecuritySchemeOAuth2 (OAuth2Params+          { _oauth2Flow = OAuth2Implicit "http://swagger.io/api/oauth/dialog"+          , _oauth2Scopes =+              [ ("write:pets", "modify pets in your account") ] } )+      , _securitySchemeDescription = Nothing })+  ]++oAuth2SecurityDefinitionsExample :: SecurityDefinitions+oAuth2SecurityDefinitionsExample =+  oAuth2SecurityDefinitionsWriteExample <>+  oAuth2SecurityDefinitionsReadExample++oAuth2SecurityDefinitionsExampleJSON :: Value+oAuth2SecurityDefinitionsExampleJSON = [aesonQQ|+{   "petstore_auth": {     "type": "oauth2",     "authorizationUrl": "http://swagger.io/api/oauth/dialog",