git.iko.soy/typeable/swagger2
on master help sign in
swap
5470313297 ahead, 0 behind
.ghcinew file+2
since splitsnapshots
unifiedsplit
@@ -0,0 +1,2 @@
1+:set -itest -isrc -optP-include -optP.stack-work/dist/x86_64-linux/Cabal-1.24.2.0/build/autogen/cabal_macros.h -optP-I -optPinclude
2+:set -hide-package base-compat-0.10.4
.gitignore+2
@@ -1,4 +1,6 @@
1dist
1dist
2+dist-newstyle
3+.ghc.environment.*
2cabal-dev
4cabal-dev
3*.o
5*.o
4*.hi
6*.hi
.travis.yml+155−34
@@ -1,41 +1,162 @@
1+# This Travis job script has been generated by a script via
2+#
3+# haskell-ci '--branches' 'master' '--haddock-jobs=>=8.4' '--output' '.travis.yml' 'swagger2.cabal'
4+#
5+# For more information, see https://github.com/haskell-CI/haskell-ci
6+#
7+# version: 0.5.20191020
8+#
1language: c
9language: c
2−
10+dist: xenial
3−# explicitly request container-based infrastructure
11+git:
12+ # whether to recursively clone submodules
4−sudo: false
13+ submodules: false
5−
14+branches:
15+ only:
16+ - master
17+cache:
18+ directories:
19+ - $HOME/.cabal/packages
20+ - $HOME/.cabal/store
21+before_cache:
22+ - rm -fv $CABALHOME/packages/hackage.haskell.org/build-reports.log
23+ # remove files that are regenerated by 'cabal update'
24+ - rm -fv $CABALHOME/packages/hackage.haskell.org/00-index.*
25+ - rm -fv $CABALHOME/packages/hackage.haskell.org/*.json
26+ - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.cache
27+ - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.tar
28+ - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.tar.idx
29+ - rm -rfv $CABALHOME/packages/head.hackage
6matrix:
30matrix:
7 include:
31 include:
8− - env: CABALVER=1.18 GHCVER=7.8.4 HAPPYVER=1.19.4
32+ - compiler: ghc-8.8.1
9− addons: {apt: {packages: [cabal-install-1.18,ghc-7.8.4,happy-1.19.4], sources: [hvr-ghc]}}
33+ addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-8.8.1","cabal-install-3.0"]}}
10− - env: CABALVER=1.22 GHCVER=7.10.1 HAPPYVER=1.19.5
34+ - compiler: ghc-8.6.5
11− addons: {apt: {packages: [cabal-install-1.22,ghc-7.10.1,happy-1.19.5],sources: [hvr-ghc]}}
35+ addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-8.6.5","cabal-install-3.0"]}}
12− - env: CABALVER=head GHCVER=head HAPPYVER=head
36+ - compiler: ghc-8.4.4
13− addons: {apt: {packages: [cabal-install-head,ghc-head,happy-head], sources: [hvr-ghc]}}
37+ addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-8.4.4","cabal-install-3.0"]}}
14−
38+ - compiler: ghc-8.2.2
15− allow_failures:
39+ addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-8.2.2","cabal-install-3.0"]}}
16− - env: CABALVER=1.18 GHCVER=7.8.4 HAPPYVER=1.19.4
40+ - compiler: ghc-8.0.2
17− - env: CABALVER=head GHCVER=head HAPPYVER=head
41+ addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-8.0.2","cabal-install-3.0"]}}
18−
19before_install:
42before_install:
20− - export PATH=/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:$PATH:/opt/happy/$HAPPYVER/bin
43+ - HC=$(echo "/opt/$CC/bin/ghc" | sed 's/-/\//')
21−
44+ - WITHCOMPILER="-w $HC"
45+ - HADDOCK=$(echo "/opt/$CC/bin/haddock" | sed 's/-/\//')
46+ - HCPKG="$HC-pkg"
47+ - unset CC
48+ - CABAL=/opt/ghc/bin/cabal
49+ - CABALHOME=$HOME/.cabal
50+ - export PATH="$CABALHOME/bin:$PATH"
51+ - TOP=$(pwd)
52+ - "HCNUMVER=$(${HC} --numeric-version|perl -ne '/^(\\d+)\\.(\\d+)\\.(\\d+)(\\.(\\d+))?$/; print(10000 * $1 + 100 * $2 + ($3 == 0 ? $5 != 1 : $3))')"
53+ - echo $HCNUMVER
54+ - CABAL="$CABAL -vnormal+nowrap+markoutput"
55+ - set -o pipefail
56+ - |
57+ echo 'function blue(s) { printf "\033[0;34m" s "\033[0m " }' >> .colorful.awk
58+ echo 'BEGIN { state = "output"; }' >> .colorful.awk
59+ echo '/^-----BEGIN CABAL OUTPUT-----$/ { state = "cabal" }' >> .colorful.awk
60+ echo '/^-----END CABAL OUTPUT-----$/ { state = "output" }' >> .colorful.awk
61+ echo '!/^(-----BEGIN CABAL OUTPUT-----|-----END CABAL OUTPUT-----)/ {' >> .colorful.awk
62+ echo ' if (state == "cabal") {' >> .colorful.awk
63+ echo ' print blue($0)' >> .colorful.awk
64+ echo ' } else {' >> .colorful.awk
65+ echo ' print $0' >> .colorful.awk
66+ echo ' }' >> .colorful.awk
67+ echo '}' >> .colorful.awk
68+ - cat .colorful.awk
69+ - |
70+ color_cabal_output () {
71+ awk -f $TOP/.colorful.awk
72+ }
73+ - echo text | color_cabal_output
22install:
74install:
23− - cabal --version
75+ - ${CABAL} --version
24− - echo "$(ghc --version) [$(ghc --print-project-git-commit-id 2> /dev/null || echo '?')]"
76+ - echo "$(${HC} --version) [$(${HC} --print-project-git-commit-id 2> /dev/null || echo '?')]"
77+ - TEST=--enable-tests
78+ - BENCH=--enable-benchmarks
79+ - HEADHACKAGE=false
80+ - rm -f $CABALHOME/config
81+ - |
82+ echo "verbose: normal +nowrap +markoutput" >> $CABALHOME/config
83+ echo "remote-build-reporting: anonymous" >> $CABALHOME/config
84+ echo "write-ghc-environment-files: always" >> $CABALHOME/config
85+ echo "remote-repo-cache: $CABALHOME/packages" >> $CABALHOME/config
86+ echo "logs-dir: $CABALHOME/logs" >> $CABALHOME/config
87+ echo "world-file: $CABALHOME/world" >> $CABALHOME/config
88+ echo "extra-prog-path: $CABALHOME/bin" >> $CABALHOME/config
89+ echo "symlink-bindir: $CABALHOME/bin" >> $CABALHOME/config
90+ echo "installdir: $CABALHOME/bin" >> $CABALHOME/config
91+ echo "build-summary: $CABALHOME/logs/build.log" >> $CABALHOME/config
92+ echo "store-dir: $CABALHOME/store" >> $CABALHOME/config
93+ echo "install-dirs user" >> $CABALHOME/config
94+ echo " prefix: $CABALHOME" >> $CABALHOME/config
95+ echo "repository hackage.haskell.org" >> $CABALHOME/config
96+ echo " url: http://hackage.haskell.org/" >> $CABALHOME/config
97+ echo " secure: True" >> $CABALHOME/config
98+ echo " key-threshold: 3" >> $CABALHOME/config
99+ echo " root-keys:" >> $CABALHOME/config
100+ echo " fe331502606802feac15e514d9b9ea83fee8b6ffef71335479a2e68d84adc6b0" >> $CABALHOME/config
101+ echo " 1ea9ba32c526d1cc91ab5e5bd364ec5e9e8cb67179a471872f6e26f0ae773d42" >> $CABALHOME/config
102+ echo " 2c6c3627bd6c982990239487f1abd02e08a02e6cf16edb105a8012d444d870c3" >> $CABALHOME/config
103+ echo " 0a5c7ea47cd1b15f01f5f51a33adda7e655bc0f0b0615baa8e271f4c3351e21d" >> $CABALHOME/config
104+ echo " 51f0161b906011b52c6613376b1ae937670da69322113a246a09f807c62f6921" >> $CABALHOME/config
105+ - |
106+ echo "program-default-options" >> $CABALHOME/config
107+ echo " ghc-options: $GHCJOBS +RTS -M6G -RTS" >> $CABALHOME/config
108+ - cat $CABALHOME/config
109+ - rm -fv cabal.project cabal.project.local cabal.project.freeze
25− - travis_retry cabal update
110+ - travis_retry ${CABAL} v2-update -v
26− - cabal install --only-dependencies --enable-tests --enable-benchmarks
111+ # Generate cabal.project
27−
112+ - rm -rf cabal.project cabal.project.local cabal.project.freeze
28−# Here starts the actual work to be performed for the package under test; any command which exits with a non-zero exit code causes the build to fail.
113+ - touch cabal.project
114+ - |
115+ echo "packages: ." >> cabal.project
116+ - |
117+ - "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | (grep -vE -- '^(swagger2)$' || true) | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"
118+ - cat cabal.project || true
119+ - cat cabal.project.local || true
120+ - if [ -f "./configure.ac" ]; then (cd "." && autoreconf -i); fi
121+ - ${CABAL} v2-freeze $WITHCOMPILER ${TEST} ${BENCH} | color_cabal_output
122+ - "cat cabal.project.freeze | sed -E 's/^(constraints: *| *)//' | sed 's/any.//'"
123+ - rm cabal.project.freeze
124+ - ${CABAL} v2-build $WITHCOMPILER ${TEST} ${BENCH} --dep -j2 all | color_cabal_output
125+ - ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks --dep -j2 all | color_cabal_output
29script:
126script:
30− - if [ -f configure.ac ]; then autoreconf -i; fi
127+ - DISTDIR=$(mktemp -d /tmp/dist-test.XXXX)
31− - cabal configure --enable-tests --enable-benchmarks -v2 # -v2 provides useful information for debugging
128+ # Packaging...
129+ - ${CABAL} v2-sdist all | color_cabal_output
130+ # Unpacking...
131+ - mv dist-newstyle/sdist/*.tar.gz ${DISTDIR}/
132+ - cd ${DISTDIR} || false
133+ - find . -maxdepth 1 -type f -name '*.tar.gz' -exec tar -xvf '{}' \;
134+ - find . -maxdepth 1 -type f -name '*.tar.gz' -exec rm '{}' \;
135+ - PKGDIR_swagger2="$(find . -maxdepth 1 -type d -regex '.*/swagger2-[0-9.]*')"
136+ # Generate cabal.project
137+ - rm -rf cabal.project cabal.project.local cabal.project.freeze
138+ - touch cabal.project
139+ - |
140+ echo "packages: ${PKGDIR_swagger2}" >> cabal.project
141+ - |
142+ - "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | (grep -vE -- '^(swagger2)$' || true) | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"
143+ - cat cabal.project || true
144+ - cat cabal.project.local || true
145+ # Building...
32− - cabal build --ghc-options="-O0" # this builds all libraries and executables (including tests/benchmarks)
146+ # this builds all libraries and executables (without tests/benchmarks)
33− - cabal test
147+ - ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks all | color_cabal_output
34− - cabal check
148+ # Building with tests and benchmarks...
35− - cabal sdist # tests that a source-distribution can be generated
149+ # build & run tests, build benchmarks
150+ - ${CABAL} v2-build $WITHCOMPILER ${TEST} ${BENCH} all | color_cabal_output
151+ # Testing...
152+ - ${CABAL} v2-test $WITHCOMPILER ${TEST} ${BENCH} all | color_cabal_output
153+ # cabal check...
154+ - (cd ${PKGDIR_swagger2} && ${CABAL} -vnormal check)
155+ # haddock...
156+ - if [ $HCNUMVER -ge 80400 ] ; then ${CABAL} v2-haddock $WITHCOMPILER --with-haddock $HADDOCK ${TEST} ${BENCH} all | color_cabal_output ; fi
157+ # Building without installed constraints for packages in global-db...
158+ - rm -f cabal.project.local
159+ - ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks all | color_cabal_output
36
160
37−# Check that the resulting source distribution can be built & installed.
161+# REGENDATA ("0.5.20191020",["--branches","master","--haddock-jobs=>=8.4","--output",".travis.yml","swagger2.cabal"])
38−# If there are no other `.tar.gz` files in `dist`, this can be even simpler:
162+# EOF
39−# `cabal install --force-reinstalls dist/*-*.tar.gz`
40− - SRC_TGZ=$(cabal info . | awk '{print $2;exit}').tar.gz &&
41− (cd dist && cabal install --force-reinstalls "$SRC_TGZ")
CHANGELOG.md+186−1
@@ -1,7 +1,192 @@
1+2.5
2+---
3+
4+Highlights:
5+- Add instance for `TimeOfDay` (see [#196]( https://github.com/GetShopTV/swagger2/pull/196 ));
6+- Add support for [`optics`](https://hackage.haskell.org/package/optics) (see [#200]( https://github.com/GetShopTV/swagger2/pull/200 ));
7+- Slightly better validation errors (see [#195]( https://github.com/GetShopTV/swagger2/pull/195 ));
8+
9+Fixes and minor changes:
10+- Minor cleanup (see [#194]( https://github.com/GetShopTV/swagger2/pull/194 ));
11+- Allow base-4.13 and other GHC-8.8 related stuff (see [#198]( https://github.com/GetShopTV/swagger2/pull/198 ));
12+- Fix `stack.yaml` (see [#201]( https://github.com/GetShopTV/swagger2/pull/201 ));
13+
14+2.4
15+---
16+
17+- Allow hashable-1.3, semigroups-0.19, network-3.1, time-1.9, generics-sop-0.5
18+- Tags aren't sorted
19+ (see [#165](https://github.com/GetShopTV/swagger2/issues/165))
20+- Schema type is optional
21+ (see [#138](https://github.com/GetShopTV/swagger2/issues/138), [#164](https://github.com/GetShopTV/swagger2/pull/164))
22+- Take concrete 'Proxy' as argument
23+ (see [#180](https://github.com/GetShopTV/swagger2/pull/180))
24+- GHC-8.8 preparations
25+
26+2.3.1.1
27+-------
28+
29+- Allow `network-3.0`
30+
31+2.3.1
32+-----
33+
34+- Add a quickcheck generator for aeson Values that match a swagger schema
35+ (see [#162](https://github.com/GetShopTV/swagger2/pull/162))
36+- Add `ToParamSchema` instance for `SetCookie`
37+ (see [#173](https://github.com/GetShopTV/swagger2/pull/173))
38+- Make nullary schemas valid
39+ (see [#168](https://github.com/GetShopTV/swagger2/pull/168))
40+
41+2.3.0.1
42+-------
43+
44+- Support GHC-8.6
45+
46+2.3
47+---
48+
49+Major changes:
50+
51+- Add support for `additionalProperties` with `Bool` value (see [#159](https://github.com/GetShopTV/swagger2/pull/159));
52+- Add `ToSchema` `Object` instance (for aeson's `Object`) (see [`d72466a`](https://github.com/GetShopTV/swagger2/commit/d72466a));
53+
54+Dependencies and CI:
55+
56+- Aeson 1.4 (see [#158](https://github.com/GetShopTV/swagger2/pull/158));
57+- Update .travis.yml (see [#160](https://github.com/GetShopTV/swagger2/pull/160));
58+- Allow network 2.7 (see [#155](https://github.com/GetShopTV/swagger2/pull/155));
59+- Allow lens-4.17 (see [#161](https://github.com/GetShopTV/swagger2/pull/161));
60+
61+2.2.2
62+-----
63+
64+* Add `ToSchema Version` instance
65+* Use base-compat-batteries (0.10)
66+* PVP bounds
67+
68+2.2.1
69+-----
70+
71+* Add `Semigroup` instances
72+* GHC-8.4 compatibility
73+* `Schema (NonEmpty a) instance (see [#141](https://github.com/GetShopTV/swagger2/pull/141))
74+* Fix optional property for unary records (see [#142](https://github.com/GetShopTV/swagger2/issues/142))
75+* Add `fromAesonOptions` helper (see [#146](https://github.com/GetShopTV/swagger2/issues/139))
76+* Fix non-termination when using `datatypeNameModifier` with recursive data types (see [#132](https://github.com/GetShopTV/swagger2/issues/132))
77+
78+2.2
79+---
80+
81+* Treat unknown properties as validation errors in `validateToJSON` (see [#126](https://github.com/GetShopTV/swagger2/pull/126));
82+* Add `validateJSON` and `validateJSONWithPatternChecker` to validate JSON `Value` against `Schema` without classes (see [#126](https://github.com/GetShopTV/swagger2/pull/126));
83+* Add more `Schema` helpers (see [#126](https://github.com/GetShopTV/swagger2/pull/126)):
84+ * `genericNameSchema` — to give a custom schema `Generic`-based name;
85+ * `genericDeclareNamedSchemaNewtype` — to derive `NamedSchema` for `newtype`s;
86+ * `declareSchemaBoundedEnumKeyMapping` — to derive more specific `Schema` for maps with `Bounded` `Enum` keys;
87+* Add a few tests with invalid `Schema`.
88+
89+2.1.6
90+-----
91+
92+* Add `ToParamSchema` and `ToSchema` instances for `Fixed` (see [#121](https://github.com/GetShopTV/swagger2/pull/121)) and `Natural` (see [#123](https://github.com/GetShopTV/swagger2/pull/123));
93+* Fix instance for `NominalDiffTime` (see [#121](https://github.com/GetShopTV/swagger2/pull/121));
94+* Fix build for `aeson-1.2.2.0` (see [#125](https://github.com/GetShopTV/swagger2/pull/125)).
95+
96+2.1.5
97+-----
98+
99+* Type error by default when deriving Generic-based instances for mixed sum types (see [#118](https://github.com/GetShopTV/swagger2/pull/118));
100+* Adjust `allOf` to accept referenced schemas (see [#119](https://github.com/GetShopTV/swagger2/issues/119));
101+* Add instances for `Identity` (see [#116](https://github.com/GetShopTV/swagger2/pull/116));
102+* Add Gitter chat badge (see [#114](https://github.com/GetShopTV/swagger2/pull/114)).
103+
104+2.1.4.1
105+-------
106+
107+* GHC-8.2 support (see [#95](https://github.com/GetShopTV/swagger2/issues/95), [#106](https://github.com/GetShopTV/swagger2/pull/106) and [#108](https://github.com/GetShopTV/swagger2/pull/108));
108+* Documentation corrections (see [#105](https://github.com/GetShopTV/swagger2/pull/105));
109+* Allow `generics-sop-0.3` (see [#102](https://github.com/GetShopTV/swagger2/pull/102));
110+* Fix `ToSchema` example in docs (see [#104](https://github.com/GetShopTV/swagger2/pull/104)).
111+
112+2.1.4
113+-----
114+
115+* Add `liftDeclare` (see [#100](https://github.com/GetShopTV/swagger2/pull/100));
116+* Add `MonadDeclare` instances for all monad transformers (see [#100](https://github.com/GetShopTV/swagger2/pull/100)).
117+
118+2.1.3
119+-----
120+
121+* Add [`UUID`](http://hackage.haskell.org/package/uuid-types/docs/Data-UUID-Types.html#t:UUID) instances (see [#81](https://github.com/GetShopTV/swagger2/pull/81)).
122+* Add [`TypeError`](https://hackage.haskell.org/package/base-4.9.0.0/docs/GHC-TypeLits.html#g:4) `ToSchema` and `ToParamSchema ByteString` instances (see [#78](https://github.com/GetShopTV/swagger2/pull/78))
123+* Improve documentation for generic sum type instance derivation (see [#75](https://github.com/GetShopTV/swagger2/pull/75))
124+* Compile warning free (see [#82](https://github.com/GetShopTV/swagger2/pull/82))
125+
126+2.1.2.1
127+-------
128+
129+* Bug fix previous release
130+
131+2.1.2
132+---
133+
134+* Minor changes:
135+ * Support `aeson-1.0.0.0` (see [#70](https://github.com/GetShopTV/swagger2/pull/70)).
136+
137+2.1.1
138+---
139+
140+* Minor changes:
141+ * Proper `Schema` examples for `Char`, `Day`, `LocalTime`, `ZonedTime` and `UTCTime`.
142+
143+2.1
144+---
145+
146+* Major changes:
147+ * Use `InsOrdHashMap` to preserve insertion order for endpoints and definitions (see [#56](https://github.com/GetShopTV/swagger2/pull/56));
148+ * Add support for GHC 8.0 (see [#65](https://github.com/GetShopTV/swagger2/pull/65)).
149+
150+2.0.2
151+---
152+
153+* Fixes:
154+ * Fix `additionalProperties` to allow references;
155+ * Fix `ToSchema` instances for `Map` and `HashMap` (prevent infinite recursion for recursive values).
156+
157+2.0.1
158+---
159+
160+* Fixes:
161+ * Re-export `Pattern` synonym from `Data.Swagger`;
162+ * Documentation fixes.
163+
164+2.0
165+---
166+
167+* Major changes:
168+ * GHC 7.8 support (see [#49](https://github.com/GetShopTV/swagger2/pull/49));
169+ * Switch to classy field lenses (see [#41](https://github.com/GetShopTV/swagger2/pull/41));
170+ * Add `Data.Swagger.Schema.Validation` (see [#18](https://github.com/GetShopTV/swagger2/pull/18));
171+ * Add `Data.Swagger.Operation` with helpers (see [#50](https://github.com/GetShopTV/swagger2/pull/50));
172+ * Add `IsString` instances for some types (see [#47](https://github.com/GetShopTV/swagger2/pull/47));
173+ * Add helpers to sketch `Schema` from JSON (see [#48](https://github.com/GetShopTV/swagger2/pull/48)).
174+
175+* Minor changes:
176+ * Make `NamedSchema` a `data` rather than `type` (see [#42](https://github.com/GetShopTV/swagger2/pull/42));
177+ * Change `Definitions` to `Definitions Schema`;
178+ * Add schema templates for `"binary"`, `"byte"` and `"password"` formats (see [63ed597](https://github.com/GetShopTV/swagger2/commit/63ed59736dc4f942f0e2a7d668d7cee513fa9eaf));
179+ * Add `Monoid` instance for `Contact`;
180+ * Change `tags` to be `Set` rather than list.
181+
182+* Fixes:
183+ * Fix schema for `()` and nullary constructors (see [ab65c4a](https://github.com/GetShopTV/swagger2/commit/ab65c4a48253c34f8a88221a53dc97bf5e6e8d29));
184+ * Fix `Operation` `FromJSON` instance to allow missing `tags` and `parameters` properties.
185+
11.2.1
1861.2.1
2---
187---
3
188
4−* Minor change:
189+* Minor changes:
5 * Change `_SwaggerItemsPrimitive` type from a `Prism'` to a more restrictive `Review`-like `Optic'`.
190 * Change `_SwaggerItemsPrimitive` type from a `Prism'` to a more restrictive `Review`-like `Optic'`.
6
191
7* Fixes:
192* Fixes:
LICENSE+1−1
@@ -1,4 +1,4 @@
1−Copyright (c) 2015, GetShopTV
1+Copyright (c) 2015-2017, GetShopTV
2All rights reserved.
2All rights reserved.
3
3
4Redistribution and use in source and binary forms, with or without
4Redistribution and use in source and binary forms, with or without
README.md+3−1
@@ -1,5 +1,7 @@
1# swagger2
1# swagger2
2
2
3+[![Join the chat at https://gitter.im/haskell-swagger2/Lobby](https://badges.gitter.im/haskell-swagger2/Lobby.svg)](https://gitter.im/haskell-swagger2/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
4+
3[![Hackage](https://img.shields.io/hackage/v/swagger2.svg)](http://hackage.haskell.org/package/swagger2)
5[![Hackage](https://img.shields.io/hackage/v/swagger2.svg)](http://hackage.haskell.org/package/swagger2)
4[![Build Status](https://travis-ci.org/GetShopTV/swagger2.svg?branch=master)](https://travis-ci.org/GetShopTV/swagger2)
6[![Build Status](https://travis-ci.org/GetShopTV/swagger2.svg?branch=master)](https://travis-ci.org/GetShopTV/swagger2)
5[![Stackage LTS](http://stackage.org/package/swagger2/badge/lts)](http://stackage.org/lts/package/swagger2)
7[![Stackage LTS](http://stackage.org/package/swagger2/badge/lts)](http://stackage.org/lts/package/swagger2)
@@ -11,7 +13,7 @@ The original Swagger 2.0 specification is available at http://swagger.io/specifi
11
13
12## Usage
14## Usage
13
15
14−This library is inteded to be used for decoding and encoding Swagger 2.0 API specifications as well as manipulating them.
16+This library is intended to be used for decoding and encoding Swagger 2.0 API specifications as well as manipulating them.
15
17
16Please refer to [haddock documentation](http://hackage.haskell.org/package/swagger2).
18Please refer to [haddock documentation](http://hackage.haskell.org/package/swagger2).
17
19
Setup.hs+31
@@ -1,2 +1,33 @@
1+{-# LANGUAGE CPP #-}
2+{-# OPTIONS_GHC -Wall #-}
3+module Main (main) where
4+
5+#ifndef MIN_VERSION_cabal_doctest
6+#define MIN_VERSION_cabal_doctest(x,y,z) 0
7+#endif
8+
9+#if MIN_VERSION_cabal_doctest(1,0,0)
10+
11+import Distribution.Extra.Doctest ( defaultMainWithDoctests )
12+main :: IO ()
13+main = defaultMainWithDoctests "doctests"
14+
15+#else
16+
17+#ifdef MIN_VERSION_Cabal
18+-- If the macro is defined, we have new cabal-install,
19+-- but for some reason we don't have cabal-doctest in package-db
20+--
21+-- Probably we are running cabal sdist, when otherwise using new-build
22+-- workflow
23+#warning You are configuring this package without cabal-doctest installed. \
24+ The doctests test-suite will not work as a result. \
25+ To fix this, install cabal-doctest before configuring.
26+#endif
27+
1import Distribution.Simple
28import Distribution.Simple
29+
30+main :: IO ()
2main = defaultMain
31main = defaultMain
32+
33+#endif
cabal.projectnew file+2
@@ -0,0 +1,2 @@
1+packages: .
2+tests: true
examples/hackage.hs+40−24
@@ -13,13 +13,28 @@ import GHC.Generics
13import Data.Swagger
13import Data.Swagger
14import Data.Swagger.Declare
14import Data.Swagger.Declare
15import Data.Swagger.Lens
15import Data.Swagger.Lens
16+import Data.Swagger.Operation
16
17
17type Username = Text
18type Username = Text
18
19
19data UserSummary = UserSummary
20data UserSummary = UserSummary
20 { summaryUsername :: Username
21 { summaryUsername :: Username
21 , summaryUserid :: Int
22 , summaryUserid :: Int
22− } deriving (Generic, ToSchema)
23+ } deriving (Generic)
24+
25+instance ToSchema UserSummary where
26+ declareNamedSchema _ = do
27+ usernameSchema <- declareSchemaRef (Proxy :: Proxy Username)
28+ useridSchema <- declareSchemaRef (Proxy :: Proxy Int)
29+ return $ NamedSchema (Just "UserSummary") $ mempty
30+ & type_ ?~ SwaggerObject
31+ & properties .~
32+ [ ("summaryUsername", usernameSchema )
33+ , ("summaryUserid" , useridSchema )
34+ ]
35+ & required .~ [ "summaryUsername"
36+ , "summaryUserid" ]
37+
23
38
24type Group = Text
39type Group = Text
25
40
@@ -37,32 +52,33 @@ hackageSwagger = spec & definitions .~ defs
37 where
52 where
38 (defs, spec) = runDeclare declareHackageSwagger mempty
53 (defs, spec) = runDeclare declareHackageSwagger mempty
39
54
40−declareHackageSwagger :: Declare Definitions Swagger
55+declareHackageSwagger :: Declare (Definitions Schema) Swagger
41declareHackageSwagger = do
56declareHackageSwagger = do
57+ -- param schemas
42 let usernameParamSchema = toParamSchema (Proxy :: Proxy Username)
58 let usernameParamSchema = toParamSchema (Proxy :: Proxy Username)
43− userSummarySchemaRef <- declareSchemaRef (Proxy :: Proxy UserSummary)
59+
44− userDetailedSchemaRef <- declareSchemaRef (Proxy :: Proxy UserDetailed)
60+ -- responses
45− packagesSchemaRef <- declareSchemaRef (Proxy :: Proxy [Package])
61+ userSummaryResponse <- declareResponse (Proxy :: Proxy UserSummary)
62+ userDetailedResponse <- declareResponse (Proxy :: Proxy UserDetailed)
63+ packagesResponse <- declareResponse (Proxy :: Proxy [Package])
64+
46 return $ mempty
65 return $ mempty
47− & paths.pathsMap .~
66+ & paths .~
48− [ ("/users", mempty & pathItemGet ?~ (mempty
67+ [ ("/users", mempty & get ?~ (mempty
49− & operationProduces ?~ MimeList ["application/json"]
68+ & produces ?~ MimeList ["application/json"]
50− & operationResponses .~ (mempty
69+ & at 200 ?~ Inline userSummaryResponse))
51− & responsesResponses . at 200 ?~ Inline (mempty & responseSchema ?~ userSummarySchemaRef))))
52− , ("/user/{username}", mempty & pathItemGet ?~ (mempty
70+ , ("/user/{username}", mempty & get ?~ (mempty
53− & operationProduces ?~ MimeList ["application/json"]
71+ & produces ?~ MimeList ["application/json"]
54− & operationParameters .~ [ Inline $ mempty
72+ & parameters .~ [ Inline $ mempty
55− & paramName .~ "username"
73+ & name .~ "username"
56− & paramRequired ?~ True
74+ & required ?~ True
57− & paramSchema .~ ParamOther (mempty
75+ & schema .~ ParamOther (mempty
58− & paramOtherSchemaIn .~ ParamPath
76+ & in_ .~ ParamPath
59− & paramOtherSchemaParamSchema .~ usernameParamSchema) ]
77+ & paramSchema .~ usernameParamSchema) ]
60− & operationResponses .~ (mempty
78+ & at 200 ?~ Inline userDetailedResponse))
61− & responsesResponses . at 200 ?~ Inline (mempty & responseSchema ?~ userDetailedSchemaRef))))
62− , ("/packages", mempty & pathItemGet ?~ (mempty
79+ , ("/packages", mempty & get ?~ (mempty
63− & operationProduces ?~ MimeList ["application/json"]
80+ & produces ?~ MimeList ["application/json"]
64− & operationResponses .~ (mempty
81+ & at 200 ?~ Inline packagesResponse))
65− & responsesResponses . at 200 ?~ Inline (mempty & responseSchema ?~ packagesSchemaRef))))
66 ]
82 ]
67
83
68main :: IO ()
84main :: IO ()
hackage-docs.shnew file+78
@@ -0,0 +1,78 @@
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"
include/overlapping-compat.hnew file+8
@@ -0,0 +1,8 @@
1+#if __GLASGOW_HASKELL__ >= 710
2+#define OVERLAPPABLE_ {-# OVERLAPPABLE #-}
3+#define OVERLAPPING_ {-# OVERLAPPING #-}
4+#else
5+{-# LANGUAGE OverlappingInstances #-}
6+#define OVERLAPPABLE_
7+#define OVERLAPPING_
8+#endif
src/Data/Swagger.hs+101−11
@@ -1,4 +1,9 @@
1+{-# LANGUAGE CPP #-}
1-- |
2-- |
3+-- Module: Data.Swagger
4+-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
5+-- Stability: experimental
6+--
2-- Swagger™ is a project used to describe and document RESTful APIs.
7-- Swagger™ is a project used to describe and document RESTful APIs.
3--
8--
4-- The Swagger specification defines a set of files required to describe such an API.
9-- The Swagger specification defines a set of files required to describe such an API.
@@ -18,10 +23,19 @@ module Data.Swagger (
18 -- ** Schema specification
23 -- ** Schema specification
19 -- $schema
24 -- $schema
20
25
26+ -- ** Manipulation
27+ -- $manipulation
28+
29+ -- ** Validation
30+ -- $validation
31+
21 -- * Re-exports
32 -- * Re-exports
22 module Data.Swagger.Lens,
33 module Data.Swagger.Lens,
34+ module Data.Swagger.Optics,
35+ module Data.Swagger.Operation,
23 module Data.Swagger.ParamSchema,
36 module Data.Swagger.ParamSchema,
24 module Data.Swagger.Schema,
37 module Data.Swagger.Schema,
38+ module Data.Swagger.Schema.Validation,
25
39
26 -- * Swagger specification
40 -- * Swagger specification
27 Swagger(..),
41 Swagger(..),
@@ -63,6 +77,8 @@ module Data.Swagger (
63 NamedSchema(..),
77 NamedSchema(..),
64 SwaggerItems(..),
78 SwaggerItems(..),
65 Xml(..),
79 Xml(..),
80+ Pattern,
81+ AdditionalProperties(..),
66
82
67 -- ** Responses
83 -- ** Responses
68 Responses(..),
84 Responses(..),
@@ -73,6 +89,7 @@ module Data.Swagger (
73 SecurityScheme(..),
89 SecurityScheme(..),
74 SecuritySchemeType(..),
90 SecuritySchemeType(..),
75 SecurityRequirement(..),
91 SecurityRequirement(..),
92+ SecurityDefinitions(..),
76
93
77 -- *** API key
94 -- *** API key
78 ApiKeyParams(..),
95 ApiKeyParams(..),
@@ -97,8 +114,11 @@ module Data.Swagger (
97) where
114) where
98
115
99import Data.Swagger.Lens
116import Data.Swagger.Lens
117+import Data.Swagger.Optics ()
118+import Data.Swagger.Operation
100import Data.Swagger.ParamSchema
119import Data.Swagger.ParamSchema
101import Data.Swagger.Schema
120import Data.Swagger.Schema
121+import Data.Swagger.Schema.Validation
102
122
103import Data.Swagger.Internal
123import Data.Swagger.Internal
104
124
@@ -158,44 +178,47 @@ import Data.Swagger.Internal
158
178
159-- $lens
179-- $lens
160--
180--
181+-- Note: if you're working with the <https://hackage.haskell.org/package/optics optics> library, take a look at "Data.Swagger.Optics".
182+--
161-- Since @'Swagger'@ has a fairly complex structure, lenses and prisms are used
183-- Since @'Swagger'@ has a fairly complex structure, lenses and prisms are used
162−-- to work comfortly with it. In combination with @'Monoid'@ instances, lenses
184+-- to work comfortably with it. In combination with @'Monoid'@ instances, lenses
163-- make it fairly simple to construct/modify any part of the specification:
185-- make it fairly simple to construct/modify any part of the specification:
164--
186--
165-- >>> :{
187-- >>> :{
166-- encode $ (mempty :: Swagger)
188-- encode $ (mempty :: Swagger)
167−-- & definitions .~ [ ("User", mempty & type_ .~ SwaggerString) ]
189+-- & definitions .~ [ ("User", mempty & type_ ?~ SwaggerString) ]
168-- & paths .~
190-- & paths .~
169-- [ ("/user", mempty & get ?~ (mempty
191-- [ ("/user", mempty & get ?~ (mempty
170-- & produces ?~ MimeList ["application/json"]
192-- & produces ?~ MimeList ["application/json"]
171-- & at 200 ?~ ("OK" & _Inline.schema ?~ Ref (Reference "User"))
193-- & at 200 ?~ ("OK" & _Inline.schema ?~ Ref (Reference "User"))
172-- & at 404 ?~ "User info not found")) ]
194-- & at 404 ?~ "User info not found")) ]
173-- :}
195-- :}
174−-- "{\"swagger\":\"2.0\",\"info\":{\"version\":\"\",\"title\":\"\"},\"definitions\":{\"User\":{\"type\":\"string\"}},\"paths\":{\"/user\":{\"get\":{\"responses\":{\"404\":{\"description\":\"User info not found\"},\"200\":{\"schema\":{\"$ref\":\"#/definitions/User\"},\"description\":\"OK\"}},\"produces\":[\"application/json\"]}}}}"
196+-- "{\"swagger\":\"2.0\",\"info\":{\"version\":\"\",\"title\":\"\"},\"paths\":{\"/user\":{\"get\":{\"produces\":[\"application/json\"],\"responses\":{\"404\":{\"description\":\"User info not found\"},\"200\":{\"schema\":{\"$ref\":\"#/definitions/User\"},\"description\":\"OK\"}}}}},\"definitions\":{\"User\":{\"type\":\"string\"}}}"
175--
197--
176−-- In the snippet above we declare API with a single path @/user@ providing method @GET@
198+-- In the snippet above we declare an API with a single path @/user@. This path provides method @GET@
177−-- which produces @application/json@ output and should respond with code @200@ and body specified
199+-- which produces @application/json@ output. It should respond with code @200@ and body specified
178-- by schema @User@ which is defined in @'definitions'@ property of swagger specification.
200-- by schema @User@ which is defined in @'definitions'@ property of swagger specification.
201+-- Alternatively it may respond with code @404@ meaning that user info is not found.
179--
202--
180-- For convenience, @swagger2@ uses /classy field lenses/. It means that
203-- For convenience, @swagger2@ uses /classy field lenses/. It means that
181-- field accessor names can be overloaded for different types. One such
204-- field accessor names can be overloaded for different types. One such
182−-- common field is @'description'@. Many components of Swagger specification
205+-- common field is @'description'@. Many components of a Swagger specification
183-- can have descriptions, and you can use the same name for them:
206-- can have descriptions, and you can use the same name for them:
184--
207--
185-- >>> encode $ (mempty :: Response) & description .~ "No content"
208-- >>> encode $ (mempty :: Response) & description .~ "No content"
186-- "{\"description\":\"No content\"}"
209-- "{\"description\":\"No content\"}"
187-- >>> :{
210-- >>> :{
188-- encode $ (mempty :: Schema)
211-- encode $ (mempty :: Schema)
189−-- & type_ .~ SwaggerBoolean
212+-- & type_ ?~ SwaggerBoolean
190-- & description ?~ "To be or not to be"
213-- & description ?~ "To be or not to be"
191-- :}
214-- :}
192−-- "{\"type\":\"boolean\",\"description\":\"To be or not to be\"}"
215+-- "{\"description\":\"To be or not to be\",\"type\":\"boolean\"}"
193--
216--
194-- @'ParamSchema'@ is basically the /base schema specification/ and many types contain it (see @'HasParamSchema'@).
217-- @'ParamSchema'@ is basically the /base schema specification/ and many types contain it (see @'HasParamSchema'@).
195-- So for convenience, all @'ParamSchema'@ fields are transitively made fields of the type that has it.
218-- So for convenience, all @'ParamSchema'@ fields are transitively made fields of the type that has it.
196-- For example, you can use @'type_'@ to access @'SwaggerType'@ of @'Header'@ schema without having to use @'paramSchema'@:
219-- For example, you can use @'type_'@ to access @'SwaggerType'@ of @'Header'@ schema without having to use @'paramSchema'@:
197--
220--
198−-- >>> encode $ (mempty :: Header) & type_ .~ SwaggerNumber
221+-- >>> encode $ (mempty :: Header) & type_ ?~ SwaggerNumber
199-- "{\"type\":\"number\"}"
222-- "{\"type\":\"number\"}"
200--
223--
201-- Additionally, to simplify working with @'Response'@, both @'Operation'@ and @'Responses'@
224-- Additionally, to simplify working with @'Response'@, both @'Operation'@ and @'Responses'@
@@ -213,7 +236,7 @@ import Data.Swagger.Internal
213-- A few other field accessors are modified in this way:
236-- A few other field accessors are modified in this way:
214--
237--
215-- - @'in_'@, @'type_'@, @'default_'@ (as keywords);
238-- - @'in_'@, @'type_'@, @'default_'@ (as keywords);
216−-- - @'maximum_'@ and @'minimum_'@ (as conflicting with @Prelude@);
239+-- - @'maximum_'@, @'minimum_'@, @'head_'@ (as conflicting with @Prelude@);
217-- - @'enum_'@ (as conflicting with @Control.Lens@).
240-- - @'enum_'@ (as conflicting with @Control.Lens@).
218
241
219-- $schema
242-- $schema
@@ -255,6 +278,73 @@ import Data.Swagger.Internal
255-- >>> encode (Person "David" 28)
278-- >>> encode (Person "David" 28)
256-- "{\"age\":28,\"name\":\"David\"}"
279-- "{\"age\":28,\"name\":\"David\"}"
257-- >>> encode $ toSchema (Proxy :: Proxy Person)
280-- >>> encode $ toSchema (Proxy :: Proxy Person)
258−-- "{\"required\":[\"name\",\"age\"],\"type\":\"object\",\"properties\":{\"age\":{\"type\":\"integer\"},\"name\":{\"type\":\"string\"}}}"
281+-- "{\"required\":[\"name\",\"age\"],\"properties\":{\"name\":{\"type\":\"string\"},\"age\":{\"type\":\"integer\"}},\"type\":\"object\"}"
282+--
283+-- Please note that not all valid Haskell data types will have a proper swagger schema. For example while we can derive a
284+-- schema for basic enums like
285+--
286+-- >>> data SampleEnum = ChoiceOne | ChoiceTwo deriving Generic
287+-- >>> instance ToSchema SampleEnum
288+-- >>> instance ToJSON SampleEnum
289+--
290+-- and for sum types that have constructors with values
291+--
292+-- >>> data SampleSumType = ChoiceInt Int | ChoiceString String deriving Generic
293+-- >>> instance ToSchema SampleSumType
294+-- >>> instance ToJSON SampleSumType
295+--
296+-- we can not derive a valid schema for a mix of the above. The following will result in a type error
297+--
298+#if __GLASGOW_HASKELL__ < 800
299+-- >>> data BadMixedType = ChoiceBool Bool | JustTag deriving Generic
300+-- >>> instance ToSchema BadMixedType
301+-- ...
302+-- ... error:
303+-- ... • No instance for (Data.Swagger.Internal.TypeShape.CannotDeriveSchemaForMixedSumType
304+-- ... BadMixedType)
305+-- ... arising from a use of ‘Data.Swagger.Internal.Schema.$dmdeclareNamedSchema’
306+-- ... • In the expression:
307+-- ... Data.Swagger.Internal.Schema.$dmdeclareNamedSchema @BadMixedType
308+-- ... In an equation for ‘declareNamedSchema’:
309+-- ... declareNamedSchema
310+-- ... = Data.Swagger.Internal.Schema.$dmdeclareNamedSchema @BadMixedType
311+-- ... In the instance declaration for ‘ToSchema BadMixedType’
312+#else
313+-- >>> data BadMixedType = ChoiceBool Bool | JustTag deriving Generic
314+-- >>> instance ToSchema BadMixedType
315+-- ...
316+-- ... error:
317+-- ... • Cannot derive Generic-based Swagger Schema for BadMixedType
318+-- ... BadMixedType is a mixed sum type (has both unit and non-unit constructors).
319+-- ... Swagger does not have a good representation for these types.
320+-- ... Use genericDeclareNamedSchemaUnrestricted if you want to derive schema
321+-- ... that matches aeson's Generic-based toJSON,
322+-- ... but that's not supported by some Swagger tools.
323+-- ... • In the expression:
324+-- ... Data.Swagger.Internal.Schema.$dmdeclareNamedSchema @BadMixedType
325+-- ... In an equation for ‘declareNamedSchema’:
326+-- ... declareNamedSchema
327+-- ... = Data.Swagger.Internal.Schema.$dmdeclareNamedSchema @BadMixedType
328+-- ... In the instance declaration for ‘ToSchema BadMixedType’
329+#endif
330+--
331+-- We can use 'genericDeclareNamedSchemaUnrestricted' to try our best to represent this type as a Swagger Schema and match 'ToJSON':
332+--
333+-- >>> data BadMixedType = ChoiceBool Bool | JustTag deriving Generic
334+-- >>> instance ToSchema BadMixedType where declareNamedSchema = genericDeclareNamedSchemaUnrestricted defaultSchemaOptions
335+-- >>> instance ToJSON BadMixedType
259--
336--
260
337
338+-- $manipulation
339+-- Sometimes you have to work with an imported or generated @'Swagger'@.
340+-- For instance, <servant-swagger http://hackage.haskell.org/package/servant-swagger> generates basic @'Swagger'@
341+-- for a type-level servant API.
342+--
343+-- Lenses and prisms can be used to manipulate such specification to add additional information, tags, extra responses, etc.
344+-- To facilitate common needs, @"Data.Swagger.Operation"@ module provides useful helpers.
345+
346+-- $validation
347+-- While @'ToParamSchema'@ and @'ToSchema'@ provide means to easily obtain schemas for Haskell types,
348+-- there is no static mechanism to ensure those instances correspond to the @'ToHttpApiData'@ or @'ToJSON'@ instances.
349+--
350+-- @"Data.Swagger.Schema.Validation"@ addresses @'ToJSON'@/@'ToSchema'@ validation.
src/Data/Swagger/Declare.hs+91−10
@@ -2,12 +2,33 @@
2{-# LANGUAGE FlexibleInstances #-}
2{-# LANGUAGE FlexibleInstances #-}
3{-# LANGUAGE FunctionalDependencies #-}
3{-# LANGUAGE FunctionalDependencies #-}
4{-# LANGUAGE MultiParamTypeClasses #-}
4{-# LANGUAGE MultiParamTypeClasses #-}
5+{-# LANGUAGE UndecidableInstances #-}
6+-- |
7+-- Module: Data.Swagger.Declare
8+-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
9+-- Stability: experimental
10+--
11+-- Declare monad transformer and associated functions.
5module Data.Swagger.Declare where
12module Data.Swagger.Declare where
6
13
14+import Prelude ()
15+import Prelude.Compat
16+
7import Control.Monad
17import Control.Monad
18+import Control.Monad.Cont (ContT)
19+import Control.Monad.List (ListT)
20+import Control.Monad.Reader (ReaderT)
8import Control.Monad.Trans
21import Control.Monad.Trans
22+import Control.Monad.Trans.Except (ExceptT)
23+import Control.Monad.Trans.Identity (IdentityT)
24+import Control.Monad.Trans.Maybe (MaybeT)
25+import Control.Monad.Trans.State.Lazy as Lazy
26+import Control.Monad.Trans.State.Strict as Strict
27+import Control.Monad.Trans.RWS.Lazy as Lazy
28+import Control.Monad.Trans.RWS.Strict as Strict
29+import Control.Monad.Trans.Writer.Lazy as Lazy
30+import Control.Monad.Trans.Writer.Strict as Strict
9import Data.Functor.Identity
31import Data.Functor.Identity
10−import Data.Monoid
11
32
12-- | A declare monad transformer parametrized by:
33-- | A declare monad transformer parametrized by:
13--
34--
@@ -24,22 +45,22 @@ import Data.Monoid
24newtype DeclareT d m a = DeclareT { runDeclareT :: d -> m (d, a) }
45newtype DeclareT d m a = DeclareT { runDeclareT :: d -> m (d, a) }
25 deriving (Functor)
46 deriving (Functor)
26
47
27−instance (Monad m, Monoid d) => Applicative (DeclareT d m) where
48+instance (Applicative m, Monad m, Monoid d) => Applicative (DeclareT d m) where
28 pure x = DeclareT (\_ -> pure (mempty, x))
49 pure x = DeclareT (\_ -> pure (mempty, x))
29 DeclareT df <*> DeclareT dx = DeclareT $ \d -> do
50 DeclareT df <*> DeclareT dx = DeclareT $ \d -> do
30 ~(d', f) <- df d
51 ~(d', f) <- df d
31− ~(d'', x) <- dx (d <> d')
52+ ~(d'', x) <- dx (mappend d d')
32− return (d' <> d'', f x)
53+ return (mappend d' d'', f x)
33
54
34−instance (Monad m, Monoid d) => Monad (DeclareT d m) where
55+instance (Applicative m, Monad m, Monoid d) => Monad (DeclareT d m) where
35 return x = DeclareT (\_ -> pure (mempty, x))
56 return x = DeclareT (\_ -> pure (mempty, x))
36 DeclareT dx >>= f = DeclareT $ \d -> do
57 DeclareT dx >>= f = DeclareT $ \d -> do
37 ~(d', x) <- dx d
58 ~(d', x) <- dx d
38− ~(d'', y) <- runDeclareT (f x) (d <> d')
59+ ~(d'', y) <- runDeclareT (f x) (mappend d d')
39− return (d' <> d'', y)
60+ return (mappend d' d'', y)
40
61
41instance Monoid d => MonadTrans (DeclareT d) where
62instance Monoid d => MonadTrans (DeclareT d) where
42− lift m = DeclareT (\_ -> (,) mempty <$> m)
63+ lift m = DeclareT (\_ -> (,) mempty `liftM` m)
43
64
44-- |
65-- |
45-- Definitions of @declare@ and @look@ must satisfy the following laws:
66-- Definitions of @declare@ and @look@ must satisfy the following laws:
@@ -58,16 +79,23 @@ instance Monoid d => MonadTrans (DeclareT d) where
58-- [/@look@ as left identity/]
79-- [/@look@ as left identity/]
59-- @'look' >> m == m@
80-- @'look' >> m == m@
60-- for every @m@
81-- for every @m@
61−class Monad m => MonadDeclare d m | m -> d where
82+class (Applicative m, Monad m) => MonadDeclare d m | m -> d where
62 -- | @'declare' x@ is an action that produces the output @x@.
83 -- | @'declare' x@ is an action that produces the output @x@.
63 declare :: d -> m ()
84 declare :: d -> m ()
64 -- | @'look'@ is an action that returns all the output so far.
85 -- | @'look'@ is an action that returns all the output so far.
65 look :: m d
86 look :: m d
66
87
67−instance (Monad m, Monoid d) => MonadDeclare d (DeclareT d m) where
88+instance (Applicative m, Monad m, Monoid d) => MonadDeclare d (DeclareT d m) where
68 declare d = DeclareT (\_ -> return (d, ()))
89 declare d = DeclareT (\_ -> return (d, ()))
69 look = DeclareT (\d -> return (mempty, d))
90 look = DeclareT (\d -> return (mempty, d))
70
91
92+-- | Lift a computation from the simple Declare monad.
93+liftDeclare :: MonadDeclare d m => Declare d a -> m a
94+liftDeclare da = do
95+ (d', a) <- looks (runDeclare da)
96+ declare d'
97+ pure a
98+
71-- | Retrieve a function of all the output so far.
99-- | Retrieve a function of all the output so far.
72looks :: MonadDeclare d m => (d -> a) -> m a
100looks :: MonadDeclare d m => (d -> a) -> m a
73looks f = f <$> look
101looks f = f <$> look
@@ -116,3 +144,56 @@ execDeclare m = runIdentity . execDeclareT m
116undeclare :: Monoid d => Declare d a -> a
144undeclare :: Monoid d => Declare d a -> a
117undeclare = runIdentity . undeclareT
145undeclare = runIdentity . undeclareT
118
146
147+-- ---------------------------------------------------------------------------
148+-- Instances for other mtl transformers
149+--
150+-- All of these instances need UndecidableInstances,
151+-- because they do not satisfy the coverage condition.
152+
153+instance MonadDeclare d m => MonadDeclare d (ContT r m) where
154+ declare = lift . declare
155+ look = lift look
156+
157+instance MonadDeclare d m => MonadDeclare d (ExceptT e m) where
158+ declare = lift . declare
159+ look = lift look
160+
161+instance MonadDeclare d m => MonadDeclare d (IdentityT m) where
162+ declare = lift . declare
163+ look = lift look
164+
165+instance MonadDeclare d m => MonadDeclare d (ListT m) where
166+ declare = lift . declare
167+ look = lift look
168+
169+instance MonadDeclare d m => MonadDeclare d (MaybeT m) where
170+ declare = lift . declare
171+ look = lift look
172+
173+instance MonadDeclare d m => MonadDeclare d (ReaderT r m) where
174+ declare = lift . declare
175+ look = lift look
176+
177+instance (Monoid w, MonadDeclare d m) => MonadDeclare d (Lazy.RWST r w s m) where
178+ declare = lift . declare
179+ look = lift look
180+
181+instance (Monoid w, MonadDeclare d m) => MonadDeclare d (Strict.RWST r w s m) where
182+ declare = lift . declare
183+ look = lift look
184+
185+instance MonadDeclare d m => MonadDeclare d (Lazy.StateT s m) where
186+ declare = lift . declare
187+ look = lift look
188+
189+instance MonadDeclare d m => MonadDeclare d (Strict.StateT s m) where
190+ declare = lift . declare
191+ look = lift look
192+
193+instance (Monoid w, MonadDeclare d m) => MonadDeclare d (Lazy.WriterT w m) where
194+ declare = lift . declare
195+ look = lift look
196+
197+instance (Monoid w, MonadDeclare d m) => MonadDeclare d (Strict.WriterT w m) where
198+ declare = lift . declare
199+ look = lift look
src/Data/Swagger/Internal.hs+396−146
@@ -1,3 +1,5 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DataKinds #-}
1{-# LANGUAGE DeriveDataTypeable #-}
3{-# LANGUAGE DeriveDataTypeable #-}
2{-# LANGUAGE DeriveFunctor #-}
4{-# LANGUAGE DeriveFunctor #-}
3{-# LANGUAGE DeriveGeneric #-}
5{-# LANGUAGE DeriveGeneric #-}
@@ -10,32 +12,66 @@
10{-# LANGUAGE RecordWildCards #-}
12{-# LANGUAGE RecordWildCards #-}
11{-# LANGUAGE ScopedTypeVariables #-}
13{-# LANGUAGE ScopedTypeVariables #-}
12{-# LANGUAGE StandaloneDeriving #-}
14{-# LANGUAGE StandaloneDeriving #-}
15+{-# LANGUAGE TemplateHaskell #-}
16+{-# LANGUAGE TypeFamilies #-}
13{-# LANGUAGE UndecidableInstances #-}
17{-# LANGUAGE UndecidableInstances #-}
18+#if __GLASGOW_HASKELL__ <710
19+{-# LANGUAGE PolyKinds #-}
20+#endif
21+#include "overlapping-compat.h"
14module Data.Swagger.Internal where
22module Data.Swagger.Internal where
15
23
24+import Prelude ()
25+import Prelude.Compat
26+
27+import Control.Lens ((&), (.~), (?~))
16import Control.Applicative
28import Control.Applicative
17−import Control.Monad
18import Data.Aeson
29import Data.Aeson
19import qualified Data.Aeson.Types as JSON
30import qualified Data.Aeson.Types as JSON
20import Data.Data (Data(..), Typeable, mkConstr, mkDataType, Fixity(..), Constr, DataType, constrIndex)
31import Data.Data (Data(..), Typeable, mkConstr, mkDataType, Fixity(..), Constr, DataType, constrIndex)
21−import Data.HashMap.Strict (HashMap)
32+import Data.Hashable (Hashable)
22import qualified Data.HashMap.Strict as HashMap
33import qualified Data.HashMap.Strict as HashMap
34+import Data.HashSet.InsOrd (InsOrdHashSet)
23import Data.Map (Map)
35import Data.Map (Map)
24import qualified Data.Map as Map
36import qualified Data.Map as Map
25−import Data.Monoid
37+import Data.Monoid (Monoid (..))
38+import Data.Semigroup.Compat (Semigroup (..))
26import Data.Scientific (Scientific)
39import Data.Scientific (Scientific)
27import Data.String (IsString(..))
40import Data.String (IsString(..))
28import Data.Text (Text)
41import Data.Text (Text)
29import qualified Data.Text as Text
42import qualified Data.Text as Text
30import GHC.Generics (Generic)
43import GHC.Generics (Generic)
31−import Network (HostName, PortNumber)
44+import Network.Socket (HostName, PortNumber)
32import Network.HTTP.Media (MediaType)
45import Network.HTTP.Media (MediaType)
33import Text.Read (readMaybe)
46import Text.Read (readMaybe)
34
47
48+import Data.HashMap.Strict.InsOrd (InsOrdHashMap)
49+import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
50+
51+import Generics.SOP.TH (deriveGeneric)
52+import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToJSON
53+ ,sopSwaggerGenericToJSONWithOpts
54+ ,sopSwaggerGenericParseJSON
55+ ,HasSwaggerAesonOptions(..)
56+ ,AesonDefaultValue(..)
57+ ,mkSwaggerAesonOptions
58+ ,saoAdditionalPairs
59+ ,saoSubObject)
35import Data.Swagger.Internal.Utils
60import Data.Swagger.Internal.Utils
36
61
62+#if MIN_VERSION_aeson(0,10,0)
63+import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToEncoding)
64+#define DEFINE_TOENCODING toEncoding = sopSwaggerGenericToEncoding
65+#else
66+#define DEFINE_TOENCODING
67+#endif
68+
69+-- $setup
70+-- >>> :seti -XDataKinds
71+-- >>> import Data.Aeson
72+
37-- | A list of definitions that can be used in references.
73-- | A list of definitions that can be used in references.
38−type Definitions = HashMap Text
74+type Definitions = InsOrdHashMap Text
39
75
40-- | This is the root document object for the API specification.
76-- | This is the root document object for the API specification.
41data Swagger = Swagger
77data Swagger = Swagger
@@ -67,7 +103,7 @@ data Swagger = Swagger
67 -- | The available paths and operations for the API.
103 -- | The available paths and operations for the API.
68 -- Holds the relative paths to the individual endpoints.
104 -- Holds the relative paths to the individual endpoints.
69 -- The path is appended to the @'basePath'@ in order to construct the full URL.
105 -- The path is appended to the @'basePath'@ in order to construct the full URL.
70− , _swaggerPaths :: HashMap FilePath PathItem
106+ , _swaggerPaths :: InsOrdHashMap FilePath PathItem
71
107
72 -- | An object to hold data types produced and consumed by operations.
108 -- | An object to hold data types produced and consumed by operations.
73 , _swaggerDefinitions :: Definitions Schema
109 , _swaggerDefinitions :: Definitions Schema
@@ -81,7 +117,7 @@ data Swagger = Swagger
81 , _swaggerResponses :: Definitions Response
117 , _swaggerResponses :: Definitions Response
82
118
83 -- | Security scheme definitions that can be used across the specification.
119 -- | Security scheme definitions that can be used across the specification.
84− , _swaggerSecurityDefinitions :: Definitions SecurityScheme
120+ , _swaggerSecurityDefinitions :: SecurityDefinitions
85
121
86 -- | A declaration of which security schemes are applied for the API as a whole.
122 -- | A declaration of which security schemes are applied for the API as a whole.
87 -- The list of values describes alternative security schemes that can be used
123 -- The list of values describes alternative security schemes that can be used
@@ -94,7 +130,7 @@ data Swagger = Swagger
94 -- Not all tags that are used by the Operation Object must be declared.
130 -- Not all tags that are used by the Operation Object must be declared.
95 -- The tags that are not declared may be organized randomly or based on the tools' logic.
131 -- The tags that are not declared may be organized randomly or based on the tools' logic.
96 -- Each tag name in the list MUST be unique.
132 -- Each tag name in the list MUST be unique.
97− , _swaggerTags :: [Tag]
133+ , _swaggerTags :: InsOrdHashSet Tag
98
134
99 -- | Additional external documentation.
135 -- | Additional external documentation.
100 , _swaggerExternalDocs :: Maybe ExternalDocs
136 , _swaggerExternalDocs :: Maybe ExternalDocs
@@ -216,7 +252,7 @@ data PathItem = PathItem
216data Operation = Operation
252data Operation = Operation
217 { -- | A list of tags for API documentation control.
253 { -- | A list of tags for API documentation control.
218 -- Tags can be used for logical grouping of operations by resources or any other qualifier.
254 -- Tags can be used for logical grouping of operations by resources or any other qualifier.
219− _operationTags :: [TagName]
255+ _operationTags :: InsOrdHashSet TagName
220
256
221 -- | A short summary of what the operation does.
257 -- | A short summary of what the operation does.
222 -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
258 -- For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
@@ -273,7 +309,7 @@ data Operation = Operation
273 } deriving (Eq, Show, Generic, Data, Typeable)
309 } deriving (Eq, Show, Generic, Data, Typeable)
274
310
275newtype MimeList = MimeList { getMimeList :: [MediaType] }
311newtype MimeList = MimeList { getMimeList :: [MediaType] }
276− deriving (Eq, Show, Monoid, Typeable)
312+ deriving (Eq, Show, Semigroup, Monoid, Typeable)
277
313
278mimeListConstr :: Constr
314mimeListConstr :: Constr
279mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
315mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
@@ -324,8 +360,8 @@ data ParamOtherSchema = ParamOtherSchema
324 -- Default value is @False@.
360 -- Default value is @False@.
325 , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
361 , _paramOtherSchemaAllowEmptyValue :: Maybe Bool
326
362
327− , _paramOtherSchemaParamSchema :: ParamSchema ParamOtherSchema
363+ , _paramOtherSchemaParamSchema :: ParamSchema 'SwaggerKindParamOtherSchema
328− } deriving (Eq, Show, Generic, Data, Typeable)
364+ } deriving (Eq, Show, Generic, Typeable, Data)
329
365
330-- | Items for @'SwaggerArray'@ schemas.
366-- | Items for @'SwaggerArray'@ schemas.
331--
367--
@@ -338,28 +374,78 @@ data ParamOtherSchema = ParamOtherSchema
338--
374--
339-- @'SwaggerItemsArray'@ should be used to specify tuple @'Schema'@s.
375-- @'SwaggerItemsArray'@ should be used to specify tuple @'Schema'@s.
340data SwaggerItems t where
376data SwaggerItems t where
341− SwaggerItemsPrimitive :: Maybe (CollectionFormat t) -> ParamSchema t -> SwaggerItems t
377+ SwaggerItemsPrimitive :: Maybe (CollectionFormat k) -> ParamSchema k-> SwaggerItems k
342− SwaggerItemsObject :: Referenced Schema -> SwaggerItems Schema
378+ SwaggerItemsObject :: Referenced Schema -> SwaggerItems 'SwaggerKindSchema
343− SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems Schema
379+ SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems 'SwaggerKindSchema
380+ deriving (Typeable)
344
381
345deriving instance Eq (SwaggerItems t)
382deriving instance Eq (SwaggerItems t)
346deriving instance Show (SwaggerItems t)
383deriving instance Show (SwaggerItems t)
347−deriving instance Typeable (SwaggerItems t)
384+--deriving instance Typeable (SwaggerItems t)
348
385
349swaggerItemsPrimitiveConstr :: Constr
386swaggerItemsPrimitiveConstr :: Constr
350swaggerItemsPrimitiveConstr = mkConstr swaggerItemsDataType "SwaggerItemsPrimitive" [] Prefix
387swaggerItemsPrimitiveConstr = mkConstr swaggerItemsDataType "SwaggerItemsPrimitive" [] Prefix
351
388
389+swaggerItemsObjectConstr :: Constr
390+swaggerItemsObjectConstr = mkConstr swaggerItemsDataType "SwaggerItemsObject" [] Prefix
391+
392+swaggerItemsArrayConstr :: Constr
393+swaggerItemsArrayConstr = mkConstr swaggerItemsDataType "SwaggerItemsArray" [] Prefix
394+
352swaggerItemsDataType :: DataType
395swaggerItemsDataType :: DataType
353swaggerItemsDataType = mkDataType "Data.Swagger.SwaggerItems" [swaggerItemsPrimitiveConstr]
396swaggerItemsDataType = mkDataType "Data.Swagger.SwaggerItems" [swaggerItemsPrimitiveConstr]
354
397
398+-- Note: unfortunately we have to write these Data instances by hand,
399+-- to get better contexts / avoid duplicate name when using standalone deriving
400+
355−instance {-# OVERLAPPABLE #-} Data t => Data (SwaggerItems t) where
401+instance Data t => Data (SwaggerItems ('SwaggerKindNormal t)) where
402+ -- TODO: define gfoldl
356 gunfold k z c = case constrIndex c of
403 gunfold k z c = case constrIndex c of
357 1 -> k (k (z SwaggerItemsPrimitive))
404 1 -> k (k (z SwaggerItemsPrimitive))
358 _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems t)."
405 _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems t)."
359 toConstr _ = swaggerItemsPrimitiveConstr
406 toConstr _ = swaggerItemsPrimitiveConstr
360 dataTypeOf _ = swaggerItemsDataType
407 dataTypeOf _ = swaggerItemsDataType
361
408
409+-- SwaggerItems SwaggerKindParamOtherSchema can be constructed using SwaggerItemsPrimitive only
362−deriving instance Data (SwaggerItems Schema)
410+instance Data (SwaggerItems 'SwaggerKindParamOtherSchema) where
411+ -- TODO: define gfoldl
412+ gunfold k z c = case constrIndex c of
413+ 1 -> k (k (z SwaggerItemsPrimitive))
414+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems SwaggerKindParamOtherSchema)."
415+ toConstr _ = swaggerItemsPrimitiveConstr
416+ dataTypeOf _ = swaggerItemsDataType
417+
418+instance Data (SwaggerItems 'SwaggerKindSchema) where
419+ gfoldl _ _ (SwaggerItemsPrimitive _ _) = error $ " Data.Data.gfoldl: Constructor SwaggerItemsPrimitive used to construct SwaggerItems SwaggerKindSchema"
420+ gfoldl k z (SwaggerItemsObject ref) = z SwaggerItemsObject `k` ref
421+ gfoldl k z (SwaggerItemsArray ref) = z SwaggerItemsArray `k` ref
422+
423+ gunfold k z c = case constrIndex c of
424+ 2 -> k (z SwaggerItemsObject)
425+ 3 -> k (z SwaggerItemsArray)
426+ _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type (SwaggerItems SwaggerKindSchema)."
427+
428+ toConstr (SwaggerItemsPrimitive _ _) = error "Not supported"
429+ toConstr (SwaggerItemsObject _) = swaggerItemsObjectConstr
430+ toConstr (SwaggerItemsArray _) = swaggerItemsArrayConstr
431+
432+ dataTypeOf _ = swaggerItemsDataType
433+
434+-- | Type used as a kind to avoid overlapping instances.
435+data SwaggerKind t
436+ = SwaggerKindNormal t
437+ | SwaggerKindParamOtherSchema
438+ | SwaggerKindSchema
439+ deriving (Typeable)
440+
441+deriving instance Typeable 'SwaggerKindNormal
442+deriving instance Typeable 'SwaggerKindParamOtherSchema
443+deriving instance Typeable 'SwaggerKindSchema
444+
445+type family SwaggerKindType (k :: SwaggerKind *) :: *
446+type instance SwaggerKindType ('SwaggerKindNormal t) = t
447+type instance SwaggerKindType 'SwaggerKindSchema = Schema
448+type instance SwaggerKindType 'SwaggerKindParamOtherSchema = ParamOtherSchema
363
449
364data SwaggerType t where
450data SwaggerType t where
365 SwaggerString :: SwaggerType t
451 SwaggerString :: SwaggerType t
@@ -367,44 +453,44 @@ data SwaggerType t where
367 SwaggerInteger :: SwaggerType t
453 SwaggerInteger :: SwaggerType t
368 SwaggerBoolean :: SwaggerType t
454 SwaggerBoolean :: SwaggerType t
369 SwaggerArray :: SwaggerType t
455 SwaggerArray :: SwaggerType t
370− SwaggerFile :: SwaggerType ParamOtherSchema
456+ SwaggerFile :: SwaggerType 'SwaggerKindParamOtherSchema
371− SwaggerNull :: SwaggerType Schema
457+ SwaggerNull :: SwaggerType 'SwaggerKindSchema
372− SwaggerObject :: SwaggerType Schema
458+ SwaggerObject :: SwaggerType 'SwaggerKindSchema
459+ deriving (Typeable)
373
460
374deriving instance Eq (SwaggerType t)
461deriving instance Eq (SwaggerType t)
375deriving instance Show (SwaggerType t)
462deriving instance Show (SwaggerType t)
376−deriving instance Typeable (SwaggerType t)
377
463
378swaggerTypeConstr :: Data (SwaggerType t) => SwaggerType t -> Constr
464swaggerTypeConstr :: Data (SwaggerType t) => SwaggerType t -> Constr
379swaggerTypeConstr t = mkConstr (dataTypeOf t) (show t) [] Prefix
465swaggerTypeConstr t = mkConstr (dataTypeOf t) (show t) [] Prefix
380
466
381−swaggerTypeDataType :: Data (SwaggerType t) => SwaggerType t -> DataType
467+swaggerTypeDataType :: {- Data (SwaggerType t) => -} SwaggerType t -> DataType
382swaggerTypeDataType _ = mkDataType "Data.Swagger.SwaggerType" swaggerTypeConstrs
468swaggerTypeDataType _ = mkDataType "Data.Swagger.SwaggerType" swaggerTypeConstrs
383
469
384−swaggerCommonTypes :: [SwaggerType t]
470+swaggerCommonTypes :: [SwaggerType k]
385swaggerCommonTypes = [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
471swaggerCommonTypes = [SwaggerString, SwaggerNumber, SwaggerInteger, SwaggerBoolean, SwaggerArray]
386
472
387−swaggerParamTypes :: [SwaggerType ParamOtherSchema]
473+swaggerParamTypes :: [SwaggerType 'SwaggerKindParamOtherSchema]
388swaggerParamTypes = swaggerCommonTypes ++ [SwaggerFile]
474swaggerParamTypes = swaggerCommonTypes ++ [SwaggerFile]
389
475
390−swaggerSchemaTypes :: [SwaggerType Schema]
476+swaggerSchemaTypes :: [SwaggerType 'SwaggerKindSchema]
391swaggerSchemaTypes = swaggerCommonTypes ++ [error "SwaggerFile is invalid SwaggerType Schema", SwaggerNull, SwaggerObject]
477swaggerSchemaTypes = swaggerCommonTypes ++ [error "SwaggerFile is invalid SwaggerType Schema", SwaggerNull, SwaggerObject]
392
478
393swaggerTypeConstrs :: [Constr]
479swaggerTypeConstrs :: [Constr]
394−swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType Schema])
480+swaggerTypeConstrs = map swaggerTypeConstr (swaggerCommonTypes :: [SwaggerType 'SwaggerKindSchema])
395 ++ [swaggerTypeConstr SwaggerFile, swaggerTypeConstr SwaggerNull, swaggerTypeConstr SwaggerObject]
481 ++ [swaggerTypeConstr SwaggerFile, swaggerTypeConstr SwaggerNull, swaggerTypeConstr SwaggerObject]
396
482
397−instance {-# OVERLAPPABLE #-} Typeable t => Data (SwaggerType t) where
483+instance Typeable t => Data (SwaggerType ('SwaggerKindNormal t)) where
398 gunfold = gunfoldEnum "SwaggerType" swaggerCommonTypes
484 gunfold = gunfoldEnum "SwaggerType" swaggerCommonTypes
399 toConstr = swaggerTypeConstr
485 toConstr = swaggerTypeConstr
400 dataTypeOf = swaggerTypeDataType
486 dataTypeOf = swaggerTypeDataType
401
487
402−instance {-# OVERLAPPING #-} Data (SwaggerType ParamOtherSchema) where
488+instance Data (SwaggerType 'SwaggerKindParamOtherSchema) where
403 gunfold = gunfoldEnum "SwaggerType ParamOtherSchema" swaggerParamTypes
489 gunfold = gunfoldEnum "SwaggerType ParamOtherSchema" swaggerParamTypes
404 toConstr = swaggerTypeConstr
490 toConstr = swaggerTypeConstr
405 dataTypeOf = swaggerTypeDataType
491 dataTypeOf = swaggerTypeDataType
406
492
407−instance {-# OVERLAPPING #-} Data (SwaggerType Schema) where
493+instance Data (SwaggerType 'SwaggerKindSchema) where
408 gunfold = gunfoldEnum "SwaggerType Schema" swaggerSchemaTypes
494 gunfold = gunfoldEnum "SwaggerType Schema" swaggerSchemaTypes
409 toConstr = swaggerTypeConstr
495 toConstr = swaggerTypeConstr
410 dataTypeOf = swaggerTypeDataType
496 dataTypeOf = swaggerTypeDataType
@@ -444,11 +530,11 @@ data CollectionFormat t where
444 -- Corresponds to multiple parameter instances
530 -- Corresponds to multiple parameter instances
445 -- instead of multiple values for a single instance @foo=bar&foo=baz@.
531 -- instead of multiple values for a single instance @foo=bar&foo=baz@.
446 -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
532 -- This is valid only for parameters in @'ParamQuery'@ or @'ParamFormData'@.
447− CollectionMulti :: CollectionFormat ParamOtherSchema
533+ CollectionMulti :: CollectionFormat 'SwaggerKindParamOtherSchema
534+ deriving (Typeable)
448
535
449deriving instance Eq (CollectionFormat t)
536deriving instance Eq (CollectionFormat t)
450deriving instance Show (CollectionFormat t)
537deriving instance Show (CollectionFormat t)
451−deriving instance Typeable (CollectionFormat t)
452
538
453collectionFormatConstr :: CollectionFormat t -> Constr
539collectionFormatConstr :: CollectionFormat t -> Constr
454collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
540collectionFormatConstr cf = mkConstr collectionFormatDataType (show cf) [] Prefix
@@ -460,12 +546,12 @@ collectionFormatDataType = mkDataType "Data.Swagger.CollectionFormat" $
460collectionCommonFormats :: [CollectionFormat t]
546collectionCommonFormats :: [CollectionFormat t]
461collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
547collectionCommonFormats = [ CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes ]
462
548
463−instance {-# OVERLAPPABLE #-} Data t => Data (CollectionFormat t) where
549+instance Data t => Data (CollectionFormat ('SwaggerKindNormal t)) where
464 gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
550 gunfold = gunfoldEnum "CollectionFormat" collectionCommonFormats
465 toConstr = collectionFormatConstr
551 toConstr = collectionFormatConstr
466 dataTypeOf _ = collectionFormatDataType
552 dataTypeOf _ = collectionFormatDataType
467
553
468−deriving instance {-# OVERLAPPING #-} Data (CollectionFormat ParamOtherSchema)
554+deriving instance Data (CollectionFormat 'SwaggerKindParamOtherSchema)
469
555
470type ParamName = Text
556type ParamName = Text
471
557
@@ -474,9 +560,9 @@ data Schema = Schema
474 , _schemaDescription :: Maybe Text
560 , _schemaDescription :: Maybe Text
475 , _schemaRequired :: [ParamName]
561 , _schemaRequired :: [ParamName]
476
562
477− , _schemaAllOf :: Maybe [Schema]
563+ , _schemaAllOf :: Maybe [Referenced Schema]
478− , _schemaProperties :: HashMap Text (Referenced Schema)
564+ , _schemaProperties :: InsOrdHashMap Text (Referenced Schema)
479− , _schemaAdditionalProperties :: Maybe Schema
565+ , _schemaAdditionalProperties :: Maybe AdditionalProperties
480
566
481 , _schemaDiscriminator :: Maybe Text
567 , _schemaDiscriminator :: Maybe Text
482 , _schemaReadOnly :: Maybe Bool
568 , _schemaReadOnly :: Maybe Bool
@@ -487,7 +573,7 @@ data Schema = Schema
487 , _schemaMaxProperties :: Maybe Integer
573 , _schemaMaxProperties :: Maybe Integer
488 , _schemaMinProperties :: Maybe Integer
574 , _schemaMinProperties :: Maybe Integer
489
575
490− , _schemaParamSchema :: ParamSchema Schema
576+ , _schemaParamSchema :: ParamSchema 'SwaggerKindSchema
491 } deriving (Eq, Show, Generic, Data, Typeable)
577 } deriving (Eq, Show, Generic, Data, Typeable)
492
578
493-- | A @'Schema'@ with an optional name.
579-- | A @'Schema'@ with an optional name.
@@ -497,7 +583,10 @@ data NamedSchema = NamedSchema
497 , _namedSchemaSchema :: Schema
583 , _namedSchemaSchema :: Schema
498 } deriving (Eq, Show, Generic, Data, Typeable)
584 } deriving (Eq, Show, Generic, Data, Typeable)
499
585
586+-- | Regex pattern for @string@ type.
587+type Pattern = Text
588+
500−data ParamSchema t = ParamSchema
589+data ParamSchema (t :: SwaggerKind *) = ParamSchema
501 { -- | Declares the value of the parameter that the server will use if none is provided,
590 { -- | Declares the value of the parameter that the server will use if none is provided,
502 -- for example a @"count"@ to control the number of results per page might default to @100@
591 -- for example a @"count"@ to control the number of results per page might default to @100@
503 -- if not supplied by the client in the request.
592 -- if not supplied by the client in the request.
@@ -505,7 +594,7 @@ data ParamSchema t = ParamSchema
505 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
594 -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
506 _paramSchemaDefault :: Maybe Value
595 _paramSchemaDefault :: Maybe Value
507
596
508− , _paramSchemaType :: SwaggerType t
597+ , _paramSchemaType :: Maybe (SwaggerType t)
509 , _paramSchemaFormat :: Maybe Format
598 , _paramSchemaFormat :: Maybe Format
510 , _paramSchemaItems :: Maybe (SwaggerItems t)
599 , _paramSchemaItems :: Maybe (SwaggerItems t)
511 , _paramSchemaMaximum :: Maybe Scientific
600 , _paramSchemaMaximum :: Maybe Scientific
@@ -514,7 +603,7 @@ data ParamSchema t = ParamSchema
514 , _paramSchemaExclusiveMinimum :: Maybe Bool
603 , _paramSchemaExclusiveMinimum :: Maybe Bool
515 , _paramSchemaMaxLength :: Maybe Integer
604 , _paramSchemaMaxLength :: Maybe Integer
516 , _paramSchemaMinLength :: Maybe Integer
605 , _paramSchemaMinLength :: Maybe Integer
517− , _paramSchemaPattern :: Maybe Text
606+ , _paramSchemaPattern :: Maybe Pattern
518 , _paramSchemaMaxItems :: Maybe Integer
607 , _paramSchemaMaxItems :: Maybe Integer
519 , _paramSchemaMinItems :: Maybe Integer
608 , _paramSchemaMinItems :: Maybe Integer
520 , _paramSchemaUniqueItems :: Maybe Bool
609 , _paramSchemaUniqueItems :: Maybe Bool
@@ -522,7 +611,7 @@ data ParamSchema t = ParamSchema
522 , _paramSchemaMultipleOf :: Maybe Scientific
611 , _paramSchemaMultipleOf :: Maybe Scientific
523 } deriving (Eq, Show, Generic, Typeable)
612 } deriving (Eq, Show, Generic, Typeable)
524
613
525−deriving instance (Data t, Data (SwaggerType t), Data (SwaggerItems t)) => Data (ParamSchema t)
614+deriving instance (Typeable k, Data (Maybe (SwaggerType k)), Data (SwaggerItems k)) => Data (ParamSchema k)
526
615
527data Xml = Xml
616data Xml = Xml
528 { -- | Replaces the name of the element/attribute used for the described schema property.
617 { -- | Replaces the name of the element/attribute used for the described schema property.
@@ -564,7 +653,7 @@ data Responses = Responses
564
653
565 -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
654 -- | Any HTTP status code can be used as the property name (one property per HTTP status code).
566 -- Describes the expected response for those HTTP status codes.
655 -- Describes the expected response for those HTTP status codes.
567− , _responsesResponses :: HashMap HttpStatusCode (Referenced Response)
656+ , _responsesResponses :: InsOrdHashMap HttpStatusCode (Referenced Response)
568 } deriving (Eq, Show, Generic, Data, Typeable)
657 } deriving (Eq, Show, Generic, Data, Typeable)
569
658
570type HttpStatusCode = Int
659type HttpStatusCode = Int
@@ -583,7 +672,7 @@ data Response = Response
583 , _responseSchema :: Maybe (Referenced Schema)
672 , _responseSchema :: Maybe (Referenced Schema)
584
673
585 -- | A list of headers that are sent with the response.
674 -- | A list of headers that are sent with the response.
586− , _responseHeaders :: HashMap HeaderName Header
675+ , _responseHeaders :: InsOrdHashMap HeaderName Header
587
676
588 -- | An example of the response message.
677 -- | An example of the response message.
589 , _responseExamples :: Maybe Example
678 , _responseExamples :: Maybe Example
@@ -598,7 +687,7 @@ data Header = Header
598 { -- | A short description of the header.
687 { -- | A short description of the header.
599 _headerDescription :: Maybe Text
688 _headerDescription :: Maybe Text
600
689
601− , _headerParamSchema :: ParamSchema Header
690+ , _headerParamSchema :: ParamSchema ('SwaggerKindNormal Header)
602 } deriving (Eq, Show, Generic, Data, Typeable)
691 } deriving (Eq, Show, Generic, Data, Typeable)
603
692
604data Example = Example { getExample :: Map MediaType Value }
693data Example = Example { getExample :: Map MediaType Value }
@@ -649,7 +738,7 @@ data OAuth2Params = OAuth2Params
649 _oauth2Flow :: OAuth2Flow
738 _oauth2Flow :: OAuth2Flow
650
739
651 -- | The available scopes for the OAuth2 security scheme.
740 -- | The available scopes for the OAuth2 security scheme.
652− , _oauth2Scopes :: HashMap Text Text
741+ , _oauth2Scopes :: InsOrdHashMap Text Text
653 } deriving (Eq, Show, Generic, Data, Typeable)
742 } deriving (Eq, Show, Generic, Data, Typeable)
654
743
655data SecuritySchemeType
744data SecuritySchemeType
@@ -666,12 +755,28 @@ data SecurityScheme = SecurityScheme
666 , _securitySchemeDescription :: Maybe Text
755 , _securitySchemeDescription :: Maybe Text
667 } deriving (Eq, Show, Generic, Data, Typeable)
756 } deriving (Eq, Show, Generic, Data, Typeable)
668
757
758+
759+-- | merge scopes of two OAuth2 security schemes when their flows are identical.
760+-- In other case returns first security scheme
761+mergeSecurityScheme :: SecurityScheme -> SecurityScheme -> SecurityScheme
762+mergeSecurityScheme s1@(SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow1 scopes1)) desc)
763+ s2@(SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow2 scopes2)) _)
764+ = if flow1 == flow2 then
765+ SecurityScheme (SecuritySchemeOAuth2 (OAuth2Params flow1 (scopes1 <> scopes2))) desc
766+ else
767+ s1
768+mergeSecurityScheme s1 _ = s1
769+
770+newtype SecurityDefinitions
771+ = SecurityDefinitions (Definitions SecurityScheme)
772+ deriving (Eq, Show, Generic, Data, Typeable)
773+
669-- | Lists the required security schemes to execute this operation.
774-- | Lists the required security schemes to execute this operation.
670-- The object can have multiple security schemes declared in it which are all required
775-- The object can have multiple security schemes declared in it which are all required
671-- (that is, there is a logical AND between the schemes).
776-- (that is, there is a logical AND between the schemes).
672newtype SecurityRequirement = SecurityRequirement
777newtype SecurityRequirement = SecurityRequirement
673− { getSecurityRequirement :: HashMap Text [Text]
778+ { getSecurityRequirement :: InsOrdHashMap Text [Text]
674− } deriving (Eq, Read, Show, Monoid, ToJSON, FromJSON, Data, Typeable)
779+ } deriving (Eq, Read, Show, Semigroup, Monoid, ToJSON, FromJSON, Data, Typeable)
675
780
676-- | Tag name.
781-- | Tag name.
677type TagName = Text
782type TagName = Text
@@ -688,7 +793,9 @@ data Tag = Tag
688
793
689 -- | Additional external documentation for this tag.
794 -- | Additional external documentation for this tag.
690 , _tagExternalDocs :: Maybe ExternalDocs
795 , _tagExternalDocs :: Maybe ExternalDocs
691− } deriving (Eq, Show, Generic, Data, Typeable)
796+ } deriving (Eq, Ord, Show, Generic, Data, Typeable)
797+
798+instance Hashable Tag
692
799
693instance IsString Tag where
800instance IsString Tag where
694 fromString s = Tag (fromString s) Nothing Nothing
801 fromString s = Tag (fromString s) Nothing Nothing
@@ -701,7 +808,9 @@ data ExternalDocs = ExternalDocs
701
808
702 -- | The URL for the target documentation.
809 -- | The URL for the target documentation.
703 , _externalDocsUrl :: URL
810 , _externalDocsUrl :: URL
704− } deriving (Eq, Show, Generic, Data, Typeable)
811+ } deriving (Eq, Ord, Show, Generic, Data, Typeable)
812+
813+instance Hashable ExternalDocs
705
814
706-- | A simple object to allow referencing other definitions in the specification.
815-- | A simple object to allow referencing other definitions in the specification.
707-- It can be used to reference parameters and responses that are defined at the top level for reuse.
816-- It can be used to reference parameters and responses that are defined at the top level for reuse.
@@ -716,67 +825,111 @@ data Referenced a
716instance IsString a => IsString (Referenced a) where
825instance IsString a => IsString (Referenced a) where
717 fromString = Inline . fromString
826 fromString = Inline . fromString
718
827
719−newtype URL = URL { getUrl :: Text } deriving (Eq, Show, ToJSON, FromJSON, Data, Typeable)
828+newtype URL = URL { getUrl :: Text } deriving (Eq, Ord, Show, Hashable, ToJSON, FromJSON, Data, Typeable)
829+
830+data AdditionalProperties
831+ = AdditionalPropertiesAllowed Bool
832+ | AdditionalPropertiesSchema (Referenced Schema)
833+ deriving (Eq, Show, Data, Typeable)
720
834
721-- =======================================================================
835-- =======================================================================
722-- Monoid instances
836-- Monoid instances
723-- =======================================================================
837-- =======================================================================
724
838
839+instance Semigroup Swagger where
840+ (<>) = genericMappend
725instance Monoid Swagger where
841instance Monoid Swagger where
726 mempty = genericMempty
842 mempty = genericMempty
727− mappend = genericMappend
843+ mappend = (<>)
728
844
845+instance Semigroup Info where
846+ (<>) = genericMappend
729instance Monoid Info where
847instance Monoid Info where
730 mempty = genericMempty
848 mempty = genericMempty
731− mappend = genericMappend
849+ mappend = (<>)
732
850
851+instance Semigroup Contact where
852+ (<>) = genericMappend
733instance Monoid Contact where
853instance Monoid Contact where
734 mempty = genericMempty
854 mempty = genericMempty
735− mappend = genericMappend
855+ mappend = (<>)
736
856
857+instance Semigroup PathItem where
858+ (<>) = genericMappend
737instance Monoid PathItem where
859instance Monoid PathItem where
738 mempty = genericMempty
860 mempty = genericMempty
739− mappend = genericMappend
861+ mappend = (<>)
740
862
863+instance Semigroup Schema where
864+ (<>) = genericMappend
741instance Monoid Schema where
865instance Monoid Schema where
742 mempty = genericMempty
866 mempty = genericMempty
743− mappend = genericMappend
867+ mappend = (<>)
744
868
869+instance Semigroup (ParamSchema t) where
870+ (<>) = genericMappend
745instance Monoid (ParamSchema t) where
871instance Monoid (ParamSchema t) where
746 mempty = genericMempty
872 mempty = genericMempty
747− mappend = genericMappend
873+ mappend = (<>)
748
874
875+instance Semigroup Param where
876+ (<>) = genericMappend
749instance Monoid Param where
877instance Monoid Param where
750 mempty = genericMempty
878 mempty = genericMempty
751− mappend = genericMappend
879+ mappend = (<>)
752
880
881+instance Semigroup ParamOtherSchema where
882+ (<>) = genericMappend
753instance Monoid ParamOtherSchema where
883instance Monoid ParamOtherSchema where
754 mempty = genericMempty
884 mempty = genericMempty
755− mappend = genericMappend
885+ mappend = (<>)
756
886
887+instance Semigroup Header where
888+ (<>) = genericMappend
757instance Monoid Header where
889instance Monoid Header where
758 mempty = genericMempty
890 mempty = genericMempty
759− mappend = genericMappend
891+ mappend = (<>)
760
892
893+instance Semigroup Responses where
894+ (<>) = genericMappend
761instance Monoid Responses where
895instance Monoid Responses where
762 mempty = genericMempty
896 mempty = genericMempty
763− mappend = genericMappend
897+ mappend = (<>)
764
898
899+instance Semigroup Response where
900+ (<>) = genericMappend
765instance Monoid Response where
901instance Monoid Response where
766 mempty = genericMempty
902 mempty = genericMempty
767− mappend = genericMappend
903+ mappend = (<>)
768
904
905+instance Semigroup ExternalDocs where
906+ (<>) = genericMappend
769instance Monoid ExternalDocs where
907instance Monoid ExternalDocs where
770 mempty = genericMempty
908 mempty = genericMempty
771− mappend = genericMappend
909+ mappend = (<>)
772
910
911+instance Semigroup Operation where
912+ (<>) = genericMappend
773instance Monoid Operation where
913instance Monoid Operation where
774 mempty = genericMempty
914 mempty = genericMempty
775− mappend = genericMappend
915+ mappend = (<>)
776
916
917+instance Semigroup Example where
918+ (<>) = genericMappend
777instance Monoid Example where
919instance Monoid Example where
778 mempty = genericMempty
920 mempty = genericMempty
779− mappend = genericMappend
921+ mappend = (<>)
922+
923+instance Semigroup SecurityScheme where
924+ (<>) = mergeSecurityScheme
925+
926+instance Semigroup SecurityDefinitions where
927+ (SecurityDefinitions sd1) <> (SecurityDefinitions sd2) =
928+ SecurityDefinitions $ InsOrdHashMap.unionWith (<>) sd1 sd2
929+
930+instance Monoid SecurityDefinitions where
931+ mempty = SecurityDefinitions $ InsOrdHashMap.empty
932+ mappend = (<>)
780
933
781-- =======================================================================
934-- =======================================================================
782-- SwaggerMonoid helper instances
935-- SwaggerMonoid helper instances
@@ -792,6 +945,8 @@ instance SwaggerMonoid Responses
792instance SwaggerMonoid Response
945instance SwaggerMonoid Response
793instance SwaggerMonoid ExternalDocs
946instance SwaggerMonoid ExternalDocs
794instance SwaggerMonoid Operation
947instance SwaggerMonoid Operation
948+instance SwaggerMonoid SecurityDefinitions
949+instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
795
950
796instance SwaggerMonoid MimeList
951instance SwaggerMonoid MimeList
797deriving instance SwaggerMonoid URL
952deriving instance SwaggerMonoid URL
@@ -804,13 +959,13 @@ instance SwaggerMonoid ParamLocation where
804 swaggerMempty = ParamQuery
959 swaggerMempty = ParamQuery
805 swaggerMappend _ y = y
960 swaggerMappend _ y = y
806
961
807−instance SwaggerMonoid (HashMap FilePath PathItem) where
962+instance OVERLAPPING_ SwaggerMonoid (InsOrdHashMap FilePath PathItem) where
808− swaggerMempty = HashMap.empty
963+ swaggerMempty = InsOrdHashMap.empty
809− swaggerMappend = HashMap.unionWith mappend
964+ swaggerMappend = InsOrdHashMap.unionWith mappend
810
965
811instance Monoid a => SwaggerMonoid (Referenced a) where
966instance Monoid a => SwaggerMonoid (Referenced a) where
812 swaggerMempty = Inline mempty
967 swaggerMempty = Inline mempty
813− swaggerMappend (Inline x) (Inline y) = Inline (x <> y)
968+ swaggerMappend (Inline x) (Inline y) = Inline (mappend x y)
814 swaggerMappend _ y = y
969 swaggerMappend _ y = y
815
970
816instance SwaggerMonoid ParamAnySchema where
971instance SwaggerMonoid ParamAnySchema where
@@ -904,7 +1059,8 @@ instance ToJSON OAuth2Flow where
904 , "tokenUrl" .= tokenUrl ]
1059 , "tokenUrl" .= tokenUrl ]
905
1060
906instance ToJSON OAuth2Params where
1061instance ToJSON OAuth2Params where
907− toJSON = omitEmpties . genericToJSONWithSub "flow" (jsonPrefix "oauth2")
1062+ toJSON = sopSwaggerGenericToJSON
1063+ DEFINE_TOENCODING
908
1064
909instance ToJSON SecuritySchemeType where
1065instance ToJSON SecuritySchemeType where
910 toJSON SecuritySchemeBasic
1066 toJSON SecuritySchemeBasic
@@ -917,28 +1073,37 @@ instance ToJSON SecuritySchemeType where
917 <+> object [ "type" .= ("oauth2" :: Text) ]
1073 <+> object [ "type" .= ("oauth2" :: Text) ]
918
1074
919instance ToJSON Swagger where
1075instance ToJSON Swagger where
920− toJSON = omitEmpties . addVersion . genericToJSON (jsonPrefix "swagger")
1076+ toJSON = sopSwaggerGenericToJSON
921− where
1077+ DEFINE_TOENCODING
922− addVersion (Object o) = Object (HashMap.insert "swagger" "2.0" o)
923− addVersion _ = error "impossible"
924
1078
925instance ToJSON SecurityScheme where
1079instance ToJSON SecurityScheme where
926− toJSON = genericToJSONWithSub "type" (jsonPrefix "securityScheme")
1080+ toJSON = sopSwaggerGenericToJSON
1081+ DEFINE_TOENCODING
927
1082
928instance ToJSON Schema where
1083instance ToJSON Schema where
929− toJSON = omitEmptiesExcept f . genericToJSONWithSub "paramSchema" (jsonPrefix "schema")
1084+ toJSON = sopSwaggerGenericToJSON
930− where
1085+ DEFINE_TOENCODING
931− f "items" (Array _) = True
932− f _ _ = False
933
1086
934instance ToJSON Header where
1087instance ToJSON Header where
935− toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "header")
1088+ toJSON = sopSwaggerGenericToJSON
1089+ DEFINE_TOENCODING
936
1090
1091+-- | As for nullary schema for 0-arity type constructors, see
1092+-- <https://github.com/GetShopTV/swagger2/issues/167>.
1093+--
1094+-- >>> encode (SwaggerItemsArray [])
1095+-- "{\"example\":[],\"items\":{},\"maxItems\":0}"
1096+--
937−instance ToJSON (SwaggerItems t) where
1097+instance ToJSON (ParamSchema t) => ToJSON (SwaggerItems t) where
938 toJSON (SwaggerItemsPrimitive fmt schema) = object
1098 toJSON (SwaggerItemsPrimitive fmt schema) = object
939 [ "collectionFormat" .= fmt
1099 [ "collectionFormat" .= fmt
940 , "items" .= schema ]
1100 , "items" .= schema ]
941 toJSON (SwaggerItemsObject x) = object [ "items" .= x ]
1101 toJSON (SwaggerItemsObject x) = object [ "items" .= x ]
1102+ toJSON (SwaggerItemsArray []) = object
1103+ [ "items" .= object []
1104+ , "maxItems" .= (0 :: Int)
1105+ , "example" .= Array mempty
1106+ ]
942 toJSON (SwaggerItemsArray x) = object [ "items" .= x ]
1107 toJSON (SwaggerItemsArray x) = object [ "items" .= x ]
943
1108
944instance ToJSON Host where
1109instance ToJSON Host where
@@ -951,31 +1116,39 @@ instance ToJSON MimeList where
951 toJSON (MimeList xs) = toJSON (map show xs)
1116 toJSON (MimeList xs) = toJSON (map show xs)
952
1117
953instance ToJSON Param where
1118instance ToJSON Param where
954− toJSON = genericToJSONWithSub "schema" (jsonPrefix "param")
1119+ toJSON = sopSwaggerGenericToJSON
1120+ DEFINE_TOENCODING
955
1121
956instance ToJSON ParamAnySchema where
1122instance ToJSON ParamAnySchema where
957 toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
1123 toJSON (ParamBody s) = object [ "in" .= ("body" :: Text), "schema" .= s ]
958 toJSON (ParamOther s) = toJSON s
1124 toJSON (ParamOther s) = toJSON s
959
1125
960instance ToJSON ParamOtherSchema where
1126instance ToJSON ParamOtherSchema where
961− toJSON = genericToJSONWithSub "paramSchema" (jsonPrefix "paramOtherSchema")
1127+ toJSON = sopSwaggerGenericToJSON
1128+ DEFINE_TOENCODING
962
1129
963instance ToJSON Responses where
1130instance ToJSON Responses where
964− toJSON (Responses def rs) = omitEmpties $
1131+ toJSON = sopSwaggerGenericToJSON
965− toJSON (hashMapMapKeys show rs) <+> object [ "default" .= def ]
1132+ DEFINE_TOENCODING
966
1133
967instance ToJSON Response where
1134instance ToJSON Response where
968− toJSON = omitEmpties . genericToJSON (jsonPrefix "response")
1135+ toJSON = sopSwaggerGenericToJSON
1136+ DEFINE_TOENCODING
969
1137
970instance ToJSON Operation where
1138instance ToJSON Operation where
971− toJSON = omitEmpties . genericToJSON (jsonPrefix "operation")
1139+ toJSON = sopSwaggerGenericToJSON
1140+ DEFINE_TOENCODING
972
1141
973instance ToJSON PathItem where
1142instance ToJSON PathItem where
974− toJSON = omitEmpties . genericToJSON (jsonPrefix "pathItem")
1143+ toJSON = sopSwaggerGenericToJSON
1144+ DEFINE_TOENCODING
975
1145
976instance ToJSON Example where
1146instance ToJSON Example where
977 toJSON = toJSON . Map.mapKeys show . getExample
1147 toJSON = toJSON . Map.mapKeys show . getExample
978
1148
1149+instance ToJSON SecurityDefinitions where
1150+ toJSON (SecurityDefinitions sd) = toJSON sd
1151+
979instance ToJSON Reference where
1152instance ToJSON Reference where
980 toJSON (Reference ref) = object [ "$ref" .= ref ]
1153 toJSON (Reference ref) = object [ "$ref" .= ref ]
981
1154
@@ -1004,11 +1177,14 @@ instance ToJSON (CollectionFormat t) where
1004 toJSON CollectionPipes = "pipes"
1177 toJSON CollectionPipes = "pipes"
1005 toJSON CollectionMulti = "multi"
1178 toJSON CollectionMulti = "multi"
1006
1179
1007−instance ToJSON (ParamSchema t) where
1180+instance ToJSON (ParamSchema k) where
1008− toJSON = omitEmptiesExcept f . genericToJSONWithSub "items" (jsonPrefix "paramSchema")
1181+ -- TODO: this is a bit fishy, why we need sub object only in `ToJSON`?
1009− where
1182+ toJSON = sopSwaggerGenericToJSONWithOpts $
1010− f "items" (Array _) = True
1183+ mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1011− f _ _ = False
1184+
1185+instance ToJSON AdditionalProperties where
1186+ toJSON (AdditionalPropertiesAllowed b) = toJSON b
1187+ toJSON (AdditionalPropertiesSchema s) = toJSON s
1012
1188
1013-- =======================================================================
1189-- =======================================================================
1014-- Manual FromJSON instances
1190-- Manual FromJSON instances
@@ -1028,7 +1204,7 @@ instance FromJSON OAuth2Flow where
1028 parseJSON _ = empty
1204 parseJSON _ = empty
1029
1205
1030instance FromJSON OAuth2Params where
1206instance FromJSON OAuth2Params where
1031− parseJSON = genericParseJSONWithSub "flow" (jsonPrefix "oauth2")
1207+ parseJSON = sopSwaggerGenericParseJSON
1032
1208
1033instance FromJSON SecuritySchemeType where
1209instance FromJSON SecuritySchemeType where
1034 parseJSON js@(Object o) = do
1210 parseJSON js@(Object o) = do
@@ -1041,57 +1217,65 @@ instance FromJSON SecuritySchemeType where
1041 parseJSON _ = empty
1217 parseJSON _ = empty
1042
1218
1043instance FromJSON Swagger where
1219instance FromJSON Swagger where
1044− parseJSON js@(Object o) = do
1220+ parseJSON = sopSwaggerGenericParseJSON
1045− (version :: Text) <- o .: "swagger"
1046− when (version /= "2.0") empty
1047− (genericParseJSON (jsonPrefix "swagger")
1048− `withDefaults` [ "consumes" .= (mempty :: MimeList)
1049− , "produces" .= (mempty :: MimeList)
1050− , "security" .= ([] :: [SecurityRequirement])
1051− , "tags" .= ([] :: [Tag])
1052− , "definitions" .= (mempty :: Definitions Schema)
1053− , "parameters" .= (mempty :: Definitions Param)
1054− , "responses" .= (mempty :: Definitions Response)
1055− , "securityDefinitions" .= (mempty :: Definitions SecurityScheme)
1056− ] ) js
1057− parseJSON _ = empty
1058
1221
1059instance FromJSON SecurityScheme where
1222instance FromJSON SecurityScheme where
1060− parseJSON = genericParseJSONWithSub "type" (jsonPrefix "securityScheme")
1223+ parseJSON = sopSwaggerGenericParseJSON
1061
1224
1062instance FromJSON Schema where
1225instance FromJSON Schema where
1063− parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "schema")
1226+ parseJSON = fmap nullaryCleanup . sopSwaggerGenericParseJSON
1064− `withDefaults` [ "properties" .= (mempty :: HashMap Text Schema)
1227+ where nullaryCleanup :: Schema -> Schema
1065− , "required" .= ([] :: [ParamName]) ]
1228+ nullaryCleanup s@Schema{_schemaParamSchema=ps} =
1229+ if _paramSchemaItems ps == Just (SwaggerItemsArray [])
1230+ then s { _schemaExample = Nothing
1231+ , _schemaParamSchema = ps { _paramSchemaMaxItems = Nothing } }
1232+ else s
1066
1233
1067instance FromJSON Header where
1234instance FromJSON Header where
1068− parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "header")
1235+ parseJSON = sopSwaggerGenericParseJSON
1069
1236
1070−instance {-# OVERLAPPABLE #-} (FromJSON (CollectionFormat t), FromJSON (ParamSchema t)) => FromJSON (SwaggerItems t) where
1237+instance (FromJSON (CollectionFormat ('SwaggerKindNormal t)), FromJSON (ParamSchema ('SwaggerKindNormal t))) => FromJSON (SwaggerItems ('SwaggerKindNormal t)) where
1071− parseJSON (Object o) = SwaggerItemsPrimitive
1238+ parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1072 <$> o .:? "collectionFormat"
1239 <$> o .:? "collectionFormat"
1073 <*> (o .: "items" >>= parseJSON)
1240 <*> (o .: "items" >>= parseJSON)
1074
1241
1242+instance FromJSON (SwaggerItems 'SwaggerKindParamOtherSchema) where
1243+ parseJSON = withObject "SwaggerItemsPrimitive" $ \o -> SwaggerItemsPrimitive
1244+ <$> o .:? "collectionFormat"
1245+ <*> ((o .: "items" >>= parseJSON) <|> fail ("foo" ++ show o))
1246+
1247+-- |
1248+--
1249+-- >>> decode "{}" :: Maybe (SwaggerItems 'SwaggerKindSchema)
1250+-- Just (SwaggerItemsArray [])
1251+--
1252+-- >>> eitherDecode "{\"$ref\":\"#/definitions/example\"}" :: Either String (SwaggerItems 'SwaggerKindSchema)
1253+-- Right (SwaggerItemsObject (Ref (Reference {getReference = "example"})))
1254+--
1255+-- >>> eitherDecode "[{\"$ref\":\"#/definitions/example\"}]" :: Either String (SwaggerItems 'SwaggerKindSchema)
1256+-- Right (SwaggerItemsArray [Ref (Reference {getReference = "example"})])
1257+--
1075−instance {-# OVERLAPPING #-} FromJSON (SwaggerItems Schema) where
1258+instance FromJSON (SwaggerItems 'SwaggerKindSchema) where
1259+ parseJSON js@(Object obj)
1260+ | null obj = pure $ SwaggerItemsArray [] -- Nullary schema.
1076− parseJSON js@(Object _) = SwaggerItemsObject <$> parseJSON js
1261+ | otherwise = SwaggerItemsObject <$> parseJSON js
1077 parseJSON js@(Array _) = SwaggerItemsArray <$> parseJSON js
1262 parseJSON js@(Array _) = SwaggerItemsArray <$> parseJSON js
1078 parseJSON _ = empty
1263 parseJSON _ = empty
1079
1264
1080instance FromJSON Host where
1265instance FromJSON Host where
1081− parseJSON (String s) =
1266+ parseJSON (String s) = case map Text.unpack $ Text.split (== ':') s of
1082− case fromInteger <$> readMaybe portStr of
1267+ [host] -> return $ Host host Nothing
1083− Nothing | not (null portStr) -> fail $ "Invalid port `" ++ portStr ++ "'"
1268+ [host, port] -> case readMaybe port of
1084− mport -> pure $ Host host mport
1269+ Nothing -> fail $ "Invalid port `" ++ port ++ "'"
1085− where
1270+ Just p -> return $ Host host (Just (fromInteger p))
1086− (hostText, portText) = Text.breakOn ":" s
1271+ _ -> fail $ "Invalid host `" ++ Text.unpack s ++ "'"
1087− [host, portStr] = map Text.unpack [hostText, portText]
1088 parseJSON _ = empty
1272 parseJSON _ = empty
1089
1273
1090instance FromJSON MimeList where
1274instance FromJSON MimeList where
1091 parseJSON js = (MimeList . map fromString) <$> parseJSON js
1275 parseJSON js = (MimeList . map fromString) <$> parseJSON js
1092
1276
1093instance FromJSON Param where
1277instance FromJSON Param where
1094− parseJSON = genericParseJSONWithSub "schema" (jsonPrefix "param")
1278+ parseJSON = sopSwaggerGenericParseJSON
1095
1279
1096instance FromJSON ParamAnySchema where
1280instance FromJSON ParamAnySchema where
1097 parseJSON js@(Object o) = do
1281 parseJSON js@(Object o) = do
@@ -1104,12 +1288,12 @@ instance FromJSON ParamAnySchema where
1104 parseJSON _ = empty
1288 parseJSON _ = empty
1105
1289
1106instance FromJSON ParamOtherSchema where
1290instance FromJSON ParamOtherSchema where
1107− parseJSON = genericParseJSONWithSub "paramSchema" (jsonPrefix "paramOtherSchema")
1291+ parseJSON = sopSwaggerGenericParseJSON
1108
1292
1109instance FromJSON Responses where
1293instance FromJSON Responses where
1110 parseJSON (Object o) = Responses
1294 parseJSON (Object o) = Responses
1111 <$> o .:? "default"
1295 <$> o .:? "default"
1112− <*> (parseJSON (Object (HashMap.delete "default" o)) >>= hashMapReadKeys)
1296+ <*> (parseJSON (Object (HashMap.delete "default" o)))
1113 parseJSON _ = empty
1297 parseJSON _ = empty
1114
1298
1115instance FromJSON Example where
1299instance FromJSON Example where
@@ -1118,16 +1302,16 @@ instance FromJSON Example where
1118 pure $ Example (Map.mapKeys fromString m)
1302 pure $ Example (Map.mapKeys fromString m)
1119
1303
1120instance FromJSON Response where
1304instance FromJSON Response where
1121− parseJSON = genericParseJSON (jsonPrefix "response")
1305+ parseJSON = sopSwaggerGenericParseJSON
1122− `withDefaults` [ "headers" .= (mempty :: HashMap HeaderName Header) ]
1123
1306
1124instance FromJSON Operation where
1307instance FromJSON Operation where
1125− parseJSON = genericParseJSON (jsonPrefix "operation")
1308+ parseJSON = sopSwaggerGenericParseJSON
1126− `withDefaults` [ "security" .= ([] :: [SecurityRequirement]) ]
1127
1309
1128instance FromJSON PathItem where
1310instance FromJSON PathItem where
1129− parseJSON = genericParseJSON (jsonPrefix "pathItem")
1311+ parseJSON = sopSwaggerGenericParseJSON
1130− `withDefaults` [ "parameters" .= ([] :: [Param]) ]
1312+
1313+instance FromJSON SecurityDefinitions where
1314+ parseJSON js = SecurityDefinitions <$> parseJSON js
1131
1315
1132instance FromJSON Reference where
1316instance FromJSON Reference where
1133 parseJSON (Object o) = Reference <$> o .: "$ref"
1317 parseJSON (Object o) = Reference <$> o .: "$ref"
@@ -1144,6 +1328,7 @@ referencedParseJSON prefix js@(Object o) = do
1144 case Text.stripPrefix prefix s of
1328 case Text.stripPrefix prefix s of
1145 Nothing -> fail $ "expected $ref of the form \"" <> Text.unpack prefix <> "*\", but got " <> show s
1329 Nothing -> fail $ "expected $ref of the form \"" <> Text.unpack prefix <> "*\", but got " <> show s
1146 Just suffix -> pure (Reference suffix)
1330 Just suffix -> pure (Reference suffix)
1331+referencedParseJSON _ _ = fail "referenceParseJSON: not an object"
1147
1332
1148instance FromJSON (Referenced Schema) where parseJSON = referencedParseJSON "#/definitions/"
1333instance FromJSON (Referenced Schema) where parseJSON = referencedParseJSON "#/definitions/"
1149instance FromJSON (Referenced Param) where parseJSON = referencedParseJSON "#/parameters/"
1334instance FromJSON (Referenced Param) where parseJSON = referencedParseJSON "#/parameters/"
@@ -1152,26 +1337,91 @@ instance FromJSON (Referenced Response) where parseJSON = referencedParseJSON "#
1152instance FromJSON Xml where
1337instance FromJSON Xml where
1153 parseJSON = genericParseJSON (jsonPrefix "xml")
1338 parseJSON = genericParseJSON (jsonPrefix "xml")
1154
1339
1155−instance FromJSON (SwaggerType Schema) where
1340+instance FromJSON (SwaggerType 'SwaggerKindSchema) where
1156 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
1341 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerNull, SwaggerObject]
1157
1342
1158−instance FromJSON (SwaggerType ParamOtherSchema) where
1343+instance FromJSON (SwaggerType 'SwaggerKindParamOtherSchema) where
1159 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
1344 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray, SwaggerFile]
1160
1345
1161−instance {-# OVERLAPPABLE #-} FromJSON (SwaggerType t) where
1346+instance FromJSON (SwaggerType ('SwaggerKindNormal t)) where
1162 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
1347 parseJSON = parseOneOf [SwaggerString, SwaggerInteger, SwaggerNumber, SwaggerBoolean, SwaggerArray]
1163
1348
1164−instance {-# OVERLAPPABLE #-} FromJSON (CollectionFormat t) where
1349+instance FromJSON (CollectionFormat ('SwaggerKindNormal t)) where
1165 parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1350 parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1166
1351
1352+-- NOTE: There aren't collections of 'Schema'
1167−instance FromJSON (CollectionFormat ParamOtherSchema) where
1353+--instance FromJSON (CollectionFormat (SwaggerKindSchema)) where
1168− parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
1354+-- parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes]
1169
1355
1170−-- NOTE: The constraints @FromJSON (SwaggerType t)@ and
1356+instance FromJSON (CollectionFormat 'SwaggerKindParamOtherSchema) where
1171−-- @FromJSON (SwaggerItems t)@ are necessary here!
1357+ parseJSON = parseOneOf [CollectionCSV, CollectionSSV, CollectionTSV, CollectionPipes, CollectionMulti]
1172−-- Without the constraint the general instance will be used
1173−-- that only accepts common types (i.e. NOT object, null or file)
1174−-- and primitive array items.
1175−instance (FromJSON (SwaggerType t), FromJSON (SwaggerItems t)) => FromJSON (ParamSchema t) where
1176− parseJSON = genericParseJSONWithSub "items" (jsonPrefix "ParamSchema")
1177
1358
1359+instance (FromJSON (SwaggerType ('SwaggerKindNormal t)), FromJSON (SwaggerItems ('SwaggerKindNormal t))) => FromJSON (ParamSchema ('SwaggerKindNormal t)) where
1360+ parseJSON = sopSwaggerGenericParseJSON
1361+instance FromJSON (ParamSchema 'SwaggerKindParamOtherSchema) where
1362+ parseJSON = sopSwaggerGenericParseJSON
1363+instance FromJSON (ParamSchema 'SwaggerKindSchema) where
1364+ parseJSON = sopSwaggerGenericParseJSON
1365+
1366+instance FromJSON AdditionalProperties where
1367+ parseJSON (Bool b) = pure $ AdditionalPropertiesAllowed b
1368+ parseJSON js = AdditionalPropertiesSchema <$> parseJSON js
1369+
1370+-------------------------------------------------------------------------------
1371+-- TH splices
1372+-------------------------------------------------------------------------------
1373+
1374+deriveGeneric ''Header
1375+deriveGeneric ''OAuth2Params
1376+deriveGeneric ''Operation
1377+deriveGeneric ''Param
1378+deriveGeneric ''ParamOtherSchema
1379+deriveGeneric ''PathItem
1380+deriveGeneric ''Response
1381+deriveGeneric ''Responses
1382+deriveGeneric ''SecurityScheme
1383+deriveGeneric ''Schema
1384+deriveGeneric ''ParamSchema
1385+deriveGeneric ''Swagger
1386+
1387+instance HasSwaggerAesonOptions Header where
1388+ swaggerAesonOptions _ = mkSwaggerAesonOptions "header" & saoSubObject ?~ "paramSchema"
1389+instance HasSwaggerAesonOptions OAuth2Params where
1390+ swaggerAesonOptions _ = mkSwaggerAesonOptions "oauth2" & saoSubObject ?~ "flow"
1391+instance HasSwaggerAesonOptions Operation where
1392+ swaggerAesonOptions _ = mkSwaggerAesonOptions "operation"
1393+instance HasSwaggerAesonOptions Param where
1394+ swaggerAesonOptions _ = mkSwaggerAesonOptions "param" & saoSubObject ?~ "schema"
1395+instance HasSwaggerAesonOptions ParamOtherSchema where
1396+ swaggerAesonOptions _ = mkSwaggerAesonOptions "paramOtherSchema" & saoSubObject ?~ "paramSchema"
1397+instance HasSwaggerAesonOptions PathItem where
1398+ swaggerAesonOptions _ = mkSwaggerAesonOptions "pathItem"
1399+instance HasSwaggerAesonOptions Response where
1400+ swaggerAesonOptions _ = mkSwaggerAesonOptions "response"
1401+instance HasSwaggerAesonOptions Responses where
1402+ swaggerAesonOptions _ = mkSwaggerAesonOptions "responses" & saoSubObject ?~ "responses"
1403+instance HasSwaggerAesonOptions SecurityScheme where
1404+ swaggerAesonOptions _ = mkSwaggerAesonOptions "securityScheme" & saoSubObject ?~ "type"
1405+instance HasSwaggerAesonOptions Schema where
1406+ swaggerAesonOptions _ = mkSwaggerAesonOptions "schema" & saoSubObject ?~ "paramSchema"
1407+instance HasSwaggerAesonOptions Swagger where
1408+ swaggerAesonOptions _ = mkSwaggerAesonOptions "swagger" & saoAdditionalPairs .~ [("swagger", "2.0")]
1409+
1410+instance HasSwaggerAesonOptions (ParamSchema ('SwaggerKindNormal t)) where
1411+ swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1412+instance HasSwaggerAesonOptions (ParamSchema 'SwaggerKindParamOtherSchema) where
1413+ swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1414+-- NOTE: Schema doesn't have 'items' sub object!
1415+instance HasSwaggerAesonOptions (ParamSchema 'SwaggerKindSchema) where
1416+ swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema"
1417+
1418+instance AesonDefaultValue (ParamSchema s)
1419+instance AesonDefaultValue OAuth2Flow
1420+instance AesonDefaultValue Responses
1421+instance AesonDefaultValue ParamAnySchema
1422+instance AesonDefaultValue SecuritySchemeType
1423+instance AesonDefaultValue (SwaggerType a)
1424+instance AesonDefaultValue MimeList where defaultValue = Just mempty
1425+instance AesonDefaultValue Info
1426+instance AesonDefaultValue ParamLocation
1427+instance AesonDefaultValue SecurityDefinitions where defaultValue = Just $ SecurityDefinitions mempty
src/Data/Swagger/Internal/AesonUtils.hsnew file+346
@@ -0,0 +1,346 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DataKinds #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE GADTs #-}
5+{-# LANGUAGE ScopedTypeVariables #-}
6+{-# LANGUAGE ExplicitForAll #-}
7+{-# LANGUAGE TemplateHaskell #-}
8+#if __GLASGOW_HASKELL__ >= 800
9+{-# LANGUAGE UndecidableSuperClasses #-}
10+#endif
11+module Data.Swagger.Internal.AesonUtils (
12+ -- * Generic functions
13+ AesonDefaultValue(..),
14+ sopSwaggerGenericToJSON,
15+#if MIN_VERSION_aeson(0,10,0)
16+ sopSwaggerGenericToEncoding,
17+#endif
18+ sopSwaggerGenericToJSONWithOpts,
19+ sopSwaggerGenericParseJSON,
20+ -- * Options
21+ HasSwaggerAesonOptions(..),
22+ SwaggerAesonOptions,
23+ mkSwaggerAesonOptions,
24+ saoPrefix,
25+ saoAdditionalPairs,
26+ saoSubObject,
27+ ) where
28+
29+import Prelude ()
30+import Prelude.Compat
31+
32+import Control.Applicative ((<|>))
33+import Control.Lens (makeLenses, (^.))
34+import Control.Monad (unless)
35+import Data.Aeson (ToJSON(..), FromJSON(..), Value(..), Object, object, (.:), (.:?), (.!=), withObject)
36+import Data.Aeson.Types (Parser, Pair)
37+import Data.Char (toLower, isUpper)
38+import Data.Foldable (traverse_)
39+import Data.Text (Text)
40+
41+import Generics.SOP
42+
43+import qualified Data.Text as T
44+import qualified Data.HashMap.Strict as HM
45+import qualified Data.Set as Set
46+import qualified Data.HashMap.Strict.InsOrd as InsOrd
47+import qualified Data.HashSet.InsOrd as InsOrdHS
48+
49+#if MIN_VERSION_aeson(0,10,0)
50+import Data.Aeson (Encoding, pairs, (.=), Series)
51+#endif
52+
53+-------------------------------------------------------------------------------
54+-- SwaggerAesonOptions
55+-------------------------------------------------------------------------------
56+
57+data SwaggerAesonOptions = SwaggerAesonOptions
58+ { _saoPrefix :: String
59+ , _saoAdditionalPairs :: [(Text, Value)]
60+ , _saoSubObject :: Maybe String
61+ }
62+
63+mkSwaggerAesonOptions
64+ :: String -- ^ prefix
65+ -> SwaggerAesonOptions
66+mkSwaggerAesonOptions pfx = SwaggerAesonOptions pfx [] Nothing
67+
68+makeLenses ''SwaggerAesonOptions
69+
70+class (Generic a, All2 AesonDefaultValue (Code a)) => HasSwaggerAesonOptions a where
71+ swaggerAesonOptions :: Proxy a -> SwaggerAesonOptions
72+
73+ -- So far we use only default definitions
74+ aesonDefaults :: Proxy a -> POP Maybe (Code a)
75+ aesonDefaults _ = hcpure (Proxy :: Proxy AesonDefaultValue) defaultValue
76+
77+-------------------------------------------------------------------------------
78+-- Generics
79+-------------------------------------------------------------------------------
80+
81+class AesonDefaultValue a where
82+ defaultValue :: Maybe a
83+ defaultValue = Nothing
84+
85+instance AesonDefaultValue Text where defaultValue = Nothing
86+instance AesonDefaultValue (Maybe a) where defaultValue = Just Nothing
87+instance AesonDefaultValue [a] where defaultValue = Just []
88+instance AesonDefaultValue (Set.Set a) where defaultValue = Just Set.empty
89+instance AesonDefaultValue (InsOrdHS.InsOrdHashSet k) where defaultValue = Just InsOrdHS.empty
90+instance AesonDefaultValue (InsOrd.InsOrdHashMap k v) where defaultValue = Just InsOrd.empty
91+
92+-------------------------------------------------------------------------------
93+-- ToJSON
94+-------------------------------------------------------------------------------
95+
96+-- | Generic serialisation for swagger records.
97+--
98+-- Features
99+--
100+-- * omits nulls, empty objects and empty arrays (configurable)
101+-- * possible to add fields
102+-- * possible to merge sub-object
103+sopSwaggerGenericToJSON
104+ :: forall a xs.
105+ ( HasDatatypeInfo a
106+ , HasSwaggerAesonOptions a
107+ , All2 ToJSON (Code a)
108+ , All2 Eq (Code a)
109+ , Code a ~ '[xs]
110+ )
111+ => a
112+ -> Value
113+sopSwaggerGenericToJSON x =
114+ let ps = sopSwaggerGenericToJSON' opts (from x) (datatypeInfo proxy) (aesonDefaults proxy)
115+ in object (opts ^. saoAdditionalPairs ++ ps)
116+ where
117+ proxy = Proxy :: Proxy a
118+ opts = swaggerAesonOptions proxy
119+
120+-- | *TODO:* This is only used by ToJSON (ParamSchema SwaggerKindSchema)
121+--
122+-- Also uses default `aesonDefaults`
123+sopSwaggerGenericToJSONWithOpts
124+ :: forall a xs.
125+ ( Generic a
126+ , All2 AesonDefaultValue (Code a)
127+ , HasDatatypeInfo a
128+ , All2 ToJSON (Code a)
129+ , All2 Eq (Code a)
130+ , Code a ~ '[xs]
131+ )
132+ => SwaggerAesonOptions
133+ -> a
134+ -> Value
135+sopSwaggerGenericToJSONWithOpts opts x =
136+ let ps = sopSwaggerGenericToJSON' opts (from x) (datatypeInfo proxy) defs
137+ in object (opts ^. saoAdditionalPairs ++ ps)
138+ where
139+ proxy = Proxy :: Proxy a
140+ defs = hcpure (Proxy :: Proxy AesonDefaultValue) defaultValue
141+
142+sopSwaggerGenericToJSON'
143+ :: (All2 ToJSON '[xs], All2 Eq '[xs])
144+ => SwaggerAesonOptions
145+ -> SOP I '[xs]
146+ -> DatatypeInfo '[xs]
147+ -> POP Maybe '[xs]
148+ -> [Pair]
149+#if MIN_VERSION_generics_sop(0,5,0)
150+sopSwaggerGenericToJSON' opts (SOP (Z fields)) (ADT _ _ (Record _ fieldsInfo :* Nil) _) (POP (defs :* Nil)) =
151+#else
152+sopSwaggerGenericToJSON' opts (SOP (Z fields)) (ADT _ _ (Record _ fieldsInfo :* Nil)) (POP (defs :* Nil)) =
153+#endif
154+ sopSwaggerGenericToJSON'' opts fields fieldsInfo defs
155+sopSwaggerGenericToJSON' _ _ _ _ = error "sopSwaggerGenericToJSON: unsupported type"
156+
157+sopSwaggerGenericToJSON''
158+ :: (All ToJSON xs, All Eq xs)
159+ => SwaggerAesonOptions
160+ -> NP I xs
161+ -> NP FieldInfo xs
162+ -> NP Maybe xs
163+ -> [Pair]
164+sopSwaggerGenericToJSON'' (SwaggerAesonOptions prefix _ sub) = go
165+ where
166+ go :: (All ToJSON ys, All Eq ys) => NP I ys -> NP FieldInfo ys -> NP Maybe ys -> [Pair]
167+ go Nil Nil Nil = []
168+ go (I x :* xs) (FieldInfo name :* names) (def :* defs)
169+ | Just name' == sub = case json of
170+ Object m -> HM.toList m ++ rest
171+ Null -> rest
172+ _ -> error $ "sopSwaggerGenericToJSON: subjson is not an object: " ++ show json
173+ -- If default value: omit it.
174+ | Just x == def =
175+ rest
176+ | otherwise =
177+ (T.pack name', json) : rest
178+ where
179+ json = toJSON x
180+ name' = fieldNameModifier name
181+ rest = go xs names defs
182+#if __GLASGOW_HASKELL__ < 800
183+ go _ _ _ = error "not empty"
184+#endif
185+
186+ fieldNameModifier = modifier . drop 1
187+ modifier = lowerFirstUppers . drop (length prefix)
188+ lowerFirstUppers s = map toLower x ++ y
189+ where (x, y) = span isUpper s
190+
191+-------------------------------------------------------------------------------
192+-- FromJSON
193+-------------------------------------------------------------------------------
194+
195+sopSwaggerGenericParseJSON
196+ :: forall a xs.
197+ ( HasDatatypeInfo a
198+ , HasSwaggerAesonOptions a
199+ , All2 FromJSON (Code a)
200+ , All2 Eq (Code a)
201+ , Code a ~ '[xs]
202+ )
203+ => Value
204+ -> Parser a
205+sopSwaggerGenericParseJSON = withObject "Swagger Record Object" $ \obj ->
206+ let ps = sopSwaggerGenericParseJSON' opts obj (datatypeInfo proxy) (aesonDefaults proxy)
207+ in do
208+ traverse_ (parseAdditionalField obj) (opts ^. saoAdditionalPairs)
209+ to <$> ps
210+ where
211+ proxy = Proxy :: Proxy a
212+ opts = swaggerAesonOptions proxy
213+
214+ parseAdditionalField :: Object -> (Text, Value) -> Parser ()
215+ parseAdditionalField obj (k, v) = do
216+ v' <- obj .: k
217+ unless (v == v') $ fail $
218+ "Additonal field don't match for key " ++ T.unpack k
219+ ++ ": " ++ show v
220+ ++ " /= " ++ show v'
221+
222+sopSwaggerGenericParseJSON'
223+ :: (All2 FromJSON '[xs], All2 Eq '[xs])
224+ => SwaggerAesonOptions
225+ -> Object
226+ -> DatatypeInfo '[xs]
227+ -> POP Maybe '[xs]
228+ -> Parser (SOP I '[xs])
229+#if MIN_VERSION_generics_sop(0,5,0)
230+sopSwaggerGenericParseJSON' opts obj (ADT _ _ (Record _ fieldsInfo :* Nil) _) (POP (defs :* Nil)) =
231+#else
232+sopSwaggerGenericParseJSON' opts obj (ADT _ _ (Record _ fieldsInfo :* Nil)) (POP (defs :* Nil)) =
233+#endif
234+ SOP . Z <$> sopSwaggerGenericParseJSON'' opts obj fieldsInfo defs
235+sopSwaggerGenericParseJSON' _ _ _ _ = error "sopSwaggerGenericParseJSON: unsupported type"
236+
237+sopSwaggerGenericParseJSON''
238+ :: (All FromJSON xs, All Eq xs)
239+ => SwaggerAesonOptions
240+ -> Object
241+ -> NP FieldInfo xs
242+ -> NP Maybe xs
243+ -> Parser (NP I xs)
244+sopSwaggerGenericParseJSON'' (SwaggerAesonOptions prefix _ sub) obj = go
245+ where
246+ go :: (All FromJSON ys, All Eq ys) => NP FieldInfo ys -> NP Maybe ys -> Parser (NP I ys)
247+ go Nil Nil = pure Nil
248+ go (FieldInfo name :* names) (def :* defs)
249+ | Just name' == sub =
250+ -- Note: we might strip fields of outer structure.
251+ cons <$> (withDef $ parseJSON $ Object obj) <*> rest
252+ | otherwise = case def of
253+ Just def' -> cons <$> obj .:? T.pack name' .!= def' <*> rest
254+ Nothing -> cons <$> obj .: T.pack name' <*> rest
255+ where
256+ cons h t = I h :* t
257+ name' = fieldNameModifier name
258+ rest = go names defs
259+
260+ withDef = case def of
261+ Just def' -> (<|> pure def')
262+ Nothing -> id
263+#if __GLASGOW_HASKELL__ < 800
264+ go _ _ = error "not empty"
265+#endif
266+
267+ fieldNameModifier = modifier . drop 1
268+ modifier = lowerFirstUppers . drop (length prefix)
269+ lowerFirstUppers s = map toLower x ++ y
270+ where (x, y) = span isUpper s
271+
272+-------------------------------------------------------------------------------
273+-- ToEncoding
274+-------------------------------------------------------------------------------
275+
276+#if MIN_VERSION_aeson(0,10,0)
277+
278+sopSwaggerGenericToEncoding
279+ :: forall a xs.
280+ ( HasDatatypeInfo a
281+ , HasSwaggerAesonOptions a
282+ , All2 ToJSON (Code a)
283+ , All2 Eq (Code a)
284+ , Code a ~ '[xs]
285+ )
286+ => a
287+ -> Encoding
288+sopSwaggerGenericToEncoding x =
289+ let ps = sopSwaggerGenericToEncoding' opts (from x) (datatypeInfo proxy) (aesonDefaults proxy)
290+ in pairs (pairsToSeries (opts ^. saoAdditionalPairs) <> ps)
291+ where
292+ proxy = Proxy :: Proxy a
293+ opts = swaggerAesonOptions proxy
294+
295+pairsToSeries :: [Pair] -> Series
296+pairsToSeries = foldMap (\(k, v) -> (k .= v))
297+
298+sopSwaggerGenericToEncoding'
299+ :: (All2 ToJSON '[xs], All2 Eq '[xs])
300+ => SwaggerAesonOptions
301+ -> SOP I '[xs]
302+ -> DatatypeInfo '[xs]
303+ -> POP Maybe '[xs]
304+ -> Series
305+#if MIN_VERSION_generics_sop(0,5,0)
306+sopSwaggerGenericToEncoding' opts (SOP (Z fields)) (ADT _ _ (Record _ fieldsInfo :* Nil) _) (POP (defs :* Nil)) =
307+#else
308+sopSwaggerGenericToEncoding' opts (SOP (Z fields)) (ADT _ _ (Record _ fieldsInfo :* Nil)) (POP (defs :* Nil)) =
309+#endif
310+ sopSwaggerGenericToEncoding'' opts fields fieldsInfo defs
311+sopSwaggerGenericToEncoding' _ _ _ _ = error "sopSwaggerGenericToEncoding: unsupported type"
312+
313+sopSwaggerGenericToEncoding''
314+ :: (All ToJSON xs, All Eq xs)
315+ => SwaggerAesonOptions
316+ -> NP I xs
317+ -> NP FieldInfo xs
318+ -> NP Maybe xs
319+ -> Series
320+sopSwaggerGenericToEncoding'' (SwaggerAesonOptions prefix _ sub) = go
321+ where
322+ go :: (All ToJSON ys, All Eq ys) => NP I ys -> NP FieldInfo ys -> NP Maybe ys -> Series
323+ go Nil Nil Nil = mempty
324+ go (I x :* xs) (FieldInfo name :* names) (def :* defs)
325+ | Just name' == sub = case toJSON x of
326+ Object m -> pairsToSeries (HM.toList m) <> rest
327+ Null -> rest
328+ _ -> error $ "sopSwaggerGenericToJSON: subjson is not an object: " ++ show (toJSON x)
329+ -- If default value: omit it.
330+ | Just x == def =
331+ rest
332+ | otherwise =
333+ (T.pack name' .= x) <> rest
334+ where
335+ name' = fieldNameModifier name
336+ rest = go xs names defs
337+#if __GLASGOW_HASKELL__ < 800
338+ go _ _ _ = error "not empty"
339+#endif
340+
341+ fieldNameModifier = modifier . drop 1
342+ modifier = lowerFirstUppers . drop (length prefix)
343+ lowerFirstUppers s = map toLower x ++ y
344+ where (x, y) = span isUpper s
345+
346+#endif
src/Data/Swagger/Internal/ParamSchema.hs+123−24
@@ -1,3 +1,5 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DataKinds #-}
1{-# LANGUAGE DefaultSignatures #-}
3{-# LANGUAGE DefaultSignatures #-}
2{-# LANGUAGE FlexibleContexts #-}
4{-# LANGUAGE FlexibleContexts #-}
3{-# LANGUAGE FlexibleInstances #-}
5{-# LANGUAGE FlexibleInstances #-}
@@ -6,12 +8,21 @@
6{-# LANGUAGE PackageImports #-}
8{-# LANGUAGE PackageImports #-}
7{-# LANGUAGE PolyKinds #-}
9{-# LANGUAGE PolyKinds #-}
8{-# LANGUAGE ScopedTypeVariables #-}
10{-# LANGUAGE ScopedTypeVariables #-}
11+{-# LANGUAGE TypeFamilies #-}
9{-# LANGUAGE TypeOperators #-}
12{-# LANGUAGE TypeOperators #-}
10{-# LANGUAGE TypeSynonymInstances #-}
13{-# LANGUAGE TypeSynonymInstances #-}
14+{-# LANGUAGE UndecidableInstances #-}
15+#if __GLASGOW_HASKELL__ >= 800
16+-- Generic a is redundant in ToParamSchema a default imple
17+{-# OPTIONS_GHC -Wno-redundant-constraints #-}
18+-- For TypeErrors
19+{-# OPTIONS_GHC -Wno-unticked-promoted-constructors #-}
20+#endif
21+#include "overlapping-compat.h"
11module Data.Swagger.Internal.ParamSchema where
22module Data.Swagger.Internal.ParamSchema where
12
23
13import Control.Lens
24import Control.Lens
14−import Data.Aeson
25+import Data.Aeson (ToJSON (..))
15import Data.Proxy
26import Data.Proxy
16import GHC.Generics
27import GHC.Generics
17
28
@@ -20,15 +31,50 @@ import "unordered-containers" Data.HashSet (HashSet)
20import Data.Monoid
31import Data.Monoid
21import Data.Set (Set)
32import Data.Set (Set)
22import Data.Scientific
33import Data.Scientific
34+import Data.Fixed (HasResolution(..), Fixed, Pico)
23import qualified Data.Text as T
35import qualified Data.Text as T
24import qualified Data.Text.Lazy as TL
36import qualified Data.Text.Lazy as TL
25import Data.Time
37import Data.Time
38+import qualified Data.Vector as V
39+import qualified Data.Vector.Primitive as VP
40+import qualified Data.Vector.Storable as VS
41+import qualified Data.Vector.Unboxed as VU
42+import Data.Version (Version)
43+import Numeric.Natural.Compat (Natural)
26import Data.Word
44import Data.Word
45+import Data.UUID.Types (UUID)
46+import Web.Cookie (SetCookie)
27
47
28import Data.Swagger.Internal
48import Data.Swagger.Internal
29import Data.Swagger.Lens
49import Data.Swagger.Lens
30import Data.Swagger.SchemaOptions
50import Data.Swagger.SchemaOptions
31
51
52+#if __GLASGOW_HASKELL__ < 800
53+#else
54+import qualified Data.ByteString as BS
55+import qualified Data.ByteString.Lazy as BSL
56+import GHC.TypeLits (TypeError, ErrorMessage(..))
57+#endif
58+
59+-- | Default schema for binary data (any sequence of octets).
60+binaryParamSchema :: ParamSchema t
61+binaryParamSchema = mempty
62+ & type_ ?~ SwaggerString
63+ & format ?~ "binary"
64+
65+-- | Default schema for binary data (base64 encoded).
66+byteParamSchema :: ParamSchema t
67+byteParamSchema = mempty
68+ & type_ ?~ SwaggerString
69+ & format ?~ "byte"
70+
71+-- | Default schema for password string.
72+-- @"password"@ format is used to hint UIs the input needs to be obscured.
73+passwordParamSchema :: ParamSchema t
74+passwordParamSchema = mempty
75+ & type_ ?~ SwaggerString
76+ & format ?~ "password"
77+
32-- | Convert a type into a plain @'ParamSchema'@.
78-- | Convert a type into a plain @'ParamSchema'@.
33--
79--
34-- An example type and instance:
80-- An example type and instance:
@@ -41,9 +87,9 @@ import Data.Swagger.SchemaOptions
41-- data Direction = Up | Down
87-- data Direction = Up | Down
42--
88--
43-- instance ToParamSchema Direction where
89-- instance ToParamSchema Direction where
44−-- toParamSchema = mempty
90+-- toParamSchema _ = mempty
45−-- & type_ .~ SwaggerString
91+-- & type_ ?~ SwaggerString
46−-- & enum_ .~ [ \"Up\", \"Down\" ]
92+-- & enum_ ?~ [ \"Up\", \"Down\" ]
47-- @
93-- @
48--
94--
49-- Instead of manually writing your @'ToParamSchema'@ instance you can
95-- Instead of manually writing your @'ToParamSchema'@ instance you can
@@ -69,18 +115,24 @@ class ToParamSchema a where
69 --
115 --
70 -- >>> encode $ toParamSchema (Proxy :: Proxy Integer)
116 -- >>> encode $ toParamSchema (Proxy :: Proxy Integer)
71 -- "{\"type\":\"integer\"}"
117 -- "{\"type\":\"integer\"}"
72− toParamSchema :: proxy a -> ParamSchema t
118+ toParamSchema :: Proxy a -> ParamSchema t
73− default toParamSchema :: (Generic a, GToParamSchema (Rep a)) => proxy a -> ParamSchema t
119+ default toParamSchema :: (Generic a, GToParamSchema (Rep a)) => Proxy a -> ParamSchema t
74 toParamSchema = genericToParamSchema defaultSchemaOptions
120 toParamSchema = genericToParamSchema defaultSchemaOptions
75
121
76−instance {-# OVERLAPPING #-} ToParamSchema String where
122+instance OVERLAPPING_ ToParamSchema String where
77− toParamSchema _ = mempty & type_ .~ SwaggerString
123+ toParamSchema _ = mempty & type_ ?~ SwaggerString
78
124
79instance ToParamSchema Bool where
125instance ToParamSchema Bool where
80− toParamSchema _ = mempty & type_ .~ SwaggerBoolean
126+ toParamSchema _ = mempty & type_ ?~ SwaggerBoolean
81
127
82instance ToParamSchema Integer where
128instance ToParamSchema Integer where
83− toParamSchema _ = mempty & type_ .~ SwaggerInteger
129+ toParamSchema _ = mempty & type_ ?~ SwaggerInteger
130+
131+instance ToParamSchema Natural where
132+ toParamSchema _ = mempty
133+ & type_ ?~ SwaggerInteger
134+ & minimum_ ?~ 0
135+ & exclusiveMinimum ?~ False
84
136
85instance ToParamSchema Int where toParamSchema = toParamSchemaBoundedIntegral
137instance ToParamSchema Int where toParamSchema = toParamSchemaBoundedIntegral
86instance ToParamSchema Int8 where toParamSchema = toParamSchemaBoundedIntegral
138instance ToParamSchema Int8 where toParamSchema = toParamSchemaBoundedIntegral
@@ -102,40 +154,51 @@ instance ToParamSchema Word64 where toParamSchema = toParamSchemaBoundedIntegral
102--
154--
103-- >>> encode $ toParamSchemaBoundedIntegral (Proxy :: Proxy Int8)
155-- >>> encode $ toParamSchemaBoundedIntegral (Proxy :: Proxy Int8)
104-- "{\"maximum\":127,\"minimum\":-128,\"type\":\"integer\"}"
156-- "{\"maximum\":127,\"minimum\":-128,\"type\":\"integer\"}"
105−toParamSchemaBoundedIntegral :: forall proxy a t. (Bounded a, Integral a) => proxy a -> ParamSchema t
157+toParamSchemaBoundedIntegral :: forall a t. (Bounded a, Integral a) => Proxy a -> ParamSchema t
106toParamSchemaBoundedIntegral _ = mempty
158toParamSchemaBoundedIntegral _ = mempty
107− & type_ .~ SwaggerInteger
159+ & type_ ?~ SwaggerInteger
108 & minimum_ ?~ fromInteger (toInteger (minBound :: a))
160 & minimum_ ?~ fromInteger (toInteger (minBound :: a))
109 & maximum_ ?~ fromInteger (toInteger (maxBound :: a))
161 & maximum_ ?~ fromInteger (toInteger (maxBound :: a))
110
162
111instance ToParamSchema Char where
163instance ToParamSchema Char where
112 toParamSchema _ = mempty
164 toParamSchema _ = mempty
113− & type_ .~ SwaggerString
165+ & type_ ?~ SwaggerString
114 & maxLength ?~ 1
166 & maxLength ?~ 1
115 & minLength ?~ 1
167 & minLength ?~ 1
116
168
117instance ToParamSchema Scientific where
169instance ToParamSchema Scientific where
118− toParamSchema _ = mempty & type_ .~ SwaggerNumber
170+ toParamSchema _ = mempty & type_ ?~ SwaggerNumber
171+
172+instance HasResolution a => ToParamSchema (Fixed a) where
173+ toParamSchema _ = mempty
174+ & type_ ?~ SwaggerNumber
175+ & multipleOf ?~ (recip . fromInteger $ resolution (Proxy :: Proxy a))
119
176
120instance ToParamSchema Double where
177instance ToParamSchema Double where
121 toParamSchema _ = mempty
178 toParamSchema _ = mempty
122− & type_ .~ SwaggerNumber
179+ & type_ ?~ SwaggerNumber
123 & format ?~ "double"
180 & format ?~ "double"
124
181
125instance ToParamSchema Float where
182instance ToParamSchema Float where
126 toParamSchema _ = mempty
183 toParamSchema _ = mempty
127− & type_ .~ SwaggerNumber
184+ & type_ ?~ SwaggerNumber
128 & format ?~ "float"
185 & format ?~ "float"
129
186
130timeParamSchema :: String -> ParamSchema t
187timeParamSchema :: String -> ParamSchema t
131timeParamSchema fmt = mempty
188timeParamSchema fmt = mempty
132− & type_ .~ SwaggerString
189+ & type_ ?~ SwaggerString
133 & format ?~ T.pack fmt
190 & format ?~ T.pack fmt
134
191
135-- | Format @"date"@ corresponds to @yyyy-mm-dd@ format.
192-- | Format @"date"@ corresponds to @yyyy-mm-dd@ format.
136instance ToParamSchema Day where
193instance ToParamSchema Day where
137 toParamSchema _ = timeParamSchema "date"
194 toParamSchema _ = timeParamSchema "date"
138
195
196+-- |
197+-- >>> toParamSchema (Proxy :: Proxy TimeOfDay) ^. format
198+-- Just "hh:MM:ss"
199+instance ToParamSchema TimeOfDay where
200+ toParamSchema _ = timeParamSchema "hh:MM:ss"
201+
139-- |
202-- |
140-- >>> toParamSchema (Proxy :: Proxy LocalTime) ^. format
203-- >>> toParamSchema (Proxy :: Proxy LocalTime) ^. format
141-- Just "yyyy-mm-ddThh:MM:ss"
204-- Just "yyyy-mm-ddThh:MM:ss"
@@ -155,7 +218,7 @@ instance ToParamSchema UTCTime where
155 toParamSchema _ = timeParamSchema "yyyy-mm-ddThh:MM:ssZ"
218 toParamSchema _ = timeParamSchema "yyyy-mm-ddThh:MM:ssZ"
156
219
157instance ToParamSchema NominalDiffTime where
220instance ToParamSchema NominalDiffTime where
158− toParamSchema _ = toParamSchema (Proxy :: Proxy Integer)
221+ toParamSchema _ = toParamSchema (Proxy :: Proxy Pico)
159
222
160instance ToParamSchema T.Text where
223instance ToParamSchema T.Text where
161 toParamSchema _ = toParamSchema (Proxy :: Proxy String)
224 toParamSchema _ = toParamSchema (Proxy :: Proxy String)
@@ -163,6 +226,28 @@ instance ToParamSchema T.Text where
163instance ToParamSchema TL.Text where
226instance ToParamSchema TL.Text where
164 toParamSchema _ = toParamSchema (Proxy :: Proxy String)
227 toParamSchema _ = toParamSchema (Proxy :: Proxy String)
165
228
229+instance ToParamSchema Version where
230+ toParamSchema _ = mempty
231+ & type_ ?~ SwaggerString
232+ & pattern ?~ "^\\d+(\\.\\d+)*$"
233+
234+instance ToParamSchema SetCookie where
235+ toParamSchema _ = mempty
236+ & type_ ?~ SwaggerString
237+
238+
239+#if __GLASGOW_HASKELL__ < 800
240+#else
241+type family ToParamSchemaByteStringError bs where
242+ ToParamSchemaByteStringError bs = TypeError
243+ ( 'Text "Impossible to have an instance " :<>: ShowType (ToParamSchema bs) :<>: Text "."
244+ :$$: 'Text "Please, use a newtype wrapper around " :<>: ShowType bs :<>: Text " instead."
245+ :$$: 'Text "Consider using byteParamSchema or binaryParamSchema templates." )
246+
247+instance ToParamSchemaByteStringError BS.ByteString => ToParamSchema BS.ByteString where toParamSchema = error "impossible"
248+instance ToParamSchemaByteStringError BSL.ByteString => ToParamSchema BSL.ByteString where toParamSchema = error "impossible"
249+#endif
250+
166instance ToParamSchema All where toParamSchema _ = toParamSchema (Proxy :: Proxy Bool)
251instance ToParamSchema All where toParamSchema _ = toParamSchema (Proxy :: Proxy Bool)
167instance ToParamSchema Any where toParamSchema _ = toParamSchema (Proxy :: Proxy Bool)
252instance ToParamSchema Any where toParamSchema _ = toParamSchema (Proxy :: Proxy Bool)
168instance ToParamSchema a => ToParamSchema (Sum a) where toParamSchema _ = toParamSchema (Proxy :: Proxy a)
253instance ToParamSchema a => ToParamSchema (Sum a) where toParamSchema _ = toParamSchema (Proxy :: Proxy a)
@@ -171,11 +256,18 @@ instance ToParamSchema a => ToParamSchema (First a) where toParamSchema _ = to
171instance ToParamSchema a => ToParamSchema (Last a) where toParamSchema _ = toParamSchema (Proxy :: Proxy a)
256instance ToParamSchema a => ToParamSchema (Last a) where toParamSchema _ = toParamSchema (Proxy :: Proxy a)
172instance ToParamSchema a => ToParamSchema (Dual a) where toParamSchema _ = toParamSchema (Proxy :: Proxy a)
257instance ToParamSchema a => ToParamSchema (Dual a) where toParamSchema _ = toParamSchema (Proxy :: Proxy a)
173
258
259+instance ToParamSchema a => ToParamSchema (Identity a) where toParamSchema _ = toParamSchema (Proxy :: Proxy a)
260+
174instance ToParamSchema a => ToParamSchema [a] where
261instance ToParamSchema a => ToParamSchema [a] where
175 toParamSchema _ = mempty
262 toParamSchema _ = mempty
176− & type_ .~ SwaggerArray
263+ & type_ ?~ SwaggerArray
177 & items ?~ SwaggerItemsPrimitive Nothing (toParamSchema (Proxy :: Proxy a))
264 & items ?~ SwaggerItemsPrimitive Nothing (toParamSchema (Proxy :: Proxy a))
178
265
266+instance ToParamSchema a => ToParamSchema (V.Vector a) where toParamSchema _ = toParamSchema (Proxy :: Proxy [a])
267+instance ToParamSchema a => ToParamSchema (VP.Vector a) where toParamSchema _ = toParamSchema (Proxy :: Proxy [a])
268+instance ToParamSchema a => ToParamSchema (VS.Vector a) where toParamSchema _ = toParamSchema (Proxy :: Proxy [a])
269+instance ToParamSchema a => ToParamSchema (VU.Vector a) where toParamSchema _ = toParamSchema (Proxy :: Proxy [a])
270+
179instance ToParamSchema a => ToParamSchema (Set a) where
271instance ToParamSchema a => ToParamSchema (Set a) where
180 toParamSchema _ = toParamSchema (Proxy :: Proxy [a])
272 toParamSchema _ = toParamSchema (Proxy :: Proxy [a])
181 & uniqueItems ?~ True
273 & uniqueItems ?~ True
@@ -188,20 +280,25 @@ instance ToParamSchema a => ToParamSchema (HashSet a) where
188-- "{\"type\":\"string\",\"enum\":[\"_\"]}"
280-- "{\"type\":\"string\",\"enum\":[\"_\"]}"
189instance ToParamSchema () where
281instance ToParamSchema () where
190 toParamSchema _ = mempty
282 toParamSchema _ = mempty
191− & type_ .~ SwaggerString
283+ & type_ ?~ SwaggerString
192 & enum_ ?~ ["_"]
284 & enum_ ?~ ["_"]
193
285
286+instance ToParamSchema UUID where
287+ toParamSchema _ = mempty
288+ & type_ ?~ SwaggerString
289+ & format ?~ "uuid"
290+
194-- | A configurable generic @'ParamSchema'@ creator.
291-- | A configurable generic @'ParamSchema'@ creator.
195--
292--
196-- >>> :set -XDeriveGeneric
293-- >>> :set -XDeriveGeneric
197-- >>> data Color = Red | Blue deriving Generic
294-- >>> data Color = Red | Blue deriving Generic
198-- >>> encode $ genericToParamSchema defaultSchemaOptions (Proxy :: Proxy Color)
295-- >>> encode $ genericToParamSchema defaultSchemaOptions (Proxy :: Proxy Color)
199-- "{\"type\":\"string\",\"enum\":[\"Red\",\"Blue\"]}"
296-- "{\"type\":\"string\",\"enum\":[\"Red\",\"Blue\"]}"
200−genericToParamSchema :: forall proxy a t. (Generic a, GToParamSchema (Rep a)) => SchemaOptions -> proxy a -> ParamSchema t
297+genericToParamSchema :: forall a t. (Generic a, GToParamSchema (Rep a)) => SchemaOptions -> Proxy a -> ParamSchema t
201genericToParamSchema opts _ = gtoParamSchema opts (Proxy :: Proxy (Rep a)) mempty
298genericToParamSchema opts _ = gtoParamSchema opts (Proxy :: Proxy (Rep a)) mempty
202
299
203class GToParamSchema (f :: * -> *) where
300class GToParamSchema (f :: * -> *) where
204− gtoParamSchema :: SchemaOptions -> proxy f -> ParamSchema t -> ParamSchema t
301+ gtoParamSchema :: SchemaOptions -> Proxy f -> ParamSchema t -> ParamSchema t
205
302
206instance GToParamSchema f => GToParamSchema (D1 d f) where
303instance GToParamSchema f => GToParamSchema (D1 d f) where
207 gtoParamSchema opts _ = gtoParamSchema opts (Proxy :: Proxy f)
304 gtoParamSchema opts _ = gtoParamSchema opts (Proxy :: Proxy f)
@@ -219,14 +316,14 @@ instance (GEnumParamSchema f, GEnumParamSchema g) => GToParamSchema (f :+: g) wh
219 gtoParamSchema opts _ = genumParamSchema opts (Proxy :: Proxy (f :+: g))
316 gtoParamSchema opts _ = genumParamSchema opts (Proxy :: Proxy (f :+: g))
220
317
221class GEnumParamSchema (f :: * -> *) where
318class GEnumParamSchema (f :: * -> *) where
222− genumParamSchema :: SchemaOptions -> proxy f -> ParamSchema t -> ParamSchema t
319+ genumParamSchema :: SchemaOptions -> Proxy f -> ParamSchema t -> ParamSchema t
223
320
224instance (GEnumParamSchema f, GEnumParamSchema g) => GEnumParamSchema (f :+: g) where
321instance (GEnumParamSchema f, GEnumParamSchema g) => GEnumParamSchema (f :+: g) where
225 genumParamSchema opts _ = genumParamSchema opts (Proxy :: Proxy f) . genumParamSchema opts (Proxy :: Proxy g)
322 genumParamSchema opts _ = genumParamSchema opts (Proxy :: Proxy f) . genumParamSchema opts (Proxy :: Proxy g)
226
323
227instance Constructor c => GEnumParamSchema (C1 c U1) where
324instance Constructor c => GEnumParamSchema (C1 c U1) where
228 genumParamSchema opts _ s = s
325 genumParamSchema opts _ s = s
229− & type_ .~ SwaggerString
326+ & type_ ?~ SwaggerString
230 & enum_ %~ addEnumValue tag
327 & enum_ %~ addEnumValue tag
231 where
328 where
232 tag = toJSON (constructorTagModifier opts (conName (Proxy3 :: Proxy3 c f p)))
329 tag = toJSON (constructorTagModifier opts (conName (Proxy3 :: Proxy3 c f p)))
@@ -236,3 +333,5 @@ instance Constructor c => GEnumParamSchema (C1 c U1) where
236
333
237data Proxy3 a b c = Proxy3
334data Proxy3 a b c = Proxy3
238
335
336+-- $setup
337+-- >>> import Data.Aeson (encode)
src/Data/Swagger/Internal/Schema.hs+403−90
@@ -1,7 +1,10 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE ConstraintKinds #-}
1{-# LANGUAGE DefaultSignatures #-}
3{-# LANGUAGE DefaultSignatures #-}
2{-# LANGUAGE FlexibleContexts #-}
4{-# LANGUAGE FlexibleContexts #-}
3{-# LANGUAGE FlexibleInstances #-}
5{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE KindSignatures #-}
6{-# LANGUAGE KindSignatures #-}
7+{-# LANGUAGE DataKinds #-}
5{-# LANGUAGE OverloadedLists #-}
8{-# LANGUAGE OverloadedLists #-}
6{-# LANGUAGE OverloadedStrings #-}
9{-# LANGUAGE OverloadedStrings #-}
7{-# LANGUAGE PackageImports #-}
10{-# LANGUAGE PackageImports #-}
@@ -11,39 +14,69 @@
11{-# LANGUAGE TypeFamilies #-}
14{-# LANGUAGE TypeFamilies #-}
12{-# LANGUAGE TypeOperators #-}
15{-# LANGUAGE TypeOperators #-}
13{-# LANGUAGE TypeSynonymInstances #-}
16{-# LANGUAGE TypeSynonymInstances #-}
17+{-# LANGUAGE UndecidableInstances #-}
18+#if __GLASGOW_HASKELL__ >= 800
19+-- Few generics related redundant constraints
20+{-# OPTIONS_GHC -Wno-redundant-constraints #-}
21+-- For TypeErrors
22+{-# OPTIONS_GHC -Wno-unticked-promoted-constructors #-}
23+#endif
24+#include "overlapping-compat.h"
14module Data.Swagger.Internal.Schema where
25module Data.Swagger.Internal.Schema where
15
26
27+import Prelude ()
28+import Prelude.Compat
29+
16import Control.Lens
30import Control.Lens
17import Data.Data.Lens (template)
31import Data.Data.Lens (template)
18
32
19import Control.Monad
33import Control.Monad
20import Control.Monad.Writer
34import Control.Monad.Writer
21−import Data.Aeson
35+import Data.Aeson (ToJSON (..), ToJSONKey (..), ToJSONKeyFunction (..), Value (..), Object(..))
22import Data.Char
36import Data.Char
23import Data.Data (Data)
37import Data.Data (Data)
24import Data.Foldable (traverse_)
38import Data.Foldable (traverse_)
25import Data.HashMap.Strict (HashMap)
39import Data.HashMap.Strict (HashMap)
26import qualified Data.HashMap.Strict as HashMap
40import qualified Data.HashMap.Strict as HashMap
27−import "unordered-containers" Data.HashSet (HashSet)
41+import "unordered-containers" Data.HashSet (HashSet)
42+import qualified "unordered-containers" Data.HashSet as HashSet
43+import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
28import Data.Int
44import Data.Int
29import Data.IntSet (IntSet)
45import Data.IntSet (IntSet)
30import Data.IntMap (IntMap)
46import Data.IntMap (IntMap)
47+import Data.List.NonEmpty.Compat (NonEmpty)
31import Data.Map (Map)
48import Data.Map (Map)
32−import Data.Monoid
33import Data.Proxy
49import Data.Proxy
34import Data.Scientific (Scientific)
50import Data.Scientific (Scientific)
51+import Data.Fixed (Fixed, HasResolution, Pico)
35import Data.Set (Set)
52import Data.Set (Set)
36import qualified Data.Text as T
53import qualified Data.Text as T
37import qualified Data.Text.Lazy as TL
54import qualified Data.Text.Lazy as TL
38import Data.Time
55import Data.Time
56+import qualified Data.Vector as V
57+import qualified Data.Vector.Primitive as VP
58+import qualified Data.Vector.Storable as VS
59+import qualified Data.Vector.Unboxed as VU
60+import Data.Version (Version)
61+import Numeric.Natural.Compat (Natural)
39import Data.Word
62import Data.Word
40import GHC.Generics
63import GHC.Generics
64+import qualified Data.UUID.Types as UUID
41
65
42import Data.Swagger.Declare
66import Data.Swagger.Declare
43import Data.Swagger.Internal
67import Data.Swagger.Internal
44import Data.Swagger.Internal.ParamSchema (ToParamSchema(..))
68import Data.Swagger.Internal.ParamSchema (ToParamSchema(..))
45−import Data.Swagger.Lens
69+import Data.Swagger.Lens hiding (name, schema)
70+import qualified Data.Swagger.Lens as Swagger
46import Data.Swagger.SchemaOptions
71import Data.Swagger.SchemaOptions
72+import Data.Swagger.Internal.TypeShape
73+
74+#if __GLASGOW_HASKELL__ < 800
75+#else
76+import qualified Data.ByteString as BS
77+import qualified Data.ByteString.Lazy as BSL
78+import GHC.TypeLits (TypeError, ErrorMessage(..))
79+#endif
47
80
48unnamed :: Schema -> NamedSchema
81unnamed :: Schema -> NamedSchema
49unnamed schema = NamedSchema Nothing schema
82unnamed schema = NamedSchema Nothing schema
@@ -69,19 +102,21 @@ rename name (NamedSchema _ schema) = NamedSchema name schema
69-- {-\# LANGUAGE OverloadedLists \#-} -- allows to write 'Map' and 'HashMap' as lists
102-- {-\# LANGUAGE OverloadedLists \#-} -- allows to write 'Map' and 'HashMap' as lists
70--
103--
71-- import Control.Lens
104-- import Control.Lens
105+-- import Data.Proxy
106+-- import Data.Swagger
72--
107--
73-- data Coord = Coord { x :: Double, y :: Double }
108-- data Coord = Coord { x :: Double, y :: Double }
74--
109--
75-- instance ToSchema Coord where
110-- instance ToSchema Coord where
76−-- declareNamedSchema = pure (Just \"Coord\", schema)
111+-- declareNamedSchema _ = do
77−-- where
112+-- doubleSchema <- declareSchemaRef (Proxy :: Proxy Double)
78−-- schema = mempty
113+-- return $ NamedSchema (Just \"Coord\") $ mempty
79−-- & type_ .~ SwaggerObject
114+-- & type_ ?~ SwaggerObject
80−-- & properties .~
115+-- & properties .~
81−-- [ (\"x\", toSchemaRef (Proxy :: Proxy Double))
116+-- [ (\"x\", doubleSchema)
82−-- , (\"y\", toSchemaRef (Proxy :: Proxy Double))
117+-- , (\"y\", doubleSchema)
83−-- ]
118+-- ]
84−-- & required .~ [ \"x\", \"y\" ]
119+-- & required .~ [ \"x\", \"y\" ]
85-- @
120-- @
86--
121--
87-- Instead of manually writing your @'ToSchema'@ instance you can
122-- Instead of manually writing your @'ToSchema'@ instance you can
@@ -107,12 +142,17 @@ class ToSchema a where
107 -- together with all used definitions.
142 -- together with all used definitions.
108 -- Note that the schema itself is included in definitions
143 -- Note that the schema itself is included in definitions
109 -- only if it is recursive (and thus needs its definition in scope).
144 -- only if it is recursive (and thus needs its definition in scope).
110− declareNamedSchema :: proxy a -> Declare (Definitions Schema) NamedSchema
145+ declareNamedSchema :: Proxy a -> Declare (Definitions Schema) NamedSchema
146+ default declareNamedSchema :: (Generic a, GToSchema (Rep a), TypeHasSimpleShape a "genericDeclareNamedSchemaUnrestricted") =>
111− default declareNamedSchema :: (Generic a, GToSchema (Rep a)) => proxy a -> Declare (Definitions Schema) NamedSchema
147+ Proxy a -> Declare (Definitions Schema) NamedSchema
112 declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions
148 declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions
113
149
150+instance ToSchema TimeOfDay where
151+ declareNamedSchema _ = pure $ named "TimeOfDay" $ timeSchema "hh:MM:ss"
152+ & example ?~ toJSON (TimeOfDay 12 33 15)
153+
114-- | Convert a type into a schema and declare all used schema definitions.
154-- | Convert a type into a schema and declare all used schema definitions.
115−declareSchema :: ToSchema a => proxy a -> Declare (Definitions Schema) Schema
155+declareSchema :: ToSchema a => Proxy a -> Declare (Definitions Schema) Schema
116declareSchema = fmap _namedSchemaSchema . declareNamedSchema
156declareSchema = fmap _namedSchemaSchema . declareNamedSchema
117
157
118-- | Convert a type into an optionally named schema.
158-- | Convert a type into an optionally named schema.
@@ -125,8 +165,8 @@ declareSchema = fmap _namedSchemaSchema . declareNamedSchema
125-- >>> toNamedSchema (Proxy :: Proxy Day) ^. name
165-- >>> toNamedSchema (Proxy :: Proxy Day) ^. name
126-- Just "Day"
166-- Just "Day"
127-- >>> encode (toNamedSchema (Proxy :: Proxy Day) ^. schema)
167-- >>> encode (toNamedSchema (Proxy :: Proxy Day) ^. schema)
128−-- "{\"format\":\"date\",\"type\":\"string\"}"
168+-- "{\"example\":\"2016-07-22\",\"format\":\"date\",\"type\":\"string\"}"
129−toNamedSchema :: ToSchema a => proxy a -> NamedSchema
169+toNamedSchema :: ToSchema a => Proxy a -> NamedSchema
130toNamedSchema = undeclare . declareNamedSchema
170toNamedSchema = undeclare . declareNamedSchema
131
171
132-- | Get type's schema name according to its @'ToSchema'@ instance.
172-- | Get type's schema name according to its @'ToSchema'@ instance.
@@ -136,7 +176,7 @@ toNamedSchema = undeclare . declareNamedSchema
136--
176--
137-- >>> schemaName (Proxy :: Proxy UTCTime)
177-- >>> schemaName (Proxy :: Proxy UTCTime)
138-- Just "UTCTime"
178-- Just "UTCTime"
139−schemaName :: ToSchema a => proxy a -> Maybe T.Text
179+schemaName :: ToSchema a => Proxy a -> Maybe T.Text
140schemaName = _namedSchemaName . toNamedSchema
180schemaName = _namedSchemaName . toNamedSchema
141
181
142-- | Convert a type into a schema.
182-- | Convert a type into a schema.
@@ -146,7 +186,7 @@ schemaName = _namedSchemaName . toNamedSchema
146--
186--
147-- >>> encode $ toSchema (Proxy :: Proxy [Day])
187-- >>> encode $ toSchema (Proxy :: Proxy [Day])
148-- "{\"items\":{\"$ref\":\"#/definitions/Day\"},\"type\":\"array\"}"
188-- "{\"items\":{\"$ref\":\"#/definitions/Day\"},\"type\":\"array\"}"
149−toSchema :: ToSchema a => proxy a -> Schema
189+toSchema :: ToSchema a => Proxy a -> Schema
150toSchema = _namedSchemaSchema . toNamedSchema
190toSchema = _namedSchemaSchema . toNamedSchema
151
191
152-- | Convert a type into a referenced schema if possible.
192-- | Convert a type into a referenced schema if possible.
@@ -157,7 +197,7 @@ toSchema = _namedSchemaSchema . toNamedSchema
157--
197--
158-- >>> encode $ toSchemaRef (Proxy :: Proxy Day)
198-- >>> encode $ toSchemaRef (Proxy :: Proxy Day)
159-- "{\"$ref\":\"#/definitions/Day\"}"
199-- "{\"$ref\":\"#/definitions/Day\"}"
160−toSchemaRef :: ToSchema a => proxy a -> Referenced Schema
200+toSchemaRef :: ToSchema a => Proxy a -> Referenced Schema
161toSchemaRef = undeclare . declareSchemaRef
201toSchemaRef = undeclare . declareSchemaRef
162
202
163-- | Convert a type into a referenced schema if possible
203-- | Convert a type into a referenced schema if possible
@@ -167,7 +207,7 @@ toSchemaRef = undeclare . declareSchemaRef
167-- Schema definitions are typically declared for every referenced schema.
207-- Schema definitions are typically declared for every referenced schema.
168-- If @'declareSchemaRef'@ returns a reference, a corresponding schema
208-- If @'declareSchemaRef'@ returns a reference, a corresponding schema
169-- will be declared (regardless of whether it is recusive or not).
209-- will be declared (regardless of whether it is recusive or not).
170−declareSchemaRef :: ToSchema a => proxy a -> Declare (Definitions Schema) (Referenced Schema)
210+declareSchemaRef :: ToSchema a => Proxy a -> Declare (Definitions Schema) (Referenced Schema)
171declareSchemaRef proxy = do
211declareSchemaRef proxy = do
172 case toNamedSchema proxy of
212 case toNamedSchema proxy of
173 NamedSchema (Just name) schema -> do
213 NamedSchema (Just name) schema -> do
@@ -179,7 +219,7 @@ declareSchemaRef proxy = do
179 -- have already declared it.
219 -- have already declared it.
180 -- If we have, we don't need to declare anything for
220 -- If we have, we don't need to declare anything for
181 -- this schema this time and thus simply return the reference.
221 -- this schema this time and thus simply return the reference.
182− known <- looks (HashMap.member name)
222+ known <- looks (InsOrdHashMap.member name)
183 when (not known) $ do
223 when (not known) $ do
184 declare [(name, schema)]
224 declare [(name, schema)]
185 void $ declareNamedSchema proxy
225 void $ declareNamedSchema proxy
@@ -198,7 +238,7 @@ inlineSchemasWhen p defs = template %~ deref
198 where
238 where
199 deref r@(Ref (Reference name))
239 deref r@(Ref (Reference name))
200 | p name =
240 | p name =
201− case HashMap.lookup name defs of
241+ case InsOrdHashMap.lookup name defs of
202 Just schema -> Inline (inlineSchemasWhen p defs schema)
242 Just schema -> Inline (inlineSchemasWhen p defs schema)
203 Nothing -> r
243 Nothing -> r
204 | otherwise = r
244 | otherwise = r
@@ -225,11 +265,11 @@ inlineAllSchemas = inlineSchemasWhen (const True)
225-- | Convert a type into a schema without references.
265-- | Convert a type into a schema without references.
226--
266--
227-- >>> encode $ toInlinedSchema (Proxy :: Proxy [Day])
267-- >>> encode $ toInlinedSchema (Proxy :: Proxy [Day])
228−-- "{\"items\":{\"format\":\"date\",\"type\":\"string\"},\"type\":\"array\"}"
268+-- "{\"items\":{\"example\":\"2016-07-22\",\"format\":\"date\",\"type\":\"string\"},\"type\":\"array\"}"
229--
269--
230-- __WARNING:__ @'toInlinedSchema'@ will produce infinite schema
270-- __WARNING:__ @'toInlinedSchema'@ will produce infinite schema
231-- when inlining recursive schemas.
271-- when inlining recursive schemas.
232−toInlinedSchema :: ToSchema a => proxy a -> Schema
272+toInlinedSchema :: ToSchema a => Proxy a -> Schema
233toInlinedSchema proxy = inlineAllSchemas defs schema
273toInlinedSchema proxy = inlineAllSchemas defs schema
234 where
274 where
235 (defs, schema) = runDeclare (declareSchema proxy) mempty
275 (defs, schema) = runDeclare (declareSchema proxy) mempty
@@ -240,7 +280,7 @@ inlineNonRecursiveSchemas :: Data s => (Definitions Schema) -> s -> s
240inlineNonRecursiveSchemas defs = inlineSchemasWhen nonRecursive defs
280inlineNonRecursiveSchemas defs = inlineSchemasWhen nonRecursive defs
241 where
281 where
242 nonRecursive name =
282 nonRecursive name =
243− case HashMap.lookup name defs of
283+ case InsOrdHashMap.lookup name defs of
244 Just schema -> name `notElem` execDeclare (usedNames schema) mempty
284 Just schema -> name `notElem` execDeclare (usedNames schema) mempty
245 Nothing -> False
285 Nothing -> False
246
286
@@ -252,22 +292,141 @@ inlineNonRecursiveSchemas defs = inlineSchemasWhen nonRecursive defs
252 seen <- looks (name `elem`)
292 seen <- looks (name `elem`)
253 when (not seen) $ do
293 when (not seen) $ do
254 declare [name]
294 declare [name]
255− traverse_ usedNames (HashMap.lookup name defs)
295+ traverse_ usedNames (InsOrdHashMap.lookup name defs)
256 Inline subschema -> usedNames subschema
296 Inline subschema -> usedNames subschema
257
297
298+-- | Default schema for binary data (any sequence of octets).
299+binarySchema :: Schema
300+binarySchema = mempty
301+ & type_ ?~ SwaggerString
302+ & format ?~ "binary"
303+
304+-- | Default schema for binary data (base64 encoded).
305+byteSchema :: Schema
306+byteSchema = mempty
307+ & type_ ?~ SwaggerString
308+ & format ?~ "byte"
309+
310+-- | Default schema for password string.
311+-- @"password"@ format is used to hint UIs the input needs to be obscured.
312+passwordSchema :: Schema
313+passwordSchema = mempty
314+ & type_ ?~ SwaggerString
315+ & format ?~ "password"
316+
317+-- | Make an unrestrictive sketch of a @'Schema'@ based on a @'ToJSON'@ instance.
318+-- Produced schema can be used for further refinement.
319+--
320+-- >>> encode $ sketchSchema "hello"
321+-- "{\"example\":\"hello\",\"type\":\"string\"}"
322+--
323+-- >>> encode $ sketchSchema (1, 2, 3)
324+-- "{\"example\":[1,2,3],\"items\":{\"type\":\"number\"},\"type\":\"array\"}"
325+--
326+-- >>> encode $ sketchSchema ("Jack", 25)
327+-- "{\"example\":[\"Jack\",25],\"items\":[{\"type\":\"string\"},{\"type\":\"number\"}],\"type\":\"array\"}"
328+--
329+-- >>> data Person = Person { name :: String, age :: Int } deriving (Generic)
330+-- >>> instance ToJSON Person
331+-- >>> encode $ sketchSchema (Person "Jack" 25)
332+-- "{\"required\":[\"age\",\"name\"],\"properties\":{\"age\":{\"type\":\"number\"},\"name\":{\"type\":\"string\"}},\"example\":{\"age\":25,\"name\":\"Jack\"},\"type\":\"object\"}"
333+sketchSchema :: ToJSON a => a -> Schema
334+sketchSchema = sketch . toJSON
335+ where
336+ sketch Null = go Null
337+ sketch js@(Bool _) = go js
338+ sketch js = go js & example ?~ js
339+
340+ go Null = mempty & type_ ?~ SwaggerNull
341+ go (Bool _) = mempty & type_ ?~ SwaggerBoolean
342+ go (String _) = mempty & type_ ?~ SwaggerString
343+ go (Number _) = mempty & type_ ?~ SwaggerNumber
344+ go (Array xs) = mempty
345+ & type_ ?~ SwaggerArray
346+ & items ?~ case ischema of
347+ Just s -> SwaggerItemsObject (Inline s)
348+ _ -> SwaggerItemsArray (map Inline ys)
349+ where
350+ ys = map go (V.toList xs)
351+ allSame = and ((zipWith (==)) ys (tail ys))
352+
353+ ischema = case ys of
354+ (z:_) | allSame -> Just z
355+ _ -> Nothing
356+ go (Object o) = mempty
357+ & type_ ?~ SwaggerObject
358+ & required .~ HashMap.keys o
359+ & properties .~ fmap (Inline . go) (InsOrdHashMap.fromHashMap o)
360+
361+-- | Make a restrictive sketch of a @'Schema'@ based on a @'ToJSON'@ instance.
362+-- Produced schema uses as much constraints as possible.
363+--
364+-- >>> encode $ sketchStrictSchema "hello"
365+-- "{\"maxLength\":5,\"pattern\":\"hello\",\"minLength\":5,\"type\":\"string\",\"enum\":[\"hello\"]}"
366+--
367+-- >>> encode $ sketchStrictSchema (1, 2, 3)
368+-- "{\"minItems\":3,\"uniqueItems\":true,\"items\":[{\"maximum\":1,\"minimum\":1,\"multipleOf\":1,\"type\":\"number\",\"enum\":[1]},{\"maximum\":2,\"minimum\":2,\"multipleOf\":2,\"type\":\"number\",\"enum\":[2]},{\"maximum\":3,\"minimum\":3,\"multipleOf\":3,\"type\":\"number\",\"enum\":[3]}],\"maxItems\":3,\"type\":\"array\",\"enum\":[[1,2,3]]}"
369+--
370+-- >>> encode $ sketchStrictSchema ("Jack", 25)
371+-- "{\"minItems\":2,\"uniqueItems\":true,\"items\":[{\"maxLength\":4,\"pattern\":\"Jack\",\"minLength\":4,\"type\":\"string\",\"enum\":[\"Jack\"]},{\"maximum\":25,\"minimum\":25,\"multipleOf\":25,\"type\":\"number\",\"enum\":[25]}],\"maxItems\":2,\"type\":\"array\",\"enum\":[[\"Jack\",25]]}"
372+--
373+-- >>> data Person = Person { name :: String, age :: Int } deriving (Generic)
374+-- >>> instance ToJSON Person
375+-- >>> encode $ sketchStrictSchema (Person "Jack" 25)
376+-- "{\"required\":[\"age\",\"name\"],\"properties\":{\"age\":{\"maximum\":25,\"minimum\":25,\"multipleOf\":25,\"type\":\"number\",\"enum\":[25]},\"name\":{\"maxLength\":4,\"pattern\":\"Jack\",\"minLength\":4,\"type\":\"string\",\"enum\":[\"Jack\"]}},\"maxProperties\":2,\"minProperties\":2,\"type\":\"object\",\"enum\":[{\"age\":25,\"name\":\"Jack\"}]}"
377+sketchStrictSchema :: ToJSON a => a -> Schema
378+sketchStrictSchema = go . toJSON
379+ where
380+ go Null = mempty & type_ ?~ SwaggerNull
381+ go js@(Bool _) = mempty
382+ & type_ ?~ SwaggerBoolean
383+ & enum_ ?~ [js]
384+ go js@(String s) = mempty
385+ & type_ ?~ SwaggerString
386+ & maxLength ?~ fromIntegral (T.length s)
387+ & minLength ?~ fromIntegral (T.length s)
388+ & pattern ?~ s
389+ & enum_ ?~ [js]
390+ go js@(Number n) = mempty
391+ & type_ ?~ SwaggerNumber
392+ & maximum_ ?~ n
393+ & minimum_ ?~ n
394+ & multipleOf ?~ n
395+ & enum_ ?~ [js]
396+ go js@(Array xs) = mempty
397+ & type_ ?~ SwaggerArray
398+ & maxItems ?~ fromIntegral sz
399+ & minItems ?~ fromIntegral sz
400+ & items ?~ SwaggerItemsArray (map (Inline . go) (V.toList xs))
401+ & uniqueItems ?~ allUnique
402+ & enum_ ?~ [js]
403+ where
404+ sz = length xs
405+ allUnique = sz == HashSet.size (HashSet.fromList (V.toList xs))
406+ go js@(Object o) = mempty
407+ & type_ ?~ SwaggerObject
408+ & required .~ names
409+ & properties .~ fmap (Inline . go) (InsOrdHashMap.fromHashMap o)
410+ & maxProperties ?~ fromIntegral (length names)
411+ & minProperties ?~ fromIntegral (length names)
412+ & enum_ ?~ [js]
413+ where
414+ names = HashMap.keys o
415+
258class GToSchema (f :: * -> *) where
416class GToSchema (f :: * -> *) where
259− gdeclareNamedSchema :: SchemaOptions -> proxy f -> Schema -> Declare (Definitions Schema) NamedSchema
417+ gdeclareNamedSchema :: SchemaOptions -> Proxy f -> Schema -> Declare (Definitions Schema) NamedSchema
260
418
261−instance {-# OVERLAPPABLE #-} ToSchema a => ToSchema [a] where
419+instance OVERLAPPABLE_ ToSchema a => ToSchema [a] where
262 declareNamedSchema _ = do
420 declareNamedSchema _ = do
263 ref <- declareSchemaRef (Proxy :: Proxy a)
421 ref <- declareSchemaRef (Proxy :: Proxy a)
264 return $ unnamed $ mempty
422 return $ unnamed $ mempty
265− & type_ .~ SwaggerArray
423+ & type_ ?~ SwaggerArray
266 & items ?~ SwaggerItemsObject ref
424 & items ?~ SwaggerItemsObject ref
267
425
268−instance {-# OVERLAPPING #-} ToSchema String where declareNamedSchema = plain . paramSchemaToSchema
426+instance OVERLAPPING_ ToSchema String where declareNamedSchema = plain . paramSchemaToSchema
269instance ToSchema Bool where declareNamedSchema = plain . paramSchemaToSchema
427instance ToSchema Bool where declareNamedSchema = plain . paramSchemaToSchema
270instance ToSchema Integer where declareNamedSchema = plain . paramSchemaToSchema
428instance ToSchema Integer where declareNamedSchema = plain . paramSchemaToSchema
429+instance ToSchema Natural where declareNamedSchema = plain . paramSchemaToSchema
271instance ToSchema Int where declareNamedSchema = plain . paramSchemaToSchema
430instance ToSchema Int where declareNamedSchema = plain . paramSchemaToSchema
272instance ToSchema Int8 where declareNamedSchema = plain . paramSchemaToSchema
431instance ToSchema Int8 where declareNamedSchema = plain . paramSchemaToSchema
273instance ToSchema Int16 where declareNamedSchema = plain . paramSchemaToSchema
432instance ToSchema Int16 where declareNamedSchema = plain . paramSchemaToSchema
@@ -279,11 +438,16 @@ instance ToSchema Word16 where declareNamedSchema = plain . paramSchemaToSchema
279instance ToSchema Word32 where declareNamedSchema = plain . paramSchemaToSchema
438instance ToSchema Word32 where declareNamedSchema = plain . paramSchemaToSchema
280instance ToSchema Word64 where declareNamedSchema = plain . paramSchemaToSchema
439instance ToSchema Word64 where declareNamedSchema = plain . paramSchemaToSchema
281
440
441+instance ToSchema Char where
282−instance ToSchema Char where declareNamedSchema = plain . paramSchemaToSchema
442+ declareNamedSchema proxy = plain (paramSchemaToSchema proxy)
443+ & mapped.Swagger.schema.example ?~ toJSON '?'
444+
283instance ToSchema Scientific where declareNamedSchema = plain . paramSchemaToSchema
445instance ToSchema Scientific where declareNamedSchema = plain . paramSchemaToSchema
284instance ToSchema Double where declareNamedSchema = plain . paramSchemaToSchema
446instance ToSchema Double where declareNamedSchema = plain . paramSchemaToSchema
285instance ToSchema Float where declareNamedSchema = plain . paramSchemaToSchema
447instance ToSchema Float where declareNamedSchema = plain . paramSchemaToSchema
286
448
449+instance HasResolution a => ToSchema (Fixed a) where declareNamedSchema = plain . paramSchemaToSchema
450+
287instance ToSchema a => ToSchema (Maybe a) where
451instance ToSchema a => ToSchema (Maybe a) where
288 declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy a)
452 declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy a)
289
453
@@ -292,6 +456,11 @@ instance (ToSchema a, ToSchema b) => ToSchema (Either a b)
292instance ToSchema () where
456instance ToSchema () where
293 declareNamedSchema _ = pure (NamedSchema Nothing nullarySchema)
457 declareNamedSchema _ = pure (NamedSchema Nothing nullarySchema)
294
458
459+-- | For 'ToJSON' instance, see <http://hackage.haskell.org/package/uuid-aeson uuid-aeson> package.
460+instance ToSchema UUID.UUID where
461+ declareNamedSchema p = pure $ named "UUID" $ paramSchemaToSchema p
462+ & example ?~ toJSON (UUID.toText UUID.nil)
463+
295instance (ToSchema a, ToSchema b) => ToSchema (a, b)
464instance (ToSchema a, ToSchema b) => ToSchema (a, b)
296instance (ToSchema a, ToSchema b, ToSchema c) => ToSchema (a, b, c)
465instance (ToSchema a, ToSchema b, ToSchema c) => ToSchema (a, b, c)
297instance (ToSchema a, ToSchema b, ToSchema c, ToSchema d) => ToSchema (a, b, c, d)
466instance (ToSchema a, ToSchema b, ToSchema c, ToSchema d) => ToSchema (a, b, c, d)
@@ -301,46 +470,81 @@ instance (ToSchema a, ToSchema b, ToSchema c, ToSchema d, ToSchema e, ToSchema f
301
470
302timeSchema :: T.Text -> Schema
471timeSchema :: T.Text -> Schema
303timeSchema fmt = mempty
472timeSchema fmt = mempty
304− & type_ .~ SwaggerString
473+ & type_ ?~ SwaggerString
305 & format ?~ fmt
474 & format ?~ fmt
306
475
307-- | Format @"date"@ corresponds to @yyyy-mm-dd@ format.
476-- | Format @"date"@ corresponds to @yyyy-mm-dd@ format.
308instance ToSchema Day where
477instance ToSchema Day where
309− declareNamedSchema _ = pure $ named "Day" (timeSchema "date")
478+ declareNamedSchema _ = pure $ named "Day" $ timeSchema "date"
479+ & example ?~ toJSON (fromGregorian 2016 7 22)
310
480
311-- |
481-- |
312-- >>> toSchema (Proxy :: Proxy LocalTime) ^. format
482-- >>> toSchema (Proxy :: Proxy LocalTime) ^. format
313-- Just "yyyy-mm-ddThh:MM:ss"
483-- Just "yyyy-mm-ddThh:MM:ss"
314instance ToSchema LocalTime where
484instance ToSchema LocalTime where
315− declareNamedSchema _ = pure $ named "LocalTime" (timeSchema "yyyy-mm-ddThh:MM:ss")
485+ declareNamedSchema _ = pure $ named "LocalTime" $ timeSchema "yyyy-mm-ddThh:MM:ss"
486+ & example ?~ toJSON (LocalTime (fromGregorian 2016 7 22) (TimeOfDay 7 40 0))
316
487
317-- | Format @"date"@ corresponds to @yyyy-mm-ddThh:MM:ss(Z|+hh:MM)@ format.
488-- | Format @"date"@ corresponds to @yyyy-mm-ddThh:MM:ss(Z|+hh:MM)@ format.
318instance ToSchema ZonedTime where
489instance ToSchema ZonedTime where
319 declareNamedSchema _ = pure $ named "ZonedTime" $ timeSchema "date-time"
490 declareNamedSchema _ = pure $ named "ZonedTime" $ timeSchema "date-time"
491+ & example ?~ toJSON (ZonedTime (LocalTime (fromGregorian 2016 7 22) (TimeOfDay 7 40 0)) (hoursToTimeZone 3))
320
492
321instance ToSchema NominalDiffTime where
493instance ToSchema NominalDiffTime where
322− declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy Integer)
494+ declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy Pico)
323
495
324-- |
496-- |
325-- >>> toSchema (Proxy :: Proxy UTCTime) ^. format
497-- >>> toSchema (Proxy :: Proxy UTCTime) ^. format
326-- Just "yyyy-mm-ddThh:MM:ssZ"
498-- Just "yyyy-mm-ddThh:MM:ssZ"
327instance ToSchema UTCTime where
499instance ToSchema UTCTime where
328− declareNamedSchema _ = pure $ named "UTCTime" (timeSchema "yyyy-mm-ddThh:MM:ssZ")
500+ declareNamedSchema _ = pure $ named "UTCTime" $ timeSchema "yyyy-mm-ddThh:MM:ssZ"
501+ & example ?~ toJSON (UTCTime (fromGregorian 2016 7 22) 0)
329
502
330instance ToSchema T.Text where declareNamedSchema = plain . paramSchemaToSchema
503instance ToSchema T.Text where declareNamedSchema = plain . paramSchemaToSchema
331instance ToSchema TL.Text where declareNamedSchema = plain . paramSchemaToSchema
504instance ToSchema TL.Text where declareNamedSchema = plain . paramSchemaToSchema
332
505
506+instance ToSchema Version where declareNamedSchema = plain . paramSchemaToSchema
507+
508+#if __GLASGOW_HASKELL__ < 800
509+#else
510+type family ToSchemaByteStringError bs where
511+ ToSchemaByteStringError bs = TypeError
512+ ( Text "Impossible to have an instance " :<>: ShowType (ToSchema bs) :<>: Text "."
513+ :$$: Text "Please, use a newtype wrapper around " :<>: ShowType bs :<>: Text " instead."
514+ :$$: Text "Consider using byteSchema or binarySchema templates." )
515+
516+instance ToSchemaByteStringError BS.ByteString => ToSchema BS.ByteString where declareNamedSchema = error "impossible"
517+instance ToSchemaByteStringError BSL.ByteString => ToSchema BSL.ByteString where declareNamedSchema = error "impossible"
518+#endif
519+
333instance ToSchema IntSet where declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy (Set Int))
520instance ToSchema IntSet where declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy (Set Int))
334
521
335-- | NOTE: This schema does not account for the uniqueness of keys.
522-- | NOTE: This schema does not account for the uniqueness of keys.
336instance ToSchema a => ToSchema (IntMap a) where
523instance ToSchema a => ToSchema (IntMap a) where
337 declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy [(Int, a)])
524 declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy [(Int, a)])
338
525
526+#if MIN_VERSION_aeson(1,0,0)
527+instance (ToJSONKey k, ToSchema k, ToSchema v) => ToSchema (Map k v) where
528+ declareNamedSchema _ = case toJSONKey :: ToJSONKeyFunction k of
529+ ToJSONKeyText _ _ -> declareObjectMapSchema
530+ ToJSONKeyValue _ _ -> declareNamedSchema (Proxy :: Proxy [(k, v)])
531+ where
532+ declareObjectMapSchema = do
533+ schema <- declareSchemaRef (Proxy :: Proxy v)
534+ return $ unnamed $ mempty
535+ & type_ ?~ SwaggerObject
536+ & additionalProperties ?~ AdditionalPropertiesSchema schema
537+
538+instance (ToJSONKey k, ToSchema k, ToSchema v) => ToSchema (HashMap k v) where
539+ declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy (Map k v))
540+
541+#else
542+
339instance ToSchema a => ToSchema (Map String a) where
543instance ToSchema a => ToSchema (Map String a) where
340 declareNamedSchema _ = do
544 declareNamedSchema _ = do
341− schema <- declareSchema (Proxy :: Proxy a)
545+ schema <- declareSchemaRef (Proxy :: Proxy a)
342 return $ unnamed $ mempty
546 return $ unnamed $ mempty
343− & type_ .~ SwaggerObject
547+ & type_ ?~ SwaggerObject
344 & additionalProperties ?~ schema
548 & additionalProperties ?~ schema
345
549
346instance ToSchema a => ToSchema (Map T.Text a) where declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy (Map String a))
550instance ToSchema a => ToSchema (Map T.Text a) where declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy (Map String a))
@@ -350,6 +554,19 @@ instance ToSchema a => ToSchema (HashMap String a) where declareNamedSchema _ =
350instance ToSchema a => ToSchema (HashMap T.Text a) where declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy (Map String a))
554instance ToSchema a => ToSchema (HashMap T.Text a) where declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy (Map String a))
351instance ToSchema a => ToSchema (HashMap TL.Text a) where declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy (Map String a))
555instance ToSchema a => ToSchema (HashMap TL.Text a) where declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy (Map String a))
352
556
557+#endif
558+
559+instance OVERLAPPING_ ToSchema Object where
560+ declareNamedSchema _ = pure $ NamedSchema (Just "Object") $ mempty
561+ & type_ ?~ SwaggerObject
562+ & description ?~ "Arbitrary JSON object."
563+ & additionalProperties ?~ AdditionalPropertiesAllowed True
564+
565+instance ToSchema a => ToSchema (V.Vector a) where declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy [a])
566+instance ToSchema a => ToSchema (VU.Vector a) where declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy [a])
567+instance ToSchema a => ToSchema (VS.Vector a) where declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy [a])
568+instance ToSchema a => ToSchema (VP.Vector a) where declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy [a])
569+
353instance ToSchema a => ToSchema (Set a) where
570instance ToSchema a => ToSchema (Set a) where
354 declareNamedSchema _ = do
571 declareNamedSchema _ = do
355 schema <- declareSchema (Proxy :: Proxy [a])
572 schema <- declareSchema (Proxy :: Proxy [a])
@@ -358,6 +575,13 @@ instance ToSchema a => ToSchema (Set a) where
358
575
359instance ToSchema a => ToSchema (HashSet a) where declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy (Set a))
576instance ToSchema a => ToSchema (HashSet a) where declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy (Set a))
360
577
578+-- | @since 2.2.1
579+instance ToSchema a => ToSchema (NonEmpty a) where
580+ declareNamedSchema _ = do
581+ schema <- declareSchema (Proxy :: Proxy [a])
582+ return $ unnamed $ schema
583+ & minItems .~ Just 1
584+
361instance ToSchema All where declareNamedSchema = plain . paramSchemaToSchema
585instance ToSchema All where declareNamedSchema = plain . paramSchemaToSchema
362instance ToSchema Any where declareNamedSchema = plain . paramSchemaToSchema
586instance ToSchema Any where declareNamedSchema = plain . paramSchemaToSchema
363
587
@@ -367,81 +591,161 @@ instance ToSchema a => ToSchema (First a) where declareNamedSchema _ = unname
367instance ToSchema a => ToSchema (Last a) where declareNamedSchema _ = unname <$> declareNamedSchema (Proxy :: Proxy a)
591instance ToSchema a => ToSchema (Last a) where declareNamedSchema _ = unname <$> declareNamedSchema (Proxy :: Proxy a)
368instance ToSchema a => ToSchema (Dual a) where declareNamedSchema _ = unname <$> declareNamedSchema (Proxy :: Proxy a)
592instance ToSchema a => ToSchema (Dual a) where declareNamedSchema _ = unname <$> declareNamedSchema (Proxy :: Proxy a)
369
593
594+instance ToSchema a => ToSchema (Identity a) where declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy a)
595+
370-- | Default schema for @'Bounded'@, @'Integral'@ types.
596-- | Default schema for @'Bounded'@, @'Integral'@ types.
371--
597--
372-- >>> encode $ toSchemaBoundedIntegral (Proxy :: Proxy Int16)
598-- >>> encode $ toSchemaBoundedIntegral (Proxy :: Proxy Int16)
373-- "{\"maximum\":32767,\"minimum\":-32768,\"type\":\"integer\"}"
599-- "{\"maximum\":32767,\"minimum\":-32768,\"type\":\"integer\"}"
374−toSchemaBoundedIntegral :: forall a proxy. (Bounded a, Integral a) => proxy a -> Schema
600+toSchemaBoundedIntegral :: forall a. (Bounded a, Integral a) => Proxy a -> Schema
375toSchemaBoundedIntegral _ = mempty
601toSchemaBoundedIntegral _ = mempty
376− & type_ .~ SwaggerInteger
602+ & type_ ?~ SwaggerInteger
377 & minimum_ ?~ fromInteger (toInteger (minBound :: a))
603 & minimum_ ?~ fromInteger (toInteger (minBound :: a))
378 & maximum_ ?~ fromInteger (toInteger (maxBound :: a))
604 & maximum_ ?~ fromInteger (toInteger (maxBound :: a))
379
605
380-- | Default generic named schema for @'Bounded'@, @'Integral'@ types.
606-- | Default generic named schema for @'Bounded'@, @'Integral'@ types.
381−genericToNamedSchemaBoundedIntegral :: forall a d f proxy.
607+genericToNamedSchemaBoundedIntegral :: forall a d f.
382 ( Bounded a, Integral a
608 ( Bounded a, Integral a
383 , Generic a, Rep a ~ D1 d f, Datatype d)
609 , Generic a, Rep a ~ D1 d f, Datatype d)
384− => SchemaOptions -> proxy a -> NamedSchema
610+ => SchemaOptions -> Proxy a -> NamedSchema
385genericToNamedSchemaBoundedIntegral opts proxy
611genericToNamedSchemaBoundedIntegral opts proxy
386− = NamedSchema (gdatatypeSchemaName opts (Proxy :: Proxy d)) (toSchemaBoundedIntegral proxy)
612+ = genericNameSchema opts proxy (toSchemaBoundedIntegral proxy)
613+
614+-- | Declare a named schema for a @newtype@ wrapper.
615+genericDeclareNamedSchemaNewtype :: forall a d c s i inner.
616+ (Generic a, Datatype d, Rep a ~ D1 d (C1 c (S1 s (K1 i inner))))
617+ => SchemaOptions -- ^ How to derive the name.
618+ -> (Proxy inner -> Declare (Definitions Schema) Schema) -- ^ How to create a schema for the wrapped type.
619+ -> Proxy a
620+ -> Declare (Definitions Schema) NamedSchema
621+genericDeclareNamedSchemaNewtype opts f proxy = genericNameSchema opts proxy <$> f (Proxy :: Proxy inner)
622+
623+-- | Declare 'Schema' for a mapping with 'Bounded' 'Enum' keys.
624+-- This makes a much more useful schema when there aren't many options for key values.
625+--
626+-- >>> data ButtonState = Neutral | Focus | Active | Hover | Disabled deriving (Show, Bounded, Enum, Generic)
627+-- >>> instance ToJSON ButtonState
628+-- >>> instance ToSchema ButtonState
629+-- >>> instance ToJSONKey ButtonState where toJSONKey = toJSONKeyText (T.pack . show)
630+-- >>> type ImageUrl = T.Text
631+-- >>> encode $ toSchemaBoundedEnumKeyMapping (Proxy :: Proxy (Map ButtonState ImageUrl))
632+-- "{\"properties\":{\"Neutral\":{\"type\":\"string\"},\"Focus\":{\"type\":\"string\"},\"Active\":{\"type\":\"string\"},\"Hover\":{\"type\":\"string\"},\"Disabled\":{\"type\":\"string\"}},\"type\":\"object\"}"
633+--
634+-- Note: this is only useful when @key@ is encoded with 'ToJSONKeyText'.
635+-- If it is encoded with 'ToJSONKeyValue' then a regular schema for @[(key, value)]@ is used.
636+declareSchemaBoundedEnumKeyMapping :: forall map key value.
637+ (Bounded key, Enum key, ToJSONKey key, ToSchema key, ToSchema value)
638+ => Proxy (map key value) -> Declare (Definitions Schema) Schema
639+declareSchemaBoundedEnumKeyMapping _ = case toJSONKey :: ToJSONKeyFunction key of
640+ ToJSONKeyText keyToText _ -> objectSchema keyToText
641+ ToJSONKeyValue _ _ -> declareSchema (Proxy :: Proxy [(key, value)])
642+ where
643+ objectSchema keyToText = do
644+ valueRef <- declareSchemaRef (Proxy :: Proxy value)
645+ let allKeys = [minBound..maxBound :: key]
646+ mkPair k = (keyToText k, valueRef)
647+ return $ mempty
648+ & type_ ?~ SwaggerObject
649+ & properties .~ InsOrdHashMap.fromList (map mkPair allKeys)
650+
651+-- | A 'Schema' for a mapping with 'Bounded' 'Enum' keys.
652+-- This makes a much more useful schema when there aren't many options for key values.
653+--
654+-- >>> data ButtonState = Neutral | Focus | Active | Hover | Disabled deriving (Show, Bounded, Enum, Generic)
655+-- >>> instance ToJSON ButtonState
656+-- >>> instance ToSchema ButtonState
657+-- >>> instance ToJSONKey ButtonState where toJSONKey = toJSONKeyText (T.pack . show)
658+-- >>> type ImageUrl = T.Text
659+-- >>> encode $ toSchemaBoundedEnumKeyMapping (Proxy :: Proxy (Map ButtonState ImageUrl))
660+-- "{\"properties\":{\"Neutral\":{\"type\":\"string\"},\"Focus\":{\"type\":\"string\"},\"Active\":{\"type\":\"string\"},\"Hover\":{\"type\":\"string\"},\"Disabled\":{\"type\":\"string\"}},\"type\":\"object\"}"
661+--
662+-- Note: this is only useful when @key@ is encoded with 'ToJSONKeyText'.
663+-- If it is encoded with 'ToJSONKeyValue' then a regular schema for @[(key, value)]@ is used.
664+toSchemaBoundedEnumKeyMapping :: forall map key value.
665+ (Bounded key, Enum key, ToJSONKey key, ToSchema key, ToSchema value)
666+ => Proxy (map key value) -> Schema
667+toSchemaBoundedEnumKeyMapping = flip evalDeclare mempty . declareSchemaBoundedEnumKeyMapping
387
668
388-- | A configurable generic @'Schema'@ creator.
669-- | A configurable generic @'Schema'@ creator.
670+genericDeclareSchema :: (Generic a, GToSchema (Rep a), TypeHasSimpleShape a "genericDeclareSchemaUnrestricted") =>
389−genericDeclareSchema :: (Generic a, GToSchema (Rep a)) => SchemaOptions -> proxy a -> Declare (Definitions Schema) Schema
671+ SchemaOptions -> Proxy a -> Declare (Definitions Schema) Schema
390−genericDeclareSchema opts proxy = _namedSchemaSchema <$> genericDeclareNamedSchema opts proxy
672+genericDeclareSchema = genericDeclareSchemaUnrestricted
391
673
392-- | A configurable generic @'NamedSchema'@ creator.
674-- | A configurable generic @'NamedSchema'@ creator.
393-- This function applied to @'defaultSchemaOptions'@
675-- This function applied to @'defaultSchemaOptions'@
394-- is used as the default for @'declareNamedSchema'@
676-- is used as the default for @'declareNamedSchema'@
395-- when the type is an instance of @'Generic'@.
677-- when the type is an instance of @'Generic'@.
678+genericDeclareNamedSchema :: (Generic a, GToSchema (Rep a), TypeHasSimpleShape a "genericDeclareNamedSchemaUnrestricted") =>
396−genericDeclareNamedSchema :: forall a proxy. (Generic a, GToSchema (Rep a)) => SchemaOptions -> proxy a -> Declare (Definitions Schema) NamedSchema
679+ SchemaOptions -> Proxy a -> Declare (Definitions Schema) NamedSchema
397−genericDeclareNamedSchema opts _ = gdeclareNamedSchema opts (Proxy :: Proxy (Rep a)) mempty
680+genericDeclareNamedSchema = genericDeclareNamedSchemaUnrestricted
398
681
682+-- | A configurable generic @'Schema'@ creator.
683+--
684+-- Unlike 'genericDeclareSchema' also works for mixed sum types.
685+-- Use with care since some Swagger tools do not support well schemas for mixed sum types.
686+genericDeclareSchemaUnrestricted :: (Generic a, GToSchema (Rep a)) => SchemaOptions -> Proxy a -> Declare (Definitions Schema) Schema
687+genericDeclareSchemaUnrestricted opts proxy = _namedSchemaSchema <$> genericDeclareNamedSchemaUnrestricted opts proxy
688+
689+-- | A configurable generic @'NamedSchema'@ creator.
690+--
691+-- Unlike 'genericDeclareNamedSchema' also works for mixed sum types.
692+-- Use with care since some Swagger tools do not support well schemas for mixed sum types.
693+genericDeclareNamedSchemaUnrestricted :: forall a. (Generic a, GToSchema (Rep a)) =>
694+ SchemaOptions -> Proxy a -> Declare (Definitions Schema) NamedSchema
695+genericDeclareNamedSchemaUnrestricted opts _ = gdeclareNamedSchema opts (Proxy :: Proxy (Rep a)) mempty
696+
697+-- | Derive a 'Generic'-based name for a datatype and assign it to a given 'Schema'.
698+genericNameSchema :: forall a d f.
699+ (Generic a, Rep a ~ D1 d f, Datatype d)
700+ => SchemaOptions -> Proxy a -> Schema -> NamedSchema
701+genericNameSchema opts _ = NamedSchema (gdatatypeSchemaName opts (Proxy :: Proxy d))
702+
399−gdatatypeSchemaName :: forall proxy d. Datatype d => SchemaOptions -> proxy d -> Maybe T.Text
703+gdatatypeSchemaName :: forall d. Datatype d => SchemaOptions -> Proxy d -> Maybe T.Text
400−gdatatypeSchemaName opts _ = case name of
704+gdatatypeSchemaName opts _ = case orig of
401 (c:_) | isAlpha c && isUpper c -> Just (T.pack name)
705 (c:_) | isAlpha c && isUpper c -> Just (T.pack name)
402 _ -> Nothing
706 _ -> Nothing
403 where
707 where
404− name = datatypeNameModifier opts (datatypeName (Proxy3 :: Proxy3 d f a))
708+ orig = datatypeName (Proxy3 :: Proxy3 d f a)
709+ name = datatypeNameModifier opts orig
405
710
406-- | Lift a plain @'ParamSchema'@ into a model @'NamedSchema'@.
711-- | Lift a plain @'ParamSchema'@ into a model @'NamedSchema'@.
407−paramSchemaToNamedSchema :: forall a d f proxy.
408− (ToParamSchema a, Generic a, Rep a ~ D1 d f, Datatype d)
712+paramSchemaToNamedSchema :: (ToParamSchema a, Generic a, Rep a ~ D1 d f, Datatype d) =>
409− => SchemaOptions -> proxy a -> NamedSchema
713+ SchemaOptions -> Proxy a -> NamedSchema
410−paramSchemaToNamedSchema opts proxy = NamedSchema (gdatatypeSchemaName opts (Proxy :: Proxy d)) (paramSchemaToSchema proxy)
714+paramSchemaToNamedSchema opts proxy = genericNameSchema opts proxy (paramSchemaToSchema proxy)
411
715
412-- | Lift a plain @'ParamSchema'@ into a model @'Schema'@.
716-- | Lift a plain @'ParamSchema'@ into a model @'Schema'@.
413−paramSchemaToSchema :: forall a proxy. ToParamSchema a => proxy a -> Schema
717+paramSchemaToSchema :: ToParamSchema a => Proxy a -> Schema
414−paramSchemaToSchema _ = mempty & paramSchema .~ toParamSchema (Proxy :: Proxy a)
718+paramSchemaToSchema proxy = mempty & paramSchema .~ toParamSchema proxy
415
719
416nullarySchema :: Schema
720nullarySchema :: Schema
417nullarySchema = mempty
721nullarySchema = mempty
418− & type_ .~ SwaggerArray
722+ & type_ ?~ SwaggerArray
419 & items ?~ SwaggerItemsArray []
723 & items ?~ SwaggerItemsArray []
420
724
421−gtoNamedSchema :: GToSchema f => SchemaOptions -> proxy f -> NamedSchema
725+gtoNamedSchema :: GToSchema f => SchemaOptions -> Proxy f -> NamedSchema
422gtoNamedSchema opts proxy = undeclare $ gdeclareNamedSchema opts proxy mempty
726gtoNamedSchema opts proxy = undeclare $ gdeclareNamedSchema opts proxy mempty
423
727
424−gdeclareSchema :: GToSchema f => SchemaOptions -> proxy f -> Declare (Definitions Schema) Schema
728+gdeclareSchema :: GToSchema f => SchemaOptions -> Proxy f -> Declare (Definitions Schema) Schema
425gdeclareSchema opts proxy = _namedSchemaSchema <$> gdeclareNamedSchema opts proxy mempty
729gdeclareSchema opts proxy = _namedSchemaSchema <$> gdeclareNamedSchema opts proxy mempty
426
730
427instance (GToSchema f, GToSchema g) => GToSchema (f :*: g) where
731instance (GToSchema f, GToSchema g) => GToSchema (f :*: g) where
428 gdeclareNamedSchema opts _ schema = do
732 gdeclareNamedSchema opts _ schema = do
429− NamedSchema _ gschema <- gdeclareNamedSchema opts (Proxy :: Proxy g) schema
733+ NamedSchema _ gschema <- gdeclareNamedSchema opts (Proxy :: Proxy f) schema
430− gdeclareNamedSchema opts (Proxy :: Proxy f) gschema
734+ gdeclareNamedSchema opts (Proxy :: Proxy g) gschema
431
735
432instance (Datatype d, GToSchema f) => GToSchema (D1 d f) where
736instance (Datatype d, GToSchema f) => GToSchema (D1 d f) where
433 gdeclareNamedSchema opts _ s = rename name <$> gdeclareNamedSchema opts (Proxy :: Proxy f) s
737 gdeclareNamedSchema opts _ s = rename name <$> gdeclareNamedSchema opts (Proxy :: Proxy f) s
434 where
738 where
435 name = gdatatypeSchemaName opts (Proxy :: Proxy d)
739 name = gdatatypeSchemaName opts (Proxy :: Proxy d)
436
740
437−instance {-# OVERLAPPABLE #-} GToSchema f => GToSchema (C1 c f) where
741+instance OVERLAPPABLE_ GToSchema f => GToSchema (C1 c f) where
438 gdeclareNamedSchema opts _ = gdeclareNamedSchema opts (Proxy :: Proxy f)
742 gdeclareNamedSchema opts _ = gdeclareNamedSchema opts (Proxy :: Proxy f)
439
743
440−instance {-# OVERLAPPING #-} Constructor c => GToSchema (C1 c U1) where
744+instance OVERLAPPING_ Constructor c => GToSchema (C1 c U1) where
441 gdeclareNamedSchema = gdeclareNamedSumSchema
745 gdeclareNamedSchema = gdeclareNamedSumSchema
442
746
443-- | Single field constructor.
747-- | Single field constructor.
444−instance (Selector s, GToSchema f) => GToSchema (C1 c (S1 s f)) where
748+instance (Selector s, GToSchema f, GToSchema (S1 s f)) => GToSchema (C1 c (S1 s f)) where
445 gdeclareNamedSchema opts _ s
749 gdeclareNamedSchema opts _ s
446 | unwrapUnaryRecords opts = fieldSchema
750 | unwrapUnaryRecords opts = fieldSchema
447 | otherwise =
751 | otherwise =
@@ -455,7 +759,7 @@ instance (Selector s, GToSchema f) => GToSchema (C1 c (S1 s f)) where
455 recordSchema = gdeclareNamedSchema opts (Proxy :: Proxy (S1 s f)) s
759 recordSchema = gdeclareNamedSchema opts (Proxy :: Proxy (S1 s f)) s
456 fieldSchema = gdeclareNamedSchema opts (Proxy :: Proxy f) s
760 fieldSchema = gdeclareNamedSchema opts (Proxy :: Proxy f) s
457
761
458−gdeclareSchemaRef :: GToSchema a => SchemaOptions -> proxy a -> Declare (Definitions Schema) (Referenced Schema)
762+gdeclareSchemaRef :: GToSchema a => SchemaOptions -> Proxy a -> Declare (Definitions Schema) (Referenced Schema)
459gdeclareSchemaRef opts proxy = do
763gdeclareSchemaRef opts proxy = do
460 case gtoNamedSchema opts proxy of
764 case gtoNamedSchema opts proxy of
461 NamedSchema (Just name) schema -> do
765 NamedSchema (Just name) schema -> do
@@ -467,16 +771,16 @@ gdeclareSchemaRef opts proxy = do
467 -- have already declared it.
771 -- have already declared it.
468 -- If we have, we don't need to declare anything for
772 -- If we have, we don't need to declare anything for
469 -- this schema this time and thus simply return the reference.
773 -- this schema this time and thus simply return the reference.
470− known <- looks (HashMap.member name)
774+ known <- looks (InsOrdHashMap.member name)
471 when (not known) $ do
775 when (not known) $ do
472 declare [(name, schema)]
776 declare [(name, schema)]
473 void $ gdeclareNamedSchema opts proxy mempty
777 void $ gdeclareNamedSchema opts proxy mempty
474 return $ Ref (Reference name)
778 return $ Ref (Reference name)
475 _ -> Inline <$> gdeclareSchema opts proxy
779 _ -> Inline <$> gdeclareSchema opts proxy
476
780
477−appendItem :: Referenced Schema -> Maybe (SwaggerItems Schema) -> Maybe (SwaggerItems Schema)
781+appendItem :: Referenced Schema -> Maybe (SwaggerItems 'SwaggerKindSchema) -> Maybe (SwaggerItems 'SwaggerKindSchema)
478appendItem x Nothing = Just (SwaggerItemsArray [x])
782appendItem x Nothing = Just (SwaggerItemsArray [x])
479−appendItem x (Just (SwaggerItemsArray xs)) = Just (SwaggerItemsArray (x:xs))
783+appendItem x (Just (SwaggerItemsArray xs)) = Just (SwaggerItemsArray (xs ++ [x]))
480appendItem _ _ = error "GToSchema.appendItem: cannot append to SwaggerItemsObject"
784appendItem _ _ = error "GToSchema.appendItem: cannot append to SwaggerItemsObject"
481
785
482withFieldSchema :: forall proxy s f. (Selector s, GToSchema f) =>
786withFieldSchema :: forall proxy s f. (Selector s, GToSchema f) =>
@@ -486,35 +790,40 @@ withFieldSchema opts _ isRequiredField schema = do
486 return $
790 return $
487 if T.null fname
791 if T.null fname
488 then schema
792 then schema
489− & type_ .~ SwaggerArray
793+ & type_ ?~ SwaggerArray
490 & items %~ appendItem ref
794 & items %~ appendItem ref
795+ & maxItems %~ Just . maybe 1 (+1) -- increment maxItems
796+ & minItems %~ Just . maybe 1 (+1) -- increment minItems
491 else schema
797 else schema
492− & type_ .~ SwaggerObject
798+ & type_ ?~ SwaggerObject
493 & properties . at fname ?~ ref
799 & properties . at fname ?~ ref
494 & if isRequiredField
800 & if isRequiredField
495− then required %~ (fname :)
801+ then required %~ (++ [fname])
496 else id
802 else id
497 where
803 where
498 fname = T.pack (fieldLabelModifier opts (selName (Proxy3 :: Proxy3 s f p)))
804 fname = T.pack (fieldLabelModifier opts (selName (Proxy3 :: Proxy3 s f p)))
499
805
500-- | Optional record fields.
806-- | Optional record fields.
501−instance {-# OVERLAPPING #-} (Selector s, ToSchema c) => GToSchema (S1 s (K1 i (Maybe c))) where
807+instance OVERLAPPING_ (Selector s, ToSchema c) => GToSchema (S1 s (K1 i (Maybe c))) where
502 gdeclareNamedSchema opts _ = fmap unnamed . withFieldSchema opts (Proxy2 :: Proxy2 s (K1 i (Maybe c))) False
808 gdeclareNamedSchema opts _ = fmap unnamed . withFieldSchema opts (Proxy2 :: Proxy2 s (K1 i (Maybe c))) False
503
809
504-- | Record fields.
810-- | Record fields.
505−instance {-# OVERLAPPABLE #-} (Selector s, GToSchema f) => GToSchema (S1 s f) where
811+instance OVERLAPPABLE_ (Selector s, GToSchema f) => GToSchema (S1 s f) where
506 gdeclareNamedSchema opts _ = fmap unnamed . withFieldSchema opts (Proxy2 :: Proxy2 s f) True
812 gdeclareNamedSchema opts _ = fmap unnamed . withFieldSchema opts (Proxy2 :: Proxy2 s f) True
507
813
508−instance {-# OVERLAPPING #-} ToSchema c => GToSchema (K1 i (Maybe c)) where
814+instance OVERLAPPING_ ToSchema c => GToSchema (K1 i (Maybe c)) where
509 gdeclareNamedSchema _ _ _ = declareNamedSchema (Proxy :: Proxy c)
815 gdeclareNamedSchema _ _ _ = declareNamedSchema (Proxy :: Proxy c)
510
816
511−instance {-# OVERLAPPABLE #-} ToSchema c => GToSchema (K1 i c) where
817+instance OVERLAPPABLE_ ToSchema c => GToSchema (K1 i c) where
512 gdeclareNamedSchema _ _ _ = declareNamedSchema (Proxy :: Proxy c)
818 gdeclareNamedSchema _ _ _ = declareNamedSchema (Proxy :: Proxy c)
513
819
514−instance (GSumToSchema f, GSumToSchema g) => GToSchema (f :+: g) where
820+instance ( GSumToSchema f
821+ , GSumToSchema g
822+ ) => GToSchema (f :+: g)
823+ where
515 gdeclareNamedSchema = gdeclareNamedSumSchema
824 gdeclareNamedSchema = gdeclareNamedSumSchema
516
825
517−gdeclareNamedSumSchema :: GSumToSchema f => SchemaOptions -> proxy f -> Schema -> Declare (Definitions Schema) NamedSchema
826+gdeclareNamedSumSchema :: GSumToSchema f => SchemaOptions -> Proxy f -> Schema -> Declare (Definitions Schema) NamedSchema
518gdeclareNamedSumSchema opts proxy s
827gdeclareNamedSumSchema opts proxy s
519 | allNullaryToStringTag opts && allNullary = pure $ unnamed (toStringTag sumSchema)
828 | allNullaryToStringTag opts && allNullary = pure $ unnamed (toStringTag sumSchema)
520 | otherwise = (unnamed . fst) <$> runWriterT declareSumSchema
829 | otherwise = (unnamed . fst) <$> runWriterT declareSumSchema
@@ -523,34 +832,34 @@ gdeclareNamedSumSchema opts proxy s
523 (sumSchema, All allNullary) = undeclare (runWriterT declareSumSchema)
832 (sumSchema, All allNullary) = undeclare (runWriterT declareSumSchema)
524
833
525 toStringTag schema = mempty
834 toStringTag schema = mempty
526− & type_ .~ SwaggerString
835+ & type_ ?~ SwaggerString
527− & enum_ ?~ map toJSON (schema ^.. properties.ifolded.asIndex)
836+ & enum_ ?~ map toJSON (schema ^.. properties.ifolded.asIndex)
528
837
529type AllNullary = All
838type AllNullary = All
530
839
531−class GSumToSchema f where
840+class GSumToSchema (f :: * -> *) where
532− gsumToSchema :: SchemaOptions -> proxy f -> Schema -> WriterT AllNullary (Declare (Definitions Schema)) Schema
841+ gsumToSchema :: SchemaOptions -> Proxy f -> Schema -> WriterT AllNullary (Declare (Definitions Schema)) Schema
533
842
534instance (GSumToSchema f, GSumToSchema g) => GSumToSchema (f :+: g) where
843instance (GSumToSchema f, GSumToSchema g) => GSumToSchema (f :+: g) where
535− gsumToSchema opts _ = gsumToSchema opts (Proxy :: Proxy f) <=< gsumToSchema opts (Proxy :: Proxy g)
844+ gsumToSchema opts _ = gsumToSchema opts (Proxy :: Proxy f) >=> gsumToSchema opts (Proxy :: Proxy g)
536
845
537−gsumConToSchemaWith :: forall c f proxy. (GToSchema (C1 c f), Constructor c) =>
846+gsumConToSchemaWith :: forall c f. (GToSchema (C1 c f), Constructor c) =>
538− Referenced Schema -> SchemaOptions -> proxy (C1 c f) -> Schema -> Schema
847+ Referenced Schema -> SchemaOptions -> Proxy (C1 c f) -> Schema -> Schema
539gsumConToSchemaWith ref opts _ schema = schema
848gsumConToSchemaWith ref opts _ schema = schema
540− & type_ .~ SwaggerObject
849+ & type_ ?~ SwaggerObject
541 & properties . at tag ?~ ref
850 & properties . at tag ?~ ref
542 & maxProperties ?~ 1
851 & maxProperties ?~ 1
543 & minProperties ?~ 1
852 & minProperties ?~ 1
544 where
853 where
545 tag = T.pack (constructorTagModifier opts (conName (Proxy3 :: Proxy3 c f p)))
854 tag = T.pack (constructorTagModifier opts (conName (Proxy3 :: Proxy3 c f p)))
546
855
547−gsumConToSchema :: forall c f proxy. (GToSchema (C1 c f), Constructor c) =>
856+gsumConToSchema :: (GToSchema (C1 c f), Constructor c) =>
548− SchemaOptions -> proxy (C1 c f) -> Schema -> Declare (Definitions Schema) Schema
857+ SchemaOptions -> Proxy (C1 c f) -> Schema -> Declare (Definitions Schema) Schema
549gsumConToSchema opts proxy schema = do
858gsumConToSchema opts proxy schema = do
550 ref <- gdeclareSchemaRef opts proxy
859 ref <- gdeclareSchemaRef opts proxy
551 return $ gsumConToSchemaWith ref opts proxy schema
860 return $ gsumConToSchemaWith ref opts proxy schema
552
861
553−instance {-# OVERLAPPABLE #-} (Constructor c, GToSchema f) => GSumToSchema (C1 c f) where
862+instance OVERLAPPABLE_ (Constructor c, GToSchema f) => GSumToSchema (C1 c f) where
554 gsumToSchema opts proxy schema = do
863 gsumToSchema opts proxy schema = do
555 tell (All False)
864 tell (All False)
556 lift $ gsumConToSchema opts proxy schema
865 lift $ gsumConToSchema opts proxy schema
@@ -567,3 +876,7 @@ data Proxy2 a b = Proxy2
567
876
568data Proxy3 a b c = Proxy3
877data Proxy3 a b c = Proxy3
569
878
879+-- $setup
880+-- >>> import Data.Swagger
881+-- >>> import Data.Aeson (encode)
882+-- >>> import Data.Aeson.Types (toJSONKeyText)
src/Data/Swagger/Internal/Schema/Validation.hsnew file+511
@@ -0,0 +1,511 @@
1+{-# OPTIONS_GHC -Wall #-}
2+{-# LANGUAGE DataKinds #-}
3+{-# LANGUAGE DeriveFunctor #-}
4+{-# LANGUAGE FlexibleInstances #-}
5+{-# LANGUAGE FunctionalDependencies #-}
6+{-# LANGUAGE GADTs #-}
7+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
8+{-# LANGUAGE LambdaCase #-}
9+{-# LANGUAGE MultiParamTypeClasses #-}
10+{-# LANGUAGE PackageImports #-}
11+{-# LANGUAGE RankNTypes #-}
12+{-# LANGUAGE ScopedTypeVariables #-}
13+{-# LANGUAGE TemplateHaskell #-}
14+{-# LANGUAGE UndecidableInstances #-}
15+-- |
16+-- Module: Data.Swagger.Internal.Schema.Validation
17+-- Copyright: (c) 2015 GetShopTV
18+-- License: BSD3
19+-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
20+-- Stability: experimental
21+--
22+-- Validate JSON values with Swagger Schema.
23+module Data.Swagger.Internal.Schema.Validation where
24+
25+import Prelude ()
26+import Prelude.Compat
27+
28+import Control.Applicative
29+import Control.Lens
30+import Control.Monad (when)
31+
32+import Data.Aeson hiding (Result)
33+import Data.Aeson.Encode.Pretty (encodePretty)
34+import Data.Foldable (for_, sequenceA_,
35+ traverse_)
36+import Data.HashMap.Strict (HashMap)
37+import qualified Data.HashMap.Strict as HashMap
38+import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
39+import qualified "unordered-containers" Data.HashSet as HashSet
40+import Data.Proxy
41+import Data.Scientific (Scientific, isInteger)
42+import Data.Text (Text)
43+import qualified Data.Text as Text
44+import qualified Data.Text.Lazy as TL
45+import qualified Data.Text.Lazy.Encoding as TL
46+import Data.Vector (Vector)
47+import qualified Data.Vector as Vector
48+
49+import Data.Swagger.Declare
50+import Data.Swagger.Internal
51+import Data.Swagger.Internal.Schema
52+import Data.Swagger.Lens
53+
54+-- | Validate @'ToJSON'@ instance matches @'ToSchema'@ for a given value.
55+-- This can be used with QuickCheck to ensure those instances are coherent:
56+--
57+-- prop> validateToJSON (x :: Int) == []
58+--
59+-- /NOTE:/ @'validateToJSON'@ does not perform string pattern validation.
60+-- See @'validateToJSONWithPatternChecker'@.
61+--
62+-- See 'renderValidationErrors' on how the output is structured.
63+validatePrettyToJSON :: forall a. (ToJSON a, ToSchema a) => a -> Maybe String
64+validatePrettyToJSON = renderValidationErrors validateToJSON
65+
66+-- | Variant of 'validatePrettyToJSON' with typed output.
67+validateToJSON :: forall a. (ToJSON a, ToSchema a) => a -> [ValidationError]
68+validateToJSON = validateToJSONWithPatternChecker (\_pattern _str -> True)
69+
70+-- | Validate @'ToJSON'@ instance matches @'ToSchema'@ for a given value and pattern checker.
71+-- This can be used with QuickCheck to ensure those instances are coherent.
72+--
73+-- For validation without patterns see @'validateToJSON'@. See also:
74+-- 'renderValidationErrors'.
75+validateToJSONWithPatternChecker :: forall a. (ToJSON a, ToSchema a) => (Pattern -> Text -> Bool) -> a -> [ValidationError]
76+validateToJSONWithPatternChecker checker = validateJSONWithPatternChecker checker defs sch . toJSON
77+ where
78+ (defs, sch) = runDeclare (declareSchema (Proxy :: Proxy a)) mempty
79+
80+-- | Pretty print validation errors
81+-- together with actual JSON and Swagger Schema
82+-- (using 'encodePretty').
83+--
84+-- >>> import Data.Aeson as Aeson
85+-- >>> import Data.Foldable (traverse_)
86+-- >>> import GHC.Generics
87+-- >>> data Phone = Phone { value :: String } deriving (Generic)
88+-- >>> data Person = Person { name :: String, phone :: Phone } deriving (Generic)
89+-- >>> instance ToJSON Person where toJSON p = object [ "name" Aeson..= name p ]
90+-- >>> instance ToSchema Phone
91+-- >>> instance ToSchema Person
92+-- >>> let person = Person { name = "John", phone = Phone "123456" }
93+-- >>> traverse_ putStrLn $ renderValidationErrors validateToJSON person
94+-- Validation against the schema fails:
95+-- * property "phone" is required, but not found in "{\"name\":\"John\"}"
96+-- <BLANKLINE>
97+-- JSON value:
98+-- {
99+-- "name": "John"
100+-- }
101+-- <BLANKLINE>
102+-- Swagger Schema:
103+-- {
104+-- "required": [
105+-- "name",
106+-- "phone"
107+-- ],
108+-- "type": "object",
109+-- "properties": {
110+-- "phone": {
111+-- "$ref": "#/definitions/Phone"
112+-- },
113+-- "name": {
114+-- "type": "string"
115+-- }
116+-- }
117+-- }
118+-- <BLANKLINE>
119+-- Swagger Description Context:
120+-- {
121+-- "Phone": {
122+-- "required": [
123+-- "value"
124+-- ],
125+-- "type": "object",
126+-- "properties": {
127+-- "value": {
128+-- "type": "string"
129+-- }
130+-- }
131+-- }
132+-- }
133+-- <BLANKLINE>
134+renderValidationErrors
135+ :: forall a. (ToJSON a, ToSchema a)
136+ => (a -> [ValidationError]) -> a -> Maybe String
137+renderValidationErrors f x =
138+ case f x of
139+ [] -> Nothing
140+ errors -> Just $ unlines
141+ [ "Validation against the schema fails:"
142+ , unlines (map (" * " ++) errors)
143+ , "JSON value:"
144+ , ppJSONString (toJSON x)
145+ , ""
146+ , "Swagger Schema:"
147+ , ppJSONString (toJSON schema_)
148+ , ""
149+ , "Swagger Description Context:"
150+ , ppJSONString (toJSON refs_)
151+ ]
152+ where
153+ ppJSONString = TL.unpack . TL.decodeUtf8 . encodePretty
154+ (refs_, schema_) = runDeclare (declareSchema (Proxy :: Proxy a)) mempty
155+
156+-- | Validate JSON @'Value'@ against Swagger @'Schema'@.
157+--
158+-- prop> validateJSON mempty (toSchema (Proxy :: Proxy Int)) (toJSON (x :: Int)) == []
159+--
160+-- /NOTE:/ @'validateJSON'@ does not perform string pattern validation.
161+-- See @'validateJSONWithPatternChecker'@.
162+validateJSON :: Definitions Schema -> Schema -> Value -> [ValidationError]
163+validateJSON = validateJSONWithPatternChecker (\_pattern _str -> True)
164+
165+-- | Validate JSON @'Value'@ agains Swagger @'ToSchema'@ for a given value and pattern checker.
166+--
167+-- For validation without patterns see @'validateJSON'@.
168+validateJSONWithPatternChecker :: (Pattern -> Text -> Bool) -> Definitions Schema -> Schema -> Value -> [ValidationError]
169+validateJSONWithPatternChecker checker defs sch js =
170+ case runValidation (validateWithSchema js) cfg sch of
171+ Failed xs -> xs
172+ Passed _ -> mempty
173+ where
174+ cfg = defaultConfig
175+ { configPatternChecker = checker
176+ , configDefinitions = defs }
177+
178+-- | Validation error message.
179+type ValidationError = String
180+
181+-- | Validation result type.
182+data Result a
183+ = Failed [ValidationError] -- ^ Validation failed with a list of error messages.
184+ | Passed a -- ^ Validation passed.
185+ deriving (Eq, Show, Functor)
186+
187+instance Applicative Result where
188+ pure = Passed
189+ Passed f <*> Passed x = Passed (f x)
190+ Failed xs <*> Failed ys = Failed (xs <> ys)
191+ Failed xs <*> _ = Failed xs
192+ _ <*> Failed ys = Failed ys
193+
194+instance Alternative Result where
195+ empty = Failed mempty
196+ Passed x <|> _ = Passed x
197+ _ <|> y = y
198+
199+instance Monad Result where
200+ return = pure
201+ Passed x >>= f = f x
202+ Failed xs >>= _ = Failed xs
203+
204+-- | Validation configuration.
205+data Config = Config
206+ { -- | Pattern checker for @'_paramSchemaPattern'@ validation.
207+ configPatternChecker :: Pattern -> Text -> Bool
208+ -- | Schema definitions in scope to resolve references.
209+ , configDefinitions :: Definitions Schema
210+ }
211+
212+-- | Default @'Config'@:
213+--
214+-- @
215+-- defaultConfig = 'Config'
216+-- { 'configPatternChecker' = \\_pattern _str -> True
217+-- , 'configDefinitions' = mempty
218+-- }
219+-- @
220+defaultConfig :: Config
221+defaultConfig = Config
222+ { configPatternChecker = \_pattern _str -> True
223+ , configDefinitions = mempty
224+ }
225+
226+-- | Value validation.
227+newtype Validation s a = Validation { runValidation :: Config -> s -> Result a }
228+ deriving (Functor)
229+
230+instance Applicative (Validation schema) where
231+ pure x = Validation (\_ _ -> pure x)
232+ Validation f <*> Validation x = Validation (\c s -> f c s <*> x c s)
233+
234+instance Alternative (Validation schema) where
235+ empty = Validation (\_ _ -> empty)
236+ Validation x <|> Validation y = Validation (\c s -> x c s <|> y c s)
237+
238+instance Profunctor Validation where
239+ dimap f g (Validation k) = Validation (\c s -> fmap g (k c (f s)))
240+
241+instance Choice Validation where
242+ left' (Validation g) = Validation (\c -> either (fmap Left . g c) (pure . Right))
243+ right' (Validation g) = Validation (\c -> either (pure . Left) (fmap Right . g c))
244+
245+instance Monad (Validation s) where
246+ return = pure
247+ Validation x >>= f = Validation (\c s -> x c s >>= \y -> runValidation (f y) c s)
248+ (>>) = (*>)
249+
250+withConfig :: (Config -> Validation s a) -> Validation s a
251+withConfig f = Validation (\c -> runValidation (f c) c)
252+
253+withSchema :: (s -> Validation s a) -> Validation s a
254+withSchema f = Validation (\c s -> runValidation (f s) c s)
255+
256+-- | Issue an error message.
257+invalid :: String -> Validation schema a
258+invalid msg = Validation (\_ _ -> Failed [msg])
259+
260+-- | Validation passed.
261+valid :: Validation schema ()
262+valid = pure ()
263+
264+-- | Validate schema's property given a lens into that property
265+-- and property checker.
266+checkMissing :: Validation s () -> Lens' s (Maybe a) -> (a -> Validation s ()) -> Validation s ()
267+checkMissing missing l g = withSchema $ \sch ->
268+ case sch ^. l of
269+ Nothing -> missing
270+ Just x -> g x
271+
272+-- | Validate schema's property given a lens into that property
273+-- and property checker.
274+-- If property is missing in schema, consider it valid.
275+check :: Lens' s (Maybe a) -> (a -> Validation s ()) -> Validation s ()
276+check = checkMissing valid
277+
278+-- | Validate same value with different schema.
279+sub :: t -> Validation t a -> Validation s a
280+sub = lmap . const
281+
282+-- | Validate same value with a part of the original schema.
283+sub_ :: Getting a s a -> Validation a r -> Validation s r
284+sub_ = lmap . view
285+
286+-- | Validate value against a schema given schema reference and validation function.
287+withRef :: Reference -> (Schema -> Validation s a) -> Validation s a
288+withRef (Reference ref) f = withConfig $ \cfg ->
289+ case InsOrdHashMap.lookup ref (configDefinitions cfg) of
290+ Nothing -> invalid $ "unknown schema " ++ show ref
291+ Just s -> f s
292+
293+validateWithSchemaRef :: Referenced Schema -> Value -> Validation s ()
294+validateWithSchemaRef (Ref ref) js = withRef ref $ \sch -> sub sch (validateWithSchema js)
295+validateWithSchemaRef (Inline s) js = sub s (validateWithSchema js)
296+
297+-- | Validate JSON @'Value'@ with Swagger @'Schema'@.
298+validateWithSchema :: Value -> Validation Schema ()
299+validateWithSchema value = do
300+ validateSchemaType value
301+ sub_ paramSchema $ validateEnum value
302+
303+-- | Validate JSON @'Value'@ with Swagger @'ParamSchema'@.
304+validateWithParamSchema :: Value -> Validation (ParamSchema t) ()
305+validateWithParamSchema value = do
306+ validateParamSchemaType value
307+ validateEnum value
308+
309+validateInteger :: Scientific -> Validation (ParamSchema t) ()
310+validateInteger n = do
311+ when (not (isInteger n)) $
312+ invalid ("not an integer")
313+ validateNumber n
314+
315+validateNumber :: Scientific -> Validation (ParamSchema t) ()
316+validateNumber n = withConfig $ \_cfg -> withSchema $ \sch -> do
317+ let exMax = Just True == sch ^. exclusiveMaximum
318+ exMin = Just True == sch ^. exclusiveMinimum
319+
320+ check maximum_ $ \m ->
321+ when (if exMax then (n >= m) else (n > m)) $
322+ invalid ("value " ++ show n ++ " exceeds maximum (should be " ++ if exMax then "<" else "<=" ++ show m ++ ")")
323+
324+ check minimum_ $ \m ->
325+ when (if exMin then (n <= m) else (n < m)) $
326+ invalid ("value " ++ show n ++ " falls below minimum (should be " ++ if exMin then ">" else ">=" ++ show m ++ ")")
327+
328+ check multipleOf $ \k ->
329+ when (not (isInteger (n / k))) $
330+ invalid ("expected a multiple of " ++ show k ++ " but got " ++ show n)
331+
332+validateString :: Text -> Validation (ParamSchema t) ()
333+validateString s = do
334+ check maxLength $ \n ->
335+ when (len > fromInteger n) $
336+ invalid ("string is too long (length should be <=" ++ show n ++ ")")
337+
338+ check minLength $ \n ->
339+ when (len < fromInteger n) $
340+ invalid ("string is too short (length should be >=" ++ show n ++ ")")
341+
342+ check pattern $ \regex -> do
343+ withConfig $ \cfg -> do
344+ when (not (configPatternChecker cfg regex s)) $
345+ invalid ("string does not match pattern " ++ show regex)
346+ where
347+ len = Text.length s
348+
349+validateArray :: Vector Value -> Validation (ParamSchema t) ()
350+validateArray xs = do
351+ check maxItems $ \n ->
352+ when (len > fromInteger n) $
353+ invalid ("array exceeds maximum size (should be <=" ++ show n ++ ")")
354+
355+ check minItems $ \n ->
356+ when (len < fromInteger n) $
357+ invalid ("array is too short (size should be >=" ++ show n ++ ")")
358+
359+ check items $ \case
360+ SwaggerItemsPrimitive _ itemSchema -> sub itemSchema $ traverse_ validateWithParamSchema xs
361+ SwaggerItemsObject itemSchema -> traverse_ (validateWithSchemaRef itemSchema) xs
362+ SwaggerItemsArray itemSchemas -> do
363+ when (len /= length itemSchemas) $
364+ invalid ("array size is invalid (should be exactly " ++ show (length itemSchemas) ++ ")")
365+ sequenceA_ (zipWith validateWithSchemaRef itemSchemas (Vector.toList xs))
366+
367+ check uniqueItems $ \unique ->
368+ when (unique && not allUnique) $
369+ invalid ("array is expected to contain unique items, but it does not")
370+ where
371+ len = Vector.length xs
372+ allUnique = len == HashSet.size (HashSet.fromList (Vector.toList xs))
373+
374+validateObject :: HashMap Text Value -> Validation Schema ()
375+validateObject o = withSchema $ \sch ->
376+ case sch ^. discriminator of
377+ Just pname -> case fromJSON <$> HashMap.lookup pname o of
378+ Just (Success ref) -> validateWithSchemaRef ref (Object o)
379+ Just (Error msg) -> invalid ("failed to parse discriminator property " ++ show pname ++ ": " ++ show msg)
380+ Nothing -> invalid ("discriminator property " ++ show pname ++ "is missing")
381+ Nothing -> do
382+ check maxProperties $ \n ->
383+ when (size > n) $
384+ invalid ("object size exceeds maximum (total number of properties should be <=" ++ show n ++ ")")
385+
386+ check minProperties $ \n ->
387+ when (size < n) $
388+ invalid ("object size is too small (total number of properties should be >=" ++ show n ++ ")")
389+
390+ validateRequired
391+ validateProps
392+ where
393+ size = fromIntegral (HashMap.size o)
394+
395+ validateRequired = withSchema $ \sch -> traverse_ validateReq (sch ^. required)
396+ validateReq n =
397+ when (not (HashMap.member n o)) $
398+ invalid ("property " ++ show n ++ " is required, but not found in " ++ show (encode o))
399+
400+ validateProps = withSchema $ \sch -> do
401+ for_ (HashMap.toList o) $ \(k, v) ->
402+ case v of
403+ Null | not (k `elem` (sch ^. required)) -> valid -- null is fine for non-required property
404+ _ ->
405+ case InsOrdHashMap.lookup k (sch ^. properties) of
406+ Nothing -> checkMissing (unknownProperty k) additionalProperties $ validateAdditional k v
407+ Just s -> validateWithSchemaRef s v
408+
409+ validateAdditional _ _ (AdditionalPropertiesAllowed True) = valid
410+ validateAdditional k _ (AdditionalPropertiesAllowed False) = invalid $ "additionalProperties=false but extra property " <> show k <> " found"
411+ validateAdditional _ v (AdditionalPropertiesSchema s) = validateWithSchemaRef s v
412+
413+ unknownProperty :: Text -> Validation s a
414+ unknownProperty pname = invalid $
415+ "property " <> show pname <> " is found in JSON value, but it is not mentioned in Swagger schema"
416+
417+validateEnum :: Value -> Validation (ParamSchema t) ()
418+validateEnum value = do
419+ check enum_ $ \xs ->
420+ when (value `notElem` xs) $
421+ invalid ("expected one of " ++ show (encode xs) ++ " but got " ++ show value)
422+
423+-- | Infer schema type based on used properties.
424+--
425+-- This is like 'inferParamSchemaTypes', but also works for objects:
426+--
427+-- >>> inferSchemaTypes <$> decode "{\"minProperties\": 1}"
428+-- Just [SwaggerObject]
429+inferSchemaTypes :: Schema -> [SwaggerType 'SwaggerKindSchema]
430+inferSchemaTypes sch = inferParamSchemaTypes (sch ^. paramSchema) ++
431+ [ SwaggerObject | any ($ sch)
432+ [ has (additionalProperties._Just)
433+ , has (maxProperties._Just)
434+ , has (minProperties._Just)
435+ , has (properties.folded)
436+ , has (required.folded) ] ]
437+
438+-- | Infer schema type based on used properties.
439+--
440+-- >>> inferSchemaTypes <$> decode "{\"minLength\": 2}"
441+-- Just [SwaggerString]
442+--
443+-- >>> inferSchemaTypes <$> decode "{\"maxItems\": 0}"
444+-- Just [SwaggerArray]
445+--
446+-- From numeric properties 'SwaggerInteger' type is inferred.
447+-- If you want 'SwaggerNumber' instead, you must specify it explicitly.
448+--
449+-- >>> inferSchemaTypes <$> decode "{\"minimum\": 1}"
450+-- Just [SwaggerInteger]
451+inferParamSchemaTypes :: ParamSchema t -> [SwaggerType t]
452+inferParamSchemaTypes sch = concat
453+ [ [ SwaggerArray | any ($ sch)
454+ [ has (items._Just)
455+ , has (maxItems._Just)
456+ , has (minItems._Just)
457+ , has (uniqueItems._Just) ] ]
458+ , [ SwaggerInteger | any ($ sch)
459+ [ has (exclusiveMaximum._Just)
460+ , has (exclusiveMinimum._Just)
461+ , has (maximum_._Just)
462+ , has (minimum_._Just)
463+ , has (multipleOf._Just) ] ]
464+ , [ SwaggerString | any ($ sch)
465+ [ has (maxLength._Just)
466+ , has (minLength._Just)
467+ , has (pattern._Just) ] ]
468+ ]
469+
470+validateSchemaType :: Value -> Validation Schema ()
471+validateSchemaType value = withSchema $ \sch ->
472+ case (sch ^. type_, value) of
473+ (Just SwaggerNull, Null) -> valid
474+ (Just SwaggerBoolean, Bool _) -> valid
475+ (Just SwaggerInteger, Number n) -> sub_ paramSchema (validateInteger n)
476+ (Just SwaggerNumber, Number n) -> sub_ paramSchema (validateNumber n)
477+ (Just SwaggerString, String s) -> sub_ paramSchema (validateString s)
478+ (Just SwaggerArray, Array xs) -> sub_ paramSchema (validateArray xs)
479+ (Just SwaggerObject, Object o) -> validateObject o
480+ (Nothing, Null) -> valid
481+ (Nothing, Bool _) -> valid
482+ -- Number by default
483+ (Nothing, Number n) -> sub_ paramSchema (validateNumber n)
484+ (Nothing, String s) -> sub_ paramSchema (validateString s)
485+ (Nothing, Array xs) -> sub_ paramSchema (validateArray xs)
486+ (Nothing, Object o) -> validateObject o
487+ bad -> invalid $ "expected JSON value of type " ++ showType bad
488+
489+validateParamSchemaType :: Value -> Validation (ParamSchema t) ()
490+validateParamSchemaType value = withSchema $ \sch ->
491+ case (sch ^. type_, value) of
492+ (Just SwaggerBoolean, Bool _) -> valid
493+ (Just SwaggerInteger, Number n) -> validateInteger n
494+ (Just SwaggerNumber, Number n) -> validateNumber n
495+ (Just SwaggerString, String s) -> validateString s
496+ (Just SwaggerArray, Array xs) -> validateArray xs
497+ (Nothing, Bool _) -> valid
498+ -- Number by default
499+ (Nothing, Number n) -> validateNumber n
500+ (Nothing, String s) -> validateString s
501+ (Nothing, Array xs) -> validateArray xs
502+ bad -> invalid $ "expected JSON value of type " ++ showType bad
503+
504+showType :: (Maybe (SwaggerType t), Value) -> String
505+showType (Just type_, _) = show type_
506+showType (Nothing, Null) = "SwaggerNull"
507+showType (Nothing, Bool _) = "SwaggerBoolean"
508+showType (Nothing, Number _) = "SwaggerNumber"
509+showType (Nothing, String _) = "SwaggerString"
510+showType (Nothing, Array _) = "SwaggerArray"
511+showType (Nothing, Object _) = "SwaggerObject"
src/Data/Swagger/Internal/TypeShape.hsnew file+66
@@ -0,0 +1,66 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE ConstraintKinds #-}
3+{-# LANGUAGE DataKinds #-}
4+{-# LANGUAGE KindSignatures #-}
5+{-# LANGUAGE TypeFamilies #-}
6+{-# LANGUAGE TypeOperators #-}
7+{-# LANGUAGE UndecidableInstances #-}
8+
9+module Data.Swagger.Internal.TypeShape where
10+
11+import Data.Proxy
12+import GHC.Generics
13+import GHC.TypeLits
14+import GHC.Exts (Constraint)
15+
16+-- | Shape of a datatype.
17+data TypeShape
18+ = Enumeration -- ^ A simple enumeration.
19+ | SumOfProducts -- ^ A product or a sum of non-unit products.
20+ | Mixed -- ^ Mixed sum type with both unit and non-unit constructors.
21+
22+-- | A combined shape for a product type.
23+type family ProdCombine (a :: TypeShape) (b :: TypeShape) :: TypeShape where
24+ ProdCombine Mixed b = Mixed -- technically this cannot happen since Haskell types are sums of products
25+ ProdCombine a Mixed = Mixed -- technically this cannot happen since Haskell types are sums of products
26+ ProdCombine a b = SumOfProducts
27+
28+-- | A combined shape for a sum type.
29+type family SumCombine (a :: TypeShape) (b :: TypeShape) :: TypeShape where
30+ SumCombine Enumeration Enumeration = Enumeration
31+ SumCombine SumOfProducts SumOfProducts = SumOfProducts
32+ SumCombine a b = Mixed
33+
34+type family TypeHasSimpleShape t (f :: Symbol) :: Constraint where
35+ TypeHasSimpleShape t f = GenericHasSimpleShape t f (GenericShape (Rep t))
36+
37+type family GenericHasSimpleShape t (f :: Symbol) (s :: TypeShape) :: Constraint where
38+ GenericHasSimpleShape t f Enumeration = ()
39+ GenericHasSimpleShape t f SumOfProducts = ()
40+#if __GLASGOW_HASKELL__ < 800
41+ GenericHasSimpleShape t f Mixed = CannotDeriveSchemaForMixedSumType t
42+
43+class CannotDeriveSchemaForMixedSumType t where
44+#else
45+ GenericHasSimpleShape t f Mixed =
46+ TypeError
47+ ( Text "Cannot derive Generic-based Swagger Schema for " :<>: ShowType t
48+ :$$: ShowType t :<>: Text " is a mixed sum type (has both unit and non-unit constructors)."
49+ :$$: Text "Swagger does not have a good representation for these types."
50+ :$$: Text "Use " :<>: Text f :<>: Text " if you want to derive schema"
51+ :$$: Text "that matches aeson's Generic-based toJSON,"
52+ :$$: Text "but that's not supported by some Swagger tools."
53+ )
54+#endif
55+
56+-- | Infer a 'TypeShape' for a generic representation of a type.
57+type family GenericShape (g :: * -> *) :: TypeShape
58+
59+type instance GenericShape (f :*: g) = ProdCombine (GenericShape f) (GenericShape g)
60+type instance GenericShape (f :+: g) = SumCombine (GenericShape f) (GenericShape g)
61+type instance GenericShape (D1 d f) = GenericShape f
62+type instance GenericShape (C1 c U1) = Enumeration
63+type instance GenericShape (C1 c (S1 s f)) = SumOfProducts
64+type instance GenericShape (C1 c (f :*: g)) = SumOfProducts
65+
66+
src/Data/Swagger/Internal/Utils.hs+13−47
@@ -6,8 +6,9 @@
6{-# LANGUAGE TypeOperators #-}
6{-# LANGUAGE TypeOperators #-}
7module Data.Swagger.Internal.Utils where
7module Data.Swagger.Internal.Utils where
8
8
9−import Control.Arrow (first)
9+import Prelude ()
10−import Control.Applicative
10+import Prelude.Compat
11+
11import Control.Lens ((&), (%~))
12import Control.Lens ((&), (%~))
12import Control.Lens.TH
13import Control.Lens.TH
13import Data.Aeson
14import Data.Aeson
@@ -17,12 +18,13 @@ import Data.Data
17import Data.Hashable (Hashable)
18import Data.Hashable (Hashable)
18import Data.HashMap.Strict (HashMap)
19import Data.HashMap.Strict (HashMap)
19import qualified Data.HashMap.Strict as HashMap
20import qualified Data.HashMap.Strict as HashMap
21+import Data.HashMap.Strict.InsOrd (InsOrdHashMap)
22+import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
20import Data.Map (Map)
23import Data.Map (Map)
21−import Data.Monoid
24+import Data.Set (Set)
22import Data.Text (Text)
25import Data.Text (Text)
23import GHC.Generics
26import GHC.Generics
24import Language.Haskell.TH (mkName)
27import Language.Haskell.TH (mkName)
25−import Text.Read (readMaybe)
26
28
27swaggerFieldRules :: LensRules
29swaggerFieldRules :: LensRules
28swaggerFieldRules = defaultFieldRules & lensField %~ swaggerFieldNamer
30swaggerFieldRules = defaultFieldRules & lensField %~ swaggerFieldNamer
@@ -41,6 +43,7 @@ swaggerFieldRules = defaultFieldRules & lensField %~ swaggerFieldNamer
41 fixName' "minimum" = "minimum_" -- Prelude conflict
43 fixName' "minimum" = "minimum_" -- Prelude conflict
42 fixName' "maximum" = "maximum_" -- Prelude conflict
44 fixName' "maximum" = "maximum_" -- Prelude conflict
43 fixName' "enum" = "enum_" -- Control.Lens conflict
45 fixName' "enum" = "enum_" -- Control.Lens conflict
46+ fixName' "head" = "head_" -- Prelude conflict
44 fixName' n = n
47 fixName' n = n
45
48
46gunfoldEnum :: String -> [a] -> (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c a
49gunfoldEnum :: String -> [a] -> (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c a
@@ -48,17 +51,6 @@ gunfoldEnum tname xs _k z c = case lookup (constrIndex c) (zip [1..] xs) of
48 Just x -> z x
51 Just x -> z x
49 Nothing -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type " ++ tname ++ "."
52 Nothing -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type " ++ tname ++ "."
50
53
51−hashMapMapKeys :: (Eq k', Hashable k') => (k -> k') -> HashMap k v -> HashMap k' v
52−hashMapMapKeys f = HashMap.fromList . map (first f) . HashMap.toList
53−
54−hashMapTraverseKeys :: (Eq k', Hashable k', Applicative f) => (k -> f k') -> HashMap k v -> f (HashMap k' v)
55−hashMapTraverseKeys f = fmap HashMap.fromList . traverse g . HashMap.toList
56− where
57− g (x, y) = (\a -> (a, y)) <$> f x
58−
59−hashMapReadKeys :: (Eq k, Read k, Hashable k, Alternative f) => HashMap String v -> f (HashMap k v)
60−hashMapReadKeys = hashMapTraverseKeys (maybe empty pure . readMaybe)
61−
62jsonPrefix :: String -> Options
54jsonPrefix :: String -> Options
63jsonPrefix prefix = defaultOptions
55jsonPrefix prefix = defaultOptions
64 { fieldLabelModifier = modifier . drop 1
56 { fieldLabelModifier = modifier . drop 1
@@ -80,40 +72,10 @@ parseOneOf xs js =
80 where
72 where
81 ys = zip (map toJSON xs) xs
73 ys = zip (map toJSON xs) xs
82
74
83−omitEmptiesExcept :: (Text -> Value -> Bool) -> Value -> Value
84−omitEmptiesExcept f (Object o) = Object (HashMap.filterWithKey nonEmpty o)
85− where
86− nonEmpty k js = f k js || (js /= Object mempty) && (js /= Array mempty) && (js /= Null)
87−omitEmptiesExcept _ js = js
88−
89−omitEmpties :: Value -> Value
90−omitEmpties = omitEmptiesExcept (\_ _ -> False)
91−
92−genericToJSONWithSub :: (Generic a, GToJSON (Rep a)) => Text -> Options -> a -> Value
93−genericToJSONWithSub sub opts x =
94− case genericToJSON opts x of
95− Object o ->
96− case HashMap.lookup sub o of
97− Just so -> Object (HashMap.delete sub o) <+> so
98− Nothing -> Object o -- no subjson, leaving object as is
99− _ -> error "genericToJSONWithSub: subjson is not an object"
100−
101−genericParseJSONWithSub :: (Generic a, GFromJSON (Rep a)) => Text -> Options -> Value -> Parser a
102−genericParseJSONWithSub sub opts js@(Object o)
103− = genericParseJSON opts js -- try without subjson
104− <|> genericParseJSON opts js' -- try with subjson
105− where
106− js' = Object (HashMap.insert sub (Object o) o)
107−genericParseJSONWithSub _ _ _ = error "genericParseJSONWithSub: given json is not an object"
108−
109(<+>) :: Value -> Value -> Value
75(<+>) :: Value -> Value -> Value
110Object x <+> Object y = Object (x <> y)
76Object x <+> Object y = Object (x <> y)
111_ <+> _ = error "<+>: merging non-objects"
77_ <+> _ = error "<+>: merging non-objects"
112
78
113−withDefaults :: (Value -> Parser a) -> [Pair] -> Value -> Parser a
114−withDefaults parser defs js@(Object _) = parser (js <+> object defs)
115−withDefaults _ _ _ = empty
116−
117genericMempty :: (Generic a, GMonoid (Rep a)) => a
79genericMempty :: (Generic a, GMonoid (Rep a)) => a
118genericMempty = to gmempty
80genericMempty = to gmempty
119
81
@@ -149,12 +111,17 @@ class SwaggerMonoid m where
149 swaggerMappend = mappend
111 swaggerMappend = mappend
150
112
151instance SwaggerMonoid [a]
113instance SwaggerMonoid [a]
114+instance Ord a => SwaggerMonoid (Set a)
152instance Ord k => SwaggerMonoid (Map k v)
115instance Ord k => SwaggerMonoid (Map k v)
153
116
154−instance {-# OVERLAPPABLE #-} (Eq k, Hashable k) => SwaggerMonoid (HashMap k v) where
117+instance (Eq k, Hashable k) => SwaggerMonoid (HashMap k v) where
155 swaggerMempty = mempty
118 swaggerMempty = mempty
156 swaggerMappend = HashMap.unionWith (\_old new -> new)
119 swaggerMappend = HashMap.unionWith (\_old new -> new)
157
120
121+instance (Eq k, Hashable k) => SwaggerMonoid (InsOrdHashMap k v) where
122+ swaggerMempty = mempty
123+ swaggerMappend = InsOrdHashMap.unionWith (\_old new -> new)
124+
158instance SwaggerMonoid Text where
125instance SwaggerMonoid Text where
159 swaggerMempty = mempty
126 swaggerMempty = mempty
160 swaggerMappend x "" = x
127 swaggerMappend x "" = x
@@ -164,4 +131,3 @@ instance SwaggerMonoid (Maybe a) where
164 swaggerMempty = Nothing
131 swaggerMempty = Nothing
165 swaggerMappend x Nothing = x
132 swaggerMappend x Nothing = x
166 swaggerMappend _ y = y
133 swaggerMappend _ y = y
167−
src/Data/Swagger/Lens.hs+57−23
@@ -1,3 +1,4 @@
1+{-# LANGUAGE CPP #-}
1{-# LANGUAGE FlexibleContexts #-}
2{-# LANGUAGE FlexibleContexts #-}
2{-# LANGUAGE FlexibleInstances #-}
3{-# LANGUAGE FlexibleInstances #-}
3{-# LANGUAGE FunctionalDependencies #-}
4{-# LANGUAGE FunctionalDependencies #-}
@@ -6,7 +7,16 @@
6{-# LANGUAGE RankNTypes #-}
7{-# LANGUAGE RankNTypes #-}
7{-# LANGUAGE TemplateHaskell #-}
8{-# LANGUAGE TemplateHaskell #-}
8{-# LANGUAGE TypeFamilies #-}
9{-# LANGUAGE TypeFamilies #-}
10+{-# LANGUAGE DataKinds #-}
9{-# LANGUAGE UndecidableInstances #-}
11{-# LANGUAGE UndecidableInstances #-}
12+{-# OPTIONS_GHC -fno-warn-orphans #-}
13+#include "overlapping-compat.h"
14+-- |
15+-- Module: Data.Swagger.Lens
16+-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
17+-- Stability: experimental
18+--
19+-- Lenses and prisms for Swagger.
10module Data.Swagger.Lens where
20module Data.Swagger.Lens where
11
21
12import Control.Lens
22import Control.Lens
@@ -23,7 +33,7 @@ makeFields ''Host
23makeFields ''Info
33makeFields ''Info
24makeFields ''Contact
34makeFields ''Contact
25makeFields ''License
35makeFields ''License
26−makeFields ''PathItem
36+makeLensesWith swaggerFieldRules ''PathItem
27makeFields ''Tag
37makeFields ''Tag
28makeFields ''Operation
38makeFields ''Operation
29makeFields ''Param
39makeFields ''Param
@@ -50,19 +60,23 @@ makePrisms ''Referenced
50
60
51-- ** 'SwaggerItems' prisms
61-- ** 'SwaggerItems' prisms
52
62
53−_SwaggerItemsArray :: forall t. (t ~ Schema) => Review (SwaggerItems t) [Referenced Schema]
63+_SwaggerItemsArray :: Review (SwaggerItems 'SwaggerKindSchema) [Referenced Schema]
54_SwaggerItemsArray
64_SwaggerItemsArray
55− = prism (\x -> SwaggerItemsArray x) $ \x -> case x of
65+ = unto (\x -> SwaggerItemsArray x)
66+{- \x -> case x of
56 SwaggerItemsPrimitive c p -> Left (SwaggerItemsPrimitive c p)
67 SwaggerItemsPrimitive c p -> Left (SwaggerItemsPrimitive c p)
57 SwaggerItemsObject o -> Left (SwaggerItemsObject o)
68 SwaggerItemsObject o -> Left (SwaggerItemsObject o)
58 SwaggerItemsArray a -> Right a
69 SwaggerItemsArray a -> Right a
70+-}
59
71
60−_SwaggerItemsObject :: forall t. (t ~ Schema) => Review (SwaggerItems t) (Referenced Schema)
72+_SwaggerItemsObject :: Review (SwaggerItems 'SwaggerKindSchema) (Referenced Schema)
61_SwaggerItemsObject
73_SwaggerItemsObject
62− = prism (\x -> SwaggerItemsObject x) $ \x -> case x of
74+ = unto (\x -> SwaggerItemsObject x)
75+{- \x -> case x of
63 SwaggerItemsPrimitive c p -> Left (SwaggerItemsPrimitive c p)
76 SwaggerItemsPrimitive c p -> Left (SwaggerItemsPrimitive c p)
64 SwaggerItemsObject o -> Right o
77 SwaggerItemsObject o -> Right o
65 SwaggerItemsArray a -> Left (SwaggerItemsArray a)
78 SwaggerItemsArray a -> Left (SwaggerItemsArray a)
79+-}
66
80
67_SwaggerItemsPrimitive :: forall t p f. (Profunctor p, Bifunctor p, Functor f) => Optic' p f (SwaggerItems t) (Maybe (CollectionFormat t), ParamSchema t)
81_SwaggerItemsPrimitive :: forall t p f. (Profunctor p, Bifunctor p, Functor f) => Optic' p f (SwaggerItems t) (Maybe (CollectionFormat t), ParamSchema t)
68_SwaggerItemsPrimitive = unto (\(c, p) -> SwaggerItemsPrimitive c p)
82_SwaggerItemsPrimitive = unto (\(c, p) -> SwaggerItemsPrimitive c p)
@@ -82,11 +96,19 @@ instance At Responses where at n = responses . at n
82instance Ixed Operation where ix n = responses . ix n
96instance Ixed Operation where ix n = responses . ix n
83instance At Operation where at n = responses . at n
97instance At Operation where at n = responses . at n
84
98
99+type instance Index SecurityDefinitions = Text
100+type instance IxValue SecurityDefinitions = SecurityScheme
101+
102+instance Ixed SecurityDefinitions where ix n = (coerced :: Lens' SecurityDefinitions (Definitions SecurityScheme)). ix n
103+instance At SecurityDefinitions where at n = (coerced :: Lens' SecurityDefinitions (Definitions SecurityScheme)). at n
104+
105+instance HasParamSchema NamedSchema (ParamSchema 'SwaggerKindSchema) where paramSchema = schema.paramSchema
106+
85-- HasType instances
107-- HasType instances
86−instance HasType Header (SwaggerType Header) where type_ = paramSchema.type_
108+instance HasType Header (Maybe (SwaggerType ('SwaggerKindNormal Header))) where type_ = paramSchema.type_
87−instance HasType Schema (SwaggerType Schema) where type_ = paramSchema.type_
109+instance HasType Schema (Maybe (SwaggerType 'SwaggerKindSchema)) where type_ = paramSchema.type_
88−instance HasType NamedSchema (SwaggerType Schema) where type_ = schema.paramSchema.type_
110+instance HasType NamedSchema (Maybe (SwaggerType 'SwaggerKindSchema)) where type_ = paramSchema.type_
89−instance HasType ParamOtherSchema (SwaggerType ParamOtherSchema) where type_ = paramSchema.type_
111+instance HasType ParamOtherSchema (Maybe (SwaggerType 'SwaggerKindParamOtherSchema)) where type_ = paramSchema.type_
90
112
91-- HasDefault instances
113-- HasDefault instances
92instance HasDefault Header (Maybe Value) where default_ = paramSchema.default_
114instance HasDefault Header (Maybe Value) where default_ = paramSchema.default_
@@ -95,58 +117,70 @@ instance HasDefault ParamOtherSchema (Maybe Value) where default_ = paramSchema.
95
117
96-- OVERLAPPABLE instances
118-- OVERLAPPABLE instances
97
119
120+instance
121+#if __GLASGOW_HASKELL__ >= 710
122+ OVERLAPPABLE_
123+#endif
98−instance {-# OVERLAPPABLE #-} HasParamSchema s (ParamSchema t)
124+ HasParamSchema s (ParamSchema t)
99 => HasFormat s (Maybe Format) where
125 => HasFormat s (Maybe Format) where
100 format = paramSchema.format
126 format = paramSchema.format
101
127
128+instance
129+#if __GLASGOW_HASKELL__ >= 710
130+ OVERLAPPABLE_
131+#endif
102−instance {-# OVERLAPPABLE #-} HasParamSchema s (ParamSchema t)
132+ HasParamSchema s (ParamSchema t)
103 => HasItems s (Maybe (SwaggerItems t)) where
133 => HasItems s (Maybe (SwaggerItems t)) where
104 items = paramSchema.items
134 items = paramSchema.items
105
135
136+instance
137+#if __GLASGOW_HASKELL__ >= 710
138+ OVERLAPPABLE_
139+#endif
106−instance {-# OVERLAPPABLE #-} HasParamSchema s (ParamSchema t)
140+ HasParamSchema s (ParamSchema t)
107 => HasMaximum s (Maybe Scientific) where
141 => HasMaximum s (Maybe Scientific) where
108 maximum_ = paramSchema.maximum_
142 maximum_ = paramSchema.maximum_
109
143
110−instance {-# OVERLAPPABLE #-} HasParamSchema s (ParamSchema t)
144+instance OVERLAPPABLE_ HasParamSchema s (ParamSchema t)
111 => HasExclusiveMaximum s (Maybe Bool) where
145 => HasExclusiveMaximum s (Maybe Bool) where
112 exclusiveMaximum = paramSchema.exclusiveMaximum
146 exclusiveMaximum = paramSchema.exclusiveMaximum
113
147
114−instance {-# OVERLAPPABLE #-} HasParamSchema s (ParamSchema t)
148+instance OVERLAPPABLE_ HasParamSchema s (ParamSchema t)
115 => HasMinimum s (Maybe Scientific) where
149 => HasMinimum s (Maybe Scientific) where
116 minimum_ = paramSchema.minimum_
150 minimum_ = paramSchema.minimum_
117
151
118−instance {-# OVERLAPPABLE #-} HasParamSchema s (ParamSchema t)
152+instance OVERLAPPABLE_ HasParamSchema s (ParamSchema t)
119 => HasExclusiveMinimum s (Maybe Bool) where
153 => HasExclusiveMinimum s (Maybe Bool) where
120 exclusiveMinimum = paramSchema.exclusiveMinimum
154 exclusiveMinimum = paramSchema.exclusiveMinimum
121
155
122−instance {-# OVERLAPPABLE #-} HasParamSchema s (ParamSchema t)
156+instance OVERLAPPABLE_ HasParamSchema s (ParamSchema t)
123 => HasMaxLength s (Maybe Integer) where
157 => HasMaxLength s (Maybe Integer) where
124 maxLength = paramSchema.maxLength
158 maxLength = paramSchema.maxLength
125
159
126−instance {-# OVERLAPPABLE #-} HasParamSchema s (ParamSchema t)
160+instance OVERLAPPABLE_ HasParamSchema s (ParamSchema t)
127 => HasMinLength s (Maybe Integer) where
161 => HasMinLength s (Maybe Integer) where
128 minLength = paramSchema.minLength
162 minLength = paramSchema.minLength
129
163
130−instance {-# OVERLAPPABLE #-} HasParamSchema s (ParamSchema t)
164+instance OVERLAPPABLE_ HasParamSchema s (ParamSchema t)
131 => HasPattern s (Maybe Text) where
165 => HasPattern s (Maybe Text) where
132 pattern = paramSchema.pattern
166 pattern = paramSchema.pattern
133
167
134−instance {-# OVERLAPPABLE #-} HasParamSchema s (ParamSchema t)
168+instance OVERLAPPABLE_ HasParamSchema s (ParamSchema t)
135 => HasMaxItems s (Maybe Integer) where
169 => HasMaxItems s (Maybe Integer) where
136 maxItems = paramSchema.maxItems
170 maxItems = paramSchema.maxItems
137
171
138−instance {-# OVERLAPPABLE #-} HasParamSchema s (ParamSchema t)
172+instance OVERLAPPABLE_ HasParamSchema s (ParamSchema t)
139 => HasMinItems s (Maybe Integer) where
173 => HasMinItems s (Maybe Integer) where
140 minItems = paramSchema.minItems
174 minItems = paramSchema.minItems
141
175
142−instance {-# OVERLAPPABLE #-} HasParamSchema s (ParamSchema t)
176+instance OVERLAPPABLE_ HasParamSchema s (ParamSchema t)
143 => HasUniqueItems s (Maybe Bool) where
177 => HasUniqueItems s (Maybe Bool) where
144 uniqueItems = paramSchema.uniqueItems
178 uniqueItems = paramSchema.uniqueItems
145
179
146−instance {-# OVERLAPPABLE #-} HasParamSchema s (ParamSchema t)
180+instance OVERLAPPABLE_ HasParamSchema s (ParamSchema t)
147 => HasEnum s (Maybe [Value]) where
181 => HasEnum s (Maybe [Value]) where
148 enum_ = paramSchema.enum_
182 enum_ = paramSchema.enum_
149
183
150−instance {-# OVERLAPPABLE #-} HasParamSchema s (ParamSchema t)
184+instance OVERLAPPABLE_ HasParamSchema s (ParamSchema t)
151 => HasMultipleOf s (Maybe Scientific) where
185 => HasMultipleOf s (Maybe Scientific) where
152 multipleOf = paramSchema.multipleOf
186 multipleOf = paramSchema.multipleOf
src/Data/Swagger/Operation.hsnew file+193
@@ -0,0 +1,193 @@
1+{-# LANGUAGE RankNTypes #-}
2+-- |
3+-- Module: Data.Swagger.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 (
11+ -- * Operation traversals
12+ allOperations,
13+ operationsOf,
14+
15+ -- * Manipulation
16+ -- ** Tags
17+ applyTags,
18+ applyTagsFor,
19+
20+ -- ** Responses
21+ setResponse,
22+ setResponseWith,
23+ setResponseFor,
24+ setResponseForWith,
25+
26+ -- ** Paths
27+ prependPath,
28+
29+ -- * Miscellaneous
30+ declareResponse,
31+) where
32+
33+import Prelude ()
34+import Prelude.Compat
35+
36+import Control.Lens
37+import Data.Data.Lens
38+import Data.List.Compat
39+import Data.Maybe (mapMaybe)
40+import Data.Proxy
41+import qualified Data.Set as Set
42+
43+import Data.Swagger.Declare
44+import Data.Swagger.Internal
45+import Data.Swagger.Lens
46+import Data.Swagger.Schema
47+
48+import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
49+import qualified Data.HashSet.InsOrd as InsOrdHS
50+
51+-- $setup
52+-- >>> import Data.Aeson
53+-- >>> import Data.Proxy
54+-- >>> import Data.Time
55+
56+-- | Prepend path piece to all operations of the spec.
57+-- Leading and trailing slashes are trimmed/added automatically.
58+--
59+-- >>> let api = (mempty :: Swagger) & paths .~ [("/info", mempty)]
60+-- >>> encode $ prependPath "user/{user_id}" api ^. paths
61+-- "{\"/user/{user_id}/info\":{}}"
62+prependPath :: FilePath -> Swagger -> Swagger
63+prependPath path = paths %~ InsOrdHashMap.mapKeys (path </>)
64+ where
65+ x </> y = case trim y of
66+ "" -> "/" <> trim x
67+ y' -> "/" <> trim x <> "/" <> y'
68+
69+ trim = dropWhile (== '/') . dropWhileEnd (== '/')
70+
71+-- | All operations of a Swagger spec.
72+allOperations :: Traversal' Swagger Operation
73+allOperations = paths.traverse.template
74+
75+-- | @'operationsOf' sub@ will traverse only those operations
76+-- that are present in @sub@. Note that @'Operation'@ is determined
77+-- by both path and method.
78+--
79+-- >>> let ok = (mempty :: Operation) & at 200 ?~ "OK"
80+-- >>> let api = (mempty :: Swagger) & paths .~ [("/user", mempty & get ?~ ok & post ?~ ok)]
81+-- >>> let sub = (mempty :: Swagger) & paths .~ [("/user", mempty & get ?~ mempty)]
82+-- >>> encode api
83+-- "{\"swagger\":\"2.0\",\"info\":{\"version\":\"\",\"title\":\"\"},\"paths\":{\"/user\":{\"get\":{\"responses\":{\"200\":{\"description\":\"OK\"}}},\"post\":{\"responses\":{\"200\":{\"description\":\"OK\"}}}}}}"
84+-- >>> encode $ api & operationsOf sub . at 404 ?~ "Not found"
85+-- "{\"swagger\":\"2.0\",\"info\":{\"version\":\"\",\"title\":\"\"},\"paths\":{\"/user\":{\"get\":{\"responses\":{\"404\":{\"description\":\"Not found\"},\"200\":{\"description\":\"OK\"}}},\"post\":{\"responses\":{\"200\":{\"description\":\"OK\"}}}}}}"
86+operationsOf :: Swagger -> Traversal' Swagger Operation
87+operationsOf sub = paths.itraversed.withIndex.subops
88+ where
89+ -- | Traverse operations that correspond to paths and methods of the sub API.
90+ subops :: Traversal' (FilePath, PathItem) Operation
91+ subops f (path, item) = case InsOrdHashMap.lookup path (sub ^. paths) of
92+ Just subitem -> (,) path <$> methodsOf subitem f item
93+ Nothing -> pure (path, item)
94+
95+ -- | Traverse operations that exist in a given @'PathItem'@
96+ -- This is used to traverse only the operations that exist in sub API.
97+ methodsOf :: PathItem -> Traversal' PathItem Operation
98+ methodsOf pathItem = partsOf template . itraversed . indices (`elem` ns) . _Just
99+ where
100+ ops = pathItem ^.. template :: [Maybe Operation]
101+ ns = mapMaybe (fmap fst . sequenceA) $ zip [0..] ops
102+
103+-- | Apply tags to all operations and update the global list of tags.
104+--
105+-- @
106+-- 'applyTags' = 'applyTagsFor' 'allOperations'
107+-- @
108+applyTags :: [Tag] -> Swagger -> Swagger
109+applyTags = applyTagsFor allOperations
110+
111+-- | Apply tags to a part of Swagger spec and update the global
112+-- list of tags.
113+applyTagsFor :: Traversal' Swagger Operation -> [Tag] -> Swagger -> Swagger
114+applyTagsFor ops ts swag = swag
115+ & ops . tags %~ (<> InsOrdHS.fromList (map _tagName ts))
116+ & tags %~ (<> InsOrdHS.fromList ts)
117+
118+-- | Construct a response with @'Schema'@ while declaring all
119+-- necessary schema definitions.
120+--
121+-- >>> encode $ runDeclare (declareResponse (Proxy :: Proxy Day)) mempty
122+-- "[{\"Day\":{\"example\":\"2016-07-22\",\"format\":\"date\",\"type\":\"string\"}},{\"description\":\"\",\"schema\":{\"$ref\":\"#/definitions/Day\"}}]"
123+declareResponse :: ToSchema a => Proxy a -> Declare (Definitions Schema) Response
124+declareResponse proxy = do
125+ s <- declareSchemaRef proxy
126+ return (mempty & schema ?~ s)
127+
128+-- | Set response for all operations.
129+-- This will also update global schema definitions.
130+--
131+-- If the response already exists it will be overwritten.
132+--
133+-- @
134+-- 'setResponse' = 'setResponseFor' 'allOperations'
135+-- @
136+--
137+-- Example:
138+--
139+-- >>> let api = (mempty :: Swagger) & paths .~ [("/user", mempty & get ?~ mempty)]
140+-- >>> let res = declareResponse (Proxy :: Proxy Day)
141+-- >>> encode $ api & setResponse 200 res
142+-- "{\"swagger\":\"2.0\",\"info\":{\"version\":\"\",\"title\":\"\"},\"paths\":{\"/user\":{\"get\":{\"responses\":{\"200\":{\"schema\":{\"$ref\":\"#/definitions/Day\"},\"description\":\"\"}}}}},\"definitions\":{\"Day\":{\"example\":\"2016-07-22\",\"format\":\"date\",\"type\":\"string\"}}}"
143+--
144+-- See also @'setResponseWith'@.
145+setResponse :: HttpStatusCode -> Declare (Definitions Schema) Response -> Swagger -> Swagger
146+setResponse = setResponseFor allOperations
147+
148+-- | Set or update response for all operations.
149+-- This will also update global schema definitions.
150+--
151+-- If the response already exists, but it can't be dereferenced (invalid @\$ref@),
152+-- then just the new response is used.
153+--
154+-- @
155+-- 'setResponseWith' = 'setResponseForWith' 'allOperations'
156+-- @
157+--
158+-- See also @'setResponse'@.
159+setResponseWith :: (Response -> Response -> Response) -> HttpStatusCode -> Declare (Definitions Schema) Response -> Swagger -> Swagger
160+setResponseWith = setResponseForWith allOperations
161+
162+-- | Set response for specified operations.
163+-- This will also update global schema definitions.
164+--
165+-- If the response already exists it will be overwritten.
166+--
167+-- See also @'setResponseForWith'@.
168+setResponseFor :: Traversal' Swagger Operation -> HttpStatusCode -> Declare (Definitions Schema) Response -> Swagger -> Swagger
169+setResponseFor ops code dres swag = swag
170+ & definitions %~ (<> defs)
171+ & ops . at code ?~ Inline res
172+ where
173+ (defs, res) = runDeclare dres mempty
174+
175+-- | Set or update response for specified operations.
176+-- This will also update global schema definitions.
177+--
178+-- If the response already exists, but it can't be dereferenced (invalid @\$ref@),
179+-- then just the new response is used.
180+--
181+-- See also @'setResponseFor'@.
182+setResponseForWith :: Traversal' Swagger Operation -> (Response -> Response -> Response) -> HttpStatusCode -> Declare (Definitions Schema) Response -> Swagger -> Swagger
183+setResponseForWith ops f code dres swag = swag
184+ & definitions %~ (<> defs)
185+ & ops . at code %~ Just . Inline . combine
186+ where
187+ (defs, new) = runDeclare dres mempty
188+
189+ combine (Just (Ref (Reference n))) = case swag ^. responses.at n of
190+ Just old -> f old new
191+ Nothing -> new -- response name can't be dereferenced, replacing with new response
192+ combine (Just (Inline old)) = f old new
193+ combine Nothing = new
src/Data/Swagger/Optics.hsnew file+597
@@ -0,0 +1,597 @@
1+{-# LANGUAGE DataKinds #-}
2+{-# LANGUAGE FlexibleInstances #-}
3+{-# LANGUAGE MultiParamTypeClasses #-}
4+{-# LANGUAGE OverloadedLabels #-}
5+{-# LANGUAGE TemplateHaskell #-}
6+{-# LANGUAGE TypeFamilies #-}
7+{-# LANGUAGE UndecidableInstances #-}
8+{-# OPTIONS_GHC -fno-warn-orphans #-}
9+-- |
10+-- Module: Data.Swagger.Optics
11+-- Maintainer: Andrzej Rybczak <andrzej@rybczak.net>
12+-- Stability: experimental
13+--
14+-- Lenses and prisms for the <https://hackage.haskell.org/package/optics optics>
15+-- library.
16+--
17+-- >>> import Data.Aeson
18+-- >>> import Optics.Core
19+-- >>> :set -XOverloadedLabels
20+--
21+-- Example from the "Data.Swagger" module using @optics@:
22+--
23+-- >>> :{
24+-- encode $ (mempty :: Swagger)
25+-- & #definitions .~ [ ("User", mempty & #type ?~ SwaggerString) ]
26+-- & #paths .~
27+-- [ ("/user", mempty & #get ?~ (mempty
28+-- & #produces ?~ MimeList ["application/json"]
29+-- & at 200 ?~ ("OK" & #_Inline % #schema ?~ Ref (Reference "User"))
30+-- & at 404 ?~ "User info not found")) ]
31+-- :}
32+-- "{\"swagger\":\"2.0\",\"info\":{\"version\":\"\",\"title\":\"\"},\"paths\":{\"/user\":{\"get\":{\"produces\":[\"application/json\"],\"responses\":{\"404\":{\"description\":\"User info not found\"},\"200\":{\"schema\":{\"$ref\":\"#/definitions/User\"},\"description\":\"OK\"}}}}},\"definitions\":{\"User\":{\"type\":\"string\"}}}"
33+--
34+-- For convenience optics are defined as /labels/. It means that field accessor
35+-- names can be overloaded for different types. One such common field is
36+-- @#description@. Many components of a Swagger specification can have
37+-- descriptions, and you can use the same name for them:
38+--
39+-- >>> encode $ (mempty :: Response) & #description .~ "No content"
40+-- "{\"description\":\"No content\"}"
41+-- >>> :{
42+-- encode $ (mempty :: Schema)
43+-- & #type ?~ SwaggerBoolean
44+-- & #description ?~ "To be or not to be"
45+-- :}
46+-- "{\"description\":\"To be or not to be\",\"type\":\"boolean\"}"
47+--
48+-- @'ParamSchema'@ is basically the /base schema specification/ and many types
49+-- contain it. So for convenience, all @'ParamSchema'@ fields are transitively
50+-- made fields of the type that has it. For example, you can use @#type@ to
51+-- access @'SwaggerType'@ of @'Header'@ schema without having to use
52+-- @#paramSchema@:
53+--
54+-- >>> encode $ (mempty :: Header) & #type ?~ SwaggerNumber
55+-- "{\"type\":\"number\"}"
56+--
57+-- Additionally, to simplify working with @'Response'@, both @'Operation'@ and
58+-- @'Responses'@ have direct access to it via @'Optics.Core.At.at'@. Example:
59+--
60+-- >>> :{
61+-- encode $ (mempty :: Operation)
62+-- & at 404 ?~ "Not found"
63+-- :}
64+-- "{\"responses\":{\"404\":{\"description\":\"Not found\"}}}"
65+--
66+module Data.Swagger.Optics () where
67+
68+import Data.Aeson (Value)
69+import Data.Scientific (Scientific)
70+import Data.Swagger.Internal
71+import Data.Text (Text)
72+import Optics.Core
73+import Optics.TH
74+
75+-- Lenses
76+
77+makeFieldLabels ''Swagger
78+makeFieldLabels ''Host
79+makeFieldLabels ''Info
80+makeFieldLabels ''Contact
81+makeFieldLabels ''License
82+makeFieldLabels ''PathItem
83+makeFieldLabels ''Tag
84+makeFieldLabels ''Operation
85+makeFieldLabels ''Param
86+makeFieldLabels ''ParamOtherSchema
87+makeFieldLabels ''Header
88+makeFieldLabels ''Schema
89+makeFieldLabels ''NamedSchema
90+makeFieldLabels ''ParamSchema
91+makeFieldLabels ''Xml
92+makeFieldLabels ''Responses
93+makeFieldLabels ''Response
94+makeFieldLabels ''SecurityScheme
95+makeFieldLabels ''ApiKeyParams
96+makeFieldLabels ''OAuth2Params
97+makeFieldLabels ''ExternalDocs
98+
99+-- Prisms
100+
101+makePrismLabels ''ParamAnySchema
102+makePrismLabels ''SecuritySchemeType
103+makePrismLabels ''Referenced
104+
105+-- SwaggerItems prisms
106+
107+instance
108+ ( a ~ [Referenced Schema]
109+ , b ~ [Referenced Schema]
110+ ) => LabelOptic "_SwaggerItemsArray"
111+ A_Review
112+ (SwaggerItems 'SwaggerKindSchema)
113+ (SwaggerItems 'SwaggerKindSchema)
114+ a
115+ b where
116+ labelOptic = unto (\x -> SwaggerItemsArray x)
117+ {-# INLINE labelOptic #-}
118+
119+instance
120+ ( a ~ Referenced Schema
121+ , b ~ Referenced Schema
122+ ) => LabelOptic "_SwaggerItemsObject"
123+ A_Review
124+ (SwaggerItems 'SwaggerKindSchema)
125+ (SwaggerItems 'SwaggerKindSchema)
126+ a
127+ b where
128+ labelOptic = unto (\x -> SwaggerItemsObject x)
129+ {-# INLINE labelOptic #-}
130+
131+instance
132+ ( a ~ (Maybe (CollectionFormat t), ParamSchema t)
133+ , b ~ (Maybe (CollectionFormat t), ParamSchema t)
134+ ) => LabelOptic "_SwaggerItemsPrimitive"
135+ A_Review
136+ (SwaggerItems t)
137+ (SwaggerItems t)
138+ a
139+ b where
140+ labelOptic = unto (\(c, p) -> SwaggerItemsPrimitive c p)
141+ {-# INLINE labelOptic #-}
142+
143+-- =============================================================
144+-- More helpful instances for easier access to schema properties
145+
146+type instance Index Responses = HttpStatusCode
147+type instance Index Operation = HttpStatusCode
148+
149+type instance IxValue Responses = Referenced Response
150+type instance IxValue Operation = Referenced Response
151+
152+instance Ixed Responses where
153+ ix n = #responses % ix n
154+ {-# INLINE ix #-}
155+instance At Responses where
156+ at n = #responses % at n
157+ {-# INLINE at #-}
158+
159+instance Ixed Operation where
160+ ix n = #responses % ix n
161+ {-# INLINE ix #-}
162+instance At Operation where
163+ at n = #responses % at n
164+ {-# INLINE at #-}
165+
166+-- #paramSchema
167+
168+instance
169+ ( a ~ ParamSchema 'SwaggerKindSchema
170+ , b ~ ParamSchema 'SwaggerKindSchema
171+ ) => LabelOptic "paramSchema" A_Lens NamedSchema NamedSchema a b where
172+ labelOptic = #schema % #paramSchema
173+ {-# INLINE labelOptic #-}
174+
175+-- #type
176+
177+instance
178+ ( a ~ Maybe (SwaggerType ('SwaggerKindNormal Header))
179+ , b ~ Maybe (SwaggerType ('SwaggerKindNormal Header))
180+ ) => LabelOptic "type" A_Lens Header Header a b where
181+ labelOptic = #paramSchema % #type
182+ {-# INLINE labelOptic #-}
183+
184+instance
185+ ( a ~ Maybe (SwaggerType 'SwaggerKindSchema)
186+ , b ~ Maybe (SwaggerType 'SwaggerKindSchema)
187+ ) => LabelOptic "type" A_Lens Schema Schema a b where
188+ labelOptic = #paramSchema % #type
189+ {-# INLINE labelOptic #-}
190+
191+instance
192+ ( a ~ Maybe (SwaggerType 'SwaggerKindSchema)
193+ , b ~ Maybe (SwaggerType 'SwaggerKindSchema)
194+ ) => LabelOptic "type" A_Lens NamedSchema NamedSchema a b where
195+ labelOptic = #paramSchema % #type
196+ {-# INLINE labelOptic #-}
197+
198+instance
199+ ( a ~ Maybe (SwaggerType 'SwaggerKindParamOtherSchema)
200+ , b ~ Maybe (SwaggerType 'SwaggerKindParamOtherSchema)
201+ ) => LabelOptic "type" A_Lens ParamOtherSchema ParamOtherSchema a b where
202+ labelOptic = #paramSchema % #type
203+ {-# INLINE labelOptic #-}
204+
205+-- #default
206+
207+instance
208+ ( a ~ Maybe Value, b ~ Maybe Value
209+ ) => LabelOptic "default" A_Lens Header Header a b where
210+ labelOptic = #paramSchema % #default
211+ {-# INLINE labelOptic #-}
212+
213+instance
214+ ( a ~ Maybe Value, b ~ Maybe Value
215+ ) => LabelOptic "default" A_Lens Schema Schema a b where
216+ labelOptic = #paramSchema % #default
217+ {-# INLINE labelOptic #-}
218+
219+instance
220+ ( a ~ Maybe Value, b ~ Maybe Value
221+ ) => LabelOptic "default" A_Lens NamedSchema NamedSchema a b where
222+ labelOptic = #paramSchema % #default
223+ {-# INLINE labelOptic #-}
224+
225+instance
226+ ( a ~ Maybe Value, b ~ Maybe Value
227+ ) => LabelOptic "default" A_Lens ParamOtherSchema ParamOtherSchema a b where
228+ labelOptic = #paramSchema % #default
229+ {-# INLINE labelOptic #-}
230+
231+-- #format
232+
233+instance
234+ ( a ~ Maybe Format, b ~ Maybe Format
235+ ) => LabelOptic "format" A_Lens Header Header a b where
236+ labelOptic = #paramSchema % #format
237+ {-# INLINE labelOptic #-}
238+
239+instance
240+ ( a ~ Maybe Format, b ~ Maybe Format
241+ ) => LabelOptic "format" A_Lens Schema Schema a b where
242+ labelOptic = #paramSchema % #format
243+ {-# INLINE labelOptic #-}
244+
245+instance
246+ ( a ~ Maybe Format, b ~ Maybe Format
247+ ) => LabelOptic "format" A_Lens NamedSchema NamedSchema a b where
248+ labelOptic = #paramSchema % #format
249+ {-# INLINE labelOptic #-}
250+
251+instance
252+ ( a ~ Maybe Format, b ~ Maybe Format
253+ ) => LabelOptic "format" A_Lens ParamOtherSchema ParamOtherSchema a b where
254+ labelOptic = #paramSchema % #format
255+ {-# INLINE labelOptic #-}
256+
257+-- #items
258+
259+instance
260+ ( a ~ Maybe (SwaggerItems ('SwaggerKindNormal Header))
261+ , b ~ Maybe (SwaggerItems ('SwaggerKindNormal Header))
262+ ) => LabelOptic "items" A_Lens Header Header a b where
263+ labelOptic = #paramSchema % #items
264+ {-# INLINE labelOptic #-}
265+
266+instance
267+ ( a ~ Maybe (SwaggerItems 'SwaggerKindSchema)
268+ , b ~ Maybe (SwaggerItems 'SwaggerKindSchema)
269+ ) => LabelOptic "items" A_Lens Schema Schema a b where
270+ labelOptic = #paramSchema % #items
271+ {-# INLINE labelOptic #-}
272+
273+instance
274+ ( a ~ Maybe (SwaggerItems 'SwaggerKindSchema)
275+ , b ~ Maybe (SwaggerItems 'SwaggerKindSchema)
276+ ) => LabelOptic "items" A_Lens NamedSchema NamedSchema a b where
277+ labelOptic = #paramSchema % #items
278+ {-# INLINE labelOptic #-}
279+
280+instance
281+ ( a ~ Maybe (SwaggerItems 'SwaggerKindParamOtherSchema)
282+ , b ~ Maybe (SwaggerItems 'SwaggerKindParamOtherSchema)
283+ ) => LabelOptic "items" A_Lens ParamOtherSchema ParamOtherSchema a b where
284+ labelOptic = #paramSchema % #items
285+ {-# INLINE labelOptic #-}
286+
287+-- #maximum
288+
289+instance
290+ ( a ~ Maybe Scientific, b ~ Maybe Scientific
291+ ) => LabelOptic "maximum" A_Lens Header Header a b where
292+ labelOptic = #paramSchema % #maximum
293+ {-# INLINE labelOptic #-}
294+
295+instance
296+ ( a ~ Maybe Scientific, b ~ Maybe Scientific
297+ ) => LabelOptic "maximum" A_Lens Schema Schema a b where
298+ labelOptic = #paramSchema % #maximum
299+ {-# INLINE labelOptic #-}
300+
301+instance
302+ ( a ~ Maybe Scientific, b ~ Maybe Scientific
303+ ) => LabelOptic "maximum" A_Lens NamedSchema NamedSchema a b where
304+ labelOptic = #paramSchema % #maximum
305+ {-# INLINE labelOptic #-}
306+
307+instance
308+ ( a ~ Maybe Scientific, b ~ Maybe Scientific
309+ ) => LabelOptic "maximum" A_Lens ParamOtherSchema ParamOtherSchema a b where
310+ labelOptic = #paramSchema % #maximum
311+ {-# INLINE labelOptic #-}
312+
313+-- #exclusiveMaximum
314+
315+instance
316+ ( a ~ Maybe Bool, b ~ Maybe Bool
317+ ) => LabelOptic "exclusiveMaximum" A_Lens Header Header a b where
318+ labelOptic = #paramSchema % #exclusiveMaximum
319+ {-# INLINE labelOptic #-}
320+
321+instance
322+ ( a ~ Maybe Bool, b ~ Maybe Bool
323+ ) => LabelOptic "exclusiveMaximum" A_Lens Schema Schema a b where
324+ labelOptic = #paramSchema % #exclusiveMaximum
325+ {-# INLINE labelOptic #-}
326+
327+instance
328+ ( a ~ Maybe Bool, b ~ Maybe Bool
329+ ) => LabelOptic "exclusiveMaximum" A_Lens NamedSchema NamedSchema a b where
330+ labelOptic = #paramSchema % #exclusiveMaximum
331+ {-# INLINE labelOptic #-}
332+
333+instance
334+ ( a ~ Maybe Bool, b ~ Maybe Bool
335+ ) => LabelOptic "exclusiveMaximum" A_Lens ParamOtherSchema ParamOtherSchema a b where
336+ labelOptic = #paramSchema % #exclusiveMaximum
337+ {-# INLINE labelOptic #-}
338+
339+-- #minimum
340+
341+instance
342+ ( a ~ Maybe Scientific, b ~ Maybe Scientific
343+ ) => LabelOptic "minimum" A_Lens Header Header a b where
344+ labelOptic = #paramSchema % #minimum
345+ {-# INLINE labelOptic #-}
346+
347+instance
348+ ( a ~ Maybe Scientific, b ~ Maybe Scientific
349+ ) => LabelOptic "minimum" A_Lens Schema Schema a b where
350+ labelOptic = #paramSchema % #minimum
351+ {-# INLINE labelOptic #-}
352+
353+instance
354+ ( a ~ Maybe Scientific, b ~ Maybe Scientific
355+ ) => LabelOptic "minimum" A_Lens NamedSchema NamedSchema a b where
356+ labelOptic = #paramSchema % #minimum
357+ {-# INLINE labelOptic #-}
358+
359+instance
360+ ( a ~ Maybe Scientific, b ~ Maybe Scientific
361+ ) => LabelOptic "minimum" A_Lens ParamOtherSchema ParamOtherSchema a b where
362+ labelOptic = #paramSchema % #minimum
363+ {-# INLINE labelOptic #-}
364+
365+-- #exclusiveMinimum
366+
367+instance
368+ ( a ~ Maybe Bool, b ~ Maybe Bool
369+ ) => LabelOptic "exclusiveMinimum" A_Lens Header Header a b where
370+ labelOptic = #paramSchema % #exclusiveMinimum
371+ {-# INLINE labelOptic #-}
372+
373+instance
374+ ( a ~ Maybe Bool, b ~ Maybe Bool
375+ ) => LabelOptic "exclusiveMinimum" A_Lens Schema Schema a b where
376+ labelOptic = #paramSchema % #exclusiveMinimum
377+ {-# INLINE labelOptic #-}
378+
379+instance
380+ ( a ~ Maybe Bool, b ~ Maybe Bool
381+ ) => LabelOptic "exclusiveMinimum" A_Lens NamedSchema NamedSchema a b where
382+ labelOptic = #paramSchema % #exclusiveMinimum
383+ {-# INLINE labelOptic #-}
384+
385+instance
386+ ( a ~ Maybe Bool, b ~ Maybe Bool
387+ ) => LabelOptic "exclusiveMinimum" A_Lens ParamOtherSchema ParamOtherSchema a b where
388+ labelOptic = #paramSchema % #exclusiveMinimum
389+ {-# INLINE labelOptic #-}
390+
391+-- #maxLength
392+
393+instance
394+ ( a ~ Maybe Integer, b ~ Maybe Integer
395+ ) => LabelOptic "maxLength" A_Lens Header Header a b where
396+ labelOptic = #paramSchema % #maxLength
397+ {-# INLINE labelOptic #-}
398+
399+instance
400+ ( a ~ Maybe Integer, b ~ Maybe Integer
401+ ) => LabelOptic "maxLength" A_Lens Schema Schema a b where
402+ labelOptic = #paramSchema % #maxLength
403+ {-# INLINE labelOptic #-}
404+
405+instance
406+ ( a ~ Maybe Integer, b ~ Maybe Integer
407+ ) => LabelOptic "maxLength" A_Lens NamedSchema NamedSchema a b where
408+ labelOptic = #paramSchema % #maxLength
409+ {-# INLINE labelOptic #-}
410+
411+instance
412+ ( a ~ Maybe Integer, b ~ Maybe Integer
413+ ) => LabelOptic "maxLength" A_Lens ParamOtherSchema ParamOtherSchema a b where
414+ labelOptic = #paramSchema % #maxLength
415+ {-# INLINE labelOptic #-}
416+
417+-- #minLength
418+
419+instance
420+ ( a ~ Maybe Integer, b ~ Maybe Integer
421+ ) => LabelOptic "minLength" A_Lens Header Header a b where
422+ labelOptic = #paramSchema % #minLength
423+ {-# INLINE labelOptic #-}
424+
425+instance
426+ ( a ~ Maybe Integer, b ~ Maybe Integer
427+ ) => LabelOptic "minLength" A_Lens Schema Schema a b where
428+ labelOptic = #paramSchema % #minLength
429+ {-# INLINE labelOptic #-}
430+
431+instance
432+ ( a ~ Maybe Integer, b ~ Maybe Integer
433+ ) => LabelOptic "minLength" A_Lens NamedSchema NamedSchema a b where
434+ labelOptic = #paramSchema % #minLength
435+ {-# INLINE labelOptic #-}
436+
437+instance
438+ ( a ~ Maybe Integer, b ~ Maybe Integer
439+ ) => LabelOptic "minLength" A_Lens ParamOtherSchema ParamOtherSchema a b where
440+ labelOptic = #paramSchema % #minLength
441+ {-# INLINE labelOptic #-}
442+
443+-- #pattern
444+
445+instance
446+ ( a ~ Maybe Text, b ~ Maybe Text
447+ ) => LabelOptic "pattern" A_Lens Header Header a b where
448+ labelOptic = #paramSchema % #pattern
449+ {-# INLINE labelOptic #-}
450+
451+instance
452+ ( a ~ Maybe Text, b ~ Maybe Text
453+ ) => LabelOptic "pattern" A_Lens Schema Schema a b where
454+ labelOptic = #paramSchema % #pattern
455+ {-# INLINE labelOptic #-}
456+
457+instance
458+ ( a ~ Maybe Text, b ~ Maybe Text
459+ ) => LabelOptic "pattern" A_Lens NamedSchema NamedSchema a b where
460+ labelOptic = #paramSchema % #pattern
461+ {-# INLINE labelOptic #-}
462+
463+instance
464+ ( a ~ Maybe Text, b ~ Maybe Text
465+ ) => LabelOptic "pattern" A_Lens ParamOtherSchema ParamOtherSchema a b where
466+ labelOptic = #paramSchema % #pattern
467+ {-# INLINE labelOptic #-}
468+
469+-- #maxItems
470+
471+instance
472+ ( a ~ Maybe Integer, b ~ Maybe Integer
473+ ) => LabelOptic "maxItems" A_Lens Header Header a b where
474+ labelOptic = #paramSchema % #maxItems
475+ {-# INLINE labelOptic #-}
476+
477+instance
478+ ( a ~ Maybe Integer, b ~ Maybe Integer
479+ ) => LabelOptic "maxItems" A_Lens Schema Schema a b where
480+ labelOptic = #paramSchema % #maxItems
481+ {-# INLINE labelOptic #-}
482+
483+instance
484+ ( a ~ Maybe Integer, b ~ Maybe Integer
485+ ) => LabelOptic "maxItems" A_Lens NamedSchema NamedSchema a b where
486+ labelOptic = #paramSchema % #maxItems
487+ {-# INLINE labelOptic #-}
488+
489+instance
490+ ( a ~ Maybe Integer, b ~ Maybe Integer
491+ ) => LabelOptic "maxItems" A_Lens ParamOtherSchema ParamOtherSchema a b where
492+ labelOptic = #paramSchema % #maxItems
493+ {-# INLINE labelOptic #-}
494+
495+-- #minItems
496+
497+instance
498+ ( a ~ Maybe Integer, b ~ Maybe Integer
499+ ) => LabelOptic "minItems" A_Lens Header Header a b where
500+ labelOptic = #paramSchema % #minItems
501+ {-# INLINE labelOptic #-}
502+
503+instance
504+ ( a ~ Maybe Integer, b ~ Maybe Integer
505+ ) => LabelOptic "minItems" A_Lens Schema Schema a b where
506+ labelOptic = #paramSchema % #minItems
507+ {-# INLINE labelOptic #-}
508+
509+instance
510+ ( a ~ Maybe Integer, b ~ Maybe Integer
511+ ) => LabelOptic "minItems" A_Lens NamedSchema NamedSchema a b where
512+ labelOptic = #paramSchema % #minItems
513+ {-# INLINE labelOptic #-}
514+
515+instance
516+ ( a ~ Maybe Integer, b ~ Maybe Integer
517+ ) => LabelOptic "minItems" A_Lens ParamOtherSchema ParamOtherSchema a b where
518+ labelOptic = #paramSchema % #minItems
519+ {-# INLINE labelOptic #-}
520+
521+-- #uniqueItems
522+
523+instance
524+ ( a ~ Maybe Bool, b ~ Maybe Bool
525+ ) => LabelOptic "uniqueItems" A_Lens Header Header a b where
526+ labelOptic = #paramSchema % #uniqueItems
527+ {-# INLINE labelOptic #-}
528+
529+instance
530+ ( a ~ Maybe Bool, b ~ Maybe Bool
531+ ) => LabelOptic "uniqueItems" A_Lens Schema Schema a b where
532+ labelOptic = #paramSchema % #uniqueItems
533+ {-# INLINE labelOptic #-}
534+
535+instance
536+ ( a ~ Maybe Bool, b ~ Maybe Bool
537+ ) => LabelOptic "uniqueItems" A_Lens NamedSchema NamedSchema a b where
538+ labelOptic = #paramSchema % #uniqueItems
539+ {-# INLINE labelOptic #-}
540+
541+instance
542+ ( a ~ Maybe Bool, b ~ Maybe Bool
543+ ) => LabelOptic "uniqueItems" A_Lens ParamOtherSchema ParamOtherSchema a b where
544+ labelOptic = #paramSchema % #uniqueItems
545+ {-# INLINE labelOptic #-}
546+
547+-- #enum
548+
549+instance
550+ ( a ~ Maybe [Value], b ~ Maybe [Value]
551+ ) => LabelOptic "enum" A_Lens Header Header a b where
552+ labelOptic = #paramSchema % #enum
553+ {-# INLINE labelOptic #-}
554+
555+instance
556+ ( a ~ Maybe [Value], b ~ Maybe [Value]
557+ ) => LabelOptic "enum" A_Lens Schema Schema a b where
558+ labelOptic = #paramSchema % #enum
559+ {-# INLINE labelOptic #-}
560+
561+instance
562+ ( a ~ Maybe [Value], b ~ Maybe [Value]
563+ ) => LabelOptic "enum" A_Lens NamedSchema NamedSchema a b where
564+ labelOptic = #paramSchema % #enum
565+ {-# INLINE labelOptic #-}
566+
567+instance
568+ ( a ~ Maybe [Value], b ~ Maybe [Value]
569+ ) => LabelOptic "enum" A_Lens ParamOtherSchema ParamOtherSchema a b where
570+ labelOptic = #paramSchema % #enum
571+ {-# INLINE labelOptic #-}
572+
573+-- #multipleOf
574+
575+instance
576+ ( a ~ Maybe Scientific, b ~ Maybe Scientific
577+ ) => LabelOptic "multipleOf" A_Lens Header Header a b where
578+ labelOptic = #paramSchema % #multipleOf
579+ {-# INLINE labelOptic #-}
580+
581+instance
582+ ( a ~ Maybe Scientific, b ~ Maybe Scientific
583+ ) => LabelOptic "multipleOf" A_Lens Schema Schema a b where
584+ labelOptic = #paramSchema % #multipleOf
585+ {-# INLINE labelOptic #-}
586+
587+instance
588+ ( a ~ Maybe Scientific, b ~ Maybe Scientific
589+ ) => LabelOptic "multipleOf" A_Lens NamedSchema NamedSchema a b where
590+ labelOptic = #paramSchema % #multipleOf
591+ {-# INLINE labelOptic #-}
592+
593+instance
594+ ( a ~ Maybe Scientific, b ~ Maybe Scientific
595+ ) => LabelOptic "multipleOf" A_Lens ParamOtherSchema ParamOtherSchema a b where
596+ labelOptic = #paramSchema % #multipleOf
597+ {-# INLINE labelOptic #-}
src/Data/Swagger/ParamSchema.hs+5−2
@@ -1,7 +1,5 @@
1-- |
1-- |
2-- Module: Data.Swagger.ParamSchema
2-- Module: Data.Swagger.ParamSchema
3−-- Copyright: (c) 2015 GetShopTV
4−-- License: BSD3
5-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
3-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
6-- Stability: experimental
4-- Stability: experimental
7--
5--
@@ -14,6 +12,11 @@ module Data.Swagger.ParamSchema (
14 genericToParamSchema,
12 genericToParamSchema,
15 toParamSchemaBoundedIntegral,
13 toParamSchemaBoundedIntegral,
16
14
15+ -- * Schema templates
16+ passwordParamSchema,
17+ binaryParamSchema,
18+ byteParamSchema,
19+
17 -- * Generic encoding configuration
20 -- * Generic encoding configuration
18 SchemaOptions(..),
21 SchemaOptions(..),
19 defaultSchemaOptions,
22 defaultSchemaOptions,
src/Data/Swagger/Schema.hs+24−2
@@ -1,7 +1,5 @@
1-- |
1-- |
2-- Module: Data.Swagger.Schema
2-- Module: Data.Swagger.Schema
3−-- Copyright: (c) 2015 GetShopTV
4−-- License: BSD3
5-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
3-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
6-- Stability: experimental
4-- Stability: experimental
7--
5--
@@ -19,11 +17,34 @@ module Data.Swagger.Schema (
19 -- * Generic schema encoding
17 -- * Generic schema encoding
20 genericDeclareNamedSchema,
18 genericDeclareNamedSchema,
21 genericDeclareSchema,
19 genericDeclareSchema,
20+ genericDeclareNamedSchemaNewtype,
21+ genericNameSchema,
22+
23+ -- ** 'Bounded' 'Integral'
22 genericToNamedSchemaBoundedIntegral,
24 genericToNamedSchemaBoundedIntegral,
23 toSchemaBoundedIntegral,
25 toSchemaBoundedIntegral,
26+
27+ -- ** 'Bounded' 'Enum' key mappings
28+ declareSchemaBoundedEnumKeyMapping,
29+ toSchemaBoundedEnumKeyMapping,
30+
31+ -- ** Reusing 'ToParamSchema'
24 paramSchemaToNamedSchema,
32 paramSchemaToNamedSchema,
25 paramSchemaToSchema,
33 paramSchemaToSchema,
26
34
35+ -- ** Unrestricted versions
36+ genericDeclareNamedSchemaUnrestricted,
37+ genericDeclareSchemaUnrestricted,
38+
39+ -- * Schema templates
40+ passwordSchema,
41+ binarySchema,
42+ byteSchema,
43+
44+ -- * Sketching @'Schema'@s using @'ToJSON'@
45+ sketchSchema,
46+ sketchStrictSchema,
47+
27 -- * Inlining @'Schema'@s
48 -- * Inlining @'Schema'@s
28 inlineNonRecursiveSchemas,
49 inlineNonRecursiveSchemas,
29 inlineAllSchemas,
50 inlineAllSchemas,
@@ -33,6 +54,7 @@ module Data.Swagger.Schema (
33 -- * Generic encoding configuration
54 -- * Generic encoding configuration
34 SchemaOptions(..),
55 SchemaOptions(..),
35 defaultSchemaOptions,
56 defaultSchemaOptions,
57+ fromAesonOptions,
36) where
58) where
37
59
38import Data.Swagger.Internal.Schema
60import Data.Swagger.Internal.Schema
src/Data/Swagger/Schema/Generator.hsnew file+114
@@ -0,0 +1,114 @@
1+{-# LANGUAGE GADTs #-}
2+{-# LANGUAGE OverloadedLists #-}
3+{-# LANGUAGE ScopedTypeVariables #-}
4+
5+module Data.Swagger.Schema.Generator where
6+
7+import Prelude ()
8+import Prelude.Compat
9+
10+import Control.Lens.Operators
11+import Control.Monad (filterM)
12+import Data.Aeson
13+import Data.Aeson.Types
14+import qualified Data.HashMap.Strict.InsOrd as M
15+import Data.Maybe
16+import Data.Maybe
17+import Data.Proxy
18+import Data.Scientific
19+import qualified Data.Set as S
20+import Data.Swagger
21+import Data.Swagger.Declare
22+import Data.Swagger.Internal.Schema.Validation (inferSchemaTypes)
23+import qualified Data.Text as T
24+import qualified Data.Vector as V
25+import Test.QuickCheck (arbitrary)
26+import Test.QuickCheck.Gen
27+import Test.QuickCheck.Property
28+
29+-- | Note: 'schemaGen' may 'error', if schema type is not specified,
30+-- and cannot be inferred.
31+schemaGen :: Definitions Schema -> Schema -> Gen Value
32+schemaGen _ schema
33+ | Just cases <- schema ^. paramSchema . enum_ = elements cases
34+schemaGen defns schema =
35+ case schema ^. type_ of
36+ Nothing ->
37+ case inferSchemaTypes schema of
38+ [ inferredType ] -> schemaGen defns (schema & type_ ?~ inferredType)
39+ -- Gen is not MonadFail
40+ _ -> error "unable to infer schema type"
41+ Just SwaggerBoolean -> Bool <$> elements [True, False]
42+ Just SwaggerNull -> pure Null
43+ Just SwaggerNumber
44+ | Just min <- schema ^. minimum_
45+ , Just max <- schema ^. maximum_ ->
46+ Number . fromFloatDigits <$>
47+ choose (toRealFloat min, toRealFloat max :: Double)
48+ | otherwise -> Number .fromFloatDigits <$> (arbitrary :: Gen Double)
49+ Just SwaggerInteger
50+ | Just min <- schema ^. minimum_
51+ , Just max <- schema ^. maximum_ ->
52+ Number . fromInteger <$>
53+ choose (truncate min, truncate max)
54+ | otherwise -> Number . fromInteger <$> arbitrary
55+ Just SwaggerArray
56+ | Just 0 <- schema ^. maxLength -> pure $ Array V.empty
57+ | Just items <- schema ^. items ->
58+ case items of
59+ SwaggerItemsObject ref -> do
60+ size <- getSize
61+ let itemSchema = dereference defns ref
62+ minLength' = fromMaybe 0 $ fromInteger <$> schema ^. minItems
63+ maxLength' = fromMaybe size $ fromInteger <$> schema ^. maxItems
64+ arrayLength <- choose (minLength', max minLength' maxLength')
65+ generatedArray <- vectorOf arrayLength $ schemaGen defns itemSchema
66+ return . Array $ V.fromList generatedArray
67+ SwaggerItemsArray refs ->
68+ let itemGens = schemaGen defns . dereference defns <$> refs
69+ in fmap (Array . V.fromList) $ sequence itemGens
70+ Just SwaggerString -> do
71+ size <- getSize
72+ let minLength' = fromMaybe 0 $ fromInteger <$> schema ^. minLength
73+ let maxLength' = fromMaybe size $ fromInteger <$> schema ^. maxLength
74+ length <- choose (minLength', max minLength' maxLength')
75+ str <- vectorOf length arbitrary
76+ return . String $ T.pack str
77+ Just SwaggerObject -> do
78+ size <- getSize
79+ let props = dereference defns <$> schema ^. properties
80+ reqKeys = S.fromList $ schema ^. required
81+ allKeys = S.fromList . M.keys $ schema ^. properties
82+ optionalKeys = allKeys S.\\ reqKeys
83+ minProps' = fromMaybe (length reqKeys) $
84+ fromInteger <$> schema ^. minProperties
85+ maxProps' = fromMaybe size $ fromInteger <$> schema ^. maxProperties
86+ shuffledOptional <- shuffle $ S.toList optionalKeys
87+ numProps <- choose (minProps', max minProps' maxProps')
88+ let presentKeys = take numProps $ S.toList reqKeys ++ shuffledOptional
89+ let presentProps = M.filterWithKey (\k _ -> k `elem` presentKeys) props
90+ let gens = schemaGen defns <$> presentProps
91+ additionalGens <- case schema ^. additionalProperties of
92+ Just (AdditionalPropertiesSchema addlSchema) -> do
93+ additionalKeys <- sequence . take (numProps - length presentProps) . repeat $ T.pack <$> arbitrary
94+ return . M.fromList $ zip additionalKeys (repeat . schemaGen defns $ dereference defns addlSchema)
95+ _ -> return []
96+ x <- sequence $ gens <> additionalGens
97+ return . Object $ M.toHashMap x
98+ where
99+ dereference :: Definitions a -> Referenced a -> a
100+ dereference _ (Inline a) = a
101+ dereference defs (Ref (Reference ref)) = fromJust $ M.lookup ref defs
102+
103+genValue :: (ToSchema a) => Proxy a -> Gen Value
104+genValue p =
105+ let (defs, NamedSchema _ schema) = runDeclare (declareNamedSchema p) M.empty
106+ in schemaGen defs schema
107+
108+validateFromJSON :: forall a . (ToSchema a, FromJSON a) => Proxy a -> Property
109+validateFromJSON p = forAll (genValue p) $
110+ \val -> case parseEither parseJSON val of
111+ Right (_ :: a) -> succeeded
112+ Left err -> failed
113+ { reason = err
114+ }
src/Data/Swagger/Schema/Validation.hsnew file+90
@@ -0,0 +1,90 @@
1+-- |
2+-- Module: Data.Swagger.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 (
8+ -- * How to use validation
9+ -- $howto
10+
11+ -- ** Examples
12+ -- $examples
13+
14+ -- ** Validating @'Maybe'@
15+ -- $maybe
16+
17+ -- * JSON validation
18+
19+ ValidationError,
20+
21+ -- ** Using 'ToJSON' and 'ToSchema'
22+ validatePrettyToJSON,
23+ validateToJSON,
24+ validateToJSONWithPatternChecker,
25+ renderValidationErrors,
26+
27+ -- ** Using 'Value' and 'Schema'
28+ validateJSON,
29+ validateJSONWithPatternChecker,
30+) where
31+
32+import Data.Swagger.Internal.Schema.Validation
33+
34+-- $setup
35+-- >>> import Control.Lens
36+-- >>> import Data.Aeson
37+-- >>> import Data.Proxy
38+-- >>> import Data.Swagger
39+-- >>> import GHC.Generics
40+-- >>> :set -XDeriveGeneric
41+
42+-- $howto
43+--
44+-- This module provides helpful functions for JSON validation.
45+-- These functions are meant to be used in test suites for your application
46+-- to ensure that JSON respresentation for your data corresponds to
47+-- schemas you're using for the Swagger specification.
48+--
49+-- It is recommended to use validation functions as QuickCheck properties
50+-- (see <http://hackage.haskell.org/package/QuickCheck>).
51+
52+-- $examples
53+--
54+-- >>> validateToJSON "hello"
55+-- []
56+--
57+-- >>> validateToJSON False
58+-- []
59+--
60+-- >>> newtype Nat = Nat Integer deriving Generic
61+-- >>> instance ToJSON Nat where toJSON (Nat n) = toJSON n
62+-- >>> instance ToSchema Nat where declareNamedSchema proxy = genericDeclareNamedSchema defaultSchemaOptions proxy & mapped.minimum_ ?~ 0
63+-- >>> validateToJSON (Nat 10)
64+-- []
65+-- >>> validateToJSON (Nat (-5))
66+-- ["value -5.0 falls below minimum (should be >=0.0)"]
67+
68+-- $maybe
69+--
70+-- Because @'Maybe' a@ has the same schema as @a@, validation
71+-- generally fails for @null@ JSON:
72+--
73+-- >>> validateToJSON (Nothing :: Maybe String)
74+-- ["expected JSON value of type SwaggerString"]
75+-- >>> validateToJSON ([Just "hello", Nothing] :: [Maybe String])
76+-- ["expected JSON value of type SwaggerString"]
77+-- >>> validateToJSON (123, Nothing :: Maybe String)
78+-- ["expected JSON value of type SwaggerString"]
79+--
80+-- However, when @'Maybe' a@ is a type of a record field,
81+-- validation takes @'required'@ property of the @'Schema'@
82+-- into account:
83+--
84+-- >>> data Person = Person { name :: String, age :: Maybe Int } deriving Generic
85+-- >>> instance ToJSON Person
86+-- >>> instance ToSchema Person
87+-- >>> validateToJSON (Person "Nick" (Just 24))
88+-- []
89+-- >>> validateToJSON (Person "Nick" Nothing)
90+-- []
src/Data/Swagger/SchemaOptions.hs+35
@@ -1,5 +1,14 @@
1+{-# LANGUAGE RecordWildCards #-}
2+-- |
3+-- Module: Data.Swagger.SchemaOptions
4+-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
5+-- Stability: experimental
6+--
7+-- Generic deriving options for @'ToParamSchema'@ and @'ToSchema'@.
1module Data.Swagger.SchemaOptions where
8module Data.Swagger.SchemaOptions where
2
9
10+import qualified Data.Aeson.Types as Aeson
11+
3-- | Options that specify how to encode your type to Swagger schema.
12-- | Options that specify how to encode your type to Swagger schema.
4data SchemaOptions = SchemaOptions
13data SchemaOptions = SchemaOptions
5 { -- | Function applied to field labels. Handy for removing common record prefixes for example.
14 { -- | Function applied to field labels. Handy for removing common record prefixes for example.
@@ -35,3 +44,29 @@ defaultSchemaOptions = SchemaOptions
35 , unwrapUnaryRecords = False
44 , unwrapUnaryRecords = False
36 }
45 }
37
46
47+-- | Convert 'Aeson.Options' to 'SchemaOptions'.
48+--
49+-- Specifically the following fields get copied:
50+--
51+-- * 'fieldLabelModifier'
52+-- * 'constructorTagModifier'
53+-- * 'allNullaryToStringTag'
54+-- * 'unwrapUnaryRecords'
55+--
56+-- Note that these fields have no effect on `SchemaOptions`:
57+--
58+-- * 'Aeson.omitNothingFields'
59+-- * 'Aeson.sumEncoding'
60+-- * 'Aeson.tagSingleConstructors'
61+--
62+-- The rest is defined as in 'defaultSchemaOptions'.
63+--
64+-- @since 2.2.1
65+--
66+fromAesonOptions :: Aeson.Options -> SchemaOptions
67+fromAesonOptions opts = defaultSchemaOptions
68+ { fieldLabelModifier = Aeson.fieldLabelModifier opts
69+ , constructorTagModifier = Aeson.constructorTagModifier opts
70+ , allNullaryToStringTag = Aeson.allNullaryToStringTag opts
71+ , unwrapUnaryRecords = Aeson.unwrapUnaryRecords opts
72+ }
stack.yaml+6−2
@@ -1,5 +1,9 @@
1−flags: {}
1+resolver: lts-14.3
2packages:
2packages:
3- '.'
3- '.'
4extra-deps:
4extra-deps:
5−resolver: lts-3.12
5+- optics-core-0.2
6+- optics-th-0.2
7+- optics-extra-0.2
8+- indexed-profunctors-0.1
9+- insert-ordered-containers-0.2.3
swagger2.cabal+107−34
@@ -1,79 +1,152 @@
1+cabal-version: >=1.10
1name: swagger2
2name: swagger2
2−version: 1.2.1
3+version: 2.5
4+
3synopsis: Swagger 2.0 data model
5synopsis: Swagger 2.0 data model
6+category: Web, Swagger
4−description: Please see README.md
7+description:
8+ This library is intended to be used for decoding and encoding Swagger 2.0 API
9+ specifications as well as manipulating them.
10+ .
11+ The original Swagger 2.0 specification is available at http://swagger.io/specification/.
12+
5homepage: https://github.com/GetShopTV/swagger2
13homepage: https://github.com/GetShopTV/swagger2
6bug-reports: https://github.com/GetShopTV/swagger2/issues
14bug-reports: https://github.com/GetShopTV/swagger2/issues
7license: BSD3
15license: BSD3
8license-file: LICENSE
16license-file: LICENSE
9author: Nickolay Kudasov
17author: Nickolay Kudasov
10maintainer: nickolay@getshoptv.com
18maintainer: nickolay@getshoptv.com
11−copyright: (c) 2015, GetShopTV
19+copyright: (c) 2015-2016, GetShopTV
12−category: Web
13−build-type: Simple
20+build-type: Custom
14extra-source-files:
21extra-source-files:
15 README.md
22 README.md
16 , CHANGELOG.md
23 , CHANGELOG.md
17 , examples/*.hs
24 , examples/*.hs
18−cabal-version: >=1.10
25+ , include/overlapping-compat.h
26+tested-with:
27+ GHC ==8.0.2
28+ || ==8.2.2
29+ || ==8.4.4
30+ || ==8.6.5
31+ || ==8.8.1
32+
33+custom-setup
34+ setup-depends:
35+ base, Cabal, cabal-doctest >=1.0.6 && <1.1
19
36
20library
37library
21 hs-source-dirs: src
38 hs-source-dirs: src
39+ include-dirs: include
22 exposed-modules:
40 exposed-modules:
23 Data.Swagger
41 Data.Swagger
24 Data.Swagger.Declare
42 Data.Swagger.Declare
25 Data.Swagger.Lens
43 Data.Swagger.Lens
44+ Data.Swagger.Operation
45+ Data.Swagger.Optics
26 Data.Swagger.ParamSchema
46 Data.Swagger.ParamSchema
27 Data.Swagger.Schema
47 Data.Swagger.Schema
48+ Data.Swagger.Schema.Generator
49+ Data.Swagger.Schema.Validation
28 Data.Swagger.SchemaOptions
50 Data.Swagger.SchemaOptions
29
51
30 -- internal modules
52 -- internal modules
31 Data.Swagger.Internal
53 Data.Swagger.Internal
32 Data.Swagger.Internal.Schema
54 Data.Swagger.Internal.Schema
55+ Data.Swagger.Internal.Schema.Validation
33 Data.Swagger.Internal.ParamSchema
56 Data.Swagger.Internal.ParamSchema
34 Data.Swagger.Internal.Utils
57 Data.Swagger.Internal.Utils
58+ Data.Swagger.Internal.AesonUtils
59+ Data.Swagger.Internal.TypeShape
60+
61+ -- GHC boot libraries
35− build-depends: base == 4.*
62+ build-depends:
63+ base >=4.9 && <4.14
36− , aeson
64+ , aeson-pretty >=0.8.7 && <0.9
65+ , bytestring >=0.10.4.0 && <0.11
37− , containers
66+ , containers >=0.5.5.1 && <0.7
67+ , template-haskell >=2.9.0.0 && <2.16
68+ , time >=1.4.2 && <1.10
69+ , transformers >=0.3.0.0 && <0.6
70+
71+ build-depends:
72+ mtl >=2.1 && <2.3
73+ , text >=1.2.3.0 && <1.3
74+
75+ -- other dependencies
76+ build-depends:
77+ base-compat-batteries >=0.10.4 && <0.12
78+ , aeson >=1.4.2.0 && <1.5
79+ -- cookie 0.4.3 is needed by GHC 7.8 due to time>=1.4 constraint
80+ , cookie >=0.4.3 && <0.5
81+ , generics-sop >=0.3.2.0 && <0.6
38− , hashable
82+ , hashable >=1.2.7.0 && <1.4
39− , http-media
83+ , http-media >=0.7.1.2 && <0.9
40− , mtl
84+ , insert-ordered-containers >=0.2.3 && <0.3
41− , network
42− , text
43− , template-haskell
44− , time
45− , unordered-containers
46− , lens
85+ , lens >=4.16.1 && <4.19
86+ , network >=2.6.3.5 && <3.2
87+ , optics-core >=0.2 && <0.3
88+ , optics-th >=0.2 && <0.3
47− , scientific
89+ , scientific >=0.3.6.2 && <0.4
90+ , transformers-compat >=0.3 && <0.7
91+ , unordered-containers >=0.2.9.0 && <0.3
92+ , uuid-types >=1.0.3 && <1.1
93+ , vector >=0.12.0.1 && <0.13
94+ , QuickCheck >=2.10.1 && <2.14
95+
48 default-language: Haskell2010
96 default-language: Haskell2010
49
97
50test-suite spec
98test-suite spec
51 type: exitcode-stdio-1.0
99 type: exitcode-stdio-1.0
52 hs-source-dirs: test
100 hs-source-dirs: test
53 main-is: Spec.hs
101 main-is: Spec.hs
102+
103+ -- From library parat
104+ -- We need aeson's toEncoding for doctests too
54− build-depends: base == 4.*
105+ build-depends:
106+ base
55− , swagger2
107+ , swagger2
56− , hspec
108+ , aeson
57− , HUnit
109+ , base-compat-batteries
58− , QuickCheck
110+ , bytestring
111+ , containers
112+ , hashable
113+ , insert-ordered-containers
114+ , lens
115+ , mtl
116+ , template-haskell
59− , text
117+ , text
60− , aeson
118+ , time
61− , aeson-qq
62− , containers
63− , unordered-containers
119+ , unordered-containers
64− , vector
120+ , vector
65− , lens
121+ , QuickCheck
122+
123+ -- test-suite only dependencies
124+ build-depends:
125+ hspec >=2.5.5 && <2.8
126+ , HUnit >=1.6.0.0 && <1.7
127+ , quickcheck-instances >=0.3.19 && <0.14
128+ , utf8-string >=1.0.1.1 && <1.1
129+
130+ -- https://github.com/haskell/cabal/issues/3708
131+ build-tool-depends:
132+ hspec-discover:hspec-discover >=2.5.5 && <2.8
133+
66 other-modules:
134 other-modules:
67 SpecCommon
135 SpecCommon
68 Data.SwaggerSpec
136 Data.SwaggerSpec
137+ Data.Swagger.CommonTestTypes
138+ Data.Swagger.ParamSchemaSpec
69 Data.Swagger.SchemaSpec
139 Data.Swagger.SchemaSpec
140+ Data.Swagger.Schema.ValidationSpec
141+ Data.Swagger.Schema.GeneratorSpec
70 default-language: Haskell2010
142 default-language: Haskell2010
71
143
72−test-suite doctest
144+test-suite doctests
145+ -- See QuickCheck note in https://github.com/phadej/cabal-doctest#notes
73− build-depends: base, doctest, Glob
146+ build-depends: base, doctest, Glob, QuickCheck
74 default-language: Haskell2010
147 default-language: Haskell2010
75 hs-source-dirs: test
148 hs-source-dirs: test
76− main-is: DocTest.hs
149+ main-is: doctests.hs
77 type: exitcode-stdio-1.0
150 type: exitcode-stdio-1.0
78
151
79source-repository head
152source-repository head
test/Data/Swagger/CommonTestTypes.hsnew file+679
@@ -0,0 +1,679 @@
1+{-# LANGUAGE DeriveGeneric #-}
2+{-# LANGUAGE QuasiQuotes #-}
3+{-# LANGUAGE ScopedTypeVariables #-}
4+
5+module Data.Swagger.CommonTestTypes where
6+
7+import Prelude ()
8+import Prelude.Compat
9+
10+import Data.Aeson (ToJSON (..), ToJSONKey (..), Value)
11+import Data.Aeson.QQ.Simple
12+import Data.Aeson.Types (toJSONKeyText)
13+import Data.Char
14+import Data.Map (Map)
15+import Data.Proxy
16+import Data.Set (Set)
17+import qualified Data.Text as Text
18+import GHC.Generics
19+
20+import Data.Swagger
21+
22+-- ========================================================================
23+-- Unit type
24+-- ========================================================================
25+
26+data Unit = Unit deriving (Generic)
27+instance ToParamSchema Unit
28+instance ToSchema Unit
29+
30+unitSchemaJSON :: Value
31+unitSchemaJSON = [aesonQQ|
32+{
33+ "type": "string",
34+ "enum": ["Unit"]
35+}
36+|]
37+
38+-- ========================================================================
39+-- Color (enum)
40+-- ========================================================================
41+data Color
42+ = Red
43+ | Green
44+ | Blue
45+ deriving (Generic)
46+instance ToParamSchema Color
47+instance ToSchema Color
48+
49+colorSchemaJSON :: Value
50+colorSchemaJSON = [aesonQQ|
51+{
52+ "type": "string",
53+ "enum": ["Red", "Green", "Blue"]
54+}
55+|]
56+
57+-- ========================================================================
58+-- Shade (paramSchemaToNamedSchema)
59+-- ========================================================================
60+
61+data Shade = Dim | Bright deriving (Generic)
62+instance ToParamSchema Shade
63+
64+instance ToSchema Shade where declareNamedSchema = pure . paramSchemaToNamedSchema defaultSchemaOptions
65+
66+shadeSchemaJSON :: Value
67+shadeSchemaJSON = [aesonQQ|
68+{
69+ "type": "string",
70+ "enum": ["Dim", "Bright"]
71+}
72+|]
73+
74+-- ========================================================================
75+-- Paint (record with bounded enum property)
76+-- ========================================================================
77+
78+newtype Paint = Paint { color :: Color }
79+ deriving (Generic)
80+instance ToSchema Paint
81+
82+paintSchemaJSON :: Value
83+paintSchemaJSON = [aesonQQ|
84+{
85+ "type": "object",
86+ "properties":
87+ {
88+ "color":
89+ {
90+ "$ref": "#/definitions/Color"
91+ }
92+ },
93+ "required": ["color"]
94+}
95+|]
96+
97+paintInlinedSchemaJSON :: Value
98+paintInlinedSchemaJSON = [aesonQQ|
99+{
100+ "type": "object",
101+ "properties":
102+ {
103+ "color":
104+ {
105+ "type": "string",
106+ "enum": ["Red", "Green", "Blue"]
107+ }
108+ },
109+ "required": ["color"]
110+}
111+|]
112+
113+-- ========================================================================
114+-- Status (constructorTagModifier)
115+-- ========================================================================
116+
117+data Status
118+ = StatusOk
119+ | StatusError
120+ deriving (Generic)
121+
122+instance ToParamSchema Status where
123+ toParamSchema = genericToParamSchema defaultSchemaOptions
124+ { constructorTagModifier = map toLower . drop (length "Status") }
125+instance ToSchema Status where
126+ declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions
127+ { constructorTagModifier = map toLower . drop (length "Status") }
128+
129+statusSchemaJSON :: Value
130+statusSchemaJSON = [aesonQQ|
131+{
132+ "type": "string",
133+ "enum": ["ok", "error"]
134+}
135+|]
136+
137+-- ========================================================================
138+-- Email (newtype with unwrapUnaryRecords set to True)
139+-- ========================================================================
140+
141+newtype Email = Email { getEmail :: String }
142+ deriving (Generic)
143+instance ToParamSchema Email
144+instance ToSchema Email where
145+ declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions
146+ { unwrapUnaryRecords = True }
147+
148+emailSchemaJSON :: Value
149+emailSchemaJSON = [aesonQQ|
150+{
151+ "type": "string"
152+}
153+|]
154+
155+-- ========================================================================
156+-- UserId (non-record newtype)
157+-- ========================================================================
158+
159+newtype UserId = UserId Integer
160+ deriving (Eq, Ord, Generic)
161+instance ToParamSchema UserId
162+instance ToSchema UserId
163+
164+userIdSchemaJSON :: Value
165+userIdSchemaJSON = [aesonQQ|
166+{
167+ "type": "integer"
168+}
169+|]
170+
171+-- ========================================================================
172+-- UserGroup (set newtype)
173+-- ========================================================================
174+
175+newtype UserGroup = UserGroup (Set UserId)
176+ deriving (Generic)
177+instance ToSchema UserGroup
178+
179+userGroupSchemaJSON :: Value
180+userGroupSchemaJSON = [aesonQQ|
181+{
182+ "type": "array",
183+ "items": { "$ref": "#/definitions/UserId" },
184+ "uniqueItems": true
185+}
186+|]
187+
188+-- ========================================================================
189+-- Person (simple record with optional fields)
190+-- ========================================================================
191+data Person = Person
192+ { name :: String
193+ , phone :: Integer
194+ , email :: Maybe String
195+ } deriving (Generic)
196+
197+instance ToSchema Person
198+
199+personSchemaJSON :: Value
200+personSchemaJSON = [aesonQQ|
201+{
202+ "type": "object",
203+ "properties":
204+ {
205+ "name": { "type": "string" },
206+ "phone": { "type": "integer" },
207+ "email": { "type": "string" }
208+ },
209+ "required": ["name", "phone"]
210+}
211+|]
212+
213+-- ========================================================================
214+-- Player (record newtype)
215+-- ========================================================================
216+
217+newtype Player = Player
218+ { position :: Point
219+ } deriving (Generic)
220+instance ToSchema Player
221+
222+playerSchemaJSON :: Value
223+playerSchemaJSON = [aesonQQ|
224+{
225+ "type": "object",
226+ "properties":
227+ {
228+ "position":
229+ {
230+ "$ref": "#/definitions/Point"
231+ }
232+ },
233+ "required": ["position"]
234+}
235+|]
236+
237+newtype Players = Players [Inlined Player]
238+ deriving (Generic)
239+instance ToSchema Players
240+
241+playersSchemaJSON :: Value
242+playersSchemaJSON = [aesonQQ|
243+{
244+ "type": "array",
245+ "items":
246+ {
247+ "type": "object",
248+ "properties":
249+ {
250+ "position":
251+ {
252+ "$ref": "#/definitions/Point"
253+ }
254+ },
255+ "required": ["position"]
256+ }
257+}
258+|]
259+
260+-- ========================================================================
261+-- Character (sum type with ref and record in alternative)
262+-- ========================================================================
263+
264+data Character
265+ = PC Player
266+ | NPC { npcName :: String, npcPosition :: Point }
267+ deriving (Generic)
268+instance ToSchema Character
269+
270+characterSchemaJSON :: Value
271+characterSchemaJSON = [aesonQQ|
272+{
273+ "type": "object",
274+ "properties":
275+ {
276+ "PC": { "$ref": "#/definitions/Player" },
277+ "NPC":
278+ {
279+ "type": "object",
280+ "properties":
281+ {
282+ "npcName": { "type": "string" },
283+ "npcPosition": { "$ref": "#/definitions/Point" }
284+ },
285+ "required": ["npcName", "npcPosition"]
286+ }
287+ },
288+ "maxProperties": 1,
289+ "minProperties": 1
290+}
291+|]
292+
293+characterInlinedSchemaJSON :: Value
294+characterInlinedSchemaJSON = [aesonQQ|
295+{
296+ "type": "object",
297+ "properties":
298+ {
299+ "PC":
300+ {
301+ "type": "object",
302+ "properties":
303+ {
304+ "position":
305+ {
306+ "type": "object",
307+ "properties":
308+ {
309+ "x": { "type": "number", "format": "double" },
310+ "y": { "type": "number", "format": "double" }
311+ },
312+ "required": ["x", "y"]
313+ }
314+ },
315+ "required": ["position"]
316+ },
317+ "NPC":
318+ {
319+ "type": "object",
320+ "properties":
321+ {
322+ "npcName": { "type": "string" },
323+ "npcPosition":
324+ {
325+ "type": "object",
326+ "properties":
327+ {
328+ "x": { "type": "number", "format": "double" },
329+ "y": { "type": "number", "format": "double" }
330+ },
331+ "required": ["x", "y"]
332+ }
333+ },
334+ "required": ["npcName", "npcPosition"]
335+ }
336+ },
337+ "maxProperties": 1,
338+ "minProperties": 1
339+}
340+|]
341+
342+characterInlinedPlayerSchemaJSON :: Value
343+characterInlinedPlayerSchemaJSON = [aesonQQ|
344+{
345+ "type": "object",
346+ "properties":
347+ {
348+ "PC":
349+ {
350+ "type": "object",
351+ "properties":
352+ {
353+ "position":
354+ {
355+ "$ref": "#/definitions/Point"
356+ }
357+ },
358+ "required": ["position"]
359+ },
360+ "NPC":
361+ {
362+ "type": "object",
363+ "properties":
364+ {
365+ "npcName": { "type": "string" },
366+ "npcPosition": { "$ref": "#/definitions/Point" }
367+ },
368+ "required": ["npcName", "npcPosition"]
369+ }
370+ },
371+ "maxProperties": 1,
372+ "minProperties": 1
373+}
374+|]
375+
376+-- ========================================================================
377+-- ISPair (non-record product data type)
378+-- ========================================================================
379+data ISPair = ISPair Integer String
380+ deriving (Generic)
381+
382+instance ToSchema ISPair
383+
384+ispairSchemaJSON :: Value
385+ispairSchemaJSON = [aesonQQ|
386+{
387+ "type": "array",
388+ "items":
389+ [
390+ { "type": "integer" },
391+ { "type": "string" }
392+ ],
393+ "minItems": 2,
394+ "maxItems": 2
395+}
396+|]
397+
398+-- ========================================================================
399+-- Point (record data type with custom fieldLabelModifier)
400+-- ========================================================================
401+
402+data Point = Point
403+ { pointX :: Double
404+ , pointY :: Double
405+ } deriving (Generic)
406+
407+instance ToSchema Point where
408+ declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions
409+ { fieldLabelModifier = map toLower . drop (length "point") }
410+
411+pointSchemaJSON :: Value
412+pointSchemaJSON = [aesonQQ|
413+{
414+ "type": "object",
415+ "properties":
416+ {
417+ "x": { "type": "number", "format": "double" },
418+ "y": { "type": "number", "format": "double" }
419+ },
420+ "required": ["x", "y"]
421+}
422+|]
423+
424+-- ========================================================================
425+-- Point (record data type with multiple fields)
426+-- ========================================================================
427+
428+data Point5 = Point5
429+ { point5X :: Double
430+ , point5Y :: Double
431+ , point5Z :: Double
432+ , point5U :: Double
433+ , point5V :: Double -- 5 dimensional!
434+ } deriving (Generic)
435+
436+instance ToSchema Point5 where
437+ declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions
438+ { fieldLabelModifier = map toLower . drop (length "point5") }
439+
440+point5SchemaJSON :: Value
441+point5SchemaJSON = [aesonQQ|
442+{
443+ "type": "object",
444+ "properties":
445+ {
446+ "x": { "type": "number", "format": "double" },
447+ "y": { "type": "number", "format": "double" },
448+ "z": { "type": "number", "format": "double" },
449+ "u": { "type": "number", "format": "double" },
450+ "v": { "type": "number", "format": "double" }
451+ },
452+ "required": ["x", "y", "z", "u", "v"]
453+}
454+|]
455+
456+point5Properties :: [String]
457+point5Properties = ["x", "y", "z", "u", "v"]
458+
459+-- ========================================================================
460+-- MyRoseTree (custom datatypeNameModifier)
461+-- ========================================================================
462+
463+data MyRoseTree = MyRoseTree
464+ { root :: String
465+ , trees :: [MyRoseTree]
466+ } deriving (Generic)
467+
468+instance ToSchema MyRoseTree where
469+ declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions
470+ { datatypeNameModifier = drop (length "My") }
471+
472+myRoseTreeSchemaJSON :: Value
473+myRoseTreeSchemaJSON = [aesonQQ|
474+{
475+ "type": "object",
476+ "properties":
477+ {
478+ "root": { "type": "string" },
479+ "trees":
480+ {
481+ "type": "array",
482+ "items":
483+ {
484+ "$ref": "#/definitions/RoseTree"
485+ }
486+ }
487+ },
488+ "required": ["root", "trees"]
489+}
490+|]
491+
492+data MyRoseTree' = MyRoseTree'
493+ { root' :: String
494+ , trees' :: [MyRoseTree']
495+ } deriving (Generic)
496+
497+instance ToSchema MyRoseTree' where
498+ declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions
499+ { datatypeNameModifier = map toLower }
500+
501+myRoseTreeSchemaJSON' :: Value
502+myRoseTreeSchemaJSON' = [aesonQQ|
503+{
504+ "type": "object",
505+ "properties":
506+ {
507+ "root'": { "type": "string" },
508+ "trees'":
509+ {
510+ "type": "array",
511+ "items":
512+ {
513+ "$ref": "#/definitions/myrosetree'"
514+ }
515+ }
516+ },
517+ "required": ["root'", "trees'"]
518+}
519+|]
520+
521+-- ========================================================================
522+-- Inlined (newtype for inlining schemas)
523+-- ========================================================================
524+
525+newtype Inlined a = Inlined { getInlined :: a }
526+
527+instance ToSchema a => ToSchema (Inlined a) where
528+ declareNamedSchema _ = unname <$> declareNamedSchema (Proxy :: Proxy a)
529+ where
530+ unname (NamedSchema _ s) = NamedSchema Nothing s
531+
532+-- ========================================================================
533+-- Light (sum type with unwrapUnaryRecords)
534+-- ========================================================================
535+
536+data Light
537+ = NoLight
538+ | LightFreq Double
539+ | LightColor Color
540+ | LightWaveLength { waveLength :: Double }
541+ deriving (Generic)
542+
543+instance ToSchema Light where
544+ declareNamedSchema = genericDeclareNamedSchemaUnrestricted defaultSchemaOptions
545+ { unwrapUnaryRecords = True }
546+
547+lightSchemaJSON :: Value
548+lightSchemaJSON = [aesonQQ|
549+{
550+ "type": "object",
551+ "properties":
552+ {
553+ "NoLight": { "type": "array", "items": {}, "maxItems": 0, "example": [] },
554+ "LightFreq": { "type": "number", "format": "double" },
555+ "LightColor": { "$ref": "#/definitions/Color" },
556+ "LightWaveLength": { "type": "number", "format": "double" }
557+ },
558+ "maxProperties": 1,
559+ "minProperties": 1
560+}
561+|]
562+
563+lightInlinedSchemaJSON :: Value
564+lightInlinedSchemaJSON = [aesonQQ|
565+{
566+ "type": "object",
567+ "properties":
568+ {
569+ "NoLight": { "type": "array", "items": {}, "maxItems": 0, "example": [] },
570+ "LightFreq": { "type": "number", "format": "double" },
571+ "LightColor":
572+ {
573+ "type": "string",
574+ "enum": ["Red", "Green", "Blue"]
575+ },
576+ "LightWaveLength": { "type": "number", "format": "double" }
577+ },
578+ "maxProperties": 1,
579+ "minProperties": 1
580+}
581+|]
582+
583+-- ========================================================================
584+-- ResourceId (series of newtypes)
585+-- ========================================================================
586+
587+newtype Id = Id String deriving (Generic)
588+instance ToSchema Id
589+
590+newtype ResourceId = ResourceId Id deriving (Generic)
591+instance ToSchema ResourceId
592+
593+-- ========================================================================
594+-- ButtonImages (bounded enum key mapping)
595+-- ========================================================================
596+
597+data ButtonState = Neutral | Focus | Active | Hover | Disabled
598+ deriving (Show, Bounded, Enum, Generic)
599+
600+instance ToJSON ButtonState
601+instance ToSchema ButtonState
602+instance ToJSONKey ButtonState where toJSONKey = toJSONKeyText (Text.pack . show)
603+
604+type ImageUrl = Text.Text
605+
606+newtype ButtonImages = ButtonImages { getButtonImages :: Map ButtonState ImageUrl }
607+ deriving (Generic)
608+
609+instance ToJSON ButtonImages where
610+ toJSON = toJSON . getButtonImages
611+
612+instance ToSchema ButtonImages where
613+ declareNamedSchema = genericDeclareNamedSchemaNewtype defaultSchemaOptions
614+ declareSchemaBoundedEnumKeyMapping
615+
616+buttonImagesSchemaJSON :: Value
617+buttonImagesSchemaJSON = [aesonQQ|
618+{
619+ "type": "object",
620+ "properties":
621+ {
622+ "Neutral": { "type": "string" },
623+ "Focus": { "type": "string" },
624+ "Active": { "type": "string" },
625+ "Hover": { "type": "string" },
626+ "Disabled": { "type": "string" }
627+ }
628+}
629+|]
630+
631+-- ========================================================================
632+-- SingleMaybeField (single field data with optional field)
633+-- ========================================================================
634+
635+data SingleMaybeField = SingleMaybeField { singleMaybeField :: Maybe String }
636+ deriving (Show, Generic)
637+
638+instance ToJSON SingleMaybeField
639+instance ToSchema SingleMaybeField
640+
641+singleMaybeFieldSchemaJSON :: Value
642+singleMaybeFieldSchemaJSON = [aesonQQ|
643+{
644+ "type": "object",
645+ "properties":
646+ {
647+ "singleMaybeField": { "type": "string" }
648+ }
649+}
650+|]
651+
652+
653+-- ========================================================================
654+-- TimeOfDay
655+-- ========================================================================
656+data TimeOfDay
657+ = Int
658+ | Pico
659+ deriving (Generic)
660+instance ToSchema TimeOfDay
661+instance ToParamSchema TimeOfDay
662+
663+
664+timeOfDaySchemaJSON :: Value
665+timeOfDaySchemaJSON = [aesonQQ|
666+{
667+ "example": "12:33:15",
668+ "type": "string",
669+ "format": "hh:MM:ss"
670+}
671+|]
672+
673+timeOfDayParamSchemaJSON :: Value
674+timeOfDayParamSchemaJSON = [aesonQQ|
675+{
676+ "type": "string",
677+ "format": "hh:MM:ss"
678+}
679+|]
test/Data/Swagger/ParamSchemaSpec.hs+10−82
@@ -1,24 +1,29 @@
1{-# LANGUAGE DeriveGeneric #-}
1{-# LANGUAGE DeriveGeneric #-}
2−{-# LANGUAGE DeriveAnyClass #-}
2+{-# LANGUAGE DataKinds #-}
3{-# LANGUAGE ScopedTypeVariables #-}
3{-# LANGUAGE ScopedTypeVariables #-}
4{-# LANGUAGE TemplateHaskell #-}
4{-# LANGUAGE TemplateHaskell #-}
5{-# LANGUAGE QuasiQuotes #-}
5{-# LANGUAGE QuasiQuotes #-}
6+{-# LANGUAGE OverloadedStrings #-}
6module Data.Swagger.ParamSchemaSpec where
7module Data.Swagger.ParamSchemaSpec where
7
8
8import Data.Aeson
9import Data.Aeson
9−import Data.Aeson.QQ
10+import Data.Aeson.QQ.Simple
10import Data.Char
11import Data.Char
11import Data.Proxy
12import Data.Proxy
12−import Data.Set (Set)
13import GHC.Generics
13import GHC.Generics
14
14
15import Data.Swagger
15import Data.Swagger
16+import Data.Swagger.Internal (SwaggerKind(..))
16
17
18+import Data.Swagger.CommonTestTypes
17import SpecCommon
19import SpecCommon
18import Test.Hspec
20import Test.Hspec
21+import Data.Time.LocalTime
22+
23+import qualified Data.HashMap.Strict as HM
19
24
20checkToParamSchema :: ToParamSchema a => Proxy a -> Value -> Spec
25checkToParamSchema :: ToParamSchema a => Proxy a -> Value -> Spec
21−checkToParamSchema proxy js = (toParamSchema proxy :: ParamSchema Param) <=> js
26+checkToParamSchema proxy js = (toParamSchema proxy :: ParamSchema ('SwaggerKindNormal Param)) <=> js
22
27
23spec :: Spec
28spec :: Spec
24spec = do
29spec = do
@@ -29,84 +34,7 @@ spec = do
29 context "Unary records" $ do
34 context "Unary records" $ do
30 context "Email (unary record)" $ checkToParamSchema (Proxy :: Proxy Email) emailSchemaJSON
35 context "Email (unary record)" $ checkToParamSchema (Proxy :: Proxy Email) emailSchemaJSON
31 context "UserId (non-record newtype)" $ checkToParamSchema (Proxy :: Proxy UserId) userIdSchemaJSON
36 context "UserId (non-record newtype)" $ checkToParamSchema (Proxy :: Proxy UserId) userIdSchemaJSON
37+ context "TimeOfDay" $ checkToParamSchema (Proxy :: Proxy Data.Time.LocalTime.TimeOfDay) timeOfDayParamSchemaJSON
32
38
33main :: IO ()
39main :: IO ()
34main = hspec spec
40main = hspec spec
35−
36−-- ========================================================================
37−-- Unit type
38−-- ========================================================================
39−
40−data Unit = Unit deriving (Generic, ToParamSchema)
41−
42−unitSchemaJSON :: Value
43−unitSchemaJSON = [aesonQQ|
44−{
45− "type": "string",
46− "enum": ["Unit"]
47−}
48−|]
49−
50−-- ========================================================================
51−-- Color (enum)
52−-- ========================================================================
53−data Color
54− = Red
55− | Green
56− | Blue
57− deriving (Generic, ToParamSchema)
58−
59−colorSchemaJSON :: Value
60−colorSchemaJSON = [aesonQQ|
61−{
62− "type": "string",
63− "enum": ["Red", "Green", "Blue"]
64−}
65−|]
66−
67−-- ========================================================================
68−-- Status (constructorTagModifier)
69−-- ========================================================================
70−
71−data Status = StatusOk | StatusError deriving (Generic)
72−
73−instance ToParamSchema Status where
74− toParamSchema = genericToParamSchema defaultSchemaOptions
75− { constructorTagModifier = map toLower . drop (length "Status") }
76−
77−statusSchemaJSON :: Value
78−statusSchemaJSON = [aesonQQ|
79−{
80− "type": "string",
81− "enum": ["ok", "error"]
82−}
83−|]
84−
85−-- ========================================================================
86−-- Email (newtype with unwrapUnaryRecords set to True)
87−-- ========================================================================
88−
89−newtype Email = Email { getEmail :: String }
90− deriving (Generic, ToParamSchema)
91−
92−emailSchemaJSON :: Value
93−emailSchemaJSON = [aesonQQ|
94−{
95− "type": "string"
96−}
97−|]
98−
99−-- ========================================================================
100−-- UserId (non-record newtype)
101−-- ========================================================================
102−
103−newtype UserId = UserId Integer
104− deriving (Generic, ToParamSchema)
105−
106−userIdSchemaJSON :: Value
107−userIdSchemaJSON = [aesonQQ|
108−{
109− "type": "integer"
110−}
111−|]
112−
test/Data/Swagger/Schema/GeneratorSpec.hsnew file+168
@@ -0,0 +1,168 @@
1+{-# LANGUAGE OverloadedLists #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE PackageImports #-}
4+module Data.Swagger.Schema.GeneratorSpec where
5+
6+import Prelude ()
7+import Prelude.Compat
8+
9+import Data.Swagger
10+import Data.Swagger.Schema.Generator
11+
12+import Control.Lens.Operators
13+import Data.Aeson
14+import Data.Hashable (Hashable)
15+import Data.HashMap.Strict (HashMap)
16+import qualified Data.HashMap.Strict as HashMap
17+import "unordered-containers" Data.HashSet (HashSet)
18+import qualified "unordered-containers" Data.HashSet as HashSet
19+import Data.Int
20+import Data.IntMap (IntMap)
21+import Data.List.NonEmpty.Compat (NonEmpty (..), nonEmpty)
22+import Data.Map (Map, fromList)
23+import Data.Monoid (mempty)
24+import Data.Proxy
25+import Data.Proxy
26+import Data.Set (Set)
27+import qualified Data.Text as T
28+import qualified Data.Text.Lazy as TL
29+import Data.Time
30+import Data.Version (Version)
31+import Data.Word
32+import GHC.Generics
33+
34+import Test.Hspec
35+import Test.Hspec.QuickCheck
36+import Test.QuickCheck
37+
38+shouldValidate :: (FromJSON a, ToSchema a) => Proxy a -> Property
39+shouldValidate = validateFromJSON
40+
41+
42+shouldNotValidate :: (FromJSON a, ToSchema a) => Proxy a -> Property
43+shouldNotValidate = expectFailure . shouldValidate
44+
45+
46+spec :: Spec
47+spec = do
48+ describe "FromJSON validation" $ do
49+ prop "Bool" $ shouldValidate (Proxy :: Proxy Bool)
50+ prop "Char" $ shouldValidate (Proxy :: Proxy Char)
51+ prop "Double" $ shouldValidate (Proxy :: Proxy Double)
52+ prop "Float" $ shouldValidate (Proxy :: Proxy Float)
53+ prop "Int" $ shouldValidate (Proxy :: Proxy Int)
54+ prop "Int8" $ shouldValidate (Proxy :: Proxy Int8)
55+ prop "Int16" $ shouldValidate (Proxy :: Proxy Int16)
56+ prop "Int32" $ shouldValidate (Proxy :: Proxy Int32)
57+ prop "Int64" $ shouldValidate (Proxy :: Proxy Int64)
58+ prop "Integer" $ shouldValidate (Proxy :: Proxy Integer)
59+ prop "Word" $ shouldValidate (Proxy :: Proxy Word)
60+ prop "Word8" $ shouldValidate (Proxy :: Proxy Word8)
61+ prop "Word16" $ shouldValidate (Proxy :: Proxy Word16)
62+ prop "Word32" $ shouldValidate (Proxy :: Proxy Word32)
63+ prop "Word64" $ shouldValidate (Proxy :: Proxy Word64)
64+ prop "String" $ shouldValidate (Proxy :: Proxy String)
65+ prop "()" $ shouldValidate (Proxy :: Proxy ())
66+-- prop "ZonedTime" $ shouldValidate (Proxy :: Proxy ZonedTime)
67+-- prop "UTCTime" $ shouldValidate (Proxy :: Proxy UTCTime)
68+ prop "T.Text" $ shouldValidate (Proxy :: Proxy T.Text)
69+ prop "TL.Text" $ shouldValidate (Proxy :: Proxy TL.Text)
70+ prop "[String]" $ shouldValidate (Proxy :: Proxy [String])
71+ -- prop "(Maybe [Int])" $ shouldValidate (Proxy :: Proxy (Maybe [Int]))
72+ prop "(IntMap String)" $ shouldValidate (Proxy :: Proxy (IntMap String))
73+ prop "(Set Bool)" $ shouldValidate (Proxy :: Proxy (Set Bool))
74+ prop "(NonEmpty Bool)" $ shouldValidate (Proxy :: Proxy (NonEmpty Bool))
75+ prop "(HashSet Bool)" $ shouldValidate (Proxy :: Proxy (HashSet Bool))
76+ prop "(Either Int String)" $ shouldValidate (Proxy :: Proxy (Either Int String))
77+ prop "(Int, String)" $ shouldValidate (Proxy :: Proxy (Int, String))
78+ prop "(Map String Int)" $ shouldValidate (Proxy :: Proxy (Map String Int))
79+ prop "(Map T.Text Int)" $ shouldValidate (Proxy :: Proxy (Map T.Text Int))
80+ prop "(Map TL.Text Bool)" $ shouldValidate (Proxy :: Proxy (Map TL.Text Bool))
81+ prop "(HashMap String Int)" $ shouldValidate (Proxy :: Proxy (HashMap String Int))
82+ prop "(HashMap T.Text Int)" $ shouldValidate (Proxy :: Proxy (HashMap T.Text Int))
83+ prop "(HashMap TL.Text Bool)" $ shouldValidate (Proxy :: Proxy (HashMap TL.Text Bool))
84+ prop "Object" $ shouldValidate (Proxy :: Proxy Object)
85+ prop "(Int, String, Double)" $ shouldValidate (Proxy :: Proxy (Int, String, Double))
86+ prop "(Int, String, Double, [Int])" $ shouldValidate (Proxy :: Proxy (Int, String, Double, [Int]))
87+ prop "(Int, String, Double, [Int], Int)" $ shouldValidate (Proxy :: Proxy (Int, String, Double, [Int], Int))
88+ describe "Invalid FromJSON validation" $ do
89+ prop "WrongType" $ shouldNotValidate (Proxy :: Proxy WrongType)
90+ prop "MissingRequired" $ shouldNotValidate (Proxy :: Proxy MissingRequired)
91+ prop "MissingProperty" $ shouldNotValidate (Proxy :: Proxy MissingProperty)
92+ prop "WrongPropType" $ shouldNotValidate (Proxy :: Proxy WrongPropType)
93+
94+-- =============================
95+-- Data types and bunk instances
96+-- =============================
97+
98+data WrongType = WrongType Bool
99+
100+instance FromJSON WrongType where
101+ parseJSON = withBool "WrongType" $ return . WrongType
102+
103+instance ToSchema WrongType where
104+ declareNamedSchema _ = return . NamedSchema (Just "WrongType") $
105+ mempty
106+ & type_ ?~ SwaggerObject
107+
108+
109+data MissingRequired = MissingRequired
110+ { propA :: String
111+ , propB :: Bool
112+ }
113+
114+instance FromJSON MissingRequired where
115+ parseJSON = withObject "MissingRequired" $ \o ->
116+ MissingRequired
117+ <$> o .: "propA"
118+ <*> o .: "propB"
119+
120+instance ToSchema MissingRequired where
121+ declareNamedSchema _ = do
122+ stringSchema <- declareSchemaRef (Proxy :: Proxy String)
123+ boolSchema <- declareSchemaRef (Proxy :: Proxy Bool)
124+ return . NamedSchema (Just "MissingRequired") $
125+ mempty
126+ & type_ ?~ SwaggerObject
127+ & properties .~ [("propA", stringSchema)
128+ ,("propB", boolSchema)
129+ ]
130+ & required .~ ["propA"]
131+
132+data MissingProperty = MissingProperty
133+ { propC :: String
134+ , propD :: Bool
135+ }
136+
137+instance FromJSON MissingProperty where
138+ parseJSON = withObject "MissingProperty" $ \o ->
139+ MissingProperty
140+ <$> o .: "propC"
141+ <*> o .: "propD"
142+
143+instance ToSchema MissingProperty where
144+ declareNamedSchema _ = do
145+ stringSchema <- declareSchemaRef (Proxy :: Proxy String)
146+ return . NamedSchema (Just "MissingProperty") $
147+ mempty
148+ & type_ ?~ SwaggerObject
149+ & properties .~ [("propC", stringSchema)]
150+ & required .~ ["propC"]
151+
152+data WrongPropType = WrongPropType
153+ { propE :: String
154+ }
155+
156+instance FromJSON WrongPropType where
157+ parseJSON = withObject "WrongPropType" $ \o ->
158+ WrongPropType
159+ <$> o .: "propE"
160+
161+instance ToSchema WrongPropType where
162+ declareNamedSchema _ = do
163+ boolSchema <- declareSchemaRef (Proxy :: Proxy Bool)
164+ return . NamedSchema (Just "WrongPropType") $
165+ mempty
166+ & type_ ?~ SwaggerObject
167+ & properties .~ [("propE", boolSchema)]
168+ & required .~ ["propE"]
test/Data/Swagger/Schema/ValidationSpec.hsnew file+278
@@ -0,0 +1,278 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DeriveGeneric #-}
3+{-# LANGUAGE PackageImports #-}
4+{-# LANGUAGE RecordWildCards #-}
5+{-# LANGUAGE ScopedTypeVariables #-}
6+{-# OPTIONS_GHC -fno-warn-orphans #-}
7+module Data.Swagger.Schema.ValidationSpec where
8+
9+import Control.Applicative
10+import Control.Lens ((&), (.~), (?~))
11+import Data.Aeson
12+import Data.Aeson.Types
13+import Data.Hashable (Hashable)
14+import Data.HashMap.Strict (HashMap)
15+import qualified Data.HashMap.Strict as HashMap
16+import "unordered-containers" Data.HashSet (HashSet)
17+import qualified "unordered-containers" Data.HashSet as HashSet
18+import Data.Int
19+import Data.IntMap (IntMap)
20+import Data.List.NonEmpty.Compat (NonEmpty (..), nonEmpty)
21+import Data.Map (Map, fromList)
22+import Data.Monoid (mempty)
23+import Data.Proxy
24+import Data.Set (Set)
25+import qualified Data.Text as T
26+import qualified Data.Text.Lazy as TL
27+import Data.Time
28+import Data.Version (Version)
29+import Data.Word
30+import GHC.Generics
31+
32+import Data.Swagger
33+import Data.Swagger.Declare
34+
35+import Test.Hspec
36+import Test.Hspec.QuickCheck
37+import Test.QuickCheck
38+import Test.QuickCheck.Instances ()
39+
40+shouldValidate :: (ToJSON a, ToSchema a) => Proxy a -> a -> Bool
41+shouldValidate _ x = validateToJSON x == []
42+
43+shouldNotValidate :: forall a. ToSchema a => (a -> Value) -> a -> Bool
44+shouldNotValidate f = not . null . validateJSON defs sch . f
45+ where
46+ (defs, sch) = runDeclare (declareSchema (Proxy :: Proxy a)) mempty
47+
48+spec :: Spec
49+spec = do
50+ describe "Validation" $ do
51+ prop "Bool" $ shouldValidate (Proxy :: Proxy Bool)
52+ prop "Char" $ shouldValidate (Proxy :: Proxy Char)
53+ prop "Double" $ shouldValidate (Proxy :: Proxy Double)
54+ prop "Float" $ shouldValidate (Proxy :: Proxy Float)
55+ prop "Int" $ shouldValidate (Proxy :: Proxy Int)
56+ prop "Int8" $ shouldValidate (Proxy :: Proxy Int8)
57+ prop "Int16" $ shouldValidate (Proxy :: Proxy Int16)
58+ prop "Int32" $ shouldValidate (Proxy :: Proxy Int32)
59+ prop "Int64" $ shouldValidate (Proxy :: Proxy Int64)
60+ prop "Integer" $ shouldValidate (Proxy :: Proxy Integer)
61+ prop "Word" $ shouldValidate (Proxy :: Proxy Word)
62+ prop "Word8" $ shouldValidate (Proxy :: Proxy Word8)
63+ prop "Word16" $ shouldValidate (Proxy :: Proxy Word16)
64+ prop "Word32" $ shouldValidate (Proxy :: Proxy Word32)
65+ prop "Word64" $ shouldValidate (Proxy :: Proxy Word64)
66+ prop "String" $ shouldValidate (Proxy :: Proxy String)
67+ prop "()" $ shouldValidate (Proxy :: Proxy ())
68+ prop "ZonedTime" $ shouldValidate (Proxy :: Proxy ZonedTime)
69+ prop "UTCTime" $ shouldValidate (Proxy :: Proxy UTCTime)
70+ prop "T.Text" $ shouldValidate (Proxy :: Proxy T.Text)
71+ prop "TL.Text" $ shouldValidate (Proxy :: Proxy TL.Text)
72+ prop "[String]" $ shouldValidate (Proxy :: Proxy [String])
73+ -- prop "(Maybe [Int])" $ shouldValidate (Proxy :: Proxy (Maybe [Int]))
74+ prop "(IntMap String)" $ shouldValidate (Proxy :: Proxy (IntMap String))
75+ prop "(Set Bool)" $ shouldValidate (Proxy :: Proxy (Set Bool))
76+ prop "(NonEmpty Bool)" $ shouldValidate (Proxy :: Proxy (NonEmpty Bool))
77+ prop "(HashSet Bool)" $ shouldValidate (Proxy :: Proxy (HashSet Bool))
78+ prop "(Either Int String)" $ shouldValidate (Proxy :: Proxy (Either Int String))
79+ prop "(Int, String)" $ shouldValidate (Proxy :: Proxy (Int, String))
80+ prop "(Map String Int)" $ shouldValidate (Proxy :: Proxy (Map String Int))
81+ prop "(Map T.Text Int)" $ shouldValidate (Proxy :: Proxy (Map T.Text Int))
82+ prop "(Map TL.Text Bool)" $ shouldValidate (Proxy :: Proxy (Map TL.Text Bool))
83+ prop "(HashMap String Int)" $ shouldValidate (Proxy :: Proxy (HashMap String Int))
84+ prop "(HashMap T.Text Int)" $ shouldValidate (Proxy :: Proxy (HashMap T.Text Int))
85+ prop "(HashMap TL.Text Bool)" $ shouldValidate (Proxy :: Proxy (HashMap TL.Text Bool))
86+ prop "Object" $ shouldValidate (Proxy :: Proxy Object)
87+ prop "(Int, String, Double)" $ shouldValidate (Proxy :: Proxy (Int, String, Double))
88+ prop "(Int, String, Double, [Int])" $ shouldValidate (Proxy :: Proxy (Int, String, Double, [Int]))
89+ prop "(Int, String, Double, [Int], Int)" $ shouldValidate (Proxy :: Proxy (Int, String, Double, [Int], Int))
90+ prop "Person" $ shouldValidate (Proxy :: Proxy Person)
91+ prop "Color" $ shouldValidate (Proxy :: Proxy Color)
92+ prop "Paint" $ shouldValidate (Proxy :: Proxy Paint)
93+ prop "MyRoseTree" $ shouldValidate (Proxy :: Proxy MyRoseTree)
94+ prop "Light" $ shouldValidate (Proxy :: Proxy Light)
95+ prop "ButtonImages" $ shouldValidate (Proxy :: Proxy ButtonImages)
96+ prop "Version" $ shouldValidate (Proxy :: Proxy Version)
97+ prop "FreeForm" $ shouldValidate (Proxy :: Proxy FreeForm)
98+
99+ describe "invalid cases" $ do
100+ prop "invalidPersonToJSON" $ shouldNotValidate invalidPersonToJSON
101+ prop "invalidColorToJSON" $ shouldNotValidate invalidColorToJSON
102+ prop "invalidPaintToJSON" $ shouldNotValidate invalidPaintToJSON
103+ prop "invalidLightToJSON" $ shouldNotValidate invalidLightToJSON
104+ prop "invalidButtonImagesToJSON" $ shouldNotValidate invalidButtonImagesToJSON
105+
106+main :: IO ()
107+main = hspec spec
108+
109+-- ========================================================================
110+-- Person (simple record with optional fields)
111+-- ========================================================================
112+data Person = Person
113+ { name :: String
114+ , phone :: Integer
115+ , email :: Maybe String
116+ } deriving (Show, Generic)
117+
118+instance ToJSON Person
119+instance ToSchema Person
120+
121+instance Arbitrary Person where
122+ arbitrary = Person <$> arbitrary <*> arbitrary <*> arbitrary
123+
124+invalidPersonToJSON :: Person -> Value
125+invalidPersonToJSON Person{..} = object
126+ [ T.pack "personName" .= toJSON name
127+ , T.pack "personPhone" .= toJSON phone
128+ , T.pack "personEmail" .= toJSON email
129+ ]
130+
131+-- ========================================================================
132+-- Color (enum)
133+-- ========================================================================
134+data Color = Red | Green | Blue deriving (Show, Generic, Bounded, Enum)
135+
136+instance ToJSON Color
137+instance ToSchema Color
138+
139+instance Arbitrary Color where
140+ arbitrary = arbitraryBoundedEnum
141+
142+invalidColorToJSON :: Color -> Value
143+invalidColorToJSON Red = toJSON "red"
144+invalidColorToJSON Green = toJSON "green"
145+invalidColorToJSON Blue = toJSON "blue"
146+
147+-- ========================================================================
148+-- Paint (record with bounded enum property)
149+-- ========================================================================
150+
151+newtype Paint = Paint { color :: Color }
152+ deriving (Show, Generic)
153+
154+instance ToJSON Paint
155+instance ToSchema Paint
156+
157+instance Arbitrary Paint where
158+ arbitrary = Paint <$> arbitrary
159+
160+invalidPaintToJSON :: Paint -> Value
161+invalidPaintToJSON = toJSON . color
162+
163+-- ========================================================================
164+-- MyRoseTree (custom datatypeNameModifier)
165+-- ========================================================================
166+
167+data MyRoseTree = MyRoseTree
168+ { root :: String
169+ , trees :: [MyRoseTree]
170+ } deriving (Show, Generic)
171+
172+instance ToJSON MyRoseTree
173+
174+instance ToSchema MyRoseTree where
175+ declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions
176+ { datatypeNameModifier = drop (length "My") }
177+
178+instance Arbitrary MyRoseTree where
179+ arbitrary = fmap (cut limit) $ MyRoseTree <$> arbitrary <*> (take limit <$> arbitrary)
180+ where
181+ limit = 4
182+ cut 0 (MyRoseTree x _ ) = MyRoseTree x []
183+ cut n (MyRoseTree x xs) = MyRoseTree x (map (cut (n - 1)) xs)
184+
185+-- ========================================================================
186+-- Light (sum type)
187+-- ========================================================================
188+
189+data Light = NoLight | LightFreq Double | LightColor Color deriving (Show, Generic)
190+
191+instance ToSchema Light where
192+ declareNamedSchema = genericDeclareNamedSchemaUnrestricted defaultSchemaOptions
193+
194+instance ToJSON Light where
195+ toJSON = genericToJSON defaultOptions { sumEncoding = ObjectWithSingleField }
196+
197+instance Arbitrary Light where
198+ arbitrary = oneof
199+ [ return NoLight
200+ , LightFreq <$> arbitrary
201+ , LightColor <$> arbitrary
202+ ]
203+
204+invalidLightToJSON :: Light -> Value
205+invalidLightToJSON = genericToJSON defaultOptions
206+
207+-- ========================================================================
208+-- ButtonImages (bounded enum key mapping)
209+-- ========================================================================
210+
211+data ButtonState = Neutral | Focus | Active | Hover | Disabled
212+ deriving (Show, Eq, Ord, Bounded, Enum, Generic)
213+
214+instance ToJSON ButtonState
215+instance ToSchema ButtonState
216+instance ToJSONKey ButtonState where toJSONKey = toJSONKeyText (T.pack . show)
217+
218+instance Arbitrary ButtonState where
219+ arbitrary = arbitraryBoundedEnum
220+
221+type ImageUrl = T.Text
222+
223+newtype ButtonImages = ButtonImages { getButtonImages :: Map ButtonState ImageUrl }
224+ deriving (Show, Generic)
225+
226+instance ToJSON ButtonImages where
227+ toJSON = toJSON . getButtonImages
228+
229+instance ToSchema ButtonImages where
230+ declareNamedSchema = genericDeclareNamedSchemaNewtype defaultSchemaOptions
231+ declareSchemaBoundedEnumKeyMapping
232+
233+invalidButtonImagesToJSON :: ButtonImages -> Value
234+invalidButtonImagesToJSON = genericToJSON defaultOptions
235+
236+instance Arbitrary ButtonImages where
237+ arbitrary = ButtonImages <$> arbitrary
238+
239+-- ========================================================================
240+-- FreeForm (wraps a raw JSON Value)
241+-- ========================================================================
242+
243+data FreeForm = FreeForm { jsonContent :: Map T.Text Value }
244+ deriving (Show, Generic)
245+
246+instance ToJSON FreeForm where
247+ toJSON = toJSON . jsonContent
248+
249+instance ToSchema FreeForm where
250+ declareNamedSchema _ = pure $ NamedSchema (Just $ T.pack "FreeForm") $ mempty
251+ & type_ ?~ SwaggerObject
252+ & additionalProperties ?~ AdditionalPropertiesAllowed True
253+
254+instance Arbitrary FreeForm where
255+ arbitrary = (FreeForm . fromList) <$> genObj
256+ where
257+ genObj = listOf $ do
258+ k <- arbitrary
259+ v <- oneof [ String <$> arbitrary, Number <$> arbitrary, Bool <$> arbitrary, pure Null ]
260+ pure (k, v)
261+
262+instance Eq ZonedTime where
263+ ZonedTime t (TimeZone x _ _) == ZonedTime t' (TimeZone y _ _) = t == t' && x == y
264+
265+-- ========================================================================
266+-- Arbitrary instance for Data.Aeson.Value
267+-- ========================================================================
268+
269+instance Arbitrary Value where
270+ -- Weights are almost random
271+ -- Uniform oneof tends not to build complex objects cause of recursive call.
272+ arbitrary = resize 4 $ frequency
273+ [ (3, Object <$> arbitrary)
274+ , (3, Array <$> arbitrary)
275+ , (3, String <$> arbitrary)
276+ , (3, Number <$> arbitrary)
277+ , (3, Bool <$> arbitrary)
278+ , (1, return Null) ]
test/Data/Swagger/SchemaSpec.hs+32−504
@@ -1,27 +1,29 @@
1{-# LANGUAGE DeriveGeneric #-}
1{-# LANGUAGE DeriveGeneric #-}
2−{-# LANGUAGE DeriveAnyClass #-}
3{-# LANGUAGE ScopedTypeVariables #-}
2{-# LANGUAGE ScopedTypeVariables #-}
4{-# LANGUAGE TemplateHaskell #-}
3{-# LANGUAGE TemplateHaskell #-}
5{-# LANGUAGE QuasiQuotes #-}
4{-# LANGUAGE QuasiQuotes #-}
6module Data.Swagger.SchemaSpec where
5module Data.Swagger.SchemaSpec where
7
6
8−import Data.Aeson
7+import Prelude ()
9−import Data.Aeson.QQ
8+import Prelude.Compat
9+
10+import Control.Lens ((^.))
10−import Data.Char
11+import Data.Aeson (Value)
11−import qualified Data.HashMap.Strict as HashMap
12+import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
12import Data.Proxy
13import Data.Proxy
13import Data.Set (Set)
14import Data.Set (Set)
14−import qualified Data.Set as Set
15−import Data.Text (Text)
16import qualified Data.Text as Text
15import qualified Data.Text as Text
17−import GHC.Generics
18
16
19import Data.Swagger
17import Data.Swagger
20import Data.Swagger.Declare
18import Data.Swagger.Declare
21
19
20+import Data.Swagger.CommonTestTypes
22import SpecCommon
21import SpecCommon
23import Test.Hspec
22import Test.Hspec
24
23
24+import qualified Data.HashMap.Strict as HM
25+import Data.Time.LocalTime
26+
25checkToSchema :: ToSchema a => Proxy a -> Value -> Spec
27checkToSchema :: ToSchema a => Proxy a -> Value -> Spec
26checkToSchema proxy js = toSchema proxy <=> js
28checkToSchema proxy js = toSchema proxy <=> js
27
29
@@ -33,22 +35,29 @@ checkSchemaName sname proxy =
33checkDefs :: ToSchema a => Proxy a -> [String] -> Spec
35checkDefs :: ToSchema a => Proxy a -> [String] -> Spec
34checkDefs proxy names =
36checkDefs proxy names =
35 it ("uses these definitions " ++ show names) $
37 it ("uses these definitions " ++ show names) $
36− Set.fromList (HashMap.keys defs) `shouldBe` Set.fromList (map Text.pack names)
38+ InsOrdHashMap.keys defs `shouldBe` map Text.pack names
37 where
39 where
38 defs = execDeclare (declareNamedSchema proxy) mempty
40 defs = execDeclare (declareNamedSchema proxy) mempty
39
41
42+checkProperties :: ToSchema a => Proxy a -> [String] -> Spec
43+checkProperties proxy names =
44+ it ("has these fields in order " ++ show names) $
45+ InsOrdHashMap.keys fields `shouldBe` map Text.pack names
46+ where
47+ fields = toSchema proxy ^. properties
48+
40checkInlinedSchema :: ToSchema a => Proxy a -> Value -> Spec
49checkInlinedSchema :: ToSchema a => Proxy a -> Value -> Spec
41checkInlinedSchema proxy js = toInlinedSchema proxy <=> js
50checkInlinedSchema proxy js = toInlinedSchema proxy <=> js
42
51
43checkInlinedSchemas :: ToSchema a => [String] -> Proxy a -> Value -> Spec
52checkInlinedSchemas :: ToSchema a => [String] -> Proxy a -> Value -> Spec
44−checkInlinedSchemas names proxy js = inlineSchemas (map Text.pack names) defs schema <=> js
53+checkInlinedSchemas names proxy js = inlineSchemas (map Text.pack names) defs s <=> js
45 where
54 where
46− (defs, schema) = runDeclare (declareSchema proxy) mempty
55+ (defs, s) = runDeclare (declareSchema proxy) mempty
47
56
48checkInlinedRecSchema :: ToSchema a => Proxy a -> Value -> Spec
57checkInlinedRecSchema :: ToSchema a => Proxy a -> Value -> Spec
49−checkInlinedRecSchema proxy js = inlineNonRecursiveSchemas defs schema <=> js
58+checkInlinedRecSchema proxy js = inlineNonRecursiveSchemas defs s <=> js
50 where
59 where
51− (defs, schema) = runDeclare (declareSchema proxy) mempty
60+ (defs, s) = runDeclare (declareSchema proxy) mempty
52
61
53spec :: Spec
62spec :: Spec
54spec = do
63spec = do
@@ -57,6 +66,9 @@ spec = do
57 context "Person" $ checkToSchema (Proxy :: Proxy Person) personSchemaJSON
66 context "Person" $ checkToSchema (Proxy :: Proxy Person) personSchemaJSON
58 context "ISPair" $ checkToSchema (Proxy :: Proxy ISPair) ispairSchemaJSON
67 context "ISPair" $ checkToSchema (Proxy :: Proxy ISPair) ispairSchemaJSON
59 context "Point (fieldLabelModifier)" $ checkToSchema (Proxy :: Proxy Point) pointSchemaJSON
68 context "Point (fieldLabelModifier)" $ checkToSchema (Proxy :: Proxy Point) pointSchemaJSON
69+ context "Point5 (many field record)" $ do
70+ checkToSchema (Proxy :: Proxy Point5) point5SchemaJSON
71+ checkProperties (Proxy :: Proxy Point5) point5Properties
60 context "Color (bounded enum)" $ checkToSchema (Proxy :: Proxy Color) colorSchemaJSON
72 context "Color (bounded enum)" $ checkToSchema (Proxy :: Proxy Color) colorSchemaJSON
61 context "Shade (paramSchemaToNamedSchema)" $ checkToSchema (Proxy :: Proxy Shade) shadeSchemaJSON
73 context "Shade (paramSchemaToNamedSchema)" $ checkToSchema (Proxy :: Proxy Shade) shadeSchemaJSON
62 context "Paint (record with bounded enum field)" $ checkToSchema (Proxy :: Proxy Paint) paintSchemaJSON
74 context "Paint (record with bounded enum field)" $ checkToSchema (Proxy :: Proxy Paint) paintSchemaJSON
@@ -65,8 +77,10 @@ spec = do
65 context "Email (unwrapUnaryRecords)" $ checkToSchema (Proxy :: Proxy Email) emailSchemaJSON
77 context "Email (unwrapUnaryRecords)" $ checkToSchema (Proxy :: Proxy Email) emailSchemaJSON
66 context "UserId (non-record newtype)" $ checkToSchema (Proxy :: Proxy UserId) userIdSchemaJSON
78 context "UserId (non-record newtype)" $ checkToSchema (Proxy :: Proxy UserId) userIdSchemaJSON
67 context "Player (unary record)" $ checkToSchema (Proxy :: Proxy Player) playerSchemaJSON
79 context "Player (unary record)" $ checkToSchema (Proxy :: Proxy Player) playerSchemaJSON
80+ context "SingleMaybeField (unary record with Maybe)" $ checkToSchema (Proxy :: Proxy SingleMaybeField) singleMaybeFieldSchemaJSON
68 context "Players (inlining schema)" $ checkToSchema (Proxy :: Proxy Players) playersSchemaJSON
81 context "Players (inlining schema)" $ checkToSchema (Proxy :: Proxy Players) playersSchemaJSON
69 context "MyRoseTree (datatypeNameModifier)" $ checkToSchema (Proxy :: Proxy MyRoseTree) myRoseTreeSchemaJSON
82 context "MyRoseTree (datatypeNameModifier)" $ checkToSchema (Proxy :: Proxy MyRoseTree) myRoseTreeSchemaJSON
83+ context "MyRoseTree' (datatypeNameModifier)" $ checkToSchema (Proxy :: Proxy MyRoseTree') myRoseTreeSchemaJSON'
70 context "Sum types" $ do
84 context "Sum types" $ do
71 context "Status (sum of unary constructors)" $ checkToSchema (Proxy :: Proxy Status) statusSchemaJSON
85 context "Status (sum of unary constructors)" $ checkToSchema (Proxy :: Proxy Status) statusSchemaJSON
72 context "Character (ref and record sum)" $ checkToSchema (Proxy :: Proxy Character) characterSchemaJSON
86 context "Character (ref and record sum)" $ checkToSchema (Proxy :: Proxy Character) characterSchemaJSON
@@ -82,6 +96,7 @@ spec = do
82 context "Light" $ checkDefs (Proxy :: Proxy Light) ["Color"]
96 context "Light" $ checkDefs (Proxy :: Proxy Light) ["Color"]
83 context "Character" $ checkDefs (Proxy :: Proxy Character) ["Player", "Point"]
97 context "Character" $ checkDefs (Proxy :: Proxy Character) ["Player", "Point"]
84 context "MyRoseTree" $ checkDefs (Proxy :: Proxy MyRoseTree) ["RoseTree"]
98 context "MyRoseTree" $ checkDefs (Proxy :: Proxy MyRoseTree) ["RoseTree"]
99+ context "MyRoseTree'" $ checkDefs (Proxy :: Proxy MyRoseTree') ["myrosetree'"]
85 context "[Set (Unit, Maybe Color)]" $ checkDefs (Proxy :: Proxy [Set (Unit, Maybe Color)]) ["Unit", "Color"]
100 context "[Set (Unit, Maybe Color)]" $ checkDefs (Proxy :: Proxy [Set (Unit, Maybe Color)]) ["Unit", "Color"]
86 context "ResourceId" $ checkDefs (Proxy :: Proxy ResourceId) []
101 context "ResourceId" $ checkDefs (Proxy :: Proxy ResourceId) []
87 describe "Inlining Schemas" $ do
102 describe "Inlining Schemas" $ do
@@ -90,497 +105,10 @@ spec = do
90 context "Character (inlining only Player)" $ checkInlinedSchemas ["Player"] (Proxy :: Proxy Character) characterInlinedPlayerSchemaJSON
105 context "Character (inlining only Player)" $ checkInlinedSchemas ["Player"] (Proxy :: Proxy Character) characterInlinedPlayerSchemaJSON
91 context "Light" $ checkInlinedSchema (Proxy :: Proxy Light) lightInlinedSchemaJSON
106 context "Light" $ checkInlinedSchema (Proxy :: Proxy Light) lightInlinedSchemaJSON
92 context "MyRoseTree (inlineNonRecursiveSchemas)" $ checkInlinedRecSchema (Proxy :: Proxy MyRoseTree) myRoseTreeSchemaJSON
107 context "MyRoseTree (inlineNonRecursiveSchemas)" $ checkInlinedRecSchema (Proxy :: Proxy MyRoseTree) myRoseTreeSchemaJSON
108+ context "MyRoseTree' (inlineNonRecursiveSchemas)" $ checkInlinedRecSchema (Proxy :: Proxy MyRoseTree') myRoseTreeSchemaJSON'
109+ describe "Bounded Enum key mapping" $ do
110+ context "ButtonImages" $ checkToSchema (Proxy :: Proxy ButtonImages) buttonImagesSchemaJSON
111+ context "TimeOfDay" $ checkToSchema (Proxy :: Proxy Data.Time.LocalTime.TimeOfDay) timeOfDaySchemaJSON
93
112
94main :: IO ()
113main :: IO ()
95main = hspec spec
114main = hspec spec
96−
97−-- ========================================================================
98−-- Person (simple record with optional fields)
99−-- ========================================================================
100−data Person = Person
101− { name :: String
102− , phone :: Integer
103− , email :: Maybe String
104− } deriving (Generic, ToSchema)
105−
106−personSchemaJSON :: Value
107−personSchemaJSON = [aesonQQ|
108−{
109− "type": "object",
110− "properties":
111− {
112− "name": { "type": "string" },
113− "phone": { "type": "integer" },
114− "email": { "type": "string" }
115− },
116− "required": ["name", "phone"]
117−}
118−|]
119−
120−-- ========================================================================
121−-- ISPair (non-record product data type)
122−-- ========================================================================
123−data ISPair = ISPair Integer String
124− deriving (Generic, ToSchema)
125−
126−ispairSchemaJSON :: Value
127−ispairSchemaJSON = [aesonQQ|
128−{
129− "type": "array",
130− "items":
131− [
132− { "type": "integer" },
133− { "type": "string" }
134− ]
135−}
136−|]
137−
138−-- ========================================================================
139−-- Point (record data type with custom fieldLabelModifier)
140−-- ========================================================================
141−data Point = Point
142− { pointX :: Double
143− , pointY :: Double
144− } deriving (Generic)
145−
146−instance ToSchema Point where
147− declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions
148− { fieldLabelModifier = map toLower . drop (length "point") }
149−
150−pointSchemaJSON :: Value
151−pointSchemaJSON = [aesonQQ|
152−{
153− "type": "object",
154− "properties":
155− {
156− "x": { "type": "number", "format": "double" },
157− "y": { "type": "number", "format": "double" }
158− },
159− "required": ["x", "y"]
160−}
161−|]
162−
163−
164−-- ========================================================================
165−-- Color (enum)
166−-- ========================================================================
167−data Color
168− = Red
169− | Green
170− | Blue
171− deriving (Generic, ToSchema)
172−
173−colorSchemaJSON :: Value
174−colorSchemaJSON = [aesonQQ|
175−{
176− "type": "string",
177− "enum": ["Red", "Green", "Blue"]
178−}
179−|]
180−
181−-- ========================================================================
182−-- Shade (paramSchemaToNamedSchema)
183−-- ========================================================================
184−
185−data Shade = Dim | Bright deriving (Generic, ToParamSchema)
186−
187−instance ToSchema Shade where declareNamedSchema = pure . paramSchemaToNamedSchema defaultSchemaOptions
188−
189−shadeSchemaJSON :: Value
190−shadeSchemaJSON = [aesonQQ|
191−{
192− "type": "string",
193− "enum": ["Dim", "Bright"]
194−}
195−|]
196−
197−-- ========================================================================
198−-- Paint (record with bounded enum property)
199−-- ========================================================================
200−
201−newtype Paint = Paint { color :: Color }
202− deriving (Generic, ToSchema)
203−
204−paintSchemaJSON :: Value
205−paintSchemaJSON = [aesonQQ|
206−{
207− "type": "object",
208− "properties":
209− {
210− "color":
211− {
212− "$ref": "#/definitions/Color"
213− }
214− },
215− "required": ["color"]
216−}
217−|]
218−
219−paintInlinedSchemaJSON :: Value
220−paintInlinedSchemaJSON = [aesonQQ|
221−{
222− "type": "object",
223− "properties":
224− {
225− "color":
226− {
227− "type": "string",
228− "enum": ["Red", "Green", "Blue"]
229− }
230− },
231− "required": ["color"]
232−}
233−|]
234−
235−-- ========================================================================
236−-- Email (newtype with unwrapUnaryRecords set to True)
237−-- ========================================================================
238−
239−newtype Email = Email { getEmail :: String }
240− deriving (Generic)
241−
242−instance ToSchema Email where
243− declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions
244− { unwrapUnaryRecords = True }
245−
246−emailSchemaJSON :: Value
247−emailSchemaJSON = [aesonQQ|
248−{
249− "type": "string"
250−}
251−|]
252−
253−-- ========================================================================
254−-- UserId (non-record newtype)
255−-- ========================================================================
256−
257−newtype UserId = UserId Integer
258− deriving (Eq, Ord, Generic, ToSchema)
259−
260−userIdSchemaJSON :: Value
261−userIdSchemaJSON = [aesonQQ|
262−{
263− "type": "integer"
264−}
265−|]
266−
267−-- ========================================================================
268−-- UserGroup (set newtype)
269−-- ========================================================================
270−
271−newtype UserGroup = UserGroup (Set UserId)
272− deriving (Generic, ToSchema)
273−
274−userGroupSchemaJSON :: Value
275−userGroupSchemaJSON = [aesonQQ|
276−{
277− "type": "array",
278− "items": { "$ref": "#/definitions/UserId" },
279− "uniqueItems": true
280−}
281−|]
282−
283−-- ========================================================================
284−-- Player (record newtype)
285−-- ========================================================================
286−
287−newtype Player = Player
288− { position :: Point
289− } deriving (Generic, ToSchema)
290−
291−playerSchemaJSON :: Value
292−playerSchemaJSON = [aesonQQ|
293−{
294− "type": "object",
295− "properties":
296− {
297− "position":
298− {
299− "$ref": "#/definitions/Point"
300− }
301− },
302− "required": ["position"]
303−}
304−|]
305−
306−-- ========================================================================
307−-- MyRoseTree (custom datatypeNameModifier)
308−-- ========================================================================
309−
310−data MyRoseTree = MyRoseTree
311− { root :: String
312− , trees :: [MyRoseTree]
313− } deriving (Generic)
314−
315−instance ToSchema MyRoseTree where
316− declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions
317− { datatypeNameModifier = drop (length "My") }
318−
319−myRoseTreeSchemaJSON :: Value
320−myRoseTreeSchemaJSON = [aesonQQ|
321−{
322− "type": "object",
323− "properties":
324− {
325− "root": { "type": "string" },
326− "trees":
327− {
328− "type": "array",
329− "items":
330− {
331− "$ref": "#/definitions/RoseTree"
332− }
333− }
334− },
335− "required": ["root", "trees"]
336−}
337−|]
338−
339−-- ========================================================================
340−-- Inlined (newtype for inlining schemas)
341−-- ========================================================================
342−
343−newtype Inlined a = Inlined { getInlined :: a }
344−
345−instance ToSchema a => ToSchema (Inlined a) where
346− declareNamedSchema _ = unname <$> declareNamedSchema (Proxy :: Proxy a)
347− where
348− unname (NamedSchema _ schema) = NamedSchema Nothing schema
349−
350−newtype Players = Players [Inlined Player]
351− deriving (Generic, ToSchema)
352−
353−playersSchemaJSON :: Value
354−playersSchemaJSON = [aesonQQ|
355−{
356− "type": "array",
357− "items":
358− {
359− "type": "object",
360− "properties":
361− {
362− "position":
363− {
364− "$ref": "#/definitions/Point"
365− }
366− },
367− "required": ["position"]
368− }
369−}
370−|]
371−
372−-- ========================================================================
373−-- Status (sum type with unary constructors)
374−-- ========================================================================
375−
376−data Status
377− = StatusOk String
378− | StatusError String
379− deriving (Generic)
380−
381−instance ToSchema Status where
382− declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions
383− { constructorTagModifier = map toLower . drop (length "Status") }
384−
385−statusSchemaJSON :: Value
386−statusSchemaJSON = [aesonQQ|
387−{
388− "type": "object",
389− "properties":
390− {
391− "ok": { "type": "string" },
392− "error": { "type": "string" }
393− },
394− "maxProperties": 1,
395− "minProperties": 1
396−}
397−|]
398−
399−-- ========================================================================
400−-- Unit type
401−-- ========================================================================
402−
403−data Unit = Unit deriving (Generic, ToSchema)
404−
405−unitSchemaJSON :: Value
406−unitSchemaJSON = [aesonQQ|
407−{
408− "type": "string",
409− "enum": ["Unit"]
410−}
411−|]
412−
413−
414−-- ========================================================================
415−-- Character (sum type with ref and record in alternative)
416−-- ========================================================================
417−
418−data Character
419− = PC Player
420− | NPC { npcName :: String, npcPosition :: Point }
421− deriving (Generic, ToSchema)
422−
423−characterSchemaJSON :: Value
424−characterSchemaJSON = [aesonQQ|
425−{
426− "type": "object",
427− "properties":
428− {
429− "PC": { "$ref": "#/definitions/Player" },
430− "NPC":
431− {
432− "type": "object",
433− "properties":
434− {
435− "npcName": { "type": "string" },
436− "npcPosition": { "$ref": "#/definitions/Point" }
437− },
438− "required": ["npcName", "npcPosition"]
439− }
440− },
441− "maxProperties": 1,
442− "minProperties": 1
443−}
444−|]
445−
446−characterInlinedSchemaJSON :: Value
447−characterInlinedSchemaJSON = [aesonQQ|
448−{
449− "type": "object",
450− "properties":
451− {
452− "PC":
453− {
454− "type": "object",
455− "properties":
456− {
457− "position":
458− {
459− "type": "object",
460− "properties":
461− {
462− "x": { "type": "number", "format": "double" },
463− "y": { "type": "number", "format": "double" }
464− },
465− "required": ["x", "y"]
466− }
467− },
468− "required": ["position"]
469− },
470− "NPC":
471− {
472− "type": "object",
473− "properties":
474− {
475− "npcName": { "type": "string" },
476− "npcPosition":
477− {
478− "type": "object",
479− "properties":
480− {
481− "x": { "type": "number", "format": "double" },
482− "y": { "type": "number", "format": "double" }
483− },
484− "required": ["x", "y"]
485− }
486− },
487− "required": ["npcName", "npcPosition"]
488− }
489− },
490− "maxProperties": 1,
491− "minProperties": 1
492−}
493−|]
494−
495−characterInlinedPlayerSchemaJSON :: Value
496−characterInlinedPlayerSchemaJSON = [aesonQQ|
497−{
498− "type": "object",
499− "properties":
500− {
501− "PC":
502− {
503− "type": "object",
504− "properties":
505− {
506− "position":
507− {
508− "$ref": "#/definitions/Point"
509− }
510− },
511− "required": ["position"]
512− },
513− "NPC":
514− {
515− "type": "object",
516− "properties":
517− {
518− "npcName": { "type": "string" },
519− "npcPosition": { "$ref": "#/definitions/Point" }
520− },
521− "required": ["npcName", "npcPosition"]
522− }
523− },
524− "maxProperties": 1,
525− "minProperties": 1
526−}
527−|]
528−
529−-- ========================================================================
530−-- Light (sum type with unwrapUnaryRecords)
531−-- ========================================================================
532−
533−data Light
534− = NoLight
535− | LightFreq Double
536− | LightColor Color
537− | LightWaveLength { waveLength :: Double }
538− deriving (Generic)
539−
540−instance ToSchema Light where
541− declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions
542− { unwrapUnaryRecords = True }
543−
544−lightSchemaJSON :: Value
545−lightSchemaJSON = [aesonQQ|
546−{
547− "type": "object",
548− "properties":
549− {
550− "NoLight": { "type": "array", "items": [] },
551− "LightFreq": { "type": "number", "format": "double" },
552− "LightColor": { "$ref": "#/definitions/Color" },
553− "LightWaveLength": { "type": "number", "format": "double" }
554− },
555− "maxProperties": 1,
556− "minProperties": 1
557−}
558−|]
559−
560−lightInlinedSchemaJSON :: Value
561−lightInlinedSchemaJSON = [aesonQQ|
562−{
563− "type": "object",
564− "properties":
565− {
566− "NoLight": { "type": "array", "items": [] },
567− "LightFreq": { "type": "number", "format": "double" },
568− "LightColor":
569− {
570− "type": "string",
571− "enum": ["Red", "Green", "Blue"]
572− },
573− "LightWaveLength": { "type": "number", "format": "double" }
574− },
575− "maxProperties": 1,
576− "minProperties": 1
577−}
578−|]
579−
580−-- ========================================================================
581−-- ResourceId (series of newtypes)
582−-- ========================================================================
583−
584−newtype Id = Id String deriving (Generic, ToSchema)
585−
586−newtype ResourceId = ResourceId Id deriving (Generic, ToSchema)
test/Data/SwaggerSpec.hs+427−333
@@ -4,11 +4,15 @@
4{-# LANGUAGE QuasiQuotes #-}
4{-# LANGUAGE QuasiQuotes #-}
5module Data.SwaggerSpec where
5module Data.SwaggerSpec where
6
6
7+import Prelude ()
8+import Prelude.Compat
9+
7import Control.Lens
10import Control.Lens
8
11
9import Data.Aeson
12import Data.Aeson
10−import Data.Aeson.QQ
13+import Data.Aeson.QQ.Simple
11import Data.HashMap.Strict (HashMap)
14import Data.HashMap.Strict (HashMap)
15+import qualified Data.HashSet.InsOrd as InsOrdHS
12import Data.Text (Text)
16import Data.Text (Text)
13
17
14import Data.Swagger
18import Data.Swagger
@@ -17,6 +21,14 @@ import Test.Hspec hiding (example)
17
21
18spec :: Spec
22spec :: Spec
19spec = do
23spec = do
24+ describe "host" $ do
25+ it "can decode the host port" $ do
26+ let h = Just $ Host "localhost" (Just (fromInteger 8000))
27+ swagger :: Swagger
28+ swagger = swaggerExample
29+ & host .~ h
30+ parsed :: Swagger = either error id $ eitherDecode' $ encode swagger
31+ parsed ^. host `shouldBe` h
20 describe "License Object" $ licenseExample <=> licenseExampleJSON
32 describe "License Object" $ licenseExample <=> licenseExampleJSON
21 describe "Contact Object" $ contactExample <=> contactExampleJSON
33 describe "Contact Object" $ contactExample <=> contactExampleJSON
22 describe "Info Object" $ infoExample <=> infoExampleJSON
34 describe "Info Object" $ infoExample <=> infoExampleJSON
@@ -25,11 +37,14 @@ spec = do
25 context "Primitive Sample" $ schemaPrimitiveExample <=> schemaPrimitiveExampleJSON
37 context "Primitive Sample" $ schemaPrimitiveExample <=> schemaPrimitiveExampleJSON
26 context "Simple Model" $ schemaSimpleModelExample <=> schemaSimpleModelExampleJSON
38 context "Simple Model" $ schemaSimpleModelExample <=> schemaSimpleModelExampleJSON
27 context "Model with Map/Dictionary Properties" $ schemaModelDictExample <=> schemaModelDictExampleJSON
39 context "Model with Map/Dictionary Properties" $ schemaModelDictExample <=> schemaModelDictExampleJSON
40+ context "Model with Arbitrary Properties" $ schemaAdditionalExample <=> schemaAdditionalExampleJSON
28 context "Model with Example" $ schemaWithExampleExample <=> schemaWithExampleExampleJSON
41 context "Model with Example" $ schemaWithExampleExample <=> schemaWithExampleExampleJSON
29 describe "Definitions Object" $ definitionsExample <=> definitionsExampleJSON
42 describe "Definitions Object" $ definitionsExample <=> definitionsExampleJSON
30 describe "Parameters Definition Object" $ paramsDefinitionExample <=> paramsDefinitionExampleJSON
43 describe "Parameters Definition Object" $ paramsDefinitionExample <=> paramsDefinitionExampleJSON
31 describe "Responses Definition Object" $ responsesDefinitionExample <=> responsesDefinitionExampleJSON
44 describe "Responses Definition Object" $ responsesDefinitionExample <=> responsesDefinitionExampleJSON
32 describe "Security Definitions Object" $ securityDefinitionsExample <=> securityDefinitionsExampleJSON
45 describe "Security Definitions Object" $ securityDefinitionsExample <=> securityDefinitionsExampleJSON
46+ describe "OAuth2 Security Definitions with merged Scope" $ oAuth2SecurityDefinitionsExample <=> oAuth2SecurityDefinitionsExampleJSON
47+ describe "Composition Schema Example" $ compositionSchemaExample <=> compositionSchemaExampleJSON
33 describe "Swagger Object" $ do
48 describe "Swagger Object" $ do
34 context "Todo Example" $ swaggerExample <=> swaggerExampleJSON
49 context "Todo Example" $ swaggerExample <=> swaggerExampleJSON
35 context "PetStore Example" $
50 context "PetStore Example" $
@@ -113,7 +128,7 @@ licenseExampleJSON = [aesonQQ|
113
128
114operationExample :: Operation
129operationExample :: Operation
115operationExample = mempty
130operationExample = mempty
116− & tags .~ ["pet"]
131+ & tags .~ InsOrdHS.fromList ["pet"]
117 & summary ?~ "Updates a pet in the store with form data"
132 & summary ?~ "Updates a pet in the store with form data"
118 & description ?~ ""
133 & description ?~ ""
119 & operationId ?~ "updatePetWithForm"
134 & operationId ?~ "updatePetWithForm"
@@ -144,7 +159,7 @@ operationExample = mempty
144 stringSchema :: ParamLocation -> ParamOtherSchema
159 stringSchema :: ParamLocation -> ParamOtherSchema
145 stringSchema loc = mempty
160 stringSchema loc = mempty
146 & in_ .~ loc
161 & in_ .~ loc
147− & type_ .~ SwaggerString
162+ & type_ ?~ SwaggerString
148
163
149operationExampleJSON :: Value
164operationExampleJSON :: Value
150operationExampleJSON = [aesonQQ|
165operationExampleJSON = [aesonQQ|
@@ -210,7 +225,7 @@ operationExampleJSON = [aesonQQ|
210
225
211schemaPrimitiveExample :: Schema
226schemaPrimitiveExample :: Schema
212schemaPrimitiveExample = mempty
227schemaPrimitiveExample = mempty
213− & type_ .~ SwaggerString
228+ & type_ ?~ SwaggerString
214 & format ?~ "email"
229 & format ?~ "email"
215
230
216schemaPrimitiveExampleJSON :: Value
231schemaPrimitiveExampleJSON :: Value
@@ -223,14 +238,14 @@ schemaPrimitiveExampleJSON = [aesonQQ|
223
238
224schemaSimpleModelExample :: Schema
239schemaSimpleModelExample :: Schema
225schemaSimpleModelExample = mempty
240schemaSimpleModelExample = mempty
226− & type_ .~ SwaggerObject
241+ & type_ ?~ SwaggerObject
227 & required .~ [ "name" ]
242 & required .~ [ "name" ]
228 & properties .~
243 & properties .~
229− [ ("name", Inline (mempty & type_ .~ SwaggerString))
244+ [ ("name", Inline (mempty & type_ ?~ SwaggerString))
230 , ("address", Ref (Reference "Address"))
245 , ("address", Ref (Reference "Address"))
231 , ("age", Inline $ mempty
246 , ("age", Inline $ mempty
232 & minimum_ ?~ 0
247 & minimum_ ?~ 0
233− & type_ .~ SwaggerInteger
248+ & type_ ?~ SwaggerInteger
234 & format ?~ "int32" ) ]
249 & format ?~ "int32" ) ]
235
250
236schemaSimpleModelExampleJSON :: Value
251schemaSimpleModelExampleJSON :: Value
@@ -258,8 +273,8 @@ schemaSimpleModelExampleJSON = [aesonQQ|
258
273
259schemaModelDictExample :: Schema
274schemaModelDictExample :: Schema
260schemaModelDictExample = mempty
275schemaModelDictExample = mempty
261− & type_ .~ SwaggerObject
276+ & type_ ?~ SwaggerObject
262− & additionalProperties ?~ (mempty & type_ .~ SwaggerString)
277+ & additionalProperties ?~ AdditionalPropertiesSchema (Inline (mempty & type_ ?~ SwaggerString))
263
278
264schemaModelDictExampleJSON :: Value
279schemaModelDictExampleJSON :: Value
265schemaModelDictExampleJSON = [aesonQQ|
280schemaModelDictExampleJSON = [aesonQQ|
@@ -271,15 +286,28 @@ schemaModelDictExampleJSON = [aesonQQ|
271}
286}
272|]
287|]
273
288
289+schemaAdditionalExample :: Schema
290+schemaAdditionalExample = mempty
291+ & type_ ?~ SwaggerObject
292+ & additionalProperties ?~ AdditionalPropertiesAllowed True
293+
294+schemaAdditionalExampleJSON :: Value
295+schemaAdditionalExampleJSON = [aesonQQ|
296+{
297+ "type": "object",
298+ "additionalProperties": true
299+}
300+|]
301+
274schemaWithExampleExample :: Schema
302schemaWithExampleExample :: Schema
275schemaWithExampleExample = mempty
303schemaWithExampleExample = mempty
276− & type_ .~ SwaggerObject
304+ & type_ ?~ SwaggerObject
277 & properties .~
305 & properties .~
278 [ ("id", Inline $ mempty
306 [ ("id", Inline $ mempty
279− & type_ .~ SwaggerInteger
307+ & type_ ?~ SwaggerInteger
280 & format ?~ "int64" )
308 & format ?~ "int64" )
281 , ("name", Inline $ mempty
309 , ("name", Inline $ mempty
282− & type_ .~ SwaggerString) ]
310+ & type_ ?~ SwaggerString) ]
283 & required .~ [ "name" ]
311 & required .~ [ "name" ]
284 & example ?~ [aesonQQ|
312 & example ?~ [aesonQQ|
285 {
313 {
@@ -318,19 +346,19 @@ schemaWithExampleExampleJSON = [aesonQQ|
318definitionsExample :: HashMap Text Schema
346definitionsExample :: HashMap Text Schema
319definitionsExample =
347definitionsExample =
320 [ ("Category", mempty
348 [ ("Category", mempty
321− & type_ .~ SwaggerObject
349+ & type_ ?~ SwaggerObject
322 & properties .~
350 & properties .~
323 [ ("id", Inline $ mempty
351 [ ("id", Inline $ mempty
324− & type_ .~ SwaggerInteger
352+ & type_ ?~ SwaggerInteger
325 & format ?~ "int64")
353 & format ?~ "int64")
326− , ("name", Inline (mempty & type_ .~ SwaggerString)) ] )
354+ , ("name", Inline (mempty & type_ ?~ SwaggerString)) ] )
327 , ("Tag", mempty
355 , ("Tag", mempty
328− & type_ .~ SwaggerObject
356+ & type_ ?~ SwaggerObject
329 & properties .~
357 & properties .~
330 [ ("id", Inline $ mempty
358 [ ("id", Inline $ mempty
331− & type_ .~ SwaggerInteger
359+ & type_ ?~ SwaggerInteger
332 & format ?~ "int64")
360 & format ?~ "int64")
333− , ("name", Inline (mempty & type_ .~ SwaggerString)) ] ) ]
361+ , ("name", Inline (mempty & type_ ?~ SwaggerString)) ] ) ]
334
362
335definitionsExampleJSON :: Value
363definitionsExampleJSON :: Value
336definitionsExampleJSON = [aesonQQ|
364definitionsExampleJSON = [aesonQQ|
@@ -374,7 +402,7 @@ paramsDefinitionExample =
374 & required ?~ True
402 & required ?~ True
375 & schema .~ ParamOther (mempty
403 & schema .~ ParamOther (mempty
376 & in_ .~ ParamQuery
404 & in_ .~ ParamQuery
377− & type_ .~ SwaggerInteger
405+ & type_ ?~ SwaggerInteger
378 & format ?~ "int32" ))
406 & format ?~ "int32" ))
379 , ("limitParam", mempty
407 , ("limitParam", mempty
380 & name .~ "limit"
408 & name .~ "limit"
@@ -382,7 +410,7 @@ paramsDefinitionExample =
382 & required ?~ True
410 & required ?~ True
383 & schema .~ ParamOther (mempty
411 & schema .~ ParamOther (mempty
384 & in_ .~ ParamQuery
412 & in_ .~ ParamQuery
385− & type_ .~ SwaggerInteger
413+ & type_ ?~ SwaggerInteger
386 & format ?~ "int32" )) ]
414 & format ?~ "int32" )) ]
387
415
388paramsDefinitionExampleJSON :: Value
416paramsDefinitionExampleJSON :: Value
@@ -432,8 +460,8 @@ responsesDefinitionExampleJSON = [aesonQQ|
432-- Responses Definition object
460-- Responses Definition object
433-- =======================================================================
461-- =======================================================================
434
462
435−securityDefinitionsExample :: HashMap Text SecurityScheme
463+securityDefinitionsExample :: SecurityDefinitions
436−securityDefinitionsExample =
464+securityDefinitionsExample = SecurityDefinitions
437 [ ("api_key", SecurityScheme
465 [ ("api_key", SecurityScheme
438 { _securitySchemeType = SecuritySchemeApiKey (ApiKeyParams "api_key" ApiKeyHeader)
466 { _securitySchemeType = SecuritySchemeApiKey (ApiKeyParams "api_key" ApiKeyHeader)
439 , _securitySchemeDescription = Nothing })
467 , _securitySchemeDescription = Nothing })
@@ -465,6 +493,46 @@ securityDefinitionsExampleJSON = [aesonQQ|
465}
493}
466|]
494|]
467
495
496+oAuth2SecurityDefinitionsReadExample :: SecurityDefinitions
497+oAuth2SecurityDefinitionsReadExample = SecurityDefinitions
498+ [ ("petstore_auth", SecurityScheme
499+ { _securitySchemeType = SecuritySchemeOAuth2 (OAuth2Params
500+ { _oauth2Flow = OAuth2Implicit "http://swagger.io/api/oauth/dialog"
501+ , _oauth2Scopes =
502+ [ ("read:pets", "read your pets") ] } )
503+ , _securitySchemeDescription = Nothing })
504+ ]
505+
506+oAuth2SecurityDefinitionsWriteExample :: SecurityDefinitions
507+oAuth2SecurityDefinitionsWriteExample = SecurityDefinitions
508+ [ ("petstore_auth", SecurityScheme
509+ { _securitySchemeType = SecuritySchemeOAuth2 (OAuth2Params
510+ { _oauth2Flow = OAuth2Implicit "http://swagger.io/api/oauth/dialog"
511+ , _oauth2Scopes =
512+ [ ("write:pets", "modify pets in your account") ] } )
513+ , _securitySchemeDescription = Nothing })
514+ ]
515+
516+oAuth2SecurityDefinitionsExample :: SecurityDefinitions
517+oAuth2SecurityDefinitionsExample =
518+ oAuth2SecurityDefinitionsWriteExample <>
519+ oAuth2SecurityDefinitionsReadExample
520+
521+oAuth2SecurityDefinitionsExampleJSON :: Value
522+oAuth2SecurityDefinitionsExampleJSON = [aesonQQ|
523+{
524+ "petstore_auth": {
525+ "type": "oauth2",
526+ "authorizationUrl": "http://swagger.io/api/oauth/dialog",
527+ "flow": "implicit",
528+ "scopes": {
529+ "write:pets": "modify pets in your account",
530+ "read:pets": "read your pets"
531+ }
532+ }
533+}
534+|]
535+
468-- =======================================================================
536-- =======================================================================
469-- Swagger object
537-- Swagger object
470-- =======================================================================
538-- =======================================================================
@@ -483,18 +551,18 @@ swaggerExample = mempty
483 & at 200 ?~ Inline (mempty
551 & at 200 ?~ Inline (mempty
484 & description .~ "OK"
552 & description .~ "OK"
485 & schema ?~ Inline (mempty
553 & schema ?~ Inline (mempty
486− & type_ .~ SwaggerObject
554+ & type_ ?~ SwaggerObject
487 & example ?~ [aesonQQ|
555 & example ?~ [aesonQQ|
488 {
556 {
489 "created": 100,
557 "created": 100,
490 "description": "get milk"
558 "description": "get milk"
491 } |]
559 } |]
492− & description ?~ "This is some real Todo right here"
560+ & description ?~ "This is some real Todo right here"
493 & properties .~
561 & properties .~
494 [ ("created", Inline $ mempty
562 [ ("created", Inline $ mempty
495− & type_ .~ SwaggerInteger
563+ & type_ ?~ SwaggerInteger
496 & format ?~ "int32")
564 & format ?~ "int32")
497− , ("description", Inline (mempty & type_ .~ SwaggerString))]))
565+ , ("description", Inline (mempty & type_ ?~ SwaggerString))]))
498 & produces ?~ MimeList [ "application/json" ]
566 & produces ?~ MimeList [ "application/json" ]
499 & parameters .~
567 & parameters .~
500 [ Inline $ mempty
568 [ Inline $ mempty
@@ -503,8 +571,8 @@ swaggerExample = mempty
503 & description ?~ "TodoId param"
571 & description ?~ "TodoId param"
504 & schema .~ ParamOther (mempty
572 & schema .~ ParamOther (mempty
505 & in_ .~ ParamPath
573 & in_ .~ ParamPath
506− & type_ .~ SwaggerString ) ]
574+ & type_ ?~ SwaggerString ) ]
507− & tags .~ [ "todo" ] ))
575+ & tags .~ InsOrdHS.fromList [ "todo" ] ))
508
576
509swaggerExampleJSON :: Value
577swaggerExampleJSON :: Value
510swaggerExampleJSON = [aesonQQ|
578swaggerExampleJSON = [aesonQQ|
@@ -571,130 +639,130 @@ swaggerExampleJSON = [aesonQQ|
571
639
572petstoreExampleJSON :: Value
640petstoreExampleJSON :: Value
573petstoreExampleJSON = [aesonQQ|
641petstoreExampleJSON = [aesonQQ|
574−{
642+{
575 "swagger":"2.0",
643 "swagger":"2.0",
576− "info":{
644+ "info":{
577 "description":"This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.",
645 "description":"This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.",
578 "version":"1.0.0",
646 "version":"1.0.0",
579 "title":"Swagger Petstore",
647 "title":"Swagger Petstore",
580 "termsOfService":"http://swagger.io/terms/",
648 "termsOfService":"http://swagger.io/terms/",
581− "contact":{
649+ "contact":{
582 "email":"apiteam@swagger.io"
650 "email":"apiteam@swagger.io"
583 },
651 },
584− "license":{
652+ "license":{
585 "name":"Apache 2.0",
653 "name":"Apache 2.0",
586 "url":"http://www.apache.org/licenses/LICENSE-2.0.html"
654 "url":"http://www.apache.org/licenses/LICENSE-2.0.html"
587 }
655 }
588 },
656 },
589 "host":"petstore.swagger.io",
657 "host":"petstore.swagger.io",
590 "basePath":"/v2",
658 "basePath":"/v2",
591− "tags":[
659+ "tags":[
592− {
660+ {
593 "name":"pet",
661 "name":"pet",
594 "description":"Everything about your Pets",
662 "description":"Everything about your Pets",
595− "externalDocs":{
663+ "externalDocs":{
596 "description":"Find out more",
664 "description":"Find out more",
597 "url":"http://swagger.io"
665 "url":"http://swagger.io"
598 }
666 }
599 },
667 },
600− {
668+ {
601 "name":"store",
669 "name":"store",
602 "description":"Access to Petstore orders"
670 "description":"Access to Petstore orders"
603 },
671 },
604− {
672+ {
605 "name":"user",
673 "name":"user",
606 "description":"Operations about user",
674 "description":"Operations about user",
607− "externalDocs":{
675+ "externalDocs":{
608 "description":"Find out more about our store",
676 "description":"Find out more about our store",
609 "url":"http://swagger.io"
677 "url":"http://swagger.io"
610 }
678 }
611 }
679 }
612 ],
680 ],
613− "schemes":[
681+ "schemes":[
614 "http"
682 "http"
615 ],
683 ],
616− "paths":{
684+ "paths":{
617− "/pet":{
685+ "/pet":{
618− "post":{
686+ "post":{
619− "tags":[
687+ "tags":[
620 "pet"
688 "pet"
621 ],
689 ],
622 "summary":"Add a new pet to the store",
690 "summary":"Add a new pet to the store",
623 "description":"",
691 "description":"",
624 "operationId":"addPet",
692 "operationId":"addPet",
625− "consumes":[
693+ "consumes":[
626 "application/json",
694 "application/json",
627 "application/xml"
695 "application/xml"
628 ],
696 ],
629− "produces":[
697+ "produces":[
630 "application/xml",
698 "application/xml",
631 "application/json"
699 "application/json"
632 ],
700 ],
633− "parameters":[
701+ "parameters":[
634− {
702+ {
635 "in":"body",
703 "in":"body",
636 "name":"body",
704 "name":"body",
637 "description":"Pet object that needs to be added to the store",
705 "description":"Pet object that needs to be added to the store",
638 "required":true,
706 "required":true,
639− "schema":{
707+ "schema":{
640 "$ref":"#/definitions/Pet"
708 "$ref":"#/definitions/Pet"
641 }
709 }
642 }
710 }
643 ],
711 ],
644− "responses":{
712+ "responses":{
645− "405":{
713+ "405":{
646 "description":"Invalid input"
714 "description":"Invalid input"
647 }
715 }
648 },
716 },
649− "security":[
717+ "security":[
650− {
718+ {
651− "petstore_auth":[
719+ "petstore_auth":[
652 "write:pets",
720 "write:pets",
653 "read:pets"
721 "read:pets"
654 ]
722 ]
655 }
723 }
656 ]
724 ]
657 },
725 },
658− "put":{
726+ "put":{
659− "tags":[
727+ "tags":[
660 "pet"
728 "pet"
661 ],
729 ],
662 "summary":"Update an existing pet",
730 "summary":"Update an existing pet",
663 "description":"",
731 "description":"",
664 "operationId":"updatePet",
732 "operationId":"updatePet",
665− "consumes":[
733+ "consumes":[
666 "application/json",
734 "application/json",
667 "application/xml"
735 "application/xml"
668 ],
736 ],
669− "produces":[
737+ "produces":[
670 "application/xml",
738 "application/xml",
671 "application/json"
739 "application/json"
672 ],
740 ],
673− "parameters":[
741+ "parameters":[
674− {
742+ {
675 "in":"body",
743 "in":"body",
676 "name":"body",
744 "name":"body",
677 "description":"Pet object that needs to be added to the store",
745 "description":"Pet object that needs to be added to the store",
678 "required":true,
746 "required":true,
679− "schema":{
747+ "schema":{
680 "$ref":"#/definitions/Pet"
748 "$ref":"#/definitions/Pet"
681 }
749 }
682 }
750 }
683 ],
751 ],
684− "responses":{
752+ "responses":{
685− "400":{
753+ "400":{
686 "description":"Invalid ID supplied"
754 "description":"Invalid ID supplied"
687 },
755 },
688− "404":{
756+ "404":{
689 "description":"Pet not found"
757 "description":"Pet not found"
690 },
758 },
691− "405":{
759+ "405":{
692 "description":"Validation exception"
760 "description":"Validation exception"
693 }
761 }
694 },
762 },
695− "security":[
763+ "security":[
696− {
764+ {
697− "petstore_auth":[
765+ "petstore_auth":[
698 "write:pets",
766 "write:pets",
699 "read:pets"
767 "read:pets"
700 ]
768 ]
@@ -702,28 +770,28 @@ petstoreExampleJSON = [aesonQQ|
702 ]
770 ]
703 }
771 }
704 },
772 },
705− "/pet/findByStatus":{
773+ "/pet/findByStatus":{
706− "get":{
774+ "get":{
707− "tags":[
775+ "tags":[
708 "pet"
776 "pet"
709 ],
777 ],
710 "summary":"Finds Pets by status",
778 "summary":"Finds Pets by status",
711 "description":"Multiple status values can be provided with comma seperated strings",
779 "description":"Multiple status values can be provided with comma seperated strings",
712 "operationId":"findPetsByStatus",
780 "operationId":"findPetsByStatus",
713− "produces":[
781+ "produces":[
714 "application/xml",
782 "application/xml",
715 "application/json"
783 "application/json"
716 ],
784 ],
717− "parameters":[
785+ "parameters":[
718− {
786+ {
719 "name":"status",
787 "name":"status",
720 "in":"query",
788 "in":"query",
721 "description":"Status values that need to be considered for filter",
789 "description":"Status values that need to be considered for filter",
722 "required":true,
790 "required":true,
723 "type":"array",
791 "type":"array",
724− "items":{
792+ "items":{
725 "type":"string",
793 "type":"string",
726− "enum":[
794+ "enum":[
727 "available",
795 "available",
728 "pending",
796 "pending",
729 "sold"
797 "sold"
@@ -733,23 +801,23 @@ petstoreExampleJSON = [aesonQQ|
733 "collectionFormat":"csv"
801 "collectionFormat":"csv"
734 }
802 }
735 ],
803 ],
736− "responses":{
804+ "responses":{
737− "200":{
805+ "200":{
738 "description":"successful operation",
806 "description":"successful operation",
739− "schema":{
807+ "schema":{
740 "type":"array",
808 "type":"array",
741− "items":{
809+ "items":{
742 "$ref":"#/definitions/Pet"
810 "$ref":"#/definitions/Pet"
743 }
811 }
744 }
812 }
745 },
813 },
746− "400":{
814+ "400":{
747 "description":"Invalid status value"
815 "description":"Invalid status value"
748 }
816 }
749 },
817 },
750− "security":[
818+ "security":[
751− {
819+ {
752− "petstore_auth":[
820+ "petstore_auth":[
753 "write:pets",
821 "write:pets",
754 "read:pets"
822 "read:pets"
755 ]
823 ]
@@ -757,48 +825,48 @@ petstoreExampleJSON = [aesonQQ|
757 ]
825 ]
758 }
826 }
759 },
827 },
760− "/pet/findByTags":{
828+ "/pet/findByTags":{
761− "get":{
829+ "get":{
762− "tags":[
830+ "tags":[
763 "pet"
831 "pet"
764 ],
832 ],
765 "summary":"Finds Pets by tags",
833 "summary":"Finds Pets by tags",
766 "description":"Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.",
834 "description":"Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.",
767 "operationId":"findPetsByTags",
835 "operationId":"findPetsByTags",
768− "produces":[
836+ "produces":[
769 "application/xml",
837 "application/xml",
770 "application/json"
838 "application/json"
771 ],
839 ],
772− "parameters":[
840+ "parameters":[
773− {
841+ {
774 "name":"tags",
842 "name":"tags",
775 "in":"query",
843 "in":"query",
776 "description":"Tags to filter by",
844 "description":"Tags to filter by",
777 "required":true,
845 "required":true,
778 "type":"array",
846 "type":"array",
779− "items":{
847+ "items":{
780 "type":"string"
848 "type":"string"
781 },
849 },
782 "collectionFormat":"csv"
850 "collectionFormat":"csv"
783 }
851 }
784 ],
852 ],
785− "responses":{
853+ "responses":{
786− "200":{
854+ "200":{
787 "description":"successful operation",
855 "description":"successful operation",
788− "schema":{
856+ "schema":{
789 "type":"array",
857 "type":"array",
790− "items":{
858+ "items":{
791 "$ref":"#/definitions/Pet"
859 "$ref":"#/definitions/Pet"
792 }
860 }
793 }
861 }
794 },
862 },
795− "400":{
863+ "400":{
796 "description":"Invalid tag value"
864 "description":"Invalid tag value"
797 }
865 }
798 },
866 },
799− "security":[
867+ "security":[
800− {
868+ {
801− "petstore_auth":[
869+ "petstore_auth":[
802 "write:pets",
870 "write:pets",
803 "read:pets"
871 "read:pets"
804 ]
872 ]
@@ -806,20 +874,20 @@ petstoreExampleJSON = [aesonQQ|
806 ]
874 ]
807 }
875 }
808 },
876 },
809− "/pet/{petId}":{
877+ "/pet/{petId}":{
810− "get":{
878+ "get":{
811− "tags":[
879+ "tags":[
812 "pet"
880 "pet"
813 ],
881 ],
814 "summary":"Find pet by ID",
882 "summary":"Find pet by ID",
815 "description":"Returns a single pet",
883 "description":"Returns a single pet",
816 "operationId":"getPetById",
884 "operationId":"getPetById",
817− "produces":[
885+ "produces":[
818 "application/xml",
886 "application/xml",
819 "application/json"
887 "application/json"
820 ],
888 ],
821− "parameters":[
889+ "parameters":[
822− {
890+ {
823 "name":"petId",
891 "name":"petId",
824 "in":"path",
892 "in":"path",
825 "description":"ID of pet to return",
893 "description":"ID of pet to return",
@@ -828,43 +896,42 @@ petstoreExampleJSON = [aesonQQ|
828 "format":"int64"
896 "format":"int64"
829 }
897 }
830 ],
898 ],
831− "responses":{
899+ "responses":{
832− "200":{
900+ "200":{
833 "description":"successful operation",
901 "description":"successful operation",
834− "schema":{
902+ "schema":{
835 "$ref":"#/definitions/Pet"
903 "$ref":"#/definitions/Pet"
836 }
904 }
837 },
905 },
838− "400":{
906+ "400":{
839 "description":"Invalid ID supplied"
907 "description":"Invalid ID supplied"
840 },
908 },
841− "404":{
909+ "404":{
842 "description":"Pet not found"
910 "description":"Pet not found"
843 }
911 }
844 },
912 },
845− "security":[
913+ "security":[
846− {
914+ {
847− "api_key":[
915+ "api_key": []
848− ]
849 }
916 }
850 ]
917 ]
851 },
918 },
852− "post":{
919+ "post":{
853− "tags":[
920+ "tags":[
854 "pet"
921 "pet"
855 ],
922 ],
856 "summary":"Updates a pet in the store with form data",
923 "summary":"Updates a pet in the store with form data",
857 "description":"",
924 "description":"",
858 "operationId":"updatePetWithForm",
925 "operationId":"updatePetWithForm",
859− "consumes":[
926+ "consumes":[
860 "application/x-www-form-urlencoded"
927 "application/x-www-form-urlencoded"
861 ],
928 ],
862− "produces":[
929+ "produces":[
863 "application/xml",
930 "application/xml",
864 "application/json"
931 "application/json"
865 ],
932 ],
866− "parameters":[
933+ "parameters":[
867− {
934+ {
868 "name":"petId",
935 "name":"petId",
869 "in":"path",
936 "in":"path",
870 "description":"ID of pet that needs to be updated",
937 "description":"ID of pet that needs to be updated",
@@ -872,14 +939,14 @@ petstoreExampleJSON = [aesonQQ|
872 "type":"integer",
939 "type":"integer",
873 "format":"int64"
940 "format":"int64"
874 },
941 },
875− {
942+ {
876 "name":"name",
943 "name":"name",
877 "in":"formData",
944 "in":"formData",
878 "description":"Updated name of the pet",
945 "description":"Updated name of the pet",
879 "required":false,
946 "required":false,
880 "type":"string"
947 "type":"string"
881 },
948 },
882− {
949+ {
883 "name":"status",
950 "name":"status",
884 "in":"formData",
951 "in":"formData",
885 "description":"Updated status of the pet",
952 "description":"Updated status of the pet",
@@ -887,39 +954,39 @@ petstoreExampleJSON = [aesonQQ|
887 "type":"string"
954 "type":"string"
888 }
955 }
889 ],
956 ],
890− "responses":{
957+ "responses":{
891− "405":{
958+ "405":{
892 "description":"Invalid input"
959 "description":"Invalid input"
893 }
960 }
894 },
961 },
895− "security":[
962+ "security":[
896− {
963+ {
897− "petstore_auth":[
964+ "petstore_auth":[
898 "write:pets",
965 "write:pets",
899 "read:pets"
966 "read:pets"
900 ]
967 ]
901 }
968 }
902 ]
969 ]
903 },
970 },
904− "delete":{
971+ "delete":{
905− "tags":[
972+ "tags":[
906 "pet"
973 "pet"
907 ],
974 ],
908 "summary":"Deletes a pet",
975 "summary":"Deletes a pet",
909 "description":"",
976 "description":"",
910 "operationId":"deletePet",
977 "operationId":"deletePet",
911− "produces":[
978+ "produces":[
912 "application/xml",
979 "application/xml",
913 "application/json"
980 "application/json"
914 ],
981 ],
915− "parameters":[
982+ "parameters":[
916− {
983+ {
917 "name":"api_key",
984 "name":"api_key",
918 "in":"header",
985 "in":"header",
919 "required":false,
986 "required":false,
920 "type":"string"
987 "type":"string"
921 },
988 },
922− {
989+ {
923 "name":"petId",
990 "name":"petId",
924 "in":"path",
991 "in":"path",
925 "description":"Pet id to delete",
992 "description":"Pet id to delete",
@@ -928,14 +995,14 @@ petstoreExampleJSON = [aesonQQ|
928 "format":"int64"
995 "format":"int64"
929 }
996 }
930 ],
997 ],
931− "responses":{
998+ "responses":{
932− "400":{
999+ "400":{
933 "description":"Invalid pet value"
1000 "description":"Invalid pet value"
934 }
1001 }
935 },
1002 },
936− "security":[
1003+ "security":[
937− {
1004+ {
938− "petstore_auth":[
1005+ "petstore_auth":[
939 "write:pets",
1006 "write:pets",
940 "read:pets"
1007 "read:pets"
941 ]
1008 ]
@@ -943,22 +1010,22 @@ petstoreExampleJSON = [aesonQQ|
943 ]
1010 ]
944 }
1011 }
945 },
1012 },
946− "/pet/{petId}/uploadImage":{
1013+ "/pet/{petId}/uploadImage":{
947− "post":{
1014+ "post":{
948− "tags":[
1015+ "tags":[
949 "pet"
1016 "pet"
950 ],
1017 ],
951 "summary":"uploads an image",
1018 "summary":"uploads an image",
952 "description":"",
1019 "description":"",
953 "operationId":"uploadFile",
1020 "operationId":"uploadFile",
954− "consumes":[
1021+ "consumes":[
955 "multipart/form-data"
1022 "multipart/form-data"
956 ],
1023 ],
957− "produces":[
1024+ "produces":[
958 "application/json"
1025 "application/json"
959 ],
1026 ],
960− "parameters":[
1027+ "parameters":[
961− {
1028+ {
962 "name":"petId",
1029 "name":"petId",
963 "in":"path",
1030 "in":"path",
964 "description":"ID of pet to update",
1031 "description":"ID of pet to update",
@@ -966,14 +1033,14 @@ petstoreExampleJSON = [aesonQQ|
966 "type":"integer",
1033 "type":"integer",
967 "format":"int64"
1034 "format":"int64"
968 },
1035 },
969− {
1036+ {
970 "name":"additionalMetadata",
1037 "name":"additionalMetadata",
971 "in":"formData",
1038 "in":"formData",
972 "description":"Additional data to pass to server",
1039 "description":"Additional data to pass to server",
973 "required":false,
1040 "required":false,
974 "type":"string"
1041 "type":"string"
975 },
1042 },
976− {
1043+ {
977 "name":"file",
1044 "name":"file",
978 "in":"formData",
1045 "in":"formData",
979 "description":"file to upload",
1046 "description":"file to upload",
@@ -981,17 +1048,17 @@ petstoreExampleJSON = [aesonQQ|
981 "type":"file"
1048 "type":"file"
982 }
1049 }
983 ],
1050 ],
984− "responses":{
1051+ "responses":{
985− "200":{
1052+ "200":{
986 "description":"successful operation",
1053 "description":"successful operation",
987− "schema":{
1054+ "schema":{
988 "$ref":"#/definitions/ApiResponse"
1055 "$ref":"#/definitions/ApiResponse"
989 }
1056 }
990 }
1057 }
991 },
1058 },
992− "security":[
1059+ "security":[
993− {
1060+ {
994− "petstore_auth":[
1061+ "petstore_auth":[
995 "write:pets",
1062 "write:pets",
996 "read:pets"
1063 "read:pets"
997 ]
1064 ]
@@ -999,89 +1066,87 @@ petstoreExampleJSON = [aesonQQ|
999 ]
1066 ]
1000 }
1067 }
1001 },
1068 },
1002− "/store/inventory":{
1069+ "/store/inventory":{
1003− "get":{
1070+ "get":{
1004− "tags":[
1071+ "tags":[
1005 "store"
1072 "store"
1006 ],
1073 ],
1007 "summary":"Returns pet inventories by status",
1074 "summary":"Returns pet inventories by status",
1008 "description":"Returns a map of status codes to quantities",
1075 "description":"Returns a map of status codes to quantities",
1009 "operationId":"getInventory",
1076 "operationId":"getInventory",
1010− "produces":[
1077+ "produces":[
1011 "application/json"
1078 "application/json"
1012 ],
1079 ],
1013− "parameters":[
1080+ "parameters": [],
1014− ],
1015− "responses":{
1081+ "responses":{
1016− "200":{
1082+ "200":{
1017 "description":"successful operation",
1083 "description":"successful operation",
1018− "schema":{
1084+ "schema":{
1019 "type":"object",
1085 "type":"object",
1020− "additionalProperties":{
1086+ "additionalProperties":{
1021 "type":"integer",
1087 "type":"integer",
1022 "format":"int32"
1088 "format":"int32"
1023 }
1089 }
1024 }
1090 }
1025 }
1091 }
1026 },
1092 },
1027− "security":[
1093+ "security":[
1028− {
1094+ {
1029− "api_key":[
1095+ "api_key": []
1030− ]
1031 }
1096 }
1032 ]
1097 ]
1033 }
1098 }
1034 },
1099 },
1035− "/store/order":{
1100+ "/store/order":{
1036− "post":{
1101+ "post":{
1037− "tags":[
1102+ "tags":[
1038 "store"
1103 "store"
1039 ],
1104 ],
1040 "summary":"Place an order for a pet",
1105 "summary":"Place an order for a pet",
1041 "description":"",
1106 "description":"",
1042 "operationId":"placeOrder",
1107 "operationId":"placeOrder",
1043− "produces":[
1108+ "produces":[
1044 "application/xml",
1109 "application/xml",
1045 "application/json"
1110 "application/json"
1046 ],
1111 ],
1047− "parameters":[
1112+ "parameters":[
1048− {
1113+ {
1049 "in":"body",
1114 "in":"body",
1050 "name":"body",
1115 "name":"body",
1051 "description":"order placed for purchasing the pet",
1116 "description":"order placed for purchasing the pet",
1052 "required":true,
1117 "required":true,
1053− "schema":{
1118+ "schema":{
1054 "$ref":"#/definitions/Order"
1119 "$ref":"#/definitions/Order"
1055 }
1120 }
1056 }
1121 }
1057 ],
1122 ],
1058− "responses":{
1123+ "responses":{
1059− "200":{
1124+ "200":{
1060 "description":"successful operation",
1125 "description":"successful operation",
1061− "schema":{
1126+ "schema":{
1062 "$ref":"#/definitions/Order"
1127 "$ref":"#/definitions/Order"
1063 }
1128 }
1064 },
1129 },
1065− "400":{
1130+ "400":{
1066 "description":"Invalid Order"
1131 "description":"Invalid Order"
1067 }
1132 }
1068 }
1133 }
1069 }
1134 }
1070 },
1135 },
1071− "/store/order/{orderId}":{
1136+ "/store/order/{orderId}":{
1072− "get":{
1137+ "get":{
1073− "tags":[
1138+ "tags":[
1074 "store"
1139 "store"
1075 ],
1140 ],
1076 "summary":"Find purchase order by ID",
1141 "summary":"Find purchase order by ID",
1077 "description":"For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions",
1142 "description":"For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions",
1078 "operationId":"getOrderById",
1143 "operationId":"getOrderById",
1079− "produces":[
1144+ "produces":[
1080 "application/xml",
1145 "application/xml",
1081 "application/json"
1146 "application/json"
1082 ],
1147 ],
1083− "parameters":[
1148+ "parameters":[
1084− {
1149+ {
1085 "name":"orderId",
1150 "name":"orderId",
1086 "in":"path",
1151 "in":"path",
1087 "description":"ID of pet that needs to be fetched",
1152 "description":"ID of pet that needs to be fetched",
@@ -1092,34 +1157,34 @@ petstoreExampleJSON = [aesonQQ|
1092 "format":"int64"
1157 "format":"int64"
1093 }
1158 }
1094 ],
1159 ],
1095− "responses":{
1160+ "responses":{
1096− "200":{
1161+ "200":{
1097 "description":"successful operation",
1162 "description":"successful operation",
1098− "schema":{
1163+ "schema":{
1099 "$ref":"#/definitions/Order"
1164 "$ref":"#/definitions/Order"
1100 }
1165 }
1101 },
1166 },
1102− "400":{
1167+ "400":{
1103 "description":"Invalid ID supplied"
1168 "description":"Invalid ID supplied"
1104 },
1169 },
1105− "404":{
1170+ "404":{
1106 "description":"Order not found"
1171 "description":"Order not found"
1107 }
1172 }
1108 }
1173 }
1109 },
1174 },
1110− "delete":{
1175+ "delete":{
1111− "tags":[
1176+ "tags":[
1112 "store"
1177 "store"
1113 ],
1178 ],
1114 "summary":"Delete purchase order by ID",
1179 "summary":"Delete purchase order by ID",
1115 "description":"For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
1180 "description":"For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
1116 "operationId":"deleteOrder",
1181 "operationId":"deleteOrder",
1117− "produces":[
1182+ "produces":[
1118 "application/xml",
1183 "application/xml",
1119 "application/json"
1184 "application/json"
1120 ],
1185 ],
1121− "parameters":[
1186+ "parameters":[
1122− {
1187+ {
1123 "name":"orderId",
1188 "name":"orderId",
1124 "in":"path",
1189 "in":"path",
1125 "description":"ID of the order that needs to be deleted",
1190 "description":"ID of the order that needs to be deleted",
@@ -1128,133 +1193,133 @@ petstoreExampleJSON = [aesonQQ|
1128 "minimum":1.0
1193 "minimum":1.0
1129 }
1194 }
1130 ],
1195 ],
1131− "responses":{
1196+ "responses":{
1132− "400":{
1197+ "400":{
1133 "description":"Invalid ID supplied"
1198 "description":"Invalid ID supplied"
1134 },
1199 },
1135− "404":{
1200+ "404":{
1136 "description":"Order not found"
1201 "description":"Order not found"
1137 }
1202 }
1138 }
1203 }
1139 }
1204 }
1140 },
1205 },
1141− "/user":{
1206+ "/user":{
1142− "post":{
1207+ "post":{
1143− "tags":[
1208+ "tags":[
1144 "user"
1209 "user"
1145 ],
1210 ],
1146 "summary":"Create user",
1211 "summary":"Create user",
1147 "description":"This can only be done by the logged in user.",
1212 "description":"This can only be done by the logged in user.",
1148 "operationId":"createUser",
1213 "operationId":"createUser",
1149− "produces":[
1214+ "produces":[
1150 "application/xml",
1215 "application/xml",
1151 "application/json"
1216 "application/json"
1152 ],
1217 ],
1153− "parameters":[
1218+ "parameters":[
1154− {
1219+ {
1155 "in":"body",
1220 "in":"body",
1156 "name":"body",
1221 "name":"body",
1157 "description":"Created user object",
1222 "description":"Created user object",
1158 "required":true,
1223 "required":true,
1159− "schema":{
1224+ "schema":{
1160 "$ref":"#/definitions/User"
1225 "$ref":"#/definitions/User"
1161 }
1226 }
1162 }
1227 }
1163 ],
1228 ],
1164− "responses":{
1229+ "responses":{
1165− "default":{
1230+ "default":{
1166 "description":"successful operation"
1231 "description":"successful operation"
1167 }
1232 }
1168 }
1233 }
1169 }
1234 }
1170 },
1235 },
1171− "/user/createWithArray":{
1236+ "/user/createWithArray":{
1172− "post":{
1237+ "post":{
1173− "tags":[
1238+ "tags":[
1174 "user"
1239 "user"
1175 ],
1240 ],
1176 "summary":"Creates list of users with given input array",
1241 "summary":"Creates list of users with given input array",
1177 "description":"",
1242 "description":"",
1178 "operationId":"createUsersWithArrayInput",
1243 "operationId":"createUsersWithArrayInput",
1179− "produces":[
1244+ "produces":[
1180 "application/xml",
1245 "application/xml",
1181 "application/json"
1246 "application/json"
1182 ],
1247 ],
1183− "parameters":[
1248+ "parameters":[
1184− {
1249+ {
1185 "in":"body",
1250 "in":"body",
1186 "name":"body",
1251 "name":"body",
1187 "description":"List of user object",
1252 "description":"List of user object",
1188 "required":true,
1253 "required":true,
1189− "schema":{
1254+ "schema":{
1190 "type":"array",
1255 "type":"array",
1191− "items":{
1256+ "items":{
1192 "$ref":"#/definitions/User"
1257 "$ref":"#/definitions/User"
1193 }
1258 }
1194 }
1259 }
1195 }
1260 }
1196 ],
1261 ],
1197− "responses":{
1262+ "responses":{
1198− "default":{
1263+ "default":{
1199 "description":"successful operation"
1264 "description":"successful operation"
1200 }
1265 }
1201 }
1266 }
1202 }
1267 }
1203 },
1268 },
1204− "/user/createWithList":{
1269+ "/user/createWithList":{
1205− "post":{
1270+ "post":{
1206− "tags":[
1271+ "tags":[
1207 "user"
1272 "user"
1208 ],
1273 ],
1209 "summary":"Creates list of users with given input array",
1274 "summary":"Creates list of users with given input array",
1210 "description":"",
1275 "description":"",
1211 "operationId":"createUsersWithListInput",
1276 "operationId":"createUsersWithListInput",
1212− "produces":[
1277+ "produces":[
1213 "application/xml",
1278 "application/xml",
1214 "application/json"
1279 "application/json"
1215 ],
1280 ],
1216− "parameters":[
1281+ "parameters":[
1217− {
1282+ {
1218 "in":"body",
1283 "in":"body",
1219 "name":"body",
1284 "name":"body",
1220 "description":"List of user object",
1285 "description":"List of user object",
1221 "required":true,
1286 "required":true,
1222− "schema":{
1287+ "schema":{
1223 "type":"array",
1288 "type":"array",
1224− "items":{
1289+ "items":{
1225 "$ref":"#/definitions/User"
1290 "$ref":"#/definitions/User"
1226 }
1291 }
1227 }
1292 }
1228 }
1293 }
1229 ],
1294 ],
1230− "responses":{
1295+ "responses":{
1231− "default":{
1296+ "default":{
1232 "description":"successful operation"
1297 "description":"successful operation"
1233 }
1298 }
1234 }
1299 }
1235 }
1300 }
1236 },
1301 },
1237− "/user/login":{
1302+ "/user/login":{
1238− "get":{
1303+ "get":{
1239− "tags":[
1304+ "tags":[
1240 "user"
1305 "user"
1241 ],
1306 ],
1242 "summary":"Logs user into the system",
1307 "summary":"Logs user into the system",
1243 "description":"",
1308 "description":"",
1244 "operationId":"loginUser",
1309 "operationId":"loginUser",
1245− "produces":[
1310+ "produces":[
1246 "application/xml",
1311 "application/xml",
1247 "application/json"
1312 "application/json"
1248 ],
1313 ],
1249− "parameters":[
1314+ "parameters":[
1250− {
1315+ {
1251 "name":"username",
1316 "name":"username",
1252 "in":"query",
1317 "in":"query",
1253 "description":"The user name for login",
1318 "description":"The user name for login",
1254 "required":true,
1319 "required":true,
1255 "type":"string"
1320 "type":"string"
1256 },
1321 },
1257− {
1322+ {
1258 "name":"password",
1323 "name":"password",
1259 "in":"query",
1324 "in":"query",
1260 "description":"The password for login in clear text",
1325 "description":"The password for login in clear text",
@@ -1262,66 +1327,65 @@ petstoreExampleJSON = [aesonQQ|
1262 "type":"string"
1327 "type":"string"
1263 }
1328 }
1264 ],
1329 ],
1265− "responses":{
1330+ "responses":{
1266− "200":{
1331+ "200":{
1267 "description":"successful operation",
1332 "description":"successful operation",
1268− "schema":{
1333+ "schema":{
1269 "type":"string"
1334 "type":"string"
1270 },
1335 },
1271− "headers":{
1336+ "headers":{
1272− "X-Rate-Limit":{
1337+ "X-Rate-Limit":{
1273 "type":"integer",
1338 "type":"integer",
1274 "format":"int32",
1339 "format":"int32",
1275 "description":"calls per hour allowed by the user"
1340 "description":"calls per hour allowed by the user"
1276 },
1341 },
1277− "X-Expires-After":{
1342+ "X-Expires-After":{
1278 "type":"string",
1343 "type":"string",
1279 "format":"date-time",
1344 "format":"date-time",
1280 "description":"date in UTC when toekn expires"
1345 "description":"date in UTC when toekn expires"
1281 }
1346 }
1282 }
1347 }
1283 },
1348 },
1284− "400":{
1349+ "400":{
1285 "description":"Invalid username/password supplied"
1350 "description":"Invalid username/password supplied"
1286 }
1351 }
1287 }
1352 }
1288 }
1353 }
1289 },
1354 },
1290− "/user/logout":{
1355+ "/user/logout":{
1291− "get":{
1356+ "get":{
1292− "tags":[
1357+ "tags":[
1293 "user"
1358 "user"
1294 ],
1359 ],
1295 "summary":"Logs out current logged in user session",
1360 "summary":"Logs out current logged in user session",
1296 "description":"",
1361 "description":"",
1297 "operationId":"logoutUser",
1362 "operationId":"logoutUser",
1298− "produces":[
1363+ "produces":[
1299 "application/xml",
1364 "application/xml",
1300 "application/json"
1365 "application/json"
1301 ],
1366 ],
1302− "parameters":[
1367+ "parameters": [],
1303− ],
1304− "responses":{
1368+ "responses":{
1305− "default":{
1369+ "default":{
1306 "description":"successful operation"
1370 "description":"successful operation"
1307 }
1371 }
1308 }
1372 }
1309 }
1373 }
1310 },
1374 },
1311− "/user/{username}":{
1375+ "/user/{username}":{
1312− "get":{
1376+ "get":{
1313− "tags":[
1377+ "tags":[
1314 "user"
1378 "user"
1315 ],
1379 ],
1316 "summary":"Get user by user name",
1380 "summary":"Get user by user name",
1317 "description":"",
1381 "description":"",
1318 "operationId":"getUserByName",
1382 "operationId":"getUserByName",
1319− "produces":[
1383+ "produces":[
1320 "application/xml",
1384 "application/xml",
1321 "application/json"
1385 "application/json"
1322 ],
1386 ],
1323− "parameters":[
1387+ "parameters":[
1324− {
1388+ {
1325 "name":"username",
1389 "name":"username",
1326 "in":"path",
1390 "in":"path",
1327 "description":"The name that needs to be fetched. Use user1 for testing. ",
1391 "description":"The name that needs to be fetched. Use user1 for testing. ",
@@ -1329,72 +1393,72 @@ petstoreExampleJSON = [aesonQQ|
1329 "type":"string"
1393 "type":"string"
1330 }
1394 }
1331 ],
1395 ],
1332− "responses":{
1396+ "responses":{
1333− "200":{
1397+ "200":{
1334 "description":"successful operation",
1398 "description":"successful operation",
1335− "schema":{
1399+ "schema":{
1336 "$ref":"#/definitions/User"
1400 "$ref":"#/definitions/User"
1337 }
1401 }
1338 },
1402 },
1339− "400":{
1403+ "400":{
1340 "description":"Invalid username supplied"
1404 "description":"Invalid username supplied"
1341 },
1405 },
1342− "404":{
1406+ "404":{
1343 "description":"User not found"
1407 "description":"User not found"
1344 }
1408 }
1345 }
1409 }
1346 },
1410 },
1347− "put":{
1411+ "put":{
1348− "tags":[
1412+ "tags":[
1349 "user"
1413 "user"
1350 ],
1414 ],
1351 "summary":"Updated user",
1415 "summary":"Updated user",
1352 "description":"This can only be done by the logged in user.",
1416 "description":"This can only be done by the logged in user.",
1353 "operationId":"updateUser",
1417 "operationId":"updateUser",
1354− "produces":[
1418+ "produces":[
1355 "application/xml",
1419 "application/xml",
1356 "application/json"
1420 "application/json"
1357 ],
1421 ],
1358− "parameters":[
1422+ "parameters":[
1359− {
1423+ {
1360 "name":"username",
1424 "name":"username",
1361 "in":"path",
1425 "in":"path",
1362 "description":"name that need to be deleted",
1426 "description":"name that need to be deleted",
1363 "required":true,
1427 "required":true,
1364 "type":"string"
1428 "type":"string"
1365 },
1429 },
1366− {
1430+ {
1367 "in":"body",
1431 "in":"body",
1368 "name":"body",
1432 "name":"body",
1369 "description":"Updated user object",
1433 "description":"Updated user object",
1370 "required":true,
1434 "required":true,
1371− "schema":{
1435+ "schema":{
1372 "$ref":"#/definitions/User"
1436 "$ref":"#/definitions/User"
1373 }
1437 }
1374 }
1438 }
1375 ],
1439 ],
1376− "responses":{
1440+ "responses":{
1377− "400":{
1441+ "400":{
1378 "description":"Invalid user supplied"
1442 "description":"Invalid user supplied"
1379 },
1443 },
1380− "404":{
1444+ "404":{
1381 "description":"User not found"
1445 "description":"User not found"
1382 }
1446 }
1383 }
1447 }
1384 },
1448 },
1385− "delete":{
1449+ "delete":{
1386− "tags":[
1450+ "tags":[
1387 "user"
1451 "user"
1388 ],
1452 ],
1389 "summary":"Delete user",
1453 "summary":"Delete user",
1390 "description":"This can only be done by the logged in user.",
1454 "description":"This can only be done by the logged in user.",
1391 "operationId":"deleteUser",
1455 "operationId":"deleteUser",
1392− "produces":[
1456+ "produces":[
1393 "application/xml",
1457 "application/xml",
1394 "application/json"
1458 "application/json"
1395 ],
1459 ],
1396− "parameters":[
1460+ "parameters":[
1397− {
1461+ {
1398 "name":"username",
1462 "name":"username",
1399 "in":"path",
1463 "in":"path",
1400 "description":"The name that needs to be deleted",
1464 "description":"The name that needs to be deleted",
@@ -1402,207 +1466,237 @@ petstoreExampleJSON = [aesonQQ|
1402 "type":"string"
1466 "type":"string"
1403 }
1467 }
1404 ],
1468 ],
1405− "responses":{
1469+ "responses":{
1406− "400":{
1470+ "400":{
1407 "description":"Invalid username supplied"
1471 "description":"Invalid username supplied"
1408 },
1472 },
1409− "404":{
1473+ "404":{
1410 "description":"User not found"
1474 "description":"User not found"
1411 }
1475 }
1412 }
1476 }
1413 }
1477 }
1414 }
1478 }
1415 },
1479 },
1416− "securityDefinitions":{
1480+ "securityDefinitions":{
1417− "petstore_auth":{
1481+ "petstore_auth":{
1418 "type":"oauth2",
1482 "type":"oauth2",
1419 "authorizationUrl":"http://petstore.swagger.io/api/oauth/dialog",
1483 "authorizationUrl":"http://petstore.swagger.io/api/oauth/dialog",
1420 "flow":"implicit",
1484 "flow":"implicit",
1421− "scopes":{
1485+ "scopes":{
1422 "write:pets":"modify pets in your account",
1486 "write:pets":"modify pets in your account",
1423 "read:pets":"read your pets"
1487 "read:pets":"read your pets"
1424 }
1488 }
1425 },
1489 },
1426− "api_key":{
1490+ "api_key":{
1427 "type":"apiKey",
1491 "type":"apiKey",
1428 "name":"api_key",
1492 "name":"api_key",
1429 "in":"header"
1493 "in":"header"
1430 }
1494 }
1431 },
1495 },
1432− "definitions":{
1496+ "definitions":{
1433− "Order":{
1497+ "Order":{
1434 "type":"object",
1498 "type":"object",
1435− "properties":{
1499+ "properties":{
1436− "id":{
1500+ "id":{
1437 "type":"integer",
1501 "type":"integer",
1438 "format":"int64"
1502 "format":"int64"
1439 },
1503 },
1440− "petId":{
1504+ "petId":{
1441 "type":"integer",
1505 "type":"integer",
1442 "format":"int64"
1506 "format":"int64"
1443 },
1507 },
1444− "quantity":{
1508+ "quantity":{
1445 "type":"integer",
1509 "type":"integer",
1446 "format":"int32"
1510 "format":"int32"
1447 },
1511 },
1448− "shipDate":{
1512+ "shipDate":{
1449 "type":"string",
1513 "type":"string",
1450 "format":"date-time"
1514 "format":"date-time"
1451 },
1515 },
1452− "status":{
1516+ "status":{
1453 "type":"string",
1517 "type":"string",
1454 "description":"Order Status",
1518 "description":"Order Status",
1455− "enum":[
1519+ "enum":[
1456 "placed",
1520 "placed",
1457 "approved",
1521 "approved",
1458 "delivered"
1522 "delivered"
1459 ]
1523 ]
1460 },
1524 },
1461− "complete":{
1525+ "complete":{
1462 "type":"boolean",
1526 "type":"boolean",
1463 "default":false
1527 "default":false
1464 }
1528 }
1465 },
1529 },
1466− "xml":{
1530+ "xml":{
1467 "name":"Order"
1531 "name":"Order"
1468 }
1532 }
1469 },
1533 },
1470− "Category":{
1534+ "Category":{
1471 "type":"object",
1535 "type":"object",
1472− "properties":{
1536+ "properties":{
1473− "id":{
1537+ "id":{
1474 "type":"integer",
1538 "type":"integer",
1475 "format":"int64"
1539 "format":"int64"
1476 },
1540 },
1477− "name":{
1541+ "name":{
1478 "type":"string"
1542 "type":"string"
1479 }
1543 }
1480 },
1544 },
1481− "xml":{
1545+ "xml":{
1482 "name":"Category"
1546 "name":"Category"
1483 }
1547 }
1484 },
1548 },
1485− "User":{
1549+ "User":{
1486 "type":"object",
1550 "type":"object",
1487− "properties":{
1551+ "properties":{
1488− "id":{
1552+ "id":{
1489 "type":"integer",
1553 "type":"integer",
1490 "format":"int64"
1554 "format":"int64"
1491 },
1555 },
1492− "username":{
1556+ "username":{
1493 "type":"string"
1557 "type":"string"
1494 },
1558 },
1495− "firstName":{
1559+ "firstName":{
1496 "type":"string"
1560 "type":"string"
1497 },
1561 },
1498− "lastName":{
1562+ "lastName":{
1499 "type":"string"
1563 "type":"string"
1500 },
1564 },
1501− "email":{
1565+ "email":{
1502 "type":"string"
1566 "type":"string"
1503 },
1567 },
1504− "password":{
1568+ "password":{
1505 "type":"string"
1569 "type":"string"
1506 },
1570 },
1507− "phone":{
1571+ "phone":{
1508 "type":"string"
1572 "type":"string"
1509 },
1573 },
1510− "userStatus":{
1574+ "userStatus":{
1511 "type":"integer",
1575 "type":"integer",
1512 "format":"int32",
1576 "format":"int32",
1513 "description":"User Status"
1577 "description":"User Status"
1514 }
1578 }
1515 },
1579 },
1516− "xml":{
1580+ "xml":{
1517 "name":"User"
1581 "name":"User"
1518 }
1582 }
1519 },
1583 },
1520− "Tag":{
1584+ "Tag":{
1521 "type":"object",
1585 "type":"object",
1522− "properties":{
1586+ "properties":{
1523− "id":{
1587+ "id":{
1524 "type":"integer",
1588 "type":"integer",
1525 "format":"int64"
1589 "format":"int64"
1526 },
1590 },
1527− "name":{
1591+ "name":{
1528 "type":"string"
1592 "type":"string"
1529 }
1593 }
1530 },
1594 },
1531− "xml":{
1595+ "xml":{
1532 "name":"Tag"
1596 "name":"Tag"
1533 }
1597 }
1534 },
1598 },
1535− "Pet":{
1599+ "Pet":{
1536 "type":"object",
1600 "type":"object",
1537− "required":[
1601+ "required":[
1538 "name",
1602 "name",
1539 "photoUrls"
1603 "photoUrls"
1540 ],
1604 ],
1541− "properties":{
1605+ "properties":{
1542− "id":{
1606+ "id":{
1543 "type":"integer",
1607 "type":"integer",
1544 "format":"int64"
1608 "format":"int64"
1545 },
1609 },
1546− "category":{
1610+ "category":{
1547 "$ref":"#/definitions/Category"
1611 "$ref":"#/definitions/Category"
1548 },
1612 },
1549− "name":{
1613+ "name":{
1550 "type":"string",
1614 "type":"string",
1551 "example":"doggie"
1615 "example":"doggie"
1552 },
1616 },
1553− "photoUrls":{
1617+ "photoUrls":{
1554 "type":"array",
1618 "type":"array",
1555− "xml":{
1619+ "xml":{
1556 "name":"photoUrl",
1620 "name":"photoUrl",
1557 "wrapped":true
1621 "wrapped":true
1558 },
1622 },
1559− "items":{
1623+ "items":{
1560 "type":"string"
1624 "type":"string"
1561 }
1625 }
1562 },
1626 },
1563− "tags":{
1627+ "tags":{
1564 "type":"array",
1628 "type":"array",
1565− "xml":{
1629+ "xml":{
1566 "name":"tag",
1630 "name":"tag",
1567 "wrapped":true
1631 "wrapped":true
1568 },
1632 },
1569− "items":{
1633+ "items":{
1570 "$ref":"#/definitions/Tag"
1634 "$ref":"#/definitions/Tag"
1571 }
1635 }
1572 },
1636 },
1573− "status":{
1637+ "status":{
1574 "type":"string",
1638 "type":"string",
1575 "description":"pet status in the store",
1639 "description":"pet status in the store",
1576− "enum":[
1640+ "enum":[
1577 "available",
1641 "available",
1578 "pending",
1642 "pending",
1579 "sold"
1643 "sold"
1580 ]
1644 ]
1581 }
1645 }
1582 },
1646 },
1583− "xml":{
1647+ "xml":{
1584 "name":"Pet"
1648 "name":"Pet"
1585 }
1649 }
1586 },
1650 },
1587− "ApiResponse":{
1651+ "ApiResponse":{
1588 "type":"object",
1652 "type":"object",
1589− "properties":{
1653+ "properties":{
1590− "code":{
1654+ "code":{
1591 "type":"integer",
1655 "type":"integer",
1592 "format":"int32"
1656 "format":"int32"
1593 },
1657 },
1594− "type":{
1658+ "type":{
1595 "type":"string"
1659 "type":"string"
1596 },
1660 },
1597− "message":{
1661+ "message":{
1598 "type":"string"
1662 "type":"string"
1599 }
1663 }
1600 }
1664 }
1601 }
1665 }
1602 },
1666 },
1603− "externalDocs":{
1667+ "externalDocs":{
1604 "description":"Find out more about Swagger",
1668 "description":"Find out more about Swagger",
1605 "url":"http://swagger.io"
1669 "url":"http://swagger.io"
1606 }
1670 }
1607}
1671}
1608|]
1672|]
1673+
1674+compositionSchemaExample :: Schema
1675+compositionSchemaExample = mempty
1676+ & type_ ?~ SwaggerObject
1677+ & Data.Swagger.allOf ?~ [
1678+ Ref (Reference "Other")
1679+ , Inline (mempty
1680+ & type_ ?~ SwaggerObject
1681+ & properties .~
1682+ [ ("greet", Inline $ mempty
1683+ & type_ ?~ SwaggerString) ])
1684+ ]
1685+
1686+compositionSchemaExampleJSON :: Value
1687+compositionSchemaExampleJSON = [aesonQQ|
1688+{
1689+ "type": "object",
1690+ "allOf": [
1691+ {
1692+ "$ref": "#/definitions/Other"
1693+ },
1694+ {
1695+ "type": "object",
1696+ "properties": {
1697+ "greet": { "type": "string" }
1698+ }
1699+ }
1700+ ]
1701+}
1702+|]
test/DocTest.hsdeleted−7
@@ -1,7 +0,0 @@
1−module Main (main) where
2−
3−import System.FilePath.Glob (glob)
4−import Test.DocTest (doctest)
5−
6−main :: IO ()
7−main = glob "src/**/*.hs" >>= doctest
test/SpecCommon.hs+7−2
@@ -1,6 +1,7 @@
1module SpecCommon where
1module SpecCommon where
2
2
3import Data.Aeson
3import Data.Aeson
4+import Data.ByteString.Builder (toLazyByteString)
4import qualified Data.Foldable as F
5import qualified Data.Foldable as F
5import qualified Data.HashMap.Strict as HashMap
6import qualified Data.HashMap.Strict as HashMap
6import qualified Data.Vector as Vector
7import qualified Data.Vector as Vector
@@ -21,5 +22,9 @@ x <=> js = do
21 toJSON x `shouldBe` js
22 toJSON x `shouldBe` js
22 it "decodes correctly" $ do
23 it "decodes correctly" $ do
23 fromJSON js `shouldBe` Success x
24 fromJSON js `shouldBe` Success x
24−
25+ it "roundtrips: eitherDecode . encode" $ do
25−
26+ eitherDecode (encode x) `shouldBe` Right x
27+ it "roundtrips with toJSON" $ do
28+ eitherDecode (encode $ toJSON x) `shouldBe` Right x
29+ it "roundtrips with toEncoding" $ do
30+ eitherDecode (toLazyByteString $ fromEncoding $ toEncoding x) `shouldBe` Right x
test/doctests.hsnew file+12
@@ -0,0 +1,12 @@
1+module Main where
2+
3+import Build_doctests (flags, pkgs, module_sources)
4+import Data.Foldable (traverse_)
5+import Test.DocTest
6+
7+main :: IO ()
8+main = do
9+ traverse_ putStrLn args
10+ doctest args
11+ where
12+ args = flags ++ pkgs ++ module_sources