5eac87f..master · typeable/openapi3

git.iko.soy/typeable/openapi3

9 files changed+246−41

unifiedsplit

.github/workflows/haskell-ci.yml+82−29 CHANGELOG.md+14 cabal.haskell-ci+4 openapi3.cabal+9−8 src/Data/OpenApi/Internal/Schema.hs+6−3 stack.yaml+1−1 test/Data/OpenApi/CommonTestTypes.hs+123 test/Data/OpenApi/Schema/ValidationSpec.hs+3 test/Data/OpenApi/SchemaSpec.hs+4

.github/workflows/haskell-ci.yml+82−29

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

88#

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

1010#

11−# version: 0.12.1

11+# version: 0.14.3

1212#

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

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

1414#

1515name: Haskell-CI

1616on:

@@ -24,55 +24,101 @@ jobs:

2424 linux:

2525 name: Haskell-CI - Linux - ${{ matrix.compiler }}

2626 runs-on: ubuntu-18.04

27+ timeout-minutes:

28+ 60

2729 container:

28− image: buildpack-deps:bionic

30+ image: buildpack-deps:focal

2931 continue-on-error: ${{ matrix.allow-failure }}

3032 strategy:

3133 matrix:

3234 include:

33− - compiler: ghc-9.0.1

35+ - compiler: ghc-9.2.2

36+ compilerKind: ghc

37+ compilerVersion: 9.2.2

38+ setup-method: ghcup

3439 allow-failure: true

35− - compiler: ghc-8.10.4

40+ - compiler: ghc-9.0.2

41+ compilerKind: ghc

42+ compilerVersion: 9.0.2

43+ setup-method: ghcup

44+ allow-failure: false

45+ - compiler: ghc-8.10.7

46+ compilerKind: ghc

47+ compilerVersion: 8.10.7

48+ setup-method: ghcup

3649 allow-failure: false

3750 - compiler: ghc-8.8.4

51+ compilerKind: ghc

52+ compilerVersion: 8.8.4

53+ setup-method: hvr-ppa

3854 allow-failure: false

3955 - compiler: ghc-8.6.5

56+ compilerKind: ghc

57+ compilerVersion: 8.6.5

58+ setup-method: hvr-ppa

4059 allow-failure: false

4160 - compiler: ghc-8.4.4

61+ compilerKind: ghc

62+ compilerVersion: 8.4.4

63+ setup-method: hvr-ppa

4264 allow-failure: false

4365 fail-fast: false

4466 steps:

4567 - name: apt

4668 run: |

4769 apt-get update

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

49− apt-add-repository -y 'ppa:hvr/ghc'

50− apt-get update

51− apt-get install -y $CC cabal-install-3.4

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.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

77+ else

78+ apt-add-repository -y 'ppa:hvr/ghc'

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.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

5286 env:

53− CC: ${{ matrix.compiler }}

87+ HCKIND: ${{ matrix.compilerKind }}

88+ HCNAME: ${{ matrix.compiler }}

89+ HCVER: ${{ matrix.compilerVersion }}

5490 - name: Set PATH and environment variables

5591 run: |

5692 echo "$HOME/.cabal/bin" >> $GITHUB_PATH

57− echo "LANG=C.UTF-8" >> $GITHUB_ENV

58− echo "CABAL_DIR=$HOME/.cabal" >> $GITHUB_ENV

59− echo "CABAL_CONFIG=$HOME/.cabal/config" >> $GITHUB_ENV

60− HCDIR=$(echo "/opt/$CC" | sed 's/-/\//')

61− HCNAME=ghc

62− HC=$HCDIR/bin/$HCNAME

63− echo "HC=$HC" >> $GITHUB_ENV

64− echo "HCPKG=$HCDIR/bin/$HCNAME-pkg" >> $GITHUB_ENV

65− echo "HADDOCK=$HCDIR/bin/haddock" >> $GITHUB_ENV

66− echo "CABAL=/opt/cabal/3.4/bin/cabal -vnormal+nowrap" >> $GITHUB_ENV

93+ echo "LANG=C.UTF-8" >> "$GITHUB_ENV"

94+ echo "CABAL_DIR=$HOME/.cabal" >> "$GITHUB_ENV"

95+ echo "CABAL_CONFIG=$HOME/.cabal/config" >> "$GITHUB_ENV"

96+ HCDIR=/opt/$HCKIND/$HCVER

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

98+ HC=$HOME/.ghcup/bin/$HCKIND-$HCVER

99+ echo "HC=$HC" >> "$GITHUB_ENV"

100+ echo "HCPKG=$HOME/.ghcup/bin/$HCKIND-pkg-$HCVER" >> "$GITHUB_ENV"

101+ echo "HADDOCK=$HOME/.ghcup/bin/haddock-$HCVER" >> "$GITHUB_ENV"

102+ echo "CABAL=$HOME/.ghcup/bin/cabal-3.6.2.0 -vnormal+nowrap" >> "$GITHUB_ENV"

103+ else

104+ HC=$HCDIR/bin/$HCKIND

105+ echo "HC=$HC" >> "$GITHUB_ENV"

106+ echo "HCPKG=$HCDIR/bin/$HCKIND-pkg" >> "$GITHUB_ENV"

107+ echo "HADDOCK=$HCDIR/bin/haddock" >> "$GITHUB_ENV"

108+ echo "CABAL=$HOME/.ghcup/bin/cabal-3.6.2.0 -vnormal+nowrap" >> "$GITHUB_ENV"

109+ fi

110+

67111 HCNUMVER=$(${HC} --numeric-version|perl -ne '/^(\d+)\.(\d+)\.(\d+)(\.(\d+))?$/; print(10000 * $1 + 100 * $2 + ($3 == 0 ? $5 != 1 : $3))')

68− echo "HCNUMVER=$HCNUMVER" >> $GITHUB_ENV

69− echo "ARG_TESTS=--enable-tests" >> $GITHUB_ENV

70− echo "ARG_BENCH=--enable-benchmarks" >> $GITHUB_ENV

71− echo "HEADHACKAGE=false" >> $GITHUB_ENV

72− echo "ARG_COMPILER=--$HCNAME --with-compiler=$HC" >> $GITHUB_ENV

73− echo "GHCJSARITH=0" >> $GITHUB_ENV

112+ echo "HCNUMVER=$HCNUMVER" >> "$GITHUB_ENV"

113+ echo "ARG_TESTS=--enable-tests" >> "$GITHUB_ENV"

114+ echo "ARG_BENCH=--enable-benchmarks" >> "$GITHUB_ENV"

115+ echo "HEADHACKAGE=false" >> "$GITHUB_ENV"

116+ echo "ARG_COMPILER=--$HCKIND --with-compiler=$HC" >> "$GITHUB_ENV"

117+ echo "GHCJSARITH=0" >> "$GITHUB_ENV"

74118 env:

75− CC: ${{ matrix.compiler }}

119+ HCKIND: ${{ matrix.compilerKind }}

120+ HCNAME: ${{ matrix.compiler }}

121+ HCVER: ${{ matrix.compilerVersion }}

76122 - name: env

77123 run: |

78124 env

@@ -95,6 +141,10 @@ jobs:

95141 repository hackage.haskell.org

96142 url: http://hackage.haskell.org/

97143 EOF

144+ cat >> $CABAL_CONFIG <<EOF

145+ program-default-options

146+ ghc-options: $GHCJOBS +RTS -M3G -RTS

147+ EOF

98148 cat $CABAL_CONFIG

99149 - name: versions

100150 run: |

@@ -133,7 +183,8 @@ jobs:

133183 - name: generate cabal.project

134184 run: |

135185 PKGDIR_openapi3="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/openapi3-[0-9.]*')"

136− echo "PKGDIR_openapi3=${PKGDIR_openapi3}" >> $GITHUB_ENV

186+ echo "PKGDIR_openapi3=${PKGDIR_openapi3}" >> "$GITHUB_ENV"

187+ rm -f cabal.project cabal.project.local

137188 touch cabal.project

138189 touch cabal.project.local

139190 echo "packages: ${PKGDIR_openapi3}" >> cabal.project

@@ -184,7 +235,9 @@ jobs:

184235 rm -f cabal.project.local

185236 - name: constraint set aeson-2

186237 run: |

238+ $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks --constraint='aeson >=2.0' --dependencies-only -j2 all

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

188240 - name: constraint set aeson-1

189241 run: |

190− $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks --constraint='aeson <2.0' 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+ 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 @@

11Unreleased

22----------

4+3.2.2

5+-----

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

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+

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

519- Use `SecurityDefinitions` type for `_componentsSecuritySchemes`

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

cabal.haskell-ci+4

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

11branches: master

3+distribution: focal

4+allow-failures: >=9.2

36constraint-set aeson-1

47 constraints: aeson <2.0

8+ ghc: <9.2

610constraint-set aeson-2

711 constraints: aeson >=2.0

openapi3.cabal+9−8

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

11cabal-version: >=1.10

22name: openapi3

3−version: 3.2.0

3+version: 3.2.2

55synopsis: OpenAPI 3.0 data model

66category: Web, Swagger, OpenApi

@@ -26,8 +26,9 @@ tested-with:

2626 GHC ==8.4.4

2727 || ==8.6.5

2828 || ==8.8.4

29− || ==8.10.4

30− || ==9.0.1

29+ || ==8.10.7

30+ || ==9.0.2

31+ || ==9.2.2

3132

3233custom-setup

3334 setup-depends:

@@ -60,16 +61,16 @@ library

6061

6162 -- GHC boot libraries

6263 build-depends:

63− base >=4.11.1.0 && <4.16

64− , bytestring >=0.10.8.2 && <0.11

64+ base >=4.11.1.0 && <4.17

65+ , bytestring >=0.10.8.2 && <0.12

6566 , containers >=0.5.11.0 && <0.7

66− , template-haskell >=2.13.0.0 && <2.18

67− , time >=1.8.0.2 && <1.10

67+ , template-haskell >=2.13.0.0 && <2.19

68+ , time >=1.8.0.2 && <1.14

6869 , transformers >=0.5.5.0 && <0.6

6970

7071 build-depends:

7172 mtl >=2.2.2 && <2.3

72− , text >=1.2.3.1 && <1.3

73+ , text >=1.2.3.1 && <2.1

7374

7475 -- other dependencies

7576 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

945945 case schema ^. items of

946946 Just (OpenApiItemsArray [_]) -> fieldSchema

947947 _ -> do

948− declare defs

949− return (unnamed schema)

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

952+ return (unnamed schema')

950953 where

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

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

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

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

954957

stack.yaml+1−1

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

1−resolver: lts-16.8

1+resolver: lts-16.31

22packages:

33- '.'

44extra-deps:

test/Data/OpenApi/CommonTestTypes.hs+123

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

863863}

864864|]

865865

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+|]

866989

867990-- ========================================================================

868991-- TimeOfDay

test/Data/OpenApi/Schema/ValidationSpec.hs+3

@@ -301,6 +301,8 @@ instance Eq ZonedTime where

301301-- Arbitrary instance for Data.Aeson.Value

302302-- ========================================================================

303303

304+-- These instances were introduces in aeson upstream in 2.0.3

305+#if !MIN_VERSION_aeson(2,0,3)

304306instance Arbitrary Value where

305307 -- Weights are almost random

306308 -- Uniform oneof tends not to build complex objects cause of recursive call.

@@ -319,3 +321,4 @@ instance Arbitrary v => Arbitrary (KeyMap.KeyMap v) where

319321instance Arbitrary Key.Key where

320322 arbitrary = Key.fromText <$> arbitrary

321323#endif

324+#endif

test/Data/OpenApi/SchemaSpec.hs+4

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

5959 where

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

6161

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

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

64+

6265spec :: Spec

6366spec = do

6467 describe "Generic ToSchema" $ do

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

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

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

8083 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

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

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

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