5e159fa...master · typeable/servant-swagger-ui

git.iko.soy/typeable/servant-swagger-ui

131 files changed+62493−30900

since splitsnapshots

unifiedsplit

.gitignore+3−1

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

11dist/

2+dist-newstyle/

3+.ghc.environment.*

24.stack-work/

35.cabal-sandbox

46cabal.sandbox.config

57src/highlight.js

6−src/style.css

8+src/style.css

.travis.meta.ymldeleted−30

@@ -1,30 +0,0 @@

1−language: haskell-multi-ghc

2−

3−env:

4− - GHCVER=8.0.1 CABALVER=1.24 CABALCONFIG=swagger2-2.1-cabal.config

5− - GHCVER=8.0.1 CABALVER=1.24 CABALCONFIG=servant-0.9-cabal.config

6− - GHCVER=8.0.1 CABALVER=1.24 CABALCONFIG=servant-0.8-cabal.config

7− - GHCVER=8.0.1 CABALVER=1.24 CABALCONFIG=servant-0.7-cabal.config

8−

9− - GHCVER=7.10.3 CABALVER=1.22 CABALCONFIG=swagger2-2.1-cabal.config

10− - GHCVER=7.10.3 CABALVER=1.22 CABALCONFIG=swagger2-2.0-cabal.config

11− - GHCVER=7.10.3 CABALVER=1.22 CABALCONFIG=servant-0.9-cabal.config

12− - GHCVER=7.10.3 CABALVER=1.22 CABALCONFIG=servant-0.8-cabal.config

13− - GHCVER=7.10.3 CABALVER=1.22 CABALCONFIG=servant-0.7-cabal.config

14− - GHCVER=7.10.3 CABALVER=1.22 CABALCONFIG=servant-0.6-cabal.config

15− - GHCVER=7.10.3 CABALVER=1.22 CABALCONFIG=servant-0.5-cabal.config

16− - GHCVER=7.10.3 CABALVER=1.22 CABALCONFIG=servant-0.4-cabal.config

17−

18− - GHCVER=7.8.4 CABALVER=1.18 CABALCONFIG=servant-0.9-cabal.config

19− - GHCVER=7.8.4 CABALVER=1.18 CABALCONFIG=servant-0.8-cabal.config

20− - GHCVER=7.8.4 CABALVER=1.18 CABALCONFIG=servant-0.7-cabal.config

21− - GHCVER=7.8.4 CABALVER=1.18 CABALCONFIG=servant-0.6-cabal.config

22− - GHCVER=7.8.4 CABALVER=1.18 CABALCONFIG=servant-0.5-cabal.config

23− - GHCVER=7.8.4 CABALVER=1.18 CABALCONFIG=servant-0.4-cabal.config

24−

25−matrix:

26− fast_finish: true

27−

28−branches:

29− only:

30− - master

.travis.yml+194−231

@@ -1,236 +1,199 @@

1−# This file has been generated by travis-meta-yaml 0.2.0.0

2−# see https://github.com/phadej/travis-meta-yaml

3−sudo: false

1+# This Travis job script has been generated by a script via

2+#

3+# haskell-ci '--output' '.travis.yml' '--config=cabal.haskell-ci' 'cabal.project'

4+#

5+# To regenerate the script (for example after adjusting tested-with) run

6+#

7+# haskell-ci regenerate

8+#

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

10+#

11+# version: 0.10.3

12+#

13+version: ~> 1.0

414language: c

5−before_install:

6−- unset CC

7−- export PATH=/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:$PATH

8−- echo "$(ghc --version) [$(ghc --print-project-git-commit-id 2> /dev/null || echo

9− '?')]"

10−- cabal --version

11−- ghc --version

12−- if [ "$NOTESTS" = "YES" ]; then export CABALCONFOPTS="$CABALFLAGS"; export CABALTEST="true";

13− else export CABALCONFOPTS="$CABALFLAGS --enable-tests --enable-benchmarks"; export

14− CABALTEST="cabal test"; fi

15−- if [ "$PEDANTIC" = "YES" ]; then export CABALBUILDOPTS="--ghc-options=-Werror --ghc-options=-Wall";

16− fi

17−install:

18−- if [ -f $HOME/.cabal/packages/hackage.haskell.org/00-index.tar.gz ]; then zcat $HOME/.cabal/packages/hackage.haskell.org/00-index.tar.gz

19− > $HOME/.cabal/packages/hackage.haskell.org/00-index.tar; ls -l $HOME/.cabal/packages/hackage.haskell.org/;

20− fi; cabal update; sed -i 's/^jobs:/-- jobs:/' ${HOME}/.cabal/config; if [ -n "$CABALCONFIG"

21− ]; then cp $CABALCONFIG cabal.config; fi; if [ -n "$STACKAGESNAPSHOT" ]; then curl

22− --silent https://www.stackage.org/$STACKAGESNAPSHOT/cabal.config | grep -v "$(cabal

23− info . -v0 | head -n 1 | awk '{ print $2 }' | sed -E 's/-[0-9]+(\.[0-9]+)+//') =="

24− > cabal.config; fi; cabal install --constraint='integer-simple installed' --only-dependencies

25− $CABALCONFOPTS --dry -v > installplan.txt; sed -i -e '1,/^Resolving /d' installplan.txt;

26− cat installplan.txt; if diff -u $HOME/.cabsnap/installplan.txt installplan.txt;

27− then echo "cabal build-cache HIT"; rm -rfv .ghc; cp -av $HOME/.cabsnap/ghc $HOME/.ghc;

28− cp -av $HOME/.cabsnap/lib $HOME/.cabsnap/share $HOME/.cabsnap/bin $HOME/.cabal/;

29− else echo "cabal build-cache MISS"; rm -rf $HOME/.cabsnap; mkdir -p $HOME/.ghc $HOME/.cabal/lib

30− $HOME/.cabal/share $HOME/.cabal/bin; cabal install --constraint='integer-simple

31− installed' --only-dependencies $CABALCONFOPTS; fi; if [ ! -d $HOME/.cabsnap ]; then

32− echo "snapshotting package-db to build-cache"; mkdir $HOME/.cabsnap; cp -av $HOME/.ghc

33− $HOME/.cabsnap/ghc; cp -av $HOME/.cabal/lib $HOME/.cabal/share $HOME/.cabal/bin

34− installplan.txt $HOME/.cabsnap/; fi;

35−script:

36−- if [ -f configure.ac ]; then autoreconf -i; fi

37−- cabal configure $CABALCONFOPTS -v2

38−- cabal build $CABALBUILDOPTS

39−- $CABALTEST

40−- if [ "$CABALVER" = "1.22" ]; then cabal check; fi

41−- cabal sdist

42−- SRC_TGZ=$(cabal info . | awk '{print $2;exit}').tar.gz && (cd dist && cabal install

43− --constraint='integer-simple installed' --force-reinstalls $CABALFLAGS "$SRC_TGZ")

44−matrix:

45− fast_finish: true

46− include:

47− - env: GHCVER=8.0.1 CABALVER=1.24 CABALCONFIG=swagger2-2.1-cabal.config

48− addons:

49− apt:

50− sources:

51− - hvr-ghc

52− packages:

53− - cabal-install-1.24

54− - ghc-8.0.1

55− - libgmp-dev

56− compiler: ! ': # ghc-8.0.1 cabal-1.24 swagger2-2.1-cabal.config'

57− - env: GHCVER=8.0.1 CABALVER=1.24 CABALCONFIG=servant-0.9-cabal.config

58− addons:

59− apt:

60− sources:

61− - hvr-ghc

62− packages:

63− - cabal-install-1.24

64− - ghc-8.0.1

65− - libgmp-dev

66− compiler: ! ': # ghc-8.0.1 cabal-1.24 servant-0.9-cabal.config'

67− - env: GHCVER=8.0.1 CABALVER=1.24 CABALCONFIG=servant-0.8-cabal.config

68− addons:

69− apt:

70− sources:

71− - hvr-ghc

72− packages:

73− - cabal-install-1.24

74− - ghc-8.0.1

75− - libgmp-dev

76− compiler: ! ': # ghc-8.0.1 cabal-1.24 servant-0.8-cabal.config'

77− - env: GHCVER=8.0.1 CABALVER=1.24 CABALCONFIG=servant-0.7-cabal.config

78− addons:

79− apt:

80− sources:

81− - hvr-ghc

82− packages:

83− - cabal-install-1.24

84− - ghc-8.0.1

85− - libgmp-dev

86− compiler: ! ': # ghc-8.0.1 cabal-1.24 servant-0.7-cabal.config'

87− - env: GHCVER=7.10.3 CABALVER=1.22 CABALCONFIG=swagger2-2.1-cabal.config

88− addons:

89− apt:

90− sources:

91− - hvr-ghc

92− packages:

93− - cabal-install-1.22

94− - ghc-7.10.3

95− - libgmp-dev

96− compiler: ! ': # ghc-7.10.3 cabal-1.22 swagger2-2.1-cabal.config'

97− - env: GHCVER=7.10.3 CABALVER=1.22 CABALCONFIG=swagger2-2.0-cabal.config

98− addons:

99− apt:

100− sources:

101− - hvr-ghc

102− packages:

103− - cabal-install-1.22

104− - ghc-7.10.3

105− - libgmp-dev

106− compiler: ! ': # ghc-7.10.3 cabal-1.22 swagger2-2.0-cabal.config'

107− - env: GHCVER=7.10.3 CABALVER=1.22 CABALCONFIG=servant-0.9-cabal.config

108− addons:

109− apt:

110− sources:

111− - hvr-ghc

112− packages:

113− - cabal-install-1.22

114− - ghc-7.10.3

115− - libgmp-dev

116− compiler: ! ': # ghc-7.10.3 cabal-1.22 servant-0.9-cabal.config'

117− - env: GHCVER=7.10.3 CABALVER=1.22 CABALCONFIG=servant-0.8-cabal.config

118− addons:

119− apt:

120− sources:

121− - hvr-ghc

122− packages:

123− - cabal-install-1.22

124− - ghc-7.10.3

125− - libgmp-dev

126− compiler: ! ': # ghc-7.10.3 cabal-1.22 servant-0.8-cabal.config'

127− - env: GHCVER=7.10.3 CABALVER=1.22 CABALCONFIG=servant-0.7-cabal.config

128− addons:

129− apt:

130− sources:

131− - hvr-ghc

132− packages:

133− - cabal-install-1.22

134− - ghc-7.10.3

135− - libgmp-dev

136− compiler: ! ': # ghc-7.10.3 cabal-1.22 servant-0.7-cabal.config'

137− - env: GHCVER=7.10.3 CABALVER=1.22 CABALCONFIG=servant-0.6-cabal.config

138− addons:

139− apt:

140− sources:

141− - hvr-ghc

142− packages:

143− - cabal-install-1.22

144− - ghc-7.10.3

145− - libgmp-dev

146− compiler: ! ': # ghc-7.10.3 cabal-1.22 servant-0.6-cabal.config'

147− - env: GHCVER=7.10.3 CABALVER=1.22 CABALCONFIG=servant-0.5-cabal.config

148− addons:

149− apt:

150− sources:

151− - hvr-ghc

152− packages:

153− - cabal-install-1.22

154− - ghc-7.10.3

155− - libgmp-dev

156− compiler: ! ': # ghc-7.10.3 cabal-1.22 servant-0.5-cabal.config'

157− - env: GHCVER=7.10.3 CABALVER=1.22 CABALCONFIG=servant-0.4-cabal.config

158− addons:

159− apt:

160− sources:

161− - hvr-ghc

162− packages:

163− - cabal-install-1.22

164− - ghc-7.10.3

165− - libgmp-dev

166− compiler: ! ': # ghc-7.10.3 cabal-1.22 servant-0.4-cabal.config'

167− - env: GHCVER=7.8.4 CABALVER=1.18 CABALCONFIG=servant-0.9-cabal.config

168− addons:

169− apt:

170− sources:

171− - hvr-ghc

172− packages:

173− - cabal-install-1.18

174− - ghc-7.8.4

175− - libgmp-dev

176− compiler: ! ': # ghc-7.8.4 cabal-1.18 servant-0.9-cabal.config'

177− - env: GHCVER=7.8.4 CABALVER=1.18 CABALCONFIG=servant-0.8-cabal.config

178− addons:

179− apt:

180− sources:

181− - hvr-ghc

182− packages:

183− - cabal-install-1.18

184− - ghc-7.8.4

185− - libgmp-dev

186− compiler: ! ': # ghc-7.8.4 cabal-1.18 servant-0.8-cabal.config'

187− - env: GHCVER=7.8.4 CABALVER=1.18 CABALCONFIG=servant-0.7-cabal.config

188− addons:

189− apt:

190− sources:

191− - hvr-ghc

192− packages:

193− - cabal-install-1.18

194− - ghc-7.8.4

195− - libgmp-dev

196− compiler: ! ': # ghc-7.8.4 cabal-1.18 servant-0.7-cabal.config'

197− - env: GHCVER=7.8.4 CABALVER=1.18 CABALCONFIG=servant-0.6-cabal.config

198− addons:

199− apt:

200− sources:

201− - hvr-ghc

202− packages:

203− - cabal-install-1.18

204− - ghc-7.8.4

205− - libgmp-dev

206− compiler: ! ': # ghc-7.8.4 cabal-1.18 servant-0.6-cabal.config'

207− - env: GHCVER=7.8.4 CABALVER=1.18 CABALCONFIG=servant-0.5-cabal.config

208− addons:

209− apt:

210− sources:

211− - hvr-ghc

212− packages:

213− - cabal-install-1.18

214− - ghc-7.8.4

215− - libgmp-dev

216− compiler: ! ': # ghc-7.8.4 cabal-1.18 servant-0.5-cabal.config'

217− - env: GHCVER=7.8.4 CABALVER=1.18 CABALCONFIG=servant-0.4-cabal.config

218− addons:

219− apt:

220− sources:

221− - hvr-ghc

222− packages:

223− - cabal-install-1.18

224− - ghc-7.8.4

225− - libgmp-dev

226− compiler: ! ': # ghc-7.8.4 cabal-1.18 servant-0.4-cabal.config'

15+os: linux

16+dist: xenial

17+git:

18+ # whether to recursively clone submodules

19+ submodules: false

22720branches:

22821 only:

229− - master

230−before_cache:

231−- rm -fv $HOME/.cabal/packages/hackage.haskell.org/build-reports.log

232−- rm -fv $HOME/.cabal/packages/hackage.haskell.org/00-index.tar

22+ - master

23323cache:

23424 directories:

235− - $HOME/.cabsnap

236− - $HOME/.cabal/packages

25+ - $HOME/.cabal/packages

26+ - $HOME/.cabal/store

27+ - $HOME/.hlint

28+before_cache:

29+ - rm -fv $CABALHOME/packages/hackage.haskell.org/build-reports.log

30+ # remove files that are regenerated by 'cabal update'

31+ - rm -fv $CABALHOME/packages/hackage.haskell.org/00-index.*

32+ - rm -fv $CABALHOME/packages/hackage.haskell.org/*.json

33+ - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.cache

34+ - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.tar

35+ - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.tar.idx

36+ - rm -rfv $CABALHOME/packages/head.hackage

37+jobs:

38+ include:

39+ - compiler: ghc-8.10.2

40+ addons: {"apt":{"sources":[{"sourceline":"deb http://ppa.launchpad.net/hvr/ghc/ubuntu xenial main","key_url":"https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x063dab2bdc0b3f9fcebc378bff3aeacef6f88286"}],"packages":["ghc-8.10.2","cabal-install-3.2"]}}

41+ os: linux

42+ - compiler: ghc-8.8.4

43+ addons: {"apt":{"sources":[{"sourceline":"deb http://ppa.launchpad.net/hvr/ghc/ubuntu xenial main","key_url":"https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x063dab2bdc0b3f9fcebc378bff3aeacef6f88286"}],"packages":["ghc-8.8.4","cabal-install-3.2"]}}

44+ os: linux

45+ - compiler: ghc-8.6.5

46+ addons: {"apt":{"sources":[{"sourceline":"deb http://ppa.launchpad.net/hvr/ghc/ubuntu xenial main","key_url":"https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x063dab2bdc0b3f9fcebc378bff3aeacef6f88286"}],"packages":["ghc-8.6.5","cabal-install-3.2"]}}

47+ os: linux

48+ - compiler: ghc-8.4.4

49+ addons: {"apt":{"sources":[{"sourceline":"deb http://ppa.launchpad.net/hvr/ghc/ubuntu xenial main","key_url":"https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x063dab2bdc0b3f9fcebc378bff3aeacef6f88286"}],"packages":["ghc-8.4.4","cabal-install-3.2"]}}

50+ os: linux

51+ - compiler: ghc-8.2.2

52+ addons: {"apt":{"sources":[{"sourceline":"deb http://ppa.launchpad.net/hvr/ghc/ubuntu xenial main","key_url":"https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x063dab2bdc0b3f9fcebc378bff3aeacef6f88286"}],"packages":["ghc-8.2.2","cabal-install-3.2"]}}

53+ os: linux

54+ - compiler: ghc-8.0.2

55+ addons: {"apt":{"sources":[{"sourceline":"deb http://ppa.launchpad.net/hvr/ghc/ubuntu xenial main","key_url":"https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x063dab2bdc0b3f9fcebc378bff3aeacef6f88286"}],"packages":["ghc-8.0.2","cabal-install-3.2"]}}

56+ os: linux

57+before_install:

58+ - HC=$(echo "/opt/$CC/bin/ghc" | sed 's/-/\//')

59+ - WITHCOMPILER="-w $HC"

60+ - HADDOCK=$(echo "/opt/$CC/bin/haddock" | sed 's/-/\//')

61+ - HCPKG="$HC-pkg"

62+ - unset CC

63+ - CABAL=/opt/ghc/bin/cabal

64+ - CABALHOME=$HOME/.cabal

65+ - export PATH="$CABALHOME/bin:$PATH"

66+ - TOP=$(pwd)

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

68+ - echo $HCNUMVER

69+ - CABAL="$CABAL -vnormal+nowrap"

70+ - set -o pipefail

71+ - TEST=--enable-tests

72+ - BENCH=--enable-benchmarks

73+ - HEADHACKAGE=false

74+ - rm -f $CABALHOME/config

75+ - |

76+ echo "verbose: normal +nowrap +markoutput" >> $CABALHOME/config

77+ echo "remote-build-reporting: anonymous" >> $CABALHOME/config

78+ echo "write-ghc-environment-files: always" >> $CABALHOME/config

79+ echo "remote-repo-cache: $CABALHOME/packages" >> $CABALHOME/config

80+ echo "logs-dir: $CABALHOME/logs" >> $CABALHOME/config

81+ echo "world-file: $CABALHOME/world" >> $CABALHOME/config

82+ echo "extra-prog-path: $CABALHOME/bin" >> $CABALHOME/config

83+ echo "symlink-bindir: $CABALHOME/bin" >> $CABALHOME/config

84+ echo "installdir: $CABALHOME/bin" >> $CABALHOME/config

85+ echo "build-summary: $CABALHOME/logs/build.log" >> $CABALHOME/config

86+ echo "store-dir: $CABALHOME/store" >> $CABALHOME/config

87+ echo "install-dirs user" >> $CABALHOME/config

88+ echo " prefix: $CABALHOME" >> $CABALHOME/config

89+ echo "repository hackage.haskell.org" >> $CABALHOME/config

90+ echo " url: http://hackage.haskell.org/" >> $CABALHOME/config

91+install:

92+ - ${CABAL} --version

93+ - echo "$(${HC} --version) [$(${HC} --print-project-git-commit-id 2> /dev/null || echo '?')]"

94+ - |

95+ echo "program-default-options" >> $CABALHOME/config

96+ echo " ghc-options: $GHCJOBS +RTS -M6G -RTS" >> $CABALHOME/config

97+ - cat $CABALHOME/config

98+ - rm -fv cabal.project cabal.project.local cabal.project.freeze

99+ - travis_retry ${CABAL} v2-update -v

100+ # Generate cabal.project

101+ - rm -rf cabal.project cabal.project.local cabal.project.freeze

102+ - touch cabal.project

103+ - |

104+ echo "packages: servant-swagger-ui" >> cabal.project

105+ echo "packages: servant-swagger-ui-core" >> cabal.project

106+ echo "packages: servant-swagger-ui-example" >> cabal.project

107+ echo "packages: servant-swagger-ui-jensoleg" >> cabal.project

108+ echo "packages: servant-swagger-ui-redoc" >> cabal.project

109+ - if [ $HCNUMVER -ge 80200 ] ; then echo 'package servant-swagger-ui' >> cabal.project ; fi

110+ - "if [ $HCNUMVER -ge 80200 ] ; then echo ' ghc-options: -Werror=missing-methods' >> cabal.project ; fi"

111+ - if [ $HCNUMVER -ge 80200 ] ; then echo 'package servant-swagger-ui-core' >> cabal.project ; fi

112+ - "if [ $HCNUMVER -ge 80200 ] ; then echo ' ghc-options: -Werror=missing-methods' >> cabal.project ; fi"

113+ - if [ $HCNUMVER -ge 80200 ] ; then echo 'package servant-swagger-ui-example' >> cabal.project ; fi

114+ - "if [ $HCNUMVER -ge 80200 ] ; then echo ' ghc-options: -Werror=missing-methods' >> cabal.project ; fi"

115+ - if [ $HCNUMVER -ge 80200 ] ; then echo 'package servant-swagger-ui-jensoleg' >> cabal.project ; fi

116+ - "if [ $HCNUMVER -ge 80200 ] ; then echo ' ghc-options: -Werror=missing-methods' >> cabal.project ; fi"

117+ - if [ $HCNUMVER -ge 80200 ] ; then echo 'package servant-swagger-ui-redoc' >> cabal.project ; fi

118+ - "if [ $HCNUMVER -ge 80200 ] ; then echo ' ghc-options: -Werror=missing-methods' >> cabal.project ; fi"

119+ - |

120+ - "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | (grep -vE -- '^(servant-swagger-ui|servant-swagger-ui-core|servant-swagger-ui-example|servant-swagger-ui-jensoleg|servant-swagger-ui-redoc)$' || true) | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"

121+ - cat cabal.project || true

122+ - cat cabal.project.local || true

123+ - if [ -f "servant-swagger-ui/configure.ac" ]; then (cd "servant-swagger-ui" && autoreconf -i); fi

124+ - if [ -f "servant-swagger-ui-core/configure.ac" ]; then (cd "servant-swagger-ui-core" && autoreconf -i); fi

125+ - if [ -f "servant-swagger-ui-example/configure.ac" ]; then (cd "servant-swagger-ui-example" && autoreconf -i); fi

126+ - if [ -f "servant-swagger-ui-jensoleg/configure.ac" ]; then (cd "servant-swagger-ui-jensoleg" && autoreconf -i); fi

127+ - if [ -f "servant-swagger-ui-redoc/configure.ac" ]; then (cd "servant-swagger-ui-redoc" && autoreconf -i); fi

128+ - ${CABAL} v2-freeze $WITHCOMPILER ${TEST} ${BENCH}

129+ - "cat cabal.project.freeze | sed -E 's/^(constraints: *| *)//' | sed 's/any.//'"

130+ - rm cabal.project.freeze

131+ - travis_wait 40 ${CABAL} v2-build $WITHCOMPILER ${TEST} ${BENCH} --dep -j2 all

132+ - travis_wait 40 ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks --dep -j2 all

133+script:

134+ - DISTDIR=$(mktemp -d /tmp/dist-test.XXXX)

135+ # Packaging...

136+ - ${CABAL} v2-sdist all

137+ # Unpacking...

138+ - mv dist-newstyle/sdist/*.tar.gz ${DISTDIR}/

139+ - cd ${DISTDIR} || false

140+ - find . -maxdepth 1 -type f -name '*.tar.gz' -exec tar -xvf '{}' \;

141+ - find . -maxdepth 1 -type f -name '*.tar.gz' -exec rm '{}' \;

142+ - PKGDIR_servant_swagger_ui="$(find . -maxdepth 1 -type d -regex '.*/servant-swagger-ui-[0-9.]*')"

143+ - PKGDIR_servant_swagger_ui_core="$(find . -maxdepth 1 -type d -regex '.*/servant-swagger-ui-core-[0-9.]*')"

144+ - PKGDIR_servant_swagger_ui_example="$(find . -maxdepth 1 -type d -regex '.*/servant-swagger-ui-example-[0-9.]*')"

145+ - PKGDIR_servant_swagger_ui_jensoleg="$(find . -maxdepth 1 -type d -regex '.*/servant-swagger-ui-jensoleg-[0-9.]*')"

146+ - PKGDIR_servant_swagger_ui_redoc="$(find . -maxdepth 1 -type d -regex '.*/servant-swagger-ui-redoc-[0-9.]*')"

147+ # Generate cabal.project

148+ - rm -rf cabal.project cabal.project.local cabal.project.freeze

149+ - touch cabal.project

150+ - |

151+ echo "packages: ${PKGDIR_servant_swagger_ui}" >> cabal.project

152+ echo "packages: ${PKGDIR_servant_swagger_ui_core}" >> cabal.project

153+ echo "packages: ${PKGDIR_servant_swagger_ui_example}" >> cabal.project

154+ echo "packages: ${PKGDIR_servant_swagger_ui_jensoleg}" >> cabal.project

155+ echo "packages: ${PKGDIR_servant_swagger_ui_redoc}" >> cabal.project

156+ - if [ $HCNUMVER -ge 80200 ] ; then echo 'package servant-swagger-ui' >> cabal.project ; fi

157+ - "if [ $HCNUMVER -ge 80200 ] ; then echo ' ghc-options: -Werror=missing-methods' >> cabal.project ; fi"

158+ - if [ $HCNUMVER -ge 80200 ] ; then echo 'package servant-swagger-ui-core' >> cabal.project ; fi

159+ - "if [ $HCNUMVER -ge 80200 ] ; then echo ' ghc-options: -Werror=missing-methods' >> cabal.project ; fi"

160+ - if [ $HCNUMVER -ge 80200 ] ; then echo 'package servant-swagger-ui-example' >> cabal.project ; fi

161+ - "if [ $HCNUMVER -ge 80200 ] ; then echo ' ghc-options: -Werror=missing-methods' >> cabal.project ; fi"

162+ - if [ $HCNUMVER -ge 80200 ] ; then echo 'package servant-swagger-ui-jensoleg' >> cabal.project ; fi

163+ - "if [ $HCNUMVER -ge 80200 ] ; then echo ' ghc-options: -Werror=missing-methods' >> cabal.project ; fi"

164+ - if [ $HCNUMVER -ge 80200 ] ; then echo 'package servant-swagger-ui-redoc' >> cabal.project ; fi

165+ - "if [ $HCNUMVER -ge 80200 ] ; then echo ' ghc-options: -Werror=missing-methods' >> cabal.project ; fi"

166+ - |

167+ - "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | (grep -vE -- '^(servant-swagger-ui|servant-swagger-ui-core|servant-swagger-ui-example|servant-swagger-ui-jensoleg|servant-swagger-ui-redoc)$' || true) | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"

168+ - cat cabal.project || true

169+ - cat cabal.project.local || true

170+ # Building...

171+ # this builds all libraries and executables (without tests/benchmarks)

172+ - ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks all

173+ # Building with tests and benchmarks...

174+ # build & run tests, build benchmarks

175+ - ${CABAL} v2-build $WITHCOMPILER ${TEST} ${BENCH} all

176+ # cabal check...

177+ - (cd ${PKGDIR_servant_swagger_ui} && ${CABAL} -vnormal check)

178+ - (cd ${PKGDIR_servant_swagger_ui_core} && ${CABAL} -vnormal check)

179+ - (cd ${PKGDIR_servant_swagger_ui_example} && ${CABAL} -vnormal check)

180+ - (cd ${PKGDIR_servant_swagger_ui_jensoleg} && ${CABAL} -vnormal check)

181+ - (cd ${PKGDIR_servant_swagger_ui_redoc} && ${CABAL} -vnormal check)

182+ # haddock...

183+ - ${CABAL} v2-haddock $WITHCOMPILER --with-haddock $HADDOCK ${TEST} ${BENCH} all

184+ # Building without installed constraints for packages in global-db...

185+ - rm -f cabal.project.local

186+ - ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks all

187+ # Constraint sets

188+ - rm -rf cabal.project.local

189+ # Constraint set servant-0.14

190+ - if [ $HCNUMVER -lt 80800 ] ; then ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks --constraint='servant ==0.14.*' all ; fi

191+ # Constraint set servant-0.15

192+ - if [ $HCNUMVER -lt 80800 ] ; then ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks --constraint='servant ==0.15.*' all ; fi

193+ # Constraint set servant-0.16

194+ - if [ $HCNUMVER -lt 81000 ] ; then ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks --constraint='servant ==0.16.*' all ; fi

195+ # Constraint set servant-0.17

196+ - if [ $HCNUMVER -lt 81000 ] ; then ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks --constraint='servant ==0.17.*' all ; fi

197+

198+# REGENDATA ("0.10.3",["--output",".travis.yml","--config=cabal.haskell-ci","cabal.project"])

199+# EOF

CHANGELOG.mddeleted−10

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

1−- 0.2.0.2.1.5

2−

3− - Introduce `SwaggerSchemaUI`, this fixes

4− [Swagger UI does not work when nested](https://github.com/phadej/servant-swagger-ui/issues/8) issue

5− by sacrificing some subjective flexibility.

6− - update bundled swagger-ui to version 2.1.5

7−

8−- 0.1.1.2.1.4

9−

10− - Documentation and example improvements

README.md+7−4

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

11# servant-swagger-ui

3−> Servant support for yaml

3+*Provide a Swagger UI for your Servant API*

5+"[Swagger UI](http://swagger.io/swagger-ui/) allows anyone — be it your development team or your end consumers — to visualize and interact with the API’s resources without having any of the implementation logic in place."

57[![Build Status](https://travis-ci.org/phadej/servant-swagger-ui.svg?branch=master)](https://travis-ci.org/phadej/servant-swagger-ui)

68[![Hackage](https://img.shields.io/hackage/v/servant-swagger-ui.svg)](http://hackage.haskell.org/package/servant-swagger-ui)

@@ -9,15 +11,16 @@

911

1012## Example

1113

12−![example screenshot](https://raw.githubusercontent.com/phadej/servant-swagger-ui/master/screenshot.png)

14+![example screenshot](https://raw.githubusercontent.com/haskell-servant/servant-swagger-ui/master/screenshot.png)

1315

14−Check [`example/Main.hs`](https://github.com/phadej/servant-swagger-ui/blob/master/example/Main.hs) for an example.

16+Check [`servant-swagger-ui-example/src/Main.hs`](https://github.com/haskell-servant/servant-swagger-ui/blob/master/servant-swagger-ui-example/src/Main.hs) for an example.

1517

1618## Development

1719

1820### Updating of bundled swagger-ui version:

1921

20−- Extract `dist` directory of `swagger-ui` into `swagger-dist-<version>`

22+- Extract `dist` directory of `swagger-ui` into `swagger-dist-<version>`. Remove the `*.map` files.

23+- update `extra-source-files` in the `.cabal`

2124- move `index.html` into `index.html.tmpl`, do the diff, port the changes

2225- search replace the embbeded directory (in `Servant/Swagger/UI.hs`)

2326- test it works

cabal.haskell-cinew file+17

@@ -0,0 +1,17 @@

1+branches: master

3+constraint-set servant-0.14

4+ ghc: >= 7.8 && <8.8

5+ constraints: servant ==0.14.*

7+constraint-set servant-0.15

8+ ghc: >= 8.0 && <8.8

9+ constraints: servant ==0.15.*

10+

11+constraint-set servant-0.16

12+ ghc: >= 8.0 && <8.10

13+ constraints: servant ==0.16.*

14+

15+constraint-set servant-0.17

16+ ghc: >= 8.0 && <8.10

17+ constraints: servant ==0.17.*

cabal.projectnew file+6

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

1+packages:

2+ servant-swagger-ui/

3+ servant-swagger-ui-core/

4+ servant-swagger-ui-example/

5+ servant-swagger-ui-jensoleg/

6+ servant-swagger-ui-redoc/

example/Main.hsdeleted−121

@@ -1,121 +0,0 @@

1−{-# LANGUAGE CPP #-}

2−{-# LANGUAGE DataKinds #-}

3−{-# LANGUAGE DeriveGeneric #-}

4−{-# LANGUAGE FlexibleInstances #-}

5−{-# LANGUAGE GeneralizedNewtypeDeriving #-}

6−{-# LANGUAGE MultiParamTypeClasses #-}

7−{-# LANGUAGE OverloadedStrings #-}

8−{-# LANGUAGE ScopedTypeVariables #-}

9−{-# LANGUAGE TypeFamilies #-}

10−{-# LANGUAGE TypeOperators #-}

11−{-# LANGUAGE UndecidableInstances #-}

12−{-# OPTIONS_GHC -fno-warn-orphans #-}

13−module Main (main, catIsMale, catName) where

14−

15−import Control.Lens hiding ((.=))

16−import Data.Aeson (ToJSON)

17−import Data.Maybe (fromMaybe)

18−import Data.String (IsString (..))

19−import Data.Text (Text)

20−import GHC.Generics (Generic)

21−import Network.Wai (Application)

22−import System.Environment (getArgs, lookupEnv)

23−import Text.Read (readMaybe)

24−

25−import Data.Swagger

26−import Servant

27−import Servant.Swagger

28−import Servant.Swagger.UI

29−

30−import qualified Network.Wai.Handler.Warp as Warp

31−

32−-- data types

33−data Cat = Cat { catName :: CatName, catIsMale :: Bool }

34− deriving (Generic, Show)

35−

36−newtype CatName = CatName Text

37− deriving ( Eq, Show, Generic

38−#if MIN_VERSION_servant(0,5,0)

39− , FromHttpApiData

40−#else

41− , FromText

42−#endif

43− )

44−

45−instance IsString CatName where

46− fromString = CatName . fromString

47−

48−-- swagger instances

49−instance ToJSON Cat

50−instance ToJSON CatName

51−instance ToParamSchema CatName

52−instance ToSchema Cat

53−instance ToSchema CatName

54−

55−-- api

56−type BasicAPI = Get '[PlainText, JSON] Text

57− :<|> "cat" :> Capture ":name" CatName :> Get '[JSON] Cat

58− :<|> "cat2" :> Capture ":name" CatName :> Get '[JSON] Cat

59− :<|> "cat3" :> Capture ":name" CatName :> Get '[JSON] Cat

60−

61−type API =

62− -- this serves both: swagger.json and swagger-ui

63− SwaggerSchemaUI "swagger-ui" "swagger.json"

64− :<|> BasicAPI

65−

66−-- To test nested case

67−type API' = API

68− :<|> "nested" :> API

69− :<|> SwaggerSchemaUI' "foo-ui" ("foo" :> "swagger.json" :> Get '[JSON] Swagger)

70−

71−-- Implementation

72−

73−-- | We test different ways to nest API, so we have an enumeration

74−data Variant

75− = Normal

76− | Nested

77− | SpecDown

78− deriving (Eq)

79−

80−server' :: Server API'

81−server' = server Normal

82− :<|> server Nested

83− :<|> swaggerSchemaUIServer (swaggerDoc' SpecDown)

84− where

85− server :: Variant -> Server API

86− server variant =

87− swaggerSchemaUIServer (swaggerDoc' variant)

88− :<|> (return "Hello World" :<|> catEndpoint :<|> catEndpoint :<|> catEndpoint)

89− where

90− catEndpoint n = return $ Cat n (variant == Normal)

91− -- Unfortunately we have to specify the basePath manually atm.

92−

93− swaggerDoc' Normal = swaggerDoc

94− swaggerDoc' Nested = swaggerDoc

95− & basePath ?~ "/nested"

96− & info.description ?~ "Nested API"

97− swaggerDoc' SpecDown = swaggerDoc

98− & info.description ?~ "Spec nested"

99−

100−-- Boilerplate

101−

102−swaggerDoc :: Swagger

103−swaggerDoc = toSwagger (Proxy :: Proxy BasicAPI)

104− & info.title .~ "Cats API"

105− & info.version .~ "2016.8.7"

106− & info.description ?~ "This is an API that tests servant-swagger support"

107−

108−api :: Proxy API'

109−api = Proxy

110−

111−app :: Application

112−app = serve api server'

113−

114−main :: IO ()

115−main = do

116− args <- getArgs

117− case args of

118− ("run":_) -> do

119− p <- fmap (fromMaybe 8000 . (>>= readMaybe)) $ lookupEnv "PORT"

120− Warp.run p app

121− _ -> putStrLn "To run the example server, pass 'run' argument"

hackage-docs.shdeleted−78

@@ -1,78 +0,0 @@

1−#!/bin/bash

2−set -e

3−

4−# This if stack-enabled fork of https://github.com/ekmett/lens/blob/master/scripts/hackage-docs.sh

5−

6−if [ "$#" -ne 1 ]; then

7− echo "Usage: scripts/hackage-docs.sh HACKAGE_USER"

8− exit 1

9−fi

10−

11−user=$1

12−

13−cabal_file=$(find . -maxdepth 1 -name "*.cabal" -print -quit)

14−if [ ! -f "$cabal_file" ]; then

15− echo "Run this script in the top-level package directory"

16− exit 1

17−fi

18−

19−pkg=$(awk -F ":[[:space:]]*" 'tolower($1)=="name" { print $2 }' < "$cabal_file")

20−ver=$(awk -F ":[[:space:]]*" 'tolower($1)=="version" { print $2 }' < "$cabal_file")

21−

22−if [ -z "$pkg" ]; then

23− echo "Unable to determine package name"

24− exit 1

25−fi

26−

27−if [ -z "$ver" ]; then

28− echo "Unable to determine package version"

29− exit 1

30−fi

31−

32−echo "Detected package: $pkg-$ver"

33−

34−dir=$(mktemp -d build-docs.XXXXXX)

35−trap 'rm -r "$dir"' EXIT

36−

37−export PATH=$(stack path --bin-path)

38−

39−ghc --version

40−cabal --version

41−stack --version

42−

43−if haddock --hyperlinked-source >/dev/null

44−then

45− echo "Using fancy hyperlinked source"

46− HYPERLINK_FLAG="--haddock-option=--hyperlinked-source"

47−else

48− echo "Using boring hyperlinked source"

49− HYPERLINK_FLAG="--hyperlink-source"

50−fi

51−

52−# Cabal dist in temporary location

53−builddir=$dir/dist

54−

55−# Build dependencies haddocks with stack, so we get links

56−stack haddock --only-dependencies

57−

58−# Configure using stack databases

59−snapshotpkgdb=$(stack path --snapshot-pkg-db)

60−localpkgdb=$(stack path --local-pkg-db)

61−cabal configure -v2 --builddir=$builddir --package-db=clear --package-db=global --package-db=$snapshotpkgdb --package-db=$localpkgdb

62−

63−# Build Hadckage compatible docs

64−cabal haddock -v2 --builddir=$builddir $HYPERLINK_FLAG --html-location='/package/$pkg-$version/docs' --contents-location='/package/$pkg-$version'

65−

66−# Copy into right directory

67−cp -R $builddir/doc/html/$pkg/ $dir/$pkg-$ver-docs

68−

69−# Tar and gzip

70−tar cvz -C $dir --format=ustar -f $dir/$pkg-$ver-docs.tar.gz $pkg-$ver-docs

71−

72−# Upload

73−curl -X PUT \

74− -H 'Content-Type: application/x-tar' \

75− -H 'Content-Encoding: gzip' \

76− -u "$user" \

77− --data-binary "@$dir/$pkg-$ver-docs.tar.gz" \

78− "https://hackage.haskell.org/package/$pkg-$ver/docs"

index.html.tmpldeleted−124

@@ -1,124 +0,0 @@

1−<!DOCTYPE html>

2−<html>

3−<head>

4− <meta charset="UTF-8">

5− <title>Swagger UI</title>

6− <link rel="icon" type="image/png" href="images/favicon-32x32.png" sizes="32x32" />

7− <link rel="icon" type="image/png" href="images/favicon-16x16.png" sizes="16x16" />

8− <link href='css/typography.css' media='screen' rel='stylesheet' type='text/css'/>

9− <link href='css/reset.css' media='screen' rel='stylesheet' type='text/css'/>

10− <link href='css/screen.css' media='screen' rel='stylesheet' type='text/css'/>

11− <link href='css/reset.css' media='print' rel='stylesheet' type='text/css'/>

12− <link href='css/print.css' media='print' rel='stylesheet' type='text/css'/>

13−

14− <script src='lib/object-assign-pollyfill.js' type='text/javascript'></script>

15− <script src='lib/jquery-1.8.0.min.js' type='text/javascript'></script>

16− <script src='lib/jquery.slideto.min.js' type='text/javascript'></script>

17− <script src='lib/jquery.wiggle.min.js' type='text/javascript'></script>

18− <script src='lib/jquery.ba-bbq.min.js' type='text/javascript'></script>

19− <script src='lib/handlebars-2.0.0.js' type='text/javascript'></script>

20− <script src='lib/lodash.min.js' type='text/javascript'></script>

21− <script src='lib/backbone-min.js' type='text/javascript'></script>

22− <script src='swagger-ui.js' type='text/javascript'></script>

23− <script src='lib/highlight.9.1.0.pack.js' type='text/javascript'></script>

24− <script src='lib/highlight.9.1.0.pack_extended.js' type='text/javascript'></script>

25− <script src='lib/jsoneditor.min.js' type='text/javascript'></script>

26− <script src='lib/marked.js' type='text/javascript'></script>

27− <script src='lib/swagger-oauth.js' type='text/javascript'></script>

28−

29−

30−

31−

32−

33−

34− <script type="text/javascript">

35− if (window.location.href.match(/\/index.html\/$/)) {

36− // drop trailing slash in "index.html/"

37− window.location.href = window.location.href.replace(/.$/, "");

38− } else if (!window.location.href.match(/\/(?:index.html)?$/)) {

39− // servant-swagger-ui: redirect to location with a trailing slash

40− // we need this because assets are served from relative paths

41− window.location.href = window.location.href + '/';

42− }

43− </script>

44−

45− <script type="text/javascript">

46− $(function () {

47− var url = window.location.search.match(/url=([^&]+)/);

48− if (url && url.length > 1) {

49− url = decodeURIComponent(url[1]);

50− } else {

51− // servant-swagger-ui addition

52− var ssuDir = "SERVANT_SWAGGER_UI_DIR";

53− var ssuSchema = "SERVANT_SWAGGER_UI_SCHEMA";

54− // more concretely:

55− // replace /swagger-ui/ or /swagger-ui/index.html with /swagger.json

56− // we always have trailing slash!

57− var re = new RegExp("\/" + ssuDir + "/(?:index\\.html)?$","g");

58− url = window.location.pathname.replace(re, "/" + ssuSchema);

59− }

60−

61− hljs.configure({

62− highlightSizeThreshold: 5000

63− });

64−

65− // Pre load translate...

66− if(window.SwaggerTranslator) {

67− window.SwaggerTranslator.translate();

68− }

69− window.swaggerUi = new SwaggerUi({

70− url: url,

71− dom_id: "swagger-ui-container",

72− supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'],

73− onComplete: function(swaggerApi, swaggerUi){

74− if(typeof initOAuth == "function") {

75− initOAuth({

76− clientId: "your-client-id",

77− clientSecret: "your-client-secret-if-required",

78− realm: "your-realms",

79− appName: "your-app-name",

80− scopeSeparator: ",",

81− additionalQueryStringParams: {}

82− });

83− }

84−

85− if(window.SwaggerTranslator) {

86− window.SwaggerTranslator.translate();

87− }

88− },

89− onFailure: function(data) {

90− log("Unable to Load SwaggerUI");

91− },

92− docExpansion: "none",

93− jsonEditor: false,

94− defaultModelRendering: 'schema',

95− showRequestHeaders: false

96− });

97−

98− window.swaggerUi.load();

99−

100− function log() {

101− if ('console' in window) {

102− console.log.apply(console, arguments);

103− }

104− }

105− });

106− </script>

107−</head>

108−

109−<body class="swagger-section">

110−<div id='header'>

111− <div class="swagger-ui-wrap">

112− <a id="logo" href="http://swagger.io"><img class="logo__img" alt="swagger" height="30" width="30" src="images/logo_small.png" /><span class="logo__title">swagger</span></a>

113− <form id='api_selector'>

114− <div class='input'><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text"/></div>

115− <div id='auth_container'></div>

116− <div class='input'><a id="explore" class="header__btn" href="#" data-sw-translate>Explore</a></div>

117− </form>

118− </div>

119−</div>

120−

121−<div id="message-bar" class="swagger-ui-wrap" data-sw-translate> </div>

122−<div id="swagger-ui-container" class="swagger-ui-wrap"></div>

123−</body>

124−</html>

package.yamldeleted−68

@@ -1,68 +0,0 @@

1−name: servant-swagger-ui

2−version: 0.2.0.2.1.5

3−synopsis: Servant swagger ui

4−description: Provide embedded swagger UI for servant and swagger (i.e. servant-swagger)

5−author: Oleg Grenrus <oleg.grenrus@iki.fi>

6−maintainer: Oleg Grenrus <oleg.grenrus@iki.fi>

7−license: BSD3

8−github: phadej/servant-swagger-ui

9−category: Web

10−tested-with: GHC==7.8.4, GHC==7.10.3, GHC==8.0.1

11−extra-source-files:

12−- README.md

13−- CHANGELOG.md

14−- index.html.tmpl

15−- swagger-dist-2.1.5/**/*

16−

17−ghc-options: -Wall

18−

19−dependencies:

20− - base >=4.7 && <4.10

21− - blaze-markup >=0.7.0.2 && <0.8

22− - bytestring >=0.10.4.0 && <0.11

23− - directory >=1.2.1.0 && <1.3

24− - file-embed >=0.0.9 && <0.1

25− - filepath >=1.3.0.2 && <1.5

26− - http-media >=0.6.2 && <0.8

27− - servant >=0.4.4.5 && <0.10

28− - servant-blaze >=0.4.4.5 && <0.9

29− - servant-server >=0.4.4.5 && <0.10

30− - servant-swagger >=1.0.3 && <1.2

31− - swagger2 >=2.0.1 && <2.2

32− - template-haskell >=2.9 && <2.12

33− - text >=1.2.0.6 && <1.3

34− - wai-app-static >=3.0.1.1 && <3.2

35−

36−flags:

37− servant-0-5:

38− description: "Whether use servant >= 0.5"

39− manual: false

40− default: true

41−

42−when:

43− - condition: flag(servant-0-5)

44− then:

45− dependencies:

46− - servant >=0.5

47− - transformers >=0.3 && <0.6

48− - transformers-compat >=0.3 && <0.6

49− else:

50− dependencies:

51− - servant <0.5

52− - either

53−

54−library:

55− source-dirs: src

56−

57−tests:

58− example:

59− main: Main.hs

60− source-dirs: example

61− dependencies:

62− - servant-swagger-ui

63− - servant-server >=0.4.4.5 && <0.10

64− - aeson >=0.8.0.2 && <1.1

65− - base-compat >=0.6.0 && <0.10

66− - lens >=4.7.0.1 && <4.15

67− - wai >=3.0.3.0 && <3.3

68− - warp >=3.0.13.1 && <3.3

screenshot.png

Binary file not shown.

servant-0.4-cabal.configdeleted−1

@@ -1 +0,0 @@

1−constraints: servant ==0.4.4.*

servant-0.5-cabal.configdeleted−1

@@ -1 +0,0 @@

1−constraints: servant ==0.5.*

servant-0.6-cabal.configdeleted−1

@@ -1 +0,0 @@

1−constraints: servant ==0.6.*

servant-0.7-cabal.configdeleted−1

@@ -1 +0,0 @@

1−constraints: servant ==0.7.*

servant-0.8-cabal.configdeleted−1

@@ -1 +0,0 @@

1−constraints: servant ==0.8.*

servant-0.9-cabal.configdeleted−1

@@ -1 +0,0 @@

1−constraints: servant ==0.9.*

servant-swagger-ui-core/Changelog.mdnew file+7

@@ -0,0 +1,7 @@

1+# 0.3.3

3+- Add `swaggerSchemaUIServerImpl'`

5+# 0.3.1

7+- Support `servant-0.14`

LICENSE → servant-swagger-ui-core/LICENSErenamed

The content is the same.

servant-swagger-ui-core/servant-swagger-ui-core.cabalnew file+54

@@ -0,0 +1,54 @@

1+cabal-version: 1.12

2+name: servant-swagger-ui-core

3+version: 0.3.3

4+x-revision: 4

5+synopsis: Servant swagger ui core components

6+category: Web, Servant, Swagger

7+description:

8+ Provide embedded swagger UI for servant and swagger (i.e. servant-swagger)

9+ .

10+ See servant-swagger-ui, servant-swagger-ui-jensoleg or

11+ servant-swagger-ui-redoc for "concrete" implementations.

12+

13+homepage: https://github.com/haskell-servant/servant-swagger-ui

14+bug-reports:

15+ https://github.com/haskell-servant/servant-swagger-ui/issues

16+

17+author: Oleg Grenrus <oleg.grenrus@iki.fi>

18+maintainer: haskell-servant-maintainers@googlegroups.com

19+license: BSD3

20+license-file: LICENSE

21+build-type: Simple

22+tested-with:

23+ GHC ==8.0.2

24+ || ==8.2.2

25+ || ==8.4.4

26+ || ==8.6.5

27+ || ==8.8.4

28+ || ==8.10.2

29+

30+extra-source-files: Changelog.md

31+

32+source-repository head

33+ type: git

34+ location: https://github.com/haskell-servant/servant-swagger-ui

35+

36+library

37+ hs-source-dirs: src

38+ ghc-options: -Wall

39+ build-depends:

40+ base >=4.7 && <4.15

41+ , blaze-markup >=0.7.0.2 && <0.9

42+ , bytestring >=0.10.4.0 && <0.11

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

44+ , servant >=0.14 && <0.19

45+ , servant-blaze >=0.8 && <0.10

46+ , servant-server >=0.14 && <0.19

47+ , swagger2 >=2.3.0.1 && <2.7

48+ , text >=1.2.3.0 && <1.3

49+ , transformers >=0.3 && <0.6

50+ , transformers-compat >=0.3 && <0.7

51+ , wai-app-static >=3.0.1.1 && <3.2

52+

53+ exposed-modules: Servant.Swagger.UI.Core

54+ default-language: Haskell2010

src/Servant/Swagger/UI.hs → servant-swagger-ui-core/src/Servant/Swagger/UI/Core.hsrenamed+28−43

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

1−{-# LANGUAGE CPP #-}

21{-# LANGUAGE ConstraintKinds #-}

32{-# LANGUAGE DataKinds #-}

43{-# LANGUAGE DeriveGeneric #-}

@@ -6,16 +5,10 @@

65{-# LANGUAGE MultiParamTypeClasses #-}

76{-# LANGUAGE OverloadedStrings #-}

87{-# LANGUAGE ScopedTypeVariables #-}

9−{-# LANGUAGE TemplateHaskell #-}

108{-# LANGUAGE TypeFamilies #-}

119{-# LANGUAGE TypeOperators #-}

1210{-# LANGUAGE UndecidableInstances #-}

1311-----------------------------------------------------------------------------

14−-- |

15−-- Module : Servant.Swagger.UI

17−-- License : BSD3

18−-- Maintainer : Oleg Grenrus <oleg.grenrus@iki.fi>

1912--

2013-- Provides 'SwaggerUI' and corresponding 'swaggerUIServer' to embed

2114-- <http://swagger.io/swagger-ui/ swagger ui> into the application.

@@ -30,7 +23,7 @@

3023-- :\<|> "cat" :> Capture ":name" CatName :> Get '[JSON] Cat

3124--

3225-- -- | API type with bells and whistles, i.e. schema file and swagger-ui.

33−-- type API = 'SwaggerSchemaUI' "swagger.json" "swagger-ui"

26+-- type API = 'SwaggerSchemaUI' "swagger-ui" "swagger.json"

3427-- :\<|> BasicAPI

3528--

3629-- -- | Servant server for an API

@@ -41,34 +34,28 @@

4134-- catEndpoint name = pure $ Cat name False

4235-- @

4336

44−module Servant.Swagger.UI (

37+module Servant.Swagger.UI.Core (

4538 -- * Swagger UI API

4639 SwaggerSchemaUI,

4740 SwaggerSchemaUI',

48− swaggerSchemaUIServer,

49− -- * Internals

41+

42+ -- * Implementation details

5043 SwaggerUiHtml(..),

44+ swaggerSchemaUIServerImpl,

45+ swaggerSchemaUIServerImpl',

46+ Handler,

5147 ) where

5248

5349import Data.ByteString (ByteString)

54−import Data.FileEmbed (embedStringFile)

5550import Data.Swagger (Swagger)

5651import GHC.TypeLits (KnownSymbol, Symbol, symbolVal)

5752import Network.Wai.Application.Static (embeddedSettings, staticApp)

5853import Servant

5954import Servant.HTML.Blaze (HTML)

60−import Servant.Swagger.UI.Internal

6155import Text.Blaze (ToMarkup (..))

6256

6357import qualified Data.Text as T

6458

65−#if MIN_VERSION_servant(0,5,0)

66−import Control.Monad.Trans.Except (ExceptT)

67−#else

68−import Control.Monad.Trans.Either (EitherT)

69−#define ExceptT EitherT

70−#endif

71−

7259-- | Swagger schema + ui api.

7360--

7461-- @SwaggerSchemaUI "swagger-ui" "swagger.json"@ will result into following hierarchy:

@@ -99,37 +86,35 @@ type SwaggerSchemaUI' (dir :: Symbol) (api :: *) =

9986--

10087-- Implementation detail: the @index.html@ is prepopulated with parameters

10188-- to find schema file automatically.

102−data SwaggerUiHtml (dir :: Symbol) (api :: *) = SwaggerUiHtml

89+data SwaggerUiHtml (dir :: Symbol) (api :: *) = SwaggerUiHtml T.Text

10390

104−instance (KnownSymbol dir, HasLink api, URI ~ MkLink api, IsElem api api)

91+instance (KnownSymbol dir, HasLink api, Link ~ MkLink api Link, IsElem api api)

10592 => ToMarkup (SwaggerUiHtml dir api)

10693 where

107− toMarkup _ = preEscapedToMarkup

94+ toMarkup (SwaggerUiHtml template) = preEscapedToMarkup

10895 $ T.replace "SERVANT_SWAGGER_UI_SCHEMA" schema

10996 $ T.replace "SERVANT_SWAGGER_UI_DIR" dir

110− $ swaggerUiIndexTemplate

97+ $ template

11198 where

112− schema = T.pack $ uriPath $ safeLink proxyApi proxyApi

99+ schema = T.pack $ uriPath . linkURI $ safeLink proxyApi proxyApi

113100 dir = T.pack $ symbolVal (Proxy :: Proxy dir)

114101 proxyApi = Proxy :: Proxy api

115102

116−-- | Serve Swagger UI on @/dir@ using @api@ as a Swagger spec source.

117−--

118−-- @

119−-- swaggerSchemaUIServer :: Swagger -> Server (SwaggerSchemaUI schema dir)

120−-- @

121−swaggerSchemaUIServer

122− :: (Server api ~ ExceptT ServantErr IO Swagger)

123− => Swagger -> Server (SwaggerSchemaUI' dir api)

124−swaggerSchemaUIServer swagger = return swagger

125− :<|> return SwaggerUiHtml

126− :<|> return SwaggerUiHtml

103+swaggerSchemaUIServerImpl

104+ :: (Server api ~ Handler Swagger)

105+ => T.Text -> [(FilePath, ByteString)]

106+ -> Swagger -> Server (SwaggerSchemaUI' dir api)

107+swaggerSchemaUIServerImpl indexTemplate files swagger

108+ = swaggerSchemaUIServerImpl' indexTemplate files $ return swagger

109+

110+-- | Use a custom server to serve the Swagger spec source.

111+swaggerSchemaUIServerImpl'

112+ :: T.Text -> [(FilePath, ByteString)]

113+ -> Server api -> Server (SwaggerSchemaUI' dir api)

114+swaggerSchemaUIServerImpl' indexTemplate files server

115+ = server

116+ :<|> return (SwaggerUiHtml indexTemplate)

117+ :<|> return (SwaggerUiHtml indexTemplate)

127118 :<|> rest

128119 where

129− rest = staticApp $ embeddedSettings swaggerUiFiles

130−

131−swaggerUiIndexTemplate :: T.Text

132−swaggerUiIndexTemplate = $(embedStringFile "index.html.tmpl")

133−

134−swaggerUiFiles :: [(FilePath, ByteString)]

135−swaggerUiFiles = $(mkRecursiveEmbedded "swagger-dist-2.1.5")

120+ rest = Tagged $ staticApp $ embeddedSettings files

servant-swagger-ui-example/LICENSEnew file+30

@@ -0,0 +1,30 @@

5+Redistribution and use in source and binary forms, with or without

6+modification, are permitted provided that the following conditions are met:

8+ * Redistributions of source code must retain the above copyright

9+ notice, this list of conditions and the following disclaimer.

10+

11+ * Redistributions in binary form must reproduce the above

12+ copyright notice, this list of conditions and the following

13+ disclaimer in the documentation and/or other materials provided

14+ with the distribution.

15+

16+ * Neither the name of Oleg Grenrus nor the names of other

17+ contributors may be used to endorse or promote products derived

18+ from this software without specific prior written permission.

19+

20+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

21+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

22+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

23+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

24+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

25+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

26+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

27+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

28+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

29+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

30+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Setup.hs → servant-swagger-ui-example/Setup.hsrenamed−1

@@ -1,3 +1,2 @@

11import Distribution.Simple

2−main :: IO ()

32main = defaultMain

servant-swagger-ui-example/servant-swagger-ui-example.cabalnew file+49

@@ -0,0 +1,49 @@

1+cabal-version: 2.0

2+name: servant-swagger-ui-example

3+version: 0

4+synopsis: servant-swagger-ui example

5+category: Web, Servant, Swagger

6+description: A kind of test-suite of servant-swagger-ui

7+homepage: https://github.com/haskell-servant/servant-swagger-ui

8+bug-reports:

9+ https://github.com/haskell-servant/servant-swagger-ui/issues

10+

11+author: Oleg Grenrus <oleg.grenrus@iki.fi>

12+maintainer: haskell-servant-maintainers@googlegroups.com

13+license: BSD3

14+license-file: LICENSE

15+build-type: Simple

16+tested-with:

17+ GHC ==8.0.2

18+ || ==8.2.2

19+ || ==8.4.4

20+ || ==8.6.5

21+ || ==8.8.4

22+ || ==8.10.2

23+

24+source-repository head

25+ type: git

26+ location: https://github.com/haskell-servant/servant-swagger-ui

27+

28+executable servant-swagger-ui-example

29+ main-is: Main.hs

30+ ghc-options: -threaded

31+ build-depends:

32+ aeson >=0.8.0.2 && <1.6

33+ , base >=4.7 && <4.15

34+ , base-compat >=0.9.3 && <0.12

35+ , lens >=4.7.0.1 && <4.20

36+ , servant

37+ , servant-server

38+ , servant-swagger

39+ , servant-swagger-ui

40+ , servant-swagger-ui-core

41+ , servant-swagger-ui-jensoleg

42+ , servant-swagger-ui-redoc

43+ , swagger2

44+ , text

45+ , wai >=3.0.3.0 && <3.3

46+ , warp >=3.0.13.1 && <3.4

47+

48+ hs-source-dirs: src

49+ default-language: Haskell2010

servant-swagger-ui-example/src/Main.hsnew file+213

@@ -0,0 +1,213 @@

1+{-# LANGUAGE CPP #-}

2+{-# LANGUAGE DataKinds #-}

3+{-# LANGUAGE DeriveGeneric #-}

4+{-# LANGUAGE FlexibleInstances #-}

5+{-# LANGUAGE GeneralizedNewtypeDeriving #-}

6+{-# LANGUAGE MultiParamTypeClasses #-}

7+{-# LANGUAGE OverloadedStrings #-}

8+{-# LANGUAGE ScopedTypeVariables #-}

9+{-# LANGUAGE TypeFamilies #-}

10+{-# LANGUAGE TypeOperators #-}

11+{-# LANGUAGE UndecidableInstances #-}

12+{-# OPTIONS_GHC -fno-warn-orphans #-}

13+module Main (main, catIsMale, catName) where

14+

15+import Prelude ()

16+import Prelude.Compat

17+

18+import Control.Lens hiding ((.=))

19+import Data.Aeson (FromJSON, ToJSON)

20+import Data.Maybe (fromMaybe)

21+import Data.String (IsString (..))

22+import Data.Text (Text)

23+import GHC.Generics (Generic)

24+import Network.Wai (Application)

25+import System.Environment (getArgs, lookupEnv)

26+import Text.Read (readMaybe)

27+

28+import Data.Swagger

29+import Servant

30+import Servant.Swagger

31+import Servant.Swagger.UI

32+import Servant.Swagger.UI.Core

33+import Servant.Swagger.UI.JensOleG

34+import Servant.Swagger.UI.ReDoc

35+

36+import qualified Network.Wai.Handler.Warp as Warp

37+

38+#if MIN_VERSION_servant(0,12,0)

39+#define SUMMARY(d) Summary d :>

40+#else

41+#define SUMMARY(d)

42+#endif

43+

44+#if MIN_VERSION_servant(0,13,0)

45+#if __GLASGOW_HASKELL__ >= 802 && MIN_VERSION_base(4,10,0)

46+import GHC.Generics (D1, Meta (..), Rep)

47+import GHC.TypeLits (AppendSymbol, Symbol)

48+#endif

49+#endif

50+

51+-- data types

52+data Cat = Cat { catName :: CatName, catIsMale :: Bool }

53+ deriving (Generic, Show)

54+

55+newtype CatName = CatName Text

56+ deriving ( Eq, Show, Generic

57+#if MIN_VERSION_servant(0,5,0)

58+ , FromHttpApiData

59+#else

60+ , FromText

61+#endif

62+ )

63+

64+instance IsString CatName where

65+ fromString = CatName . fromString

66+

67+-- swagger instances

68+instance ToJSON Cat

69+instance ToJSON CatName

70+instance FromJSON Cat

71+instance FromJSON CatName

72+instance ToParamSchema CatName

73+instance ToSchema Cat

74+instance ToSchema CatName

75+

76+-- api

77+

78+#if MIN_VERSION_servant(0,13,0)

79+#if __GLASGOW_HASKELL__ >= 802 && MIN_VERSION_base(4,10,0)

80+-- | Get a typename as type-level 'Symbol'.

81+--

82+-- Few non-Generic things are hard-coded, for else we fallback to 'Generic'

83+--

84+-- >>> :kind! TypeName Int

85+-- TypeName Int :: Symbol

86+-- = "Int"

87+--

88+-- >>> :kind! TypeName CatName

89+-- TypeName CatName :: Symbol

90+-- = "CatName"

91+--

92+-- Unfortunately we cannot use 'TypeError' for other cases,

93+-- as 'Rep' isn't reduced so 'GenericTypeName' cannot fall past first

94+-- equation. So you will get somewhat obscure errors saying

95+-- "no instance for (KnownSymbol ... (GenericTypeName YourNonGenericType ..."

96+--

97+-- >>> :kind! TypeName Float

98+-- TypeName Float :: Symbol

99+-- = GenericTypeName Float (Rep Float ())

100+--

101+-- It would be nice if there were such type family for 'Typeable', i.e. all

102+-- types :)

103+--

104+type family TypeName (x :: *) :: Symbol where

105+ TypeName Int = "Int"

106+ TypeName Text = "Text"

107+ TypeName x = GenericTypeName x (Rep x ())

108+

109+type family GenericTypeName t (r :: *) :: Symbol where

110+ GenericTypeName t (D1 ('MetaData name mod pkg nt) f x) = name

111+

112+type Desc t n = Description (AppendSymbol (TypeName t) (AppendSymbol " | " n))

113+#else

114+type Desc t n = Description n

115+#endif

116+#endif

117+

118+type FirstCatEndpoint =

119+#if MIN_VERSION_servant(0,13,0)

120+ "cat"

121+ :> Summary "First cat endpoint"

122+ :> Capture' '[Desc CatName "Cat's name"] ":name" CatName

123+ :> QueryParam' '[Required, Desc Int "Random number"] "num" Int

124+ :> QueryParam' '[Optional, Desc Text "Random text"] "text" Text

125+ :> Get '[JSON] Cat

126+#else

127+ "cat" :> Capture ":name" CatName

128+ :> QueryParam "num" Int :> QueryParam "text" Text :> Get '[JSON] Cat

129+#endif

130+

131+type BasicAPI = Get '[PlainText, JSON] Text

132+ :<|> FirstCatEndpoint

133+ :<|> SUMMARY("Second cat") "cat2" :> Capture ":name" CatName :> Get '[JSON] Cat

134+ :<|> SUMMARY("Third cat") "cat3" :> Capture ":name" CatName :> Get '[JSON] Cat

135+ :<|> SUMMARY("Post endpoint") "post-cat" :> ReqBody '[JSON] Cat :> Post '[JSON] Cat

136+

137+type API =

138+ -- this serves both: swagger.json and swagger-ui

139+ SwaggerSchemaUI "swagger-ui" "swagger.json"

140+ :<|> BasicAPI

141+

142+-- To test nested case

143+type API' = API

144+ :<|> "nested" :> API

145+ :<|> SwaggerSchemaUI' "foo-ui" ("foo" :> "swagger.json" :> Get '[JSON] Swagger)

146+

147+-- Implementation

148+

149+-- | We test different ways to nest API, so we have an enumeration

150+data Variant

151+ = Normal

152+ | Nested

153+ | SpecDown

154+ deriving (Eq)

155+

156+data UIFlavour

157+ = Original

158+ | JensOleG

159+ | ReDoc

160+ deriving (Eq)

161+

162+server' :: UIFlavour -> Server API'

163+server' uiFlavour = server Normal

164+ :<|> server Nested

165+ :<|> schemaUiServer (swaggerDoc' SpecDown)

166+ where

167+ server :: Variant -> Server API

168+ server variant =

169+ schemaUiServer (swaggerDoc' variant)

171+ where

172+ catEndpoint' n _ _ = return $ Cat n (variant == Normal)

173+ catEndpoint n = return $ Cat n (variant == Normal)

174+ -- Unfortunately we have to specify the basePath manually atm.

175+

176+ schemaUiServer

177+ :: (Server api ~ Handler Swagger)

178+ => Swagger -> Server (SwaggerSchemaUI' dir api)

179+ schemaUiServer = case uiFlavour of

180+ Original -> swaggerSchemaUIServer

181+ JensOleG -> jensolegSwaggerSchemaUIServer

182+ ReDoc -> redocSchemaUIServer

183+

184+ swaggerDoc' Normal = swaggerDoc

185+ swaggerDoc' Nested = swaggerDoc

186+ & basePath ?~ "/nested"

187+ & info.description ?~ "Nested API"

188+ swaggerDoc' SpecDown = swaggerDoc

189+ & info.description ?~ "Spec nested"

190+

191+-- Boilerplate

192+

193+swaggerDoc :: Swagger

194+swaggerDoc = toSwagger (Proxy :: Proxy BasicAPI)

195+ & info.title .~ "Cats API"

196+ & info.version .~ "2016.8.7"

197+ & info.description ?~ "This is an API that tests servant-swagger support"

198+

199+api :: Proxy API'

200+api = Proxy

201+

202+app :: UIFlavour -> Application

203+app = serve api . server'

204+

205+main :: IO ()

206+main = do

207+ args <- getArgs

208+ let uiFlavour | "jensoleg" `elem` args = JensOleG

209+ | "redoc" `elem` args = ReDoc

210+ | otherwise = Original

211+ p <- fromMaybe 8000 . (>>= readMaybe) <$> lookupEnv "PORT"

212+ putStrLn $ "http://localhost:" ++ show p ++ "/"

213+ Warp.run p (app uiFlavour)

servant-swagger-ui-jensoleg/LICENSEnew file+45

@@ -0,0 +1,45 @@