feeaa1f...master · typeable/openapi3

.github/workflows/haskell-ci.yml+8−8

since splitsnapshots

unifiedsplit

@@ -8,9 +8,9 @@

8#

9# For more information, see https://github.com/haskell-CI/haskell-ci

10#

11−# version: 0.14

11+# version: 0.14.3

12#

13−# REGENDATA ("0.14",["github","cabal.project"])

13+# REGENDATA ("0.14.3",["github","cabal.project"])

14#

15name: Haskell-CI

16on:

@@ -32,9 +32,9 @@ jobs:

32 strategy:

33 matrix:

34 include:

35− - compiler: ghc-9.2.1

35+ - compiler: ghc-9.2.2

36 compilerKind: ghc

37− compilerVersion: 9.2.1

37+ compilerVersion: 9.2.2

38 setup-method: ghcup

39 allow-failure: true

40 - compiler: ghc-9.0.2

@@ -70,7 +70,7 @@ jobs:

70 apt-get install -y --no-install-recommends gnupg ca-certificates dirmngr curl git software-properties-common libtinfo5

71 if [ "${{ matrix.setup-method }}" = ghcup ]; then

72 mkdir -p "$HOME/.ghcup/bin"

73− curl -sL https://downloads.haskell.org/ghcup/0.1.17.3/x86_64-linux-ghcup-0.1.17.3 > "$HOME/.ghcup/bin/ghcup"

73+ curl -sL https://downloads.haskell.org/ghcup/0.1.17.5/x86_64-linux-ghcup-0.1.17.5 > "$HOME/.ghcup/bin/ghcup"

74 chmod a+x "$HOME/.ghcup/bin/ghcup"

75 "$HOME/.ghcup/bin/ghcup" install ghc "$HCVER"

76 "$HOME/.ghcup/bin/ghcup" install cabal 3.6.2.0

@@ -79,7 +79,7 @@ jobs:

79 apt-get update

80 apt-get install -y "$HCNAME"

81 mkdir -p "$HOME/.ghcup/bin"

82− curl -sL https://downloads.haskell.org/ghcup/0.1.17.3/x86_64-linux-ghcup-0.1.17.3 > "$HOME/.ghcup/bin/ghcup"

82+ curl -sL https://downloads.haskell.org/ghcup/0.1.17.5/x86_64-linux-ghcup-0.1.17.5 > "$HOME/.ghcup/bin/ghcup"

83 chmod a+x "$HOME/.ghcup/bin/ghcup"

84 "$HOME/.ghcup/bin/ghcup" install cabal 3.6.2.0

85 fi

@@ -239,5 +239,5 @@ jobs:

239 $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks --constraint='aeson >=2.0' all

240 - name: constraint set aeson-1

241 run: |

242− $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks --constraint='aeson <2.0' --dependencies-only -j2 all

242+ if [ $((HCNUMVER < 90200)) -ne 0 ] ; then $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks --constraint='aeson <2.0' --dependencies-only -j2 all ; fi

243− $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks --constraint='aeson <2.0' all

243+ if [ $((HCNUMVER < 90200)) -ne 0 ] ; then $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks --constraint='aeson <2.0' all ; fi

CHANGELOG.md+14

@@ -1,6 +1,20 @@

1Unreleased

2----------

3

4+3.2.2

5+-----

6+

7+- Fix bug with infinite recursion in GToSchema [#37](https://github.com/biocad/openapi3/pull/37).

8+

9+3.2.1

10+-----

11+

12+- Support aeson-2.0.3.

13+- Support GHC-9.2 (doctests still fail).

14+

15+3.2.0

16+-----

17+

4- Support aeson-2 [#34](https://github.com/biocad/openapi3/pull/34).

18- Support aeson-2 [#34](https://github.com/biocad/openapi3/pull/34).

5- Use `SecurityDefinitions` type for `_componentsSecuritySchemes`

19- Use `SecurityDefinitions` type for `_componentsSecuritySchemes`

6 [#32](https://github.com/biocad/openapi3/pull/32).

20 [#32](https://github.com/biocad/openapi3/pull/32).

cabal.haskell-ci+4

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

1branches: master

2

3+distribution: focal

4+allow-failures: >=9.2

5+

3constraint-set aeson-1

6constraint-set aeson-1

4 constraints: aeson <2.0

7 constraints: aeson <2.0

8+ ghc: <9.2

5

9

6constraint-set aeson-2

10constraint-set aeson-2

7 constraints: aeson >=2.0

11 constraints: aeson >=2.0

openapi3.cabal+3−3

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

1cabal-version: >=1.10

2name: openapi3

3−version: 3.2.0

3+version: 3.2.2

4

5synopsis: OpenAPI 3.0 data model

6category: Web, Swagger, OpenApi

@@ -28,7 +28,7 @@ tested-with:

28 || ==8.8.4

29 || ==8.10.7

30 || ==9.0.2

31− || ==9.2.1

31+ || ==9.2.2

32

33custom-setup

34 setup-depends:

@@ -70,7 +70,7 @@ library

70

71 build-depends:

72 mtl >=2.2.2 && <2.3

73− , text >=1.2.3.1 && <1.3

73+ , text >=1.2.3.1 && <2.1

74

75 -- other dependencies

76 build-depends:

src/Data/OpenApi/Internal/Schema.hs+6−3

@@ -945,10 +945,13 @@ instance (Selector s, GToSchema f, GToSchema (S1 s f)) => GToSchema (C1 c (S1 s

945 case schema ^. items of

946 Just (OpenApiItemsArray [_]) -> fieldSchema

947 _ -> do

948− declare defs

948+ -- We have to run recordSchema instead of just using its defs,

949+ -- since those can be recursive and will lead to infinite loop,

950+ -- see https://github.com/biocad/openapi3/pull/37

951+ NamedSchema _ schema' <- recordSchema

949− return (unnamed schema)

952+ return (unnamed schema')

950 where

953 where

951− (defs, NamedSchema _ schema) = runDeclare recordSchema mempty

954+ (_, NamedSchema _ schema) = runDeclare recordSchema mempty

952 recordSchema = gdeclareNamedSchema opts (Proxy :: Proxy (S1 s f)) s

955 recordSchema = gdeclareNamedSchema opts (Proxy :: Proxy (S1 s f)) s

953 fieldSchema = gdeclareNamedSchema opts (Proxy :: Proxy f) s

956 fieldSchema = gdeclareNamedSchema opts (Proxy :: Proxy f) s

954

957

stack.yaml+1−1

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

1−resolver: lts-16.8

1+resolver: lts-16.31

2packages:

3- '.'

4extra-deps:

test/Data/OpenApi/CommonTestTypes.hs+123

@@ -863,6 +863,129 @@ singleMaybeFieldSchemaJSON = [aesonQQ|

863}

864|]

865

866+-- ========================================================================

867+-- Natural Language (single field data with recursive fields)

868+-- ========================================================================

869+

870+data Predicate

871+ = PredicateNoun Noun

872+ | PredicateOmitted Omitted

873+ deriving (Eq, Ord, Read, Show, Generic)

874+instance ToJSON Predicate

875+instance ToSchema Predicate

876+

877+data Noun

878+ = Noun

879+ { nounSurf :: LangWord

880+ , nounModify :: [Modifier]

881+ }

882+ deriving (Eq, Ord, Read, Show, Generic)

883+instance ToJSON Noun

884+instance ToSchema Noun

885+

886+data LangWord

887+ = LangWord

888+ { langWordSurf :: String

889+ , langWordBase :: String

890+ }

891+ deriving (Eq, Ord, Read, Show, Generic)

892+instance ToJSON LangWord

893+instance ToSchema LangWord

894+

895+data Modifier

896+ = ModifierNoun Noun

897+ | ModifierOmitted Omitted

898+ deriving (Eq, Ord, Read, Show, Generic)

899+instance ToJSON Modifier

900+instance ToSchema Modifier

901+

902+newtype Omitted

903+ = Omitted

904+ { omittedModify :: [Modifier]

905+ }

906+ deriving (Eq, Ord, Read, Show, Generic)

907+instance ToJSON Omitted

908+instance ToSchema Omitted

909+

910+predicateSchemaDeclareJSON :: Value

911+predicateSchemaDeclareJSON = [aesonQQ|

912+[

913+ {

914+ "Predicate": {

915+ "oneOf": [

916+ {

917+ "properties": {

918+ "contents": { "$ref": "#/components/schemas/Noun" },

919+ "tag": { "enum": ["PredicateNoun"], "type": "string" }

920+ },

921+ "required": ["tag", "contents"],

922+ "type": "object"

923+ },

924+ {

925+ "properties": {

926+ "contents": { "$ref": "#/components/schemas/Omitted" },

927+ "tag": { "enum": ["PredicateOmitted"], "type": "string" }

928+ },

929+ "required": ["tag", "contents"],

930+ "type": "object"

931+ }

932+ ],

933+ "type": "object"

934+ },

935+ "Noun": {

936+ "properties": {

937+ "nounModify": {

938+ "items": { "$ref": "#/components/schemas/Modifier" },

939+ "type": "array"

940+ },

941+ "nounSurf": { "$ref": "#/components/schemas/LangWord" }

942+ },

943+ "required": ["nounSurf", "nounModify"],

944+ "type": "object"

945+ },

946+ "LangWord": {

947+ "properties": {

948+ "langWordBase": { "type": "string" },

949+ "langWordSurf": { "type": "string" }

950+ },

951+ "required": ["langWordSurf", "langWordBase"],

952+ "type": "object"

953+ },

954+ "Modifier": {

955+ "oneOf": [

956+ {

957+ "properties": {

958+ "contents": { "$ref": "#/components/schemas/Noun" },

959+ "tag": { "enum": ["ModifierNoun"], "type": "string" }

960+ },

961+ "required": ["tag", "contents"],

962+ "type": "object"

963+ },

964+ {

965+ "properties": {

966+ "contents": { "$ref": "#/components/schemas/Omitted" },

967+ "tag": { "enum": ["ModifierOmitted"], "type": "string" }

968+ },

969+ "required": ["tag", "contents"],

970+ "type": "object"

971+ }

972+ ],

973+ "type": "object"

974+ },

975+ "Omitted": {

976+ "properties": {

977+ "omittedModify": {

978+ "items": { "$ref": "#/components/schemas/Modifier" },

979+ "type": "array"

980+ }

981+ },

982+ "required": ["omittedModify"],

983+ "type": "object"

984+ }

985+ },

986+ { "$ref": "#/components/schemas/Predicate" }

987+]

988+|]

866

989

867-- ========================================================================

990-- ========================================================================

868-- TimeOfDay

991-- TimeOfDay

test/Data/OpenApi/SchemaSpec.hs+4

@@ -59,6 +59,9 @@ checkInlinedRecSchema proxy js = inlineNonRecursiveSchemas defs s <=> js

59 where

60 (defs, s) = runDeclare (declareSchema proxy) mempty

61

62+checkToSchemaDeclare :: (HasCallStack, ToSchema a) => Proxy a -> Value -> Spec

63+checkToSchemaDeclare proxy js = runDeclare (declareSchemaRef proxy) mempty <=> js

64+

62spec :: Spec

65spec :: Spec

63spec = do

66spec = do

64 describe "Generic ToSchema" $ do

67 describe "Generic ToSchema" $ do

@@ -78,6 +81,7 @@ spec = do

78 context "UserId (non-record newtype)" $ checkToSchema (Proxy :: Proxy UserId) userIdSchemaJSON

81 context "UserId (non-record newtype)" $ checkToSchema (Proxy :: Proxy UserId) userIdSchemaJSON

79 context "Player (unary record)" $ checkToSchema (Proxy :: Proxy Player) playerSchemaJSON

82 context "Player (unary record)" $ checkToSchema (Proxy :: Proxy Player) playerSchemaJSON

80 context "SingleMaybeField (unary record with Maybe)" $ checkToSchema (Proxy :: Proxy SingleMaybeField) singleMaybeFieldSchemaJSON

83 context "SingleMaybeField (unary record with Maybe)" $ checkToSchema (Proxy :: Proxy SingleMaybeField) singleMaybeFieldSchemaJSON

84+ context "Natural Language (single field data with recursive fields)" $ checkToSchemaDeclare (Proxy :: Proxy Predicate) predicateSchemaDeclareJSON

81 context "Players (inlining schema)" $ checkToSchema (Proxy :: Proxy Players) playersSchemaJSON

85 context "Players (inlining schema)" $ checkToSchema (Proxy :: Proxy Players) playersSchemaJSON

82 context "MyRoseTree (datatypeNameModifier)" $ checkToSchema (Proxy :: Proxy MyRoseTree) myRoseTreeSchemaJSON

86 context "MyRoseTree (datatypeNameModifier)" $ checkToSchema (Proxy :: Proxy MyRoseTree) myRoseTreeSchemaJSON

83 context "MyRoseTree' (datatypeNameModifier)" $ checkToSchema (Proxy :: Proxy MyRoseTree') myRoseTreeSchemaJSON'

87 context "MyRoseTree' (datatypeNameModifier)" $ checkToSchema (Proxy :: Proxy MyRoseTree') myRoseTreeSchemaJSON'