a30c324 · typeable/openapi3

README.md+2−2

compare with master

unifiedsplit

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

1−# swagger2

1+# OpenApi 3

2

3[![Hackage](https://img.shields.io/hackage/v/openapi3.svg)](http://hackage.haskell.org/package/openapi3)

4[![Build Status](https://travis-ci.org/biocad/openapi3.svg?branch=master)](https://travis-ci.org/biocad/openapi3)

@@ -14,7 +14,7 @@ https://github.com/GetShopTV/swagger2.

14

15## Usage

16

17−This library is intended to be used for decoding and encoding Swagger 2.0 API specifications as well as manipulating them.

17+This library is intended to be used for decoding and encoding OpenApi 3.0.3 specifications as well as manipulating them.

18

19Please refer to [haddock documentation](http://hackage.haskell.org/package/openapi3).

20

examples/hackage.hs+4−4

@@ -10,10 +10,10 @@ import Data.Proxy

10import Data.Text (Text)

11import GHC.Generics

12

13−import Data.Swagger

13+import Data.OpenApi

14−import Data.Swagger.Declare

14+import Data.OpenApi.Declare

15−import Data.Swagger.Lens

15+import Data.OpenApi.Lens

16−import Data.Swagger.Operation

16+import Data.OpenApi.Operation

17

18type Username = Text

19

openapi3.cabal+24−24

@@ -3,7 +3,7 @@ name: openapi3

3version: 3.0.0

4

5synopsis: OpenAPI 3.0 data model

6−category: Web, Swagger

6+category: Web, Swagger, OpenApi

7description:

8 This library is intended to be used for decoding and encoding OpenAPI 3.0 API

9 specifications as well as manipulating them.

@@ -35,25 +35,25 @@ custom-setup

35library

36 hs-source-dirs: src

37 exposed-modules:

38− Data.Swagger

38+ Data.OpenApi

39− Data.Swagger.Declare

39+ Data.OpenApi.Declare

40− Data.Swagger.Lens

40+ Data.OpenApi.Lens

41− Data.Swagger.Operation

41+ Data.OpenApi.Operation

42− Data.Swagger.Optics

42+ Data.OpenApi.Optics

43− Data.Swagger.ParamSchema

43+ Data.OpenApi.ParamSchema

44− Data.Swagger.Schema

44+ Data.OpenApi.Schema

45− Data.Swagger.Schema.Generator

45+ Data.OpenApi.Schema.Generator

46− Data.Swagger.Schema.Validation

46+ Data.OpenApi.Schema.Validation

47− Data.Swagger.SchemaOptions

47+ Data.OpenApi.SchemaOptions

48

49 -- internal modules

50− Data.Swagger.Internal

50+ Data.OpenApi.Internal

51− Data.Swagger.Internal.Schema

51+ Data.OpenApi.Internal.Schema

52− Data.Swagger.Internal.Schema.Validation

52+ Data.OpenApi.Internal.Schema.Validation

53− Data.Swagger.Internal.ParamSchema

53+ Data.OpenApi.Internal.ParamSchema

54− Data.Swagger.Internal.Utils

54+ Data.OpenApi.Internal.Utils

55− Data.Swagger.Internal.AesonUtils

55+ Data.OpenApi.Internal.AesonUtils

56− Data.Swagger.Internal.TypeShape

56+ Data.OpenApi.Internal.TypeShape

57

58 -- GHC boot libraries

59 build-depends:

@@ -129,12 +129,12 @@ test-suite spec

129

130 other-modules:

131 SpecCommon

132− Data.SwaggerSpec

132+ Data.OpenApiSpec

133− Data.Swagger.CommonTestTypes

133+ Data.OpenApi.CommonTestTypes

134− Data.Swagger.ParamSchemaSpec

134+ Data.OpenApi.ParamSchemaSpec

135− Data.Swagger.SchemaSpec

135+ Data.OpenApi.SchemaSpec

136− Data.Swagger.Schema.ValidationSpec

136+ Data.OpenApi.Schema.ValidationSpec

137− Data.Swagger.Schema.GeneratorSpec

137+ Data.OpenApi.Schema.GeneratorSpec

138 default-language: Haskell2010

139

140test-suite doctests

src/Data/Swagger.hs → src/Data/OpenApi.hsrenamed+18−18

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

1-- |

2−-- Module: Data.Swagger

2+-- Module: Data.OpenApi

3-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>

4-- Stability: experimental

5--

@@ -9,7 +9,7 @@

9-- These files can then be used by the Swagger-UI project to display the API

10-- and Swagger-Codegen to generate clients in various languages.

11-- Additional utilities can also take advantage of the resulting files, such as testing tools.

12−module Data.Swagger (

12+module Data.OpenApi (

13 -- * How to use this library

14 -- $howto

15

@@ -29,12 +29,12 @@ module Data.Swagger (

29 -- $validation

30

31 -- * Re-exports

32− module Data.Swagger.Lens,

32+ module Data.OpenApi.Lens,

33− module Data.Swagger.Optics,

33+ module Data.OpenApi.Optics,

34− module Data.Swagger.Operation,

34+ module Data.OpenApi.Operation,

35− module Data.Swagger.ParamSchema,

35+ module Data.OpenApi.ParamSchema,

36− module Data.Swagger.Schema,

36+ module Data.OpenApi.Schema,

37− module Data.Swagger.Schema.Validation,

37+ module Data.OpenApi.Schema.Validation,

38

39 -- * Swagger specification

40 Swagger(..),

@@ -120,14 +120,14 @@ module Data.Swagger (

120 URL(..),

121) where

122

123−import Data.Swagger.Lens

123+import Data.OpenApi.Lens

124−import Data.Swagger.Optics ()

124+import Data.OpenApi.Optics ()

125−import Data.Swagger.Operation

125+import Data.OpenApi.Operation

126−import Data.Swagger.ParamSchema

126+import Data.OpenApi.ParamSchema

127−import Data.Swagger.Schema

127+import Data.OpenApi.Schema

128−import Data.Swagger.Schema.Validation

128+import Data.OpenApi.Schema.Validation

129

130−import Data.Swagger.Internal

130+import Data.OpenApi.Internal

131

132-- $setup

133-- >>> import Control.Lens

@@ -186,7 +186,7 @@ import Data.Swagger.Internal

186

187-- $lens

188--

189−-- Note: if you're working with the <https://hackage.haskell.org/package/optics optics> library, take a look at "Data.Swagger.Optics".

189+-- Note: if you're working with the <https://hackage.haskell.org/package/optics optics> library, take a look at "Data.OpenApi.Optics".

190--

191-- Since @'Swagger'@ has a fairly complex structure, lenses and prisms are used

192-- to work comfortably with it. In combination with @'Monoid'@ instances, lenses

@@ -298,10 +298,10 @@ import Data.Swagger.Internal

298-- for a type-level servant API.

299--

300-- Lenses and prisms can be used to manipulate such specification to add additional information, tags, extra responses, etc.

301−-- To facilitate common needs, @"Data.Swagger.Operation"@ module provides useful helpers.

301+-- To facilitate common needs, @"Data.OpenApi.Operation"@ module provides useful helpers.

302

303-- $validation

304-- While @'ToParamSchema'@ and @'ToSchema'@ provide means to easily obtain schemas for Haskell types,

305-- there is no static mechanism to ensure those instances correspond to the @'ToHttpApiData'@ or @'ToJSON'@ instances.

306--

307−-- @"Data.Swagger.Schema.Validation"@ addresses @'ToJSON'@/@'ToSchema'@ validation.

307+-- @"Data.OpenApi.Schema.Validation"@ addresses @'ToJSON'@/@'ToSchema'@ validation.

src/Data/Swagger/Declare.hs → src/Data/OpenApi/Declare.hsrenamed+2−2

@@ -4,12 +4,12 @@

4{-# LANGUAGE MultiParamTypeClasses #-}

5{-# LANGUAGE UndecidableInstances #-}

6-- |

7−-- Module: Data.Swagger.Declare

7+-- Module: Data.OpenApi.Declare

8-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>

9-- Stability: experimental

10--

11-- Declare monad transformer and associated functions.

12−module Data.Swagger.Declare where

12+module Data.OpenApi.Declare where

13

14import Prelude ()

15import Prelude.Compat

src/Data/Swagger/Internal.hs → src/Data/OpenApi/Internal.hsrenamed+17−18

@@ -1,6 +1,5 @@

1{-# LANGUAGE DataKinds #-}

2{-# LANGUAGE DeriveDataTypeable #-}

3−{-# LANGUAGE DeriveFunctor #-}

4{-# LANGUAGE DeriveGeneric #-}

3{-# LANGUAGE DeriveGeneric #-}

5{-# LANGUAGE DeriveTraversable #-}

4{-# LANGUAGE DeriveTraversable #-}

6{-# LANGUAGE FlexibleContexts #-}

5{-# LANGUAGE FlexibleContexts #-}

@@ -14,7 +13,7 @@

14{-# LANGUAGE TemplateHaskell #-}

13{-# LANGUAGE TemplateHaskell #-}

15{-# LANGUAGE TypeFamilies #-}

14{-# LANGUAGE TypeFamilies #-}

16{-# LANGUAGE UndecidableInstances #-}

15{-# LANGUAGE UndecidableInstances #-}

17−module Data.Swagger.Internal where

16+module Data.OpenApi.Internal where

18

17

19import Prelude ()

18import Prelude ()

20import Prelude.Compat

19import Prelude.Compat

@@ -47,7 +46,7 @@ import Data.HashMap.Strict.InsOrd (InsOrdHashMap)

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

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

48

47

49import Generics.SOP.TH (deriveGeneric)

48import Generics.SOP.TH (deriveGeneric)

50−import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToJSON

49+import Data.OpenApi.Internal.AesonUtils (sopSwaggerGenericToJSON

51 ,sopSwaggerGenericToJSONWithOpts

50 ,sopSwaggerGenericToJSONWithOpts

52 ,sopSwaggerGenericParseJSON

51 ,sopSwaggerGenericParseJSON

53 ,HasSwaggerAesonOptions(..)

52 ,HasSwaggerAesonOptions(..)

@@ -55,8 +54,8 @@ import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToJSON

55 ,mkSwaggerAesonOptions

54 ,mkSwaggerAesonOptions

56 ,saoAdditionalPairs

55 ,saoAdditionalPairs

57 ,saoSubObject)

56 ,saoSubObject)

58−import Data.Swagger.Internal.Utils

57+import Data.OpenApi.Internal.Utils

59−import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToEncoding)

58+import Data.OpenApi.Internal.AesonUtils (sopSwaggerGenericToEncoding)

60

59

61-- $setup

60-- $setup

62-- >>> :seti -XDataKinds

61-- >>> :seti -XDataKinds

@@ -433,11 +432,11 @@ mimeListConstr :: Constr

433mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix

432mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix

434

433

435mimeListDataType :: DataType

434mimeListDataType :: DataType

436−mimeListDataType = mkDataType "Data.Swagger.MimeList" [mimeListConstr]

435+mimeListDataType = mkDataType "Data.OpenApi.MimeList" [mimeListConstr]

437

436

438instance Data MimeList where

437instance Data MimeList where

439 gunfold k z c = case constrIndex c of

438 gunfold k z c = case constrIndex c of

440− 1 -> k (z (\xs -> MimeList (map fromString xs)))

439+ 1 -> k (z (MimeList . map fromString))

441 _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type MimeList."

440 _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type MimeList."

442 toConstr (MimeList _) = mimeListConstr

441 toConstr (MimeList _) = mimeListConstr

443 dataTypeOf _ = mimeListDataType

442 dataTypeOf _ = mimeListDataType

@@ -796,17 +795,17 @@ type AuthorizationURL = Text

796-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.

795-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.

797type TokenURL = Text

796type TokenURL = Text

798

797

799−data OAuth2ImplicitFlow = OAuth2ImplicitFlow

798+newtype OAuth2ImplicitFlow

800− { _oAuth2ImplicitFlowAuthorizationUrl :: AuthorizationURL

799+ = OAuth2ImplicitFlow {_oAuth2ImplicitFlowAuthorizationUrl :: AuthorizationURL}

801− } deriving (Eq, Show, Generic, Data, Typeable)

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

802

801

803−data OAuth2PasswordFlow = OAuth2PasswordFlow

802+newtype OAuth2PasswordFlow

804− { _oAuth2PasswordFlowTokenUrl :: TokenURL

803+ = OAuth2PasswordFlow {_oAuth2PasswordFlowTokenUrl :: TokenURL}

805− } deriving (Eq, Show, Generic, Data, Typeable)

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

806

805

807−data OAuth2ClientCredentialsFlow = OAuth2ClientCredentialsFlow

806+newtype OAuth2ClientCredentialsFlow

808− { _oAuth2ClientCredentialsFlowTokenUrl :: TokenURL

807+ = OAuth2ClientCredentialsFlow {_oAuth2ClientCredentialsFlowTokenUrl :: TokenURL}

809− } deriving (Eq, Show, Generic, Data, Typeable)

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

810

809

811data OAuth2AuthorizationCodeFlow = OAuth2AuthorizationCodeFlow

810data OAuth2AuthorizationCodeFlow = OAuth2AuthorizationCodeFlow

812 { _oAuth2AuthorizationCodeFlowAuthorizationUrl :: AuthorizationURL

811 { _oAuth2AuthorizationCodeFlowAuthorizationUrl :: AuthorizationURL

@@ -1420,7 +1419,7 @@ instance FromJSON Components where

1420 parseJSON = sopSwaggerGenericParseJSON

1419 parseJSON = sopSwaggerGenericParseJSON

1421

1420

1422instance FromJSON MimeList where

1421instance FromJSON MimeList where

1423− parseJSON js = (MimeList . map fromString) <$> parseJSON js

1422+ parseJSON js = MimeList . map fromString <$> parseJSON js

1424

1423

1425instance FromJSON Param where

1424instance FromJSON Param where

1426 parseJSON = sopSwaggerGenericParseJSON

1425 parseJSON = sopSwaggerGenericParseJSON

@@ -1428,7 +1427,7 @@ instance FromJSON Param where

1428instance FromJSON Responses where

1427instance FromJSON Responses where

1429 parseJSON (Object o) = Responses

1428 parseJSON (Object o) = Responses

1430 <$> o .:? "default"

1429 <$> o .:? "default"

1431− <*> (parseJSON (Object (HashMap.delete "default" o)))

1430+ <*> parseJSON (Object (HashMap.delete "default" o))

1432 parseJSON _ = empty

1431 parseJSON _ = empty

1433

1432

1434instance FromJSON Example where

1433instance FromJSON Example where

src/Data/Swagger/Internal/AesonUtils.hs → src/Data/OpenApi/Internal/AesonUtils.hsrenamed+2−4

@@ -5,7 +5,7 @@

5{-# LANGUAGE ExplicitForAll #-}

6{-# LANGUAGE TemplateHaskell #-}

7{-# LANGUAGE UndecidableSuperClasses #-}

8−module Data.Swagger.Internal.AesonUtils (

8+module Data.OpenApi.Internal.AesonUtils (

9 -- * Generic functions

10 AesonDefaultValue(..),

11 sopSwaggerGenericToJSON,

@@ -27,7 +27,7 @@ import Prelude.Compat

27import Control.Applicative ((<|>))

28import Control.Lens (makeLenses, (^.))

29import Control.Monad (unless)

30−import Data.Aeson (ToJSON(..), FromJSON(..), Value(..), Object, object, (.:), (.:?), (.!=), withObject)

30+import Data.Aeson (ToJSON(..), FromJSON(..), Value(..), Object, object, (.:), (.:?), (.!=), withObject, Encoding, pairs, (.=), Series)

31import Data.Aeson.Types (Parser, Pair)

32import Data.Char (toLower, isUpper)

33import Data.Foldable (traverse_)

@@ -41,8 +41,6 @@ import qualified Data.Set as Set

41import qualified Data.HashMap.Strict.InsOrd as InsOrd

42import qualified Data.HashSet.InsOrd as InsOrdHS

43

44−import Data.Aeson (Encoding, pairs, (.=), Series)

45−

46-------------------------------------------------------------------------------

44-------------------------------------------------------------------------------

47-- SwaggerAesonOptions

45-- SwaggerAesonOptions

48-------------------------------------------------------------------------------

46-------------------------------------------------------------------------------

src/Data/Swagger/Internal/ParamSchema.hs → src/Data/OpenApi/Internal/ParamSchema.hsrenamed+4−4

@@ -15,7 +15,7 @@

15{-# OPTIONS_GHC -Wno-redundant-constraints #-}

16-- For TypeErrors

17{-# OPTIONS_GHC -Wno-unticked-promoted-constructors #-}

18−module Data.Swagger.Internal.ParamSchema where

18+module Data.OpenApi.Internal.ParamSchema where

19

20import Control.Lens

21import Data.Aeson (ToJSON (..))

@@ -41,9 +41,9 @@ import Data.Word

41import Data.UUID.Types (UUID)

42import Web.Cookie (SetCookie)

43

44−import Data.Swagger.Internal

44+import Data.OpenApi.Internal

45−import Data.Swagger.Lens

45+import Data.OpenApi.Lens

46−import Data.Swagger.SchemaOptions

46+import Data.OpenApi.SchemaOptions

47

48import qualified Data.ByteString as BS

49import qualified Data.ByteString.Lazy as BSL

src/Data/Swagger/Internal/Schema.hs → src/Data/OpenApi/Internal/Schema.hsrenamed+10−10

@@ -17,7 +17,7 @@

17{-# OPTIONS_GHC -Wno-redundant-constraints #-}

18-- For TypeErrors

19{-# OPTIONS_GHC -Wno-unticked-promoted-constructors #-}

20−module Data.Swagger.Internal.Schema where

20+module Data.OpenApi.Internal.Schema where

21

22import Prelude ()

23import Prelude.Compat

@@ -60,13 +60,13 @@ import Data.Word

60import GHC.Generics

61import qualified Data.UUID.Types as UUID

62

63−import Data.Swagger.Declare

63+import Data.OpenApi.Declare

64−import Data.Swagger.Internal

64+import Data.OpenApi.Internal

65−import Data.Swagger.Internal.ParamSchema (ToParamSchema(..))

65+import Data.OpenApi.Internal.ParamSchema (ToParamSchema(..))

66−import Data.Swagger.Lens hiding (name, schema)

66+import Data.OpenApi.Lens hiding (name, schema)

67−import qualified Data.Swagger.Lens as Swagger

67+import qualified Data.OpenApi.Lens as Swagger

68−import Data.Swagger.SchemaOptions

68+import Data.OpenApi.SchemaOptions

69−import Data.Swagger.Internal.TypeShape

69+import Data.OpenApi.Internal.TypeShape

70

71import qualified Data.ByteString as BS

72import qualified Data.ByteString.Lazy.Char8 as BSL

@@ -97,7 +97,7 @@ rename name (NamedSchema _ schema) = NamedSchema name schema

97--

98-- import Control.Lens

99-- import Data.Proxy

100−-- import Data.Swagger

100+-- import Data.OpenApi

101--

102-- data Coord = Coord { x :: Double, y :: Double }

103--

@@ -859,6 +859,6 @@ data Proxy2 a b = Proxy2

859data Proxy3 a b c = Proxy3

860

861-- $setup

862−-- >>> import Data.Swagger

862+-- >>> import Data.OpenApi

863-- >>> import Data.Aeson (encode)

864-- >>> import Data.Aeson.Types (toJSONKeyText)

src/Data/Swagger/Internal/Schema/Validation.hs → src/Data/OpenApi/Internal/Schema/Validation.hsrenamed+6−6

@@ -14,14 +14,14 @@

14{-# LANGUAGE UndecidableInstances #-}

15{-# LANGUAGE ViewPatterns #-}

16-- |

17−-- Module: Data.Swagger.Internal.Schema.Validation

17+-- Module: Data.OpenApi.Internal.Schema.Validation

19-- License: BSD3

20-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>

21-- Stability: experimental

22--

23-- Validate JSON values with Swagger Schema.

24−module Data.Swagger.Internal.Schema.Validation where

24+module Data.OpenApi.Internal.Schema.Validation where

25

26import Prelude ()

27import Prelude.Compat

@@ -48,10 +48,10 @@ import qualified Data.Text.Lazy.Encoding as TL

48import Data.Vector (Vector)

49import qualified Data.Vector as Vector

50

51−import Data.Swagger.Declare

51+import Data.OpenApi.Declare

52−import Data.Swagger.Internal

52+import Data.OpenApi.Internal

53−import Data.Swagger.Internal.Schema

53+import Data.OpenApi.Internal.Schema

54−import Data.Swagger.Lens

54+import Data.OpenApi.Lens

55

56-- | Validate @'ToJSON'@ instance matches @'ToSchema'@ for a given value.

57-- This can be used with QuickCheck to ensure those instances are coherent:

src/Data/Swagger/Internal/TypeShape.hs → src/Data/OpenApi/Internal/TypeShape.hsrenamed+1−1

@@ -4,7 +4,7 @@

4{-# LANGUAGE TypeOperators #-}

5{-# LANGUAGE UndecidableInstances #-}

6

7−module Data.Swagger.Internal.TypeShape where

7+module Data.OpenApi.Internal.TypeShape where

8

9import Data.Proxy

10import GHC.Generics

src/Data/Swagger/Internal/Utils.hs → src/Data/OpenApi/Internal/Utils.hsrenamed+1−1

@@ -4,7 +4,7 @@

4{-# LANGUAGE OverloadedStrings #-}

5{-# LANGUAGE RankNTypes #-}

6{-# LANGUAGE TypeOperators #-}

7−module Data.Swagger.Internal.Utils where

7+module Data.OpenApi.Internal.Utils where

8

9import Prelude ()

10import Prelude.Compat

src/Data/Swagger/Lens.hs → src/Data/OpenApi/Lens.hsrenamed+4−4

@@ -10,18 +10,18 @@

10{-# LANGUAGE UndecidableInstances #-}

11{-# OPTIONS_GHC -fno-warn-orphans #-}

12-- |

13−-- Module: Data.Swagger.Lens

13+-- Module: Data.OpenApi.Lens

14-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>

15-- Stability: experimental

16--

17-- Lenses and prisms for Swagger.

18−module Data.Swagger.Lens where

18+module Data.OpenApi.Lens where

19

20import Control.Lens

21import Data.Aeson (Value)

22import Data.Scientific (Scientific)

23−import Data.Swagger.Internal

23+import Data.OpenApi.Internal

24−import Data.Swagger.Internal.Utils

24+import Data.OpenApi.Internal.Utils

25import Data.Text (Text)

26

27-- * Classy lenses

src/Data/Swagger/Operation.hs → src/Data/OpenApi/Operation.hsrenamed+6−6

@@ -1,13 +1,13 @@

1{-# LANGUAGE RankNTypes #-}

2-- |

3−-- Module: Data.Swagger.Operation

3+-- Module: Data.OpenApi.Operation

4-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>

5-- Stability: experimental

6--

7-- Helper traversals and functions for Swagger operations manipulations.

8-- These might be useful when you already have Swagger specification

9-- generated by something else.

10−module Data.Swagger.Operation (

10+module Data.OpenApi.Operation (

11 -- * Operation traversals

12 allOperations,

13 operationsOf,

@@ -42,10 +42,10 @@ import qualified Data.Set as Set

42import Data.Text (Text)

43import Network.HTTP.Media (MediaType)

44

45−import Data.Swagger.Declare

45+import Data.OpenApi.Declare

46−import Data.Swagger.Internal

46+import Data.OpenApi.Internal

47−import Data.Swagger.Lens

47+import Data.OpenApi.Lens

48−import Data.Swagger.Schema

48+import Data.OpenApi.Schema

49

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

51import qualified Data.HashSet.InsOrd as InsOrdHS

src/Data/Swagger/Optics.hs → src/Data/OpenApi/Optics.hsrenamed+4−4

@@ -7,7 +7,7 @@

7{-# LANGUAGE UndecidableInstances #-}

8{-# OPTIONS_GHC -fno-warn-orphans #-}

9-- |

10−-- Module: Data.Swagger.Optics

10+-- Module: Data.OpenApi.Optics

11-- Maintainer: Andrzej Rybczak <andrzej@rybczak.net>

12-- Stability: experimental

13--

@@ -19,7 +19,7 @@

19-- >>> :set -XOverloadedLabels

20-- >>> import qualified Data.ByteString.Lazy.Char8 as BSL

21--

22−-- Example from the "Data.Swagger" module using @optics@:

22+-- Example from the "Data.OpenApi" module using @optics@:

23--

24-- >>> :{

25-- BSL.putStrLn $ encode $ (mempty :: Swagger)

@@ -54,11 +54,11 @@

54-- :}

55-- {"responses":{"404":{"description":"Not found"}}}

56--

57−module Data.Swagger.Optics () where

57+module Data.OpenApi.Optics () where

58

59import Data.Aeson (Value)

60import Data.Scientific (Scientific)

61−import Data.Swagger.Internal

61+import Data.OpenApi.Internal

62import Data.Text (Text)

63import Optics.Core

64import Optics.TH

src/Data/Swagger/ParamSchema.hs → src/Data/OpenApi/ParamSchema.hsrenamed+4−4

@@ -1,10 +1,10 @@

1-- |

2−-- Module: Data.Swagger.ParamSchema

2+-- Module: Data.OpenApi.ParamSchema

3-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>

4-- Stability: experimental

5--

6-- Types and functions for working with Swagger parameter schema.

7−module Data.Swagger.ParamSchema (

7+module Data.OpenApi.ParamSchema (

8 -- * Encoding

9 ToParamSchema(..),

10

@@ -22,5 +22,5 @@ module Data.Swagger.ParamSchema (

22 defaultSchemaOptions,

23) where

24

25−import Data.Swagger.Internal.ParamSchema

25+import Data.OpenApi.Internal.ParamSchema

26−import Data.Swagger.SchemaOptions

26+import Data.OpenApi.SchemaOptions

src/Data/Swagger/Schema.hs → src/Data/OpenApi/Schema.hsrenamed+4−4

@@ -1,10 +1,10 @@

1-- |

2−-- Module: Data.Swagger.Schema

2+-- Module: Data.OpenApi.Schema

3-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>

4-- Stability: experimental

5--

6-- Types and functions for working with Swagger schema.

7−module Data.Swagger.Schema (

7+module Data.OpenApi.Schema (

8 -- * Encoding

9 ToSchema(..),

10 declareSchema,

@@ -48,5 +48,5 @@ module Data.Swagger.Schema (

48 fromAesonOptions,

49) where

50

51−import Data.Swagger.Internal.Schema

51+import Data.OpenApi.Internal.Schema

52−import Data.Swagger.SchemaOptions

52+import Data.OpenApi.SchemaOptions

src/Data/Swagger/Schema/Generator.hs → src/Data/OpenApi/Schema/Generator.hsrenamed+4−4

@@ -2,7 +2,7 @@

2{-# LANGUAGE OverloadedLists #-}

3{-# LANGUAGE ScopedTypeVariables #-}

4

5−module Data.Swagger.Schema.Generator where

5+module Data.OpenApi.Schema.Generator where

6

7import Prelude ()

8import Prelude.Compat

@@ -16,9 +16,9 @@ import Data.Maybe

16import Data.Proxy

17import Data.Scientific

18import qualified Data.Set as S

19−import Data.Swagger

19+import Data.OpenApi

20−import Data.Swagger.Declare

20+import Data.OpenApi.Declare

21−import Data.Swagger.Internal.Schema.Validation (inferSchemaTypes)

21+import Data.OpenApi.Internal.Schema.Validation (inferSchemaTypes)

22import qualified Data.Text as T

23import qualified Data.Vector as V

24import Test.QuickCheck (arbitrary)

src/Data/Swagger/Schema/Validation.hs → src/Data/OpenApi/Schema/Validation.hsrenamed+4−4

@@ -1,10 +1,10 @@

1-- |

2−-- Module: Data.Swagger.Schema.Validation

2+-- Module: Data.OpenApi.Schema.Validation

3-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>

4-- Stability: experimental

5--

6-- Validate JSON values with Swagger Schema.

7−module Data.Swagger.Schema.Validation (

7+module Data.OpenApi.Schema.Validation (

8 -- * How to use validation

9 -- $howto

10

@@ -29,13 +29,13 @@ module Data.Swagger.Schema.Validation (

29 validateJSONWithPatternChecker,

30) where

31

32−import Data.Swagger.Internal.Schema.Validation

32+import Data.OpenApi.Internal.Schema.Validation

33

34-- $setup

35-- >>> import Control.Lens

36-- >>> import Data.Aeson

37-- >>> import Data.Proxy

38−-- >>> import Data.Swagger

38+-- >>> import Data.OpenApi

39-- >>> import GHC.Generics

40-- >>> :set -XDeriveGeneric

41

src/Data/Swagger/SchemaOptions.hs → src/Data/OpenApi/SchemaOptions.hsrenamed+2−2

@@ -1,11 +1,11 @@

1{-# LANGUAGE RecordWildCards #-}

2-- |

3−-- Module: Data.Swagger.SchemaOptions

3+-- Module: Data.OpenApi.SchemaOptions

4-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>

5-- Stability: experimental

6--

7-- Generic deriving options for @'ToParamSchema'@ and @'ToSchema'@.

8−module Data.Swagger.SchemaOptions where

8+module Data.OpenApi.SchemaOptions where

9

10import qualified Data.Aeson.Types as Aeson

11

stack.yaml+1−1

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

1−resolver: lts-15.1

1+resolver: lts-16.8

2packages:

3- '.'

4extra-deps:

test/Data/Swagger/CommonTestTypes.hs → test/Data/OpenApi/CommonTestTypes.hsrenamed+2−2

@@ -2,7 +2,7 @@

2{-# LANGUAGE QuasiQuotes #-}

3{-# LANGUAGE ScopedTypeVariables #-}

4

5−module Data.Swagger.CommonTestTypes where

5+module Data.OpenApi.CommonTestTypes where

6

7import Prelude ()

8import Prelude.Compat

@@ -18,7 +18,7 @@ import qualified Data.Text as Text

18import Data.Word

19import GHC.Generics

20

21−import Data.Swagger

21+import Data.OpenApi

22

23-- ========================================================================

24-- Unit type

test/Data/Swagger/ParamSchemaSpec.hs → test/Data/OpenApi/ParamSchemaSpec.hsrenamed+3−3

@@ -4,7 +4,7 @@

4{-# LANGUAGE TemplateHaskell #-}

5{-# LANGUAGE QuasiQuotes #-}

6{-# LANGUAGE OverloadedStrings #-}

7−module Data.Swagger.ParamSchemaSpec where

7+module Data.OpenApi.ParamSchemaSpec where

8

9import Data.Aeson

10import Data.Aeson.QQ.Simple

@@ -12,9 +12,9 @@ import Data.Char

12import Data.Proxy

13import GHC.Generics

14

15−import Data.Swagger

15+import Data.OpenApi

16

17−import Data.Swagger.CommonTestTypes

17+import Data.OpenApi.CommonTestTypes

18import SpecCommon

19import Test.Hspec

20import Data.Time.LocalTime

test/Data/Swagger/Schema/GeneratorSpec.hs → test/Data/OpenApi/Schema/GeneratorSpec.hsrenamed+3−3

@@ -1,13 +1,13 @@

1{-# LANGUAGE OverloadedLists #-}

2{-# LANGUAGE OverloadedStrings #-}

3{-# LANGUAGE PackageImports #-}

4−module Data.Swagger.Schema.GeneratorSpec where

4+module Data.OpenApi.Schema.GeneratorSpec where

5

6import Prelude ()

7import Prelude.Compat

8

9−import Data.Swagger

9+import Data.OpenApi

10−import Data.Swagger.Schema.Generator

10+import Data.OpenApi.Schema.Generator

11

12import Control.Lens.Operators

13import Data.Aeson

test/Data/Swagger/Schema/ValidationSpec.hs → test/Data/OpenApi/Schema/ValidationSpec.hsrenamed+6−6

@@ -3,7 +3,7 @@

3{-# LANGUAGE RecordWildCards #-}

4{-# LANGUAGE ScopedTypeVariables #-}

5{-# OPTIONS_GHC -fno-warn-orphans #-}

6−module Data.Swagger.Schema.ValidationSpec where

6+module Data.OpenApi.Schema.ValidationSpec where

7

8import Control.Applicative

9import Control.Lens ((&), (.~), (?~))

@@ -28,8 +28,8 @@ import Data.Version (Version)

28import Data.Word

29import GHC.Generics

30

31−import Data.Swagger

31+import Data.OpenApi

32−import Data.Swagger.Declare

32+import Data.OpenApi.Declare

33

34import Test.Hspec

35import Test.Hspec.QuickCheck

@@ -190,7 +190,7 @@ instance Arbitrary MyRoseTree where

190data Light = NoLight | LightFreq Double | LightColor Color deriving (Show, Generic)

191

192instance ToSchema Light where

193− declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions { Data.Swagger.sumEncoding = ObjectWithSingleField }

193+ declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions { Data.OpenApi.sumEncoding = ObjectWithSingleField }

194

195instance ToJSON Light where

196 toJSON = genericToJSON defaultOptions { Data.Aeson.Types.sumEncoding = ObjectWithSingleField }

@@ -215,7 +215,7 @@ instance ToJSON LightTaggedObject where

215

216instance ToSchema LightTaggedObject where

217 declareNamedSchema _ =

218− genericDeclareNamedSchema defaultSchemaOptions { Data.Swagger.sumEncoding = defaultTaggedObject } (Proxy :: Proxy Light)

218+ genericDeclareNamedSchema defaultSchemaOptions { Data.OpenApi.sumEncoding = defaultTaggedObject } (Proxy :: Proxy Light)

219

220instance Arbitrary LightTaggedObject where

221 arbitrary = LightTaggedObject <$> arbitrary

@@ -228,7 +228,7 @@ instance ToJSON LightUntaggedValue where

228

229instance ToSchema LightUntaggedValue where

230 declareNamedSchema _ =

231− genericDeclareNamedSchema defaultSchemaOptions { Data.Swagger.sumEncoding = UntaggedValue } (Proxy :: Proxy Light)

231+ genericDeclareNamedSchema defaultSchemaOptions { Data.OpenApi.sumEncoding = UntaggedValue } (Proxy :: Proxy Light)

232

233instance Arbitrary LightUntaggedValue where

234 arbitrary = LightUntaggedValue <$> arbitrary

test/Data/Swagger/SchemaSpec.hs → test/Data/OpenApi/SchemaSpec.hsrenamed+4−4

@@ -2,7 +2,7 @@

2{-# LANGUAGE ScopedTypeVariables #-}

3{-# LANGUAGE TemplateHaskell #-}

4{-# LANGUAGE QuasiQuotes #-}

5−module Data.Swagger.SchemaSpec where

5+module Data.OpenApi.SchemaSpec where

6

7import Prelude ()

8import Prelude.Compat

@@ -14,10 +14,10 @@ import Data.Proxy

14import Data.Set (Set)

15import qualified Data.Text as Text

16

17−import Data.Swagger

17+import Data.OpenApi

18−import Data.Swagger.Declare

18+import Data.OpenApi.Declare

19

20−import Data.Swagger.CommonTestTypes

20+import Data.OpenApi.CommonTestTypes

21import SpecCommon

22import Test.Hspec

23

test/Data/SwaggerSpec.hs → test/Data/OpenApiSpec.hsrenamed+3−3

@@ -2,7 +2,7 @@

2{-# LANGUAGE OverloadedStrings #-}

3{-# LANGUAGE ScopedTypeVariables #-}

4{-# LANGUAGE QuasiQuotes #-}

5−module Data.SwaggerSpec where

5+module Data.OpenApiSpec where

6

7import Prelude ()

8import Prelude.Compat

@@ -15,7 +15,7 @@ import Data.HashMap.Strict (HashMap)

15import qualified Data.HashSet.InsOrd as InsOrdHS

16import Data.Text (Text)

17

18−import Data.Swagger

18+import Data.OpenApi

19import SpecCommon

20import Test.Hspec hiding (example)

21

@@ -918,7 +918,7 @@ petstoreExampleJSON = [aesonQQ|

918compositionSchemaExample :: Schema

919compositionSchemaExample = mempty

920 & type_ ?~ SwaggerObject

921− & Data.Swagger.allOf ?~ [

921+ & Data.OpenApi.allOf ?~ [

922 Ref (Reference "Other")

923 , Inline (mempty

924 & type_ ?~ SwaggerObject