git.iko.soy/typeable/openapi3
on 6978807 help sign in
340d86f
swap
0 ahead, 53 behind
.github/workflows/haskell-ci.ymldeleted−243
since splitsnapshots
unifiedsplit
@@ -1,243 +0,0 @@
1−# This GitHub workflow config has been generated by a script via
2−#
3−# haskell-ci 'github' 'cabal.project'
4−#
5−# To regenerate the script (for example after adjusting tested-with) run
6−#
7−# haskell-ci regenerate
8−#
9−# For more information, see https://github.com/haskell-CI/haskell-ci
10−#
11−# version: 0.14.3
12−#
13−# REGENDATA ("0.14.3",["github","cabal.project"])
14−#
15−name: Haskell-CI
16−on:
17− push:
18− branches:
19− - master
20− pull_request:
21− branches:
22− - master
23−jobs:
24− linux:
25− name: Haskell-CI - Linux - ${{ matrix.compiler }}
26− runs-on: ubuntu-18.04
27− timeout-minutes:
28− 60
29− container:
30− image: buildpack-deps:focal
31− continue-on-error: ${{ matrix.allow-failure }}
32− strategy:
33− matrix:
34− include:
35− - compiler: ghc-9.2.2
36− compilerKind: ghc
37− compilerVersion: 9.2.2
38− setup-method: ghcup
39− allow-failure: true
40− - compiler: ghc-9.0.2
41− compilerKind: ghc
42− compilerVersion: 9.0.2
43− setup-method: ghcup
44− allow-failure: false
45− - compiler: ghc-8.10.7
46− compilerKind: ghc
47− compilerVersion: 8.10.7
48− setup-method: ghcup
49− allow-failure: false
50− - compiler: ghc-8.8.4
51− compilerKind: ghc
52− compilerVersion: 8.8.4
53− setup-method: hvr-ppa
54− allow-failure: false
55− - compiler: ghc-8.6.5
56− compilerKind: ghc
57− compilerVersion: 8.6.5
58− setup-method: hvr-ppa
59− allow-failure: false
60− - compiler: ghc-8.4.4
61− compilerKind: ghc
62− compilerVersion: 8.4.4
63− setup-method: hvr-ppa
64− allow-failure: false
65− fail-fast: false
66− steps:
67− - name: apt
68− run: |
69− apt-get update
70− apt-get install -y --no-install-recommends gnupg ca-certificates dirmngr curl git software-properties-common libtinfo5
71− if [ "${{ matrix.setup-method }}" = ghcup ]; then
72− mkdir -p "$HOME/.ghcup/bin"
73− curl -sL https://downloads.haskell.org/ghcup/0.1.17.5/x86_64-linux-ghcup-0.1.17.5 > "$HOME/.ghcup/bin/ghcup"
74− chmod a+x "$HOME/.ghcup/bin/ghcup"
75− "$HOME/.ghcup/bin/ghcup" install ghc "$HCVER"
76− "$HOME/.ghcup/bin/ghcup" install cabal 3.6.2.0
77− else
78− apt-add-repository -y 'ppa:hvr/ghc'
79− apt-get update
80− apt-get install -y "$HCNAME"
81− mkdir -p "$HOME/.ghcup/bin"
82− curl -sL https://downloads.haskell.org/ghcup/0.1.17.5/x86_64-linux-ghcup-0.1.17.5 > "$HOME/.ghcup/bin/ghcup"
83− chmod a+x "$HOME/.ghcup/bin/ghcup"
84− "$HOME/.ghcup/bin/ghcup" install cabal 3.6.2.0
85− fi
86− env:
87− HCKIND: ${{ matrix.compilerKind }}
88− HCNAME: ${{ matrix.compiler }}
89− HCVER: ${{ matrix.compilerVersion }}
90− - name: Set PATH and environment variables
91− run: |
92− echo "$HOME/.cabal/bin" >> $GITHUB_PATH
93− echo "LANG=C.UTF-8" >> "$GITHUB_ENV"
94− echo "CABAL_DIR=$HOME/.cabal" >> "$GITHUB_ENV"
95− echo "CABAL_CONFIG=$HOME/.cabal/config" >> "$GITHUB_ENV"
96− HCDIR=/opt/$HCKIND/$HCVER
97− if [ "${{ matrix.setup-method }}" = ghcup ]; then
98− HC=$HOME/.ghcup/bin/$HCKIND-$HCVER
99− echo "HC=$HC" >> "$GITHUB_ENV"
100− echo "HCPKG=$HOME/.ghcup/bin/$HCKIND-pkg-$HCVER" >> "$GITHUB_ENV"
101− echo "HADDOCK=$HOME/.ghcup/bin/haddock-$HCVER" >> "$GITHUB_ENV"
102− echo "CABAL=$HOME/.ghcup/bin/cabal-3.6.2.0 -vnormal+nowrap" >> "$GITHUB_ENV"
103− else
104− HC=$HCDIR/bin/$HCKIND
105− echo "HC=$HC" >> "$GITHUB_ENV"
106− echo "HCPKG=$HCDIR/bin/$HCKIND-pkg" >> "$GITHUB_ENV"
107− echo "HADDOCK=$HCDIR/bin/haddock" >> "$GITHUB_ENV"
108− echo "CABAL=$HOME/.ghcup/bin/cabal-3.6.2.0 -vnormal+nowrap" >> "$GITHUB_ENV"
109− fi
110−
111− HCNUMVER=$(${HC} --numeric-version|perl -ne '/^(\d+)\.(\d+)\.(\d+)(\.(\d+))?$/; print(10000 * $1 + 100 * $2 + ($3 == 0 ? $5 != 1 : $3))')
112− echo "HCNUMVER=$HCNUMVER" >> "$GITHUB_ENV"
113− echo "ARG_TESTS=--enable-tests" >> "$GITHUB_ENV"
114− echo "ARG_BENCH=--enable-benchmarks" >> "$GITHUB_ENV"
115− echo "HEADHACKAGE=false" >> "$GITHUB_ENV"
116− echo "ARG_COMPILER=--$HCKIND --with-compiler=$HC" >> "$GITHUB_ENV"
117− echo "GHCJSARITH=0" >> "$GITHUB_ENV"
118− env:
119− HCKIND: ${{ matrix.compilerKind }}
120− HCNAME: ${{ matrix.compiler }}
121− HCVER: ${{ matrix.compilerVersion }}
122− - name: env
123− run: |
124− env
125− - name: write cabal config
126− run: |
127− mkdir -p $CABAL_DIR
128− cat >> $CABAL_CONFIG <<EOF
129− remote-build-reporting: anonymous
130− write-ghc-environment-files: never
131− remote-repo-cache: $CABAL_DIR/packages
132− logs-dir: $CABAL_DIR/logs
133− world-file: $CABAL_DIR/world
134− extra-prog-path: $CABAL_DIR/bin
135− symlink-bindir: $CABAL_DIR/bin
136− installdir: $CABAL_DIR/bin
137− build-summary: $CABAL_DIR/logs/build.log
138− store-dir: $CABAL_DIR/store
139− install-dirs user
140− prefix: $CABAL_DIR
141− repository hackage.haskell.org
142− url: http://hackage.haskell.org/
143− EOF
144− cat >> $CABAL_CONFIG <<EOF
145− program-default-options
146− ghc-options: $GHCJOBS +RTS -M3G -RTS
147− EOF
148− cat $CABAL_CONFIG
149− - name: versions
150− run: |
151− $HC --version || true
152− $HC --print-project-git-commit-id || true
153− $CABAL --version || true
154− - name: update cabal index
155− run: |
156− $CABAL v2-update -v
157− - name: install cabal-plan
158− run: |
159− mkdir -p $HOME/.cabal/bin
160− curl -sL https://github.com/haskell-hvr/cabal-plan/releases/download/v0.6.2.0/cabal-plan-0.6.2.0-x86_64-linux.xz > cabal-plan.xz
161− echo 'de73600b1836d3f55e32d80385acc055fd97f60eaa0ab68a755302685f5d81bc cabal-plan.xz' | sha256sum -c -
162− xz -d < cabal-plan.xz > $HOME/.cabal/bin/cabal-plan
163− rm -f cabal-plan.xz
164− chmod a+x $HOME/.cabal/bin/cabal-plan
165− cabal-plan --version
166− - name: checkout
167− uses: actions/checkout@v2
168− with:
169− path: source
170− - name: initial cabal.project for sdist
171− run: |
172− touch cabal.project
173− echo "packages: $GITHUB_WORKSPACE/source/." >> cabal.project
174− cat cabal.project
175− - name: sdist
176− run: |
177− mkdir -p sdist
178− $CABAL sdist all --output-dir $GITHUB_WORKSPACE/sdist
179− - name: unpack
180− run: |
181− mkdir -p unpacked
182− find sdist -maxdepth 1 -type f -name '*.tar.gz' -exec tar -C $GITHUB_WORKSPACE/unpacked -xzvf {} \;
183− - name: generate cabal.project
184− run: |
185− PKGDIR_openapi3="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/openapi3-[0-9.]*')"
186− echo "PKGDIR_openapi3=${PKGDIR_openapi3}" >> "$GITHUB_ENV"
187− rm -f cabal.project cabal.project.local
188− touch cabal.project
189− touch cabal.project.local
190− echo "packages: ${PKGDIR_openapi3}" >> cabal.project
191− echo "package openapi3" >> cabal.project
192− echo " ghc-options: -Werror=missing-methods" >> cabal.project
193− cat >> cabal.project <<EOF
194− allow-newer: http-media:base
195− EOF
196− $HCPKG list --simple-output --names-only | perl -ne 'for (split /\s+/) { print "constraints: $_ installed\n" unless /^(openapi3)$/; }' >> cabal.project.local
197− cat cabal.project
198− cat cabal.project.local
199− - name: dump install plan
200− run: |
201− $CABAL v2-build $ARG_COMPILER $ARG_TESTS $ARG_BENCH --dry-run all
202− cabal-plan
203− - name: cache
204− uses: actions/cache@v2
205− with:
206− key: ${{ runner.os }}-${{ matrix.compiler }}-${{ github.sha }}
207− path: ~/.cabal/store
208− restore-keys: ${{ runner.os }}-${{ matrix.compiler }}-
209− - name: install dependencies
210− run: |
211− $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks --dependencies-only -j2 all
212− $CABAL v2-build $ARG_COMPILER $ARG_TESTS $ARG_BENCH --dependencies-only -j2 all
213− - name: build w/o tests
214− run: |
215− $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks all
216− - name: build
217− run: |
218− $CABAL v2-build $ARG_COMPILER $ARG_TESTS $ARG_BENCH all --write-ghc-environment-files=always
219− - name: tests
220− run: |
221− $CABAL v2-test $ARG_COMPILER $ARG_TESTS $ARG_BENCH all --test-show-details=direct
222− - name: cabal check
223− run: |
224− cd ${PKGDIR_openapi3} || false
225− ${CABAL} -vnormal check
226− - name: haddock
227− run: |
228− $CABAL v2-haddock $ARG_COMPILER --with-haddock $HADDOCK $ARG_TESTS $ARG_BENCH all
229− - name: unconstrained build
230− run: |
231− rm -f cabal.project.local
232− $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks all
233− - name: prepare for constraint sets
234− run: |
235− rm -f cabal.project.local
236− - name: constraint set aeson-2
237− run: |
238− $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks --constraint='aeson >=2.0' --dependencies-only -j2 all
239− $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks --constraint='aeson >=2.0' all
240− - name: constraint set aeson-1
241− run: |
242− if [ $((HCNUMVER < 90200)) -ne 0 ] ; then $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks --constraint='aeson <2.0' --dependencies-only -j2 all ; fi
243− if [ $((HCNUMVER < 90200)) -ne 0 ] ; then $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks --constraint='aeson <2.0' all ; fi
.travis.ymlnew file+149
@@ -0,0 +1,149 @@
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+# To regenerate the script (for example after adjusting tested-with) run
6+#
7+# haskell-ci regenerate
8+#
9+# For more information, see https://github.com/haskell-CI/haskell-ci
10+#
11+# version: 0.10.1
12+#
13+version: ~> 1.0
14+language: c
15+os: linux
16+dist: xenial
17+git:
18+ # whether to recursively clone submodules
19+ submodules: false
20+branches:
21+ only:
22+ - master
23+cache:
24+ directories:
25+ - $HOME/.cabal/packages
26+ - $HOME/.cabal/store
27+ - $HOME/.hlint
28+before_cache:
29+ - rm -fv $CABALHOME/packages/hackage.haskell.org/build-reports.log
30+ # remove files that are regenerated by 'cabal update'
31+ - rm -fv $CABALHOME/packages/hackage.haskell.org/00-index.*
32+ - rm -fv $CABALHOME/packages/hackage.haskell.org/*.json
33+ - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.cache
34+ - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.tar
35+ - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.tar.idx
36+ - rm -rfv $CABALHOME/packages/head.hackage
37+jobs:
38+ include:
39+ - compiler: ghc-8.10.1
40+ addons: {"apt":{"sources":[{"sourceline":"deb http://ppa.launchpad.net/hvr/ghc/ubuntu xenial main","key_url":"https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x063dab2bdc0b3f9fcebc378bff3aeacef6f88286"}],"packages":["ghc-8.10.1","cabal-install-3.2"]}}
41+ os: linux
42+ - compiler: ghc-8.8.3
43+ addons: {"apt":{"sources":[{"sourceline":"deb http://ppa.launchpad.net/hvr/ghc/ubuntu xenial main","key_url":"https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x063dab2bdc0b3f9fcebc378bff3aeacef6f88286"}],"packages":["ghc-8.8.3","cabal-install-3.2"]}}
44+ os: linux
45+ - compiler: ghc-8.6.5
46+ addons: {"apt":{"sources":[{"sourceline":"deb http://ppa.launchpad.net/hvr/ghc/ubuntu xenial main","key_url":"https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x063dab2bdc0b3f9fcebc378bff3aeacef6f88286"}],"packages":["ghc-8.6.5","cabal-install-3.2"]}}
47+ os: linux
48+ - compiler: ghc-8.4.4
49+ addons: {"apt":{"sources":[{"sourceline":"deb http://ppa.launchpad.net/hvr/ghc/ubuntu xenial main","key_url":"https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x063dab2bdc0b3f9fcebc378bff3aeacef6f88286"}],"packages":["ghc-8.4.4","cabal-install-3.2"]}}
50+ os: linux
51+before_install:
52+ - HC=$(echo "/opt/$CC/bin/ghc" | sed 's/-/\//')
53+ - WITHCOMPILER="-w $HC"
54+ - HADDOCK=$(echo "/opt/$CC/bin/haddock" | sed 's/-/\//')
55+ - HCPKG="$HC-pkg"
56+ - unset CC
57+ - CABAL=/opt/ghc/bin/cabal
58+ - CABALHOME=$HOME/.cabal
59+ - export PATH="$CABALHOME/bin:$PATH"
60+ - TOP=$(pwd)
61+ - "HCNUMVER=$(${HC} --numeric-version|perl -ne '/^(\\d+)\\.(\\d+)\\.(\\d+)(\\.(\\d+))?$/; print(10000 * $1 + 100 * $2 + ($3 == 0 ? $5 != 1 : $3))')"
62+ - echo $HCNUMVER
63+ - CABAL="$CABAL -vnormal+nowrap"
64+ - set -o pipefail
65+ - TEST=--enable-tests
66+ - BENCH=--enable-benchmarks
67+ - HEADHACKAGE=false
68+ - rm -f $CABALHOME/config
69+ - |
70+ echo "verbose: normal +nowrap +markoutput" >> $CABALHOME/config
71+ echo "remote-build-reporting: anonymous" >> $CABALHOME/config
72+ echo "write-ghc-environment-files: always" >> $CABALHOME/config
73+ echo "remote-repo-cache: $CABALHOME/packages" >> $CABALHOME/config
74+ echo "logs-dir: $CABALHOME/logs" >> $CABALHOME/config
75+ echo "world-file: $CABALHOME/world" >> $CABALHOME/config
76+ echo "extra-prog-path: $CABALHOME/bin" >> $CABALHOME/config
77+ echo "symlink-bindir: $CABALHOME/bin" >> $CABALHOME/config
78+ echo "installdir: $CABALHOME/bin" >> $CABALHOME/config
79+ echo "build-summary: $CABALHOME/logs/build.log" >> $CABALHOME/config
80+ echo "store-dir: $CABALHOME/store" >> $CABALHOME/config
81+ echo "install-dirs user" >> $CABALHOME/config
82+ echo " prefix: $CABALHOME" >> $CABALHOME/config
83+ echo "repository hackage.haskell.org" >> $CABALHOME/config
84+ echo " url: http://hackage.haskell.org/" >> $CABALHOME/config
85+install:
86+ - ${CABAL} --version
87+ - echo "$(${HC} --version) [$(${HC} --print-project-git-commit-id 2> /dev/null || echo '?')]"
88+ - |
89+ echo "program-default-options" >> $CABALHOME/config
90+ echo " ghc-options: $GHCJOBS +RTS -M6G -RTS" >> $CABALHOME/config
91+ - cat $CABALHOME/config
92+ - rm -fv cabal.project cabal.project.local cabal.project.freeze
93+ - travis_retry ${CABAL} v2-update -v
94+ # Generate cabal.project
95+ - rm -rf cabal.project cabal.project.local cabal.project.freeze
96+ - touch cabal.project
97+ - |
98+ echo "packages: ." >> cabal.project
99+ - echo 'package swagger2' >> cabal.project
100+ - "echo ' ghc-options: -Werror=missing-methods' >> cabal.project"
101+ - |
102+ - "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"
103+ - cat cabal.project || true
104+ - cat cabal.project.local || true
105+ - if [ -f "./configure.ac" ]; then (cd "." && autoreconf -i); fi
106+ - ${CABAL} v2-freeze $WITHCOMPILER ${TEST} ${BENCH}
107+ - "cat cabal.project.freeze | sed -E 's/^(constraints: *| *)//' | sed 's/any.//'"
108+ - rm cabal.project.freeze
109+ - travis_wait 40 ${CABAL} v2-build $WITHCOMPILER ${TEST} ${BENCH} --dep -j2 all
110+ - travis_wait 40 ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks --dep -j2 all
111+script:
112+ - DISTDIR=$(mktemp -d /tmp/dist-test.XXXX)
113+ # Packaging...
114+ - ${CABAL} v2-sdist all
115+ # Unpacking...
116+ - mv dist-newstyle/sdist/*.tar.gz ${DISTDIR}/
117+ - cd ${DISTDIR} || false
118+ - find . -maxdepth 1 -type f -name '*.tar.gz' -exec tar -xvf '{}' \;
119+ - find . -maxdepth 1 -type f -name '*.tar.gz' -exec rm '{}' \;
120+ - PKGDIR_swagger2="$(find . -maxdepth 1 -type d -regex '.*/swagger2-[0-9.]*')"
121+ # Generate cabal.project
122+ - rm -rf cabal.project cabal.project.local cabal.project.freeze
123+ - touch cabal.project
124+ - |
125+ echo "packages: ${PKGDIR_swagger2}" >> cabal.project
126+ - echo 'package swagger2' >> cabal.project
127+ - "echo ' ghc-options: -Werror=missing-methods' >> cabal.project"
128+ - |
129+ - "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"
130+ - cat cabal.project || true
131+ - cat cabal.project.local || true
132+ # Building...
133+ # this builds all libraries and executables (without tests/benchmarks)
134+ - ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks all
135+ # Building with tests and benchmarks...
136+ # build & run tests, build benchmarks
137+ - ${CABAL} v2-build $WITHCOMPILER ${TEST} ${BENCH} all
138+ # Testing...
139+ - ${CABAL} v2-test $WITHCOMPILER ${TEST} ${BENCH} all
140+ # cabal check...
141+ - (cd ${PKGDIR_swagger2} && ${CABAL} -vnormal check)
142+ # haddock...
143+ - ${CABAL} v2-haddock $WITHCOMPILER --with-haddock $HADDOCK ${TEST} ${BENCH} all
144+ # Building without installed constraints for packages in global-db...
145+ - rm -f cabal.project.local
146+ - ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks all
147+
148+# REGENDATA ("0.10.1",["--branches","master","--haddock-jobs=>=8.4","--output",".travis.yml","swagger2.cabal"])
149+# EOF
CHANGELOG.md−47
@@ -1,50 +1,3 @@
1−Unreleased
2−----------
3−
4−3.2.2
5−-----
6−
7−- Fix bug with infinite recursion in GToSchema [#37](https://github.com/biocad/openapi3/pull/37).
8−
9−3.2.1
10−-----
11−
12−- Support aeson-2.0.3.
13−- Support GHC-9.2 (doctests still fail).
14−
15−3.2.0
16−-----
17−
18−- Support aeson-2 [#34](https://github.com/biocad/openapi3/pull/34).
19−- Use `SecurityDefinitions` type for `_componentsSecuritySchemes`
20− [#32](https://github.com/biocad/openapi3/pull/32).
21−
22−3.1.0
23−-----
24−
25−- Use `format: date-time` for `ToParamSchema ZonedTime` instance (see
26− [#20](https://github.com/biocad/openapi3/pull/20)).
27−- Support generating schema for any polymorphic types via `Typeable` (see
28− [#19](https://github.com/biocad/openapi3/pull/19)).
29−- Allow `hashable-1.3.1`, prettify doctests (see [#18](https://github.com/biocad/openapi3/pull/18)).
30−
31−3.0.2.0
32−-------
33−
34−- Fix definition for HTTP security scheme (see [#10](https://github.com/biocad/openapi3/pull/10));
35−- Fix error message in `exclusiveMaximum` / `exclusiveMinimum` validation (see
36− [#15](https://github.com/biocad/openapi3/pull/15));
37−
38−3.0.1.0
39−-------
40−
41−- Support polymorphic types in schema generator.
42−
43−3.0.0
44−-----
45−
46−- Switch to OpenAPI 3.0 specification.
47−
482.6.1
12.6.1
49-----
2-----
50
3
README.md+11−13
@@ -1,22 +1,21 @@
1−# OpenApi 3
1+# swagger2
2
2
3−[![Hackage](https://img.shields.io/hackage/v/openapi3.svg)](http://hackage.haskell.org/package/openapi3)
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−[![Build Status](https://travis-ci.org/biocad/openapi3.svg?branch=master)](https://travis-ci.org/biocad/openapi3)
5−[![Stackage LTS](http://stackage.org/package/openapi3/badge/lts)](http://stackage.org/lts/package/opeopenapi3)
6−[![Stackage Nightly](http://stackage.org/package/openapi3/badge/nightly)](http://stackage.org/nightly/package/openapi3)
7
4
8−OpenAPI 3.0 data model.
5+[![Hackage](https://img.shields.io/hackage/v/swagger2.svg)](http://hackage.haskell.org/package/swagger2)
6+[![Build Status](https://travis-ci.org/GetShopTV/swagger2.svg?branch=master)](https://travis-ci.org/GetShopTV/swagger2)
7+[![Stackage LTS](http://stackage.org/package/swagger2/badge/lts)](http://stackage.org/lts/package/swagger2)
8+[![Stackage Nightly](http://stackage.org/package/swagger2/badge/nightly)](http://stackage.org/nightly/package/swagger2)
9
9
10−The original OpenAPI 3.0 specification is available at http://swagger.io/specification/.
10+Swagger 2.0 data model.
11
11
12−This package is heavily based on excellent work on Swagger 2.0 at
12+The original Swagger 2.0 specification is available at http://swagger.io/specification/.
13−https://github.com/GetShopTV/swagger2.
14
13
15## Usage
14## Usage
16
15
17−This library is intended to be used for decoding and encoding OpenApi 3.0.3 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.
18
17
19−Please refer to [haddock documentation](http://hackage.haskell.org/package/openapi3).
18+Please refer to [haddock documentation](http://hackage.haskell.org/package/swagger2).
20
19
21Some examples can be found in [`examples/` directory](/examples).
20Some examples can be found in [`examples/` directory](/examples).
22
21
@@ -34,8 +33,7 @@ Many Swagger tools, including server and client code generation for many languag
34
33
35We are happy to receive bug reports, fixes, documentation enhancements, and other improvements.
34We are happy to receive bug reports, fixes, documentation enhancements, and other improvements.
36
35
37−Please report bugs via the [github issue tracker](https://github.com/biocad/openapi3/issues).
36+Please report bugs via the [github issue tracker](https://github.com/GetShopTV/swagger2/issues).
38
37
39*GetShopTV Team*
38*GetShopTV Team*
40
39
41−*Biocad Team*
cabal.haskell-cideleted−11
@@ -1,11 +0,0 @@
1−branches: master
2−
3−distribution: focal
4−allow-failures: >=9.2
5−
6−constraint-set aeson-1
7− constraints: aeson <2.0
8− ghc: <9.2
9−
10−constraint-set aeson-2
11− constraints: aeson >=2.0
cabal.project−2
@@ -1,4 +1,2 @@
1packages: .
1packages: .
2tests: true
2tests: true
3−
4−allow-newer: http-media:base
examples/hackage.hs+20−16
@@ -10,10 +10,10 @@ import Data.Proxy
10import Data.Text (Text)
10import Data.Text (Text)
11import GHC.Generics
11import GHC.Generics
12
12
13−import Data.OpenApi
13+import Data.Swagger
14−import Data.OpenApi.Declare
14+import Data.Swagger.Declare
15−import Data.OpenApi.Lens
15+import Data.Swagger.Lens
16−import Data.OpenApi.Operation
16+import Data.Swagger.Operation
17
17
18type Username = Text
18type Username = Text
19
19
@@ -27,7 +27,7 @@ instance ToSchema UserSummary where
27 usernameSchema <- declareSchemaRef (Proxy :: Proxy Username)
27 usernameSchema <- declareSchemaRef (Proxy :: Proxy Username)
28 useridSchema <- declareSchemaRef (Proxy :: Proxy Int)
28 useridSchema <- declareSchemaRef (Proxy :: Proxy Int)
29 return $ NamedSchema (Just "UserSummary") $ mempty
29 return $ NamedSchema (Just "UserSummary") $ mempty
30− & type_ ?~ OpenApiObject
30+ & type_ ?~ SwaggerObject
31 & properties .~
31 & properties .~
32 [ ("summaryUsername", usernameSchema )
32 [ ("summaryUsername", usernameSchema )
33 , ("summaryUserid" , useridSchema )
33 , ("summaryUserid" , useridSchema )
@@ -47,36 +47,40 @@ data UserDetailed = UserDetailed
47newtype Package = Package { packageName :: Text }
47newtype Package = Package { packageName :: Text }
48 deriving (Generic, ToSchema)
48 deriving (Generic, ToSchema)
49
49
50−hackageOpenApi :: OpenApi
50+hackageSwagger :: Swagger
51−hackageOpenApi = spec & components.schemas .~ defs
51+hackageSwagger = spec & definitions .~ defs
52 where
52 where
53− (defs, spec) = runDeclare declareHackageOpenApi mempty
53+ (defs, spec) = runDeclare declareHackageSwagger mempty
54
54
55−declareHackageOpenApi :: Declare (Definitions Schema) OpenApi
55+declareHackageSwagger :: Declare (Definitions Schema) Swagger
56−declareHackageOpenApi = do
56+declareHackageSwagger = do
57 -- param schemas
57 -- param schemas
58 let usernameParamSchema = toParamSchema (Proxy :: Proxy Username)
58 let usernameParamSchema = toParamSchema (Proxy :: Proxy Username)
59
59
60 -- responses
60 -- responses
61− userSummaryResponse <- declareResponse "application/json" (Proxy :: Proxy UserSummary)
61+ userSummaryResponse <- declareResponse (Proxy :: Proxy UserSummary)
62− userDetailedResponse <- declareResponse "application/json" (Proxy :: Proxy UserDetailed)
62+ userDetailedResponse <- declareResponse (Proxy :: Proxy UserDetailed)
63− packagesResponse <- declareResponse "application/json" (Proxy :: Proxy [Package])
63+ packagesResponse <- declareResponse (Proxy :: Proxy [Package])
64
64
65 return $ mempty
65 return $ mempty
66 & paths .~
66 & paths .~
67 [ ("/users", mempty & get ?~ (mempty
67 [ ("/users", mempty & get ?~ (mempty
68+ & produces ?~ MimeList ["application/json"]
68 & at 200 ?~ Inline userSummaryResponse))
69 & at 200 ?~ Inline userSummaryResponse))
69 , ("/user/{username}", mempty & get ?~ (mempty
70 , ("/user/{username}", mempty & get ?~ (mempty
71+ & produces ?~ MimeList ["application/json"]
70 & parameters .~ [ Inline $ mempty
72 & parameters .~ [ Inline $ mempty
71 & name .~ "username"
73 & name .~ "username"
72 & required ?~ True
74 & required ?~ True
75+ & schema .~ ParamOther (mempty
73− & in_ .~ ParamPath
76+ & in_ .~ ParamPath
74− & schema ?~ Inline usernameParamSchema ]
77+ & paramSchema .~ usernameParamSchema) ]
75 & at 200 ?~ Inline userDetailedResponse))
78 & at 200 ?~ Inline userDetailedResponse))
76 , ("/packages", mempty & get ?~ (mempty
79 , ("/packages", mempty & get ?~ (mempty
80+ & produces ?~ MimeList ["application/json"]
77 & at 200 ?~ Inline packagesResponse))
81 & at 200 ?~ Inline packagesResponse))
78 ]
82 ]
79
83
80main :: IO ()
84main :: IO ()
81−main = putStrLn . read . show . encode $ hackageOpenApi
85+main = putStrLn . read . show . encode $ hackageSwagger
82
86
src/Data/OpenApi/Aeson/Compat.hsdeleted−76
@@ -1,76 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−
3−module Data.OpenApi.Aeson.Compat where
4−
5−#if MIN_VERSION_aeson(2,0,0)
6−import Data.Aeson (Key)
7−import qualified Data.Aeson.Key as Key
8−import qualified Data.Aeson.KeyMap as KeyMap
9−#else
10−import qualified Data.HashMap.Strict as HM
11−#endif
12−import Data.Bifunctor (first)
13−import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
14−import qualified Data.Text as T
15−
16−#if MIN_VERSION_aeson(2,0,0)
17−deleteKey :: Key -> KeyMap.KeyMap v -> KeyMap.KeyMap v
18−deleteKey = KeyMap.delete
19−
20−objectToList :: KeyMap.KeyMap v -> [(Key, v)]
21−objectToList = KeyMap.toList
22−
23−objectKeys :: KeyMap.KeyMap v -> [T.Text]
24−objectKeys = map Key.toText . KeyMap.keys
25−
26−stringToKey :: String -> Key
27−stringToKey = Key.fromString
28−
29−keyToString :: Key -> String
30−keyToString = Key.toString
31−
32−keyToText :: Key -> T.Text
33−keyToText = Key.toText
34−
35−toInsOrdHashMap :: KeyMap.KeyMap v -> InsOrdHashMap.InsOrdHashMap T.Text v
36−toInsOrdHashMap = InsOrdHashMap.fromList . fmap (first Key.toText) . KeyMap.toList
37−
38−fromInsOrdHashMap :: InsOrdHashMap.InsOrdHashMap T.Text v -> KeyMap.KeyMap v
39−fromInsOrdHashMap = KeyMap.fromList . fmap (first Key.fromText) . InsOrdHashMap.toList
40−
41−lookupKey :: T.Text -> KeyMap.KeyMap v -> Maybe v
42−lookupKey = KeyMap.lookup . Key.fromText
43−
44−hasKey :: T.Text -> KeyMap.KeyMap a -> Bool
45−hasKey = KeyMap.member . Key.fromText
46−#else
47−deleteKey :: T.Text -> HM.HashMap T.Text v -> HM.HashMap T.Text v
48−deleteKey = HM.delete
49−
50−objectToList :: HM.HashMap T.Text v -> [(T.Text, v)]
51−objectToList = HM.toList
52−
53−objectKeys :: HM.HashMap T.Text v -> [T.Text]
54−objectKeys = HM.keys
55−
56−stringToKey :: String -> T.Text
57−stringToKey = T.pack
58−
59−keyToString :: T.Text -> String
60−keyToString = T.unpack
61−
62−keyToText :: T.Text -> T.Text
63−keyToText = id
64−
65−toInsOrdHashMap :: HM.HashMap T.Text v -> InsOrdHashMap.InsOrdHashMap T.Text v
66−toInsOrdHashMap = InsOrdHashMap.fromHashMap
67−
68−fromInsOrdHashMap :: InsOrdHashMap.InsOrdHashMap T.Text v -> HM.HashMap T.Text v
69−fromInsOrdHashMap = InsOrdHashMap.toHashMap
70−
71−lookupKey :: T.Text -> HM.HashMap T.Text v -> Maybe v
72−lookupKey = HM.lookup
73−
74−hasKey :: T.Text -> HM.HashMap T.Text a -> Bool
75−hasKey = HM.member
76−#endif
src/Data/OpenApi.hs → src/Data/Swagger.hsrenamed+48−168
@@ -1,5 +1,5 @@
1-- |
1-- |
2−-- Module: Data.OpenApi
2+-- Module: Data.Swagger
3-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
3-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
4-- Stability: experimental
4-- Stability: experimental
5--
5--
@@ -9,7 +9,7 @@
9-- These files can then be used by the Swagger-UI project to display the API
9-- These files can then be used by the Swagger-UI project to display the API
10-- and Swagger-Codegen to generate clients in various languages.
10-- and Swagger-Codegen to generate clients in various languages.
11-- Additional utilities can also take advantage of the resulting files, such as testing tools.
11-- Additional utilities can also take advantage of the resulting files, such as testing tools.
12−module Data.OpenApi (
12+module Data.Swagger (
13 -- * How to use this library
13 -- * How to use this library
14 -- $howto
14 -- $howto
15
15
@@ -29,15 +29,15 @@ module Data.OpenApi (
29 -- $validation
29 -- $validation
30
30
31 -- * Re-exports
31 -- * Re-exports
32− module Data.OpenApi.Lens,
32+ module Data.Swagger.Lens,
33− module Data.OpenApi.Optics,
33+ module Data.Swagger.Optics,
34− module Data.OpenApi.Operation,
34+ module Data.Swagger.Operation,
35− module Data.OpenApi.ParamSchema,
35+ module Data.Swagger.ParamSchema,
36− module Data.OpenApi.Schema,
36+ module Data.Swagger.Schema,
37− module Data.OpenApi.Schema.Validation,
37+ module Data.Swagger.Schema.Validation,
38
38
39 -- * Swagger specification
39 -- * Swagger specification
40− OpenApi(..),
40+ Swagger(..),
41 Server(..),
41 Server(..),
42 ServerVariable(..),
42 ServerVariable(..),
43 Components(..),
43 Components(..),
@@ -56,7 +56,7 @@ module Data.OpenApi (
56 TagName,
56 TagName,
57
57
58 -- ** Types and formats
58 -- ** Types and formats
59− OpenApiType(..),
59+ SwaggerType(..),
60 Format,
60 Format,
61 Definitions,
61 Definitions,
62 Style(..),
62 Style(..),
@@ -73,9 +73,10 @@ module Data.OpenApi (
73 Encoding(..),
73 Encoding(..),
74
74
75 -- ** Schemas
75 -- ** Schemas
76+ ParamSchema(..),
76 Schema(..),
77 Schema(..),
77 NamedSchema(..),
78 NamedSchema(..),
78− OpenApiItems(..),
79+ SwaggerItems(..),
79 Xml(..),
80 Xml(..),
80 Pattern,
81 Pattern,
81 AdditionalProperties(..),
82 AdditionalProperties(..),
@@ -91,7 +92,6 @@ module Data.OpenApi (
91 -- ** Security
92 -- ** Security
92 SecurityScheme(..),
93 SecurityScheme(..),
93 SecuritySchemeType(..),
94 SecuritySchemeType(..),
94− HttpSchemeType(..),
95 SecurityDefinitions(..),
95 SecurityDefinitions(..),
96 SecurityRequirement(..),
96 SecurityRequirement(..),
97
97
@@ -121,14 +121,14 @@ module Data.OpenApi (
121 URL(..),
121 URL(..),
122) where
122) where
123
123
124−import Data.OpenApi.Lens
124+import Data.Swagger.Lens
125−import Data.OpenApi.Optics ()
125+import Data.Swagger.Optics ()
126−import Data.OpenApi.Operation
126+import Data.Swagger.Operation
127−import Data.OpenApi.ParamSchema
127+import Data.Swagger.ParamSchema
128−import Data.OpenApi.Schema
128+import Data.Swagger.Schema
129−import Data.OpenApi.Schema.Validation
129+import Data.Swagger.Schema.Validation
130
130
131−import Data.OpenApi.Internal
131+import Data.Swagger.Internal
132
132
133-- $setup
133-- $setup
134-- >>> import Control.Lens
134-- >>> import Control.Lens
@@ -137,7 +137,6 @@ import Data.OpenApi.Internal
137-- >>> import Data.Proxy
137-- >>> import Data.Proxy
138-- >>> import GHC.Generics
138-- >>> import GHC.Generics
139-- >>> import qualified Data.ByteString.Lazy.Char8 as BSL
139-- >>> import qualified Data.ByteString.Lazy.Char8 as BSL
140−-- >>> import Data.OpenApi.Internal.Utils
141-- >>> :set -XDeriveGeneric
140-- >>> :set -XDeriveGeneric
142-- >>> :set -XOverloadedStrings
141-- >>> :set -XOverloadedStrings
143-- >>> :set -XOverloadedLists
142-- >>> :set -XOverloadedLists
@@ -154,16 +153,8 @@ import Data.OpenApi.Internal
154--
153--
155-- In this library you can use @'mempty'@ for a default/empty value. For instance:
154-- In this library you can use @'mempty'@ for a default/empty value. For instance:
156--
155--
157−-- >>> BSL.putStrLn $ encodePretty (mempty :: OpenApi)
156+-- >>> BSL.putStrLn $ encode (mempty :: Swagger)
158−-- {
157+-- {"openapi":"3.0.0","info":{"version":"","title":""},"components":{}}
159−-- "components": {},
160−-- "info": {
161−-- "title": "",
162−-- "version": ""
163−-- },
164−-- "openapi": "3.0.0",
165−-- "paths": {}
166−-- }
167--
158--
168-- As you can see some spec properties (e.g. @"version"@) are there even when the spec is empty.
159-- As you can see some spec properties (e.g. @"version"@) are there even when the spec is empty.
169-- That is because these properties are actually required ones.
160-- That is because these properties are actually required ones.
@@ -171,87 +162,46 @@ import Data.OpenApi.Internal
171-- You /should/ always override the default (empty) value for these properties,
162-- You /should/ always override the default (empty) value for these properties,
172-- although it is not strictly necessary:
163-- although it is not strictly necessary:
173--
164--
174−-- >>> BSL.putStrLn $ encodePretty mempty { _infoTitle = "Todo API", _infoVersion = "1.0" }
165+-- >>> BSL.putStrLn $ encode mempty { _infoTitle = "Todo API", _infoVersion = "1.0" }
175−-- {
176−-- "title": "Todo API",
177−-- "version": "1.0"
166+-- {"version":"1.0","title":"Todo API"}
178−-- }
179--
167--
180-- You can merge two values using @'mappend'@ or its infix version @('<>')@:
168-- You can merge two values using @'mappend'@ or its infix version @('<>')@:
181--
169--
182−-- >>> BSL.putStrLn $ encodePretty $ mempty { _infoTitle = "Todo API" } <> mempty { _infoVersion = "1.0" }
170+-- >>> BSL.putStrLn $ encode $ mempty { _infoTitle = "Todo API" } <> mempty { _infoVersion = "1.0" }
183−-- {
184−-- "title": "Todo API",
185−-- "version": "1.0"
171+-- {"version":"1.0","title":"Todo API"}
186−-- }
187−
188--
172--
189-- This can be useful for combining specifications of endpoints into a whole API specification:
173-- This can be useful for combining specifications of endpoints into a whole API specification:
190--
174--
191-- @
175-- @
192-- \-\- /account subAPI specification
176-- \-\- /account subAPI specification
193−-- accountAPI :: OpenApi
177+-- accountAPI :: Swagger
194--
178--
195-- \-\- /task subAPI specification
179-- \-\- /task subAPI specification
196−-- taskAPI :: OpenApi
180+-- taskAPI :: Swagger
197--
181--
198-- \-\- while API specification is just a combination
182-- \-\- while API specification is just a combination
199-- \-\- of subAPIs' specifications
183-- \-\- of subAPIs' specifications
200−-- api :: OpenApi
184+-- api :: Swagger
201-- api = accountAPI <> taskAPI
185-- api = accountAPI <> taskAPI
202-- @
186-- @
203
187
204-- $lens
188-- $lens
205--
189--
206−-- Note: if you're working with the <https://hackage.haskell.org/package/optics optics> library, take a look at "Data.OpenApi.Optics".
190+-- Note: if you're working with the <https://hackage.haskell.org/package/optics optics> library, take a look at "Data.Swagger.Optics".
207--
191--
208-- Since @'Swagger'@ has a fairly complex structure, lenses and prisms are used
192-- Since @'Swagger'@ has a fairly complex structure, lenses and prisms are used
209-- to work comfortably with it. In combination with @'Monoid'@ instances, lenses
193-- to work comfortably with it. In combination with @'Monoid'@ instances, lenses
210-- make it fairly simple to construct/modify any part of the specification:
194-- make it fairly simple to construct/modify any part of the specification:
211--
195--
212-- >>> :{
196-- >>> :{
213−-- BSL.putStrLn $ encodePretty $ (mempty :: OpenApi)
197+-- BSL.putStrLn $ encode $ (mempty :: Swagger)
214−-- & components . schemas .~ [ ("User", mempty & type_ ?~ OpenApiString) ]
198+-- & components . schemas .~ [ ("User", mempty & type_ ?~ SwaggerString) ]
215-- & paths .~
199-- & paths .~
216-- [ ("/user", mempty & get ?~ (mempty
200-- [ ("/user", mempty & get ?~ (mempty
217-- & at 200 ?~ ("OK" & _Inline.content.at "application/json" ?~ (mempty & schema ?~ Ref (Reference "User")))
201-- & at 200 ?~ ("OK" & _Inline.content.at "application/json" ?~ (mempty & schema ?~ Ref (Reference "User")))
218-- & at 404 ?~ "User info not found")) ]
202-- & at 404 ?~ "User info not found")) ]
219-- :}
203-- :}
220−-- {
204+-- {"openapi":"3.0.0","info":{"version":"","title":""},"paths":{"/user":{"get":{"responses":{"404":{"description":"User info not found"},"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK"}}}}},"components":{"schemas":{"User":{"type":"string"}}}}
221−-- "components": {
222−-- "schemas": {
223−-- "User": {
224−-- "type": "string"
225−-- }
226−-- }
227−-- },
228−-- "info": {
229−-- "title": "",
230−-- "version": ""
231−-- },
232−-- "openapi": "3.0.0",
233−-- "paths": {
234−-- "/user": {
235−-- "get": {
236−-- "responses": {
237−-- "200": {
238−-- "content": {
239−-- "application/json": {
240−-- "schema": {
241−-- "$ref": "#/components/schemas/User"
242−-- }
243−-- }
244−-- },
245−-- "description": "OK"
246−-- },
247−-- "404": {
248−-- "description": "User info not found"
249−-- }
250−-- }
251−-- }
252−-- }
253−-- }
254−-- }
255--
205--
256-- In the snippet above we declare an API with a single path @/user@. This path provides method @GET@
206-- In the snippet above we declare an API with a single path @/user@. This path provides method @GET@
257-- which produces @application/json@ output. It should respond with code @200@ and body specified
207-- which produces @application/json@ output. It should respond with code @200@ and body specified
@@ -263,34 +213,23 @@ import Data.OpenApi.Internal
263-- common field is @'description'@. Many components of a Swagger specification
213-- common field is @'description'@. Many components of a Swagger specification
264-- can have descriptions, and you can use the same name for them:
214-- can have descriptions, and you can use the same name for them:
265--
215--
266−-- >>> BSL.putStrLn $ encodePretty $ (mempty :: Response) & description .~ "No content"
216+-- >>> BSL.putStrLn $ encode $ (mempty :: Response) & description .~ "No content"
267−-- {
268−-- "description": "No content"
217+-- {"description":"No content"}
269−-- }
270-- >>> :{
218-- >>> :{
271−-- BSL.putStrLn $ encodePretty $ (mempty :: Schema)
219+-- BSL.putStrLn $ encode $ (mempty :: Schema)
272−-- & type_ ?~ OpenApiBoolean
220+-- & type_ ?~ SwaggerBoolean
273-- & description ?~ "To be or not to be"
221-- & description ?~ "To be or not to be"
274-- :}
222-- :}
275−-- {
276−-- "description": "To be or not to be",
223+-- {"description":"To be or not to be","type":"boolean"}
277−-- "type": "boolean"
278−-- }
279--
224--
280-- Additionally, to simplify working with @'Response'@, both @'Operation'@ and @'Responses'@
225-- Additionally, to simplify working with @'Response'@, both @'Operation'@ and @'Responses'@
281-- have direct access to it via @'at' code@. Example:
226-- have direct access to it via @'at' code@. Example:
282--
227--
283-- >>> :{
228-- >>> :{
284−-- BSL.putStrLn $ encodePretty $ (mempty :: Operation)
229+-- BSL.putStrLn $ encode $ (mempty :: Operation)
285-- & at 404 ?~ "Not found"
230-- & at 404 ?~ "Not found"
286-- :}
231-- :}
287−-- {
288−-- "responses": {
289−-- "404": {
290−-- "description": "Not found"
232+-- {"responses":{"404":{"description":"Not found"}}}
291−-- }
292−-- }
293−-- }
294--
233--
295-- You might've noticed that @'type_'@ has an extra underscore in its name
234-- You might've noticed that @'type_'@ has an extra underscore in its name
296-- compared to, say, @'description'@ field accessor.
235-- compared to, say, @'description'@ field accessor.
@@ -306,7 +245,7 @@ import Data.OpenApi.Internal
306-- @'ParamSchema'@ and @'Schema'@ are the two core types for data model specification.
245-- @'ParamSchema'@ and @'Schema'@ are the two core types for data model specification.
307--
246--
308-- @'ParamSchema' t@ specifies all the common properties, available for every data schema.
247-- @'ParamSchema' t@ specifies all the common properties, available for every data schema.
309−-- The @t@ parameter imposes some restrictions on @type@ and @items@ properties (see @'OpenApiType'@ and @'OpenApiItems'@).
248+-- The @t@ parameter imposes some restrictions on @type@ and @items@ properties (see @'SwaggerType'@ and @'SwaggerItems'@).
310--
249--
311-- @'Schema'@ is used for request and response bodies and allows specifying objects
250-- @'Schema'@ is used for request and response bodies and allows specifying objects
312-- with properties in addition to what @'ParamSchema'@ provides.
251-- with properties in addition to what @'ParamSchema'@ provides.
@@ -337,27 +276,10 @@ import Data.OpenApi.Internal
337-- >>> data Person = Person { name :: String, age :: Integer } deriving Generic
276-- >>> data Person = Person { name :: String, age :: Integer } deriving Generic
338-- >>> instance ToJSON Person
277-- >>> instance ToJSON Person
339-- >>> instance ToSchema Person
278-- >>> instance ToSchema Person
340−-- >>> BSL.putStrLn $ encodePretty (Person "David" 28)
279+-- >>> BSL.putStrLn $ encode (Person "David" 28)
341−-- {
342−-- "age": 28,
343−-- "name": "David"
280+-- {"age":28,"name":"David"}
344−-- }
345−-- >>> BSL.putStrLn $ encodePretty $ toSchema (Proxy :: Proxy Person)
281+-- >>> BSL.putStrLn $ encode $ toSchema (Proxy :: Proxy Person)
346−-- {
282+-- {"required":["name","age"],"properties":{"name":{"type":"string"},"age":{"type":"integer"}},"type":"object"}
347−-- "properties": {
348−-- "age": {
349−-- "type": "integer"
350−-- },
351−-- "name": {
352−-- "type": "string"
353−-- }
354−-- },
355−-- "required": [
356−-- "name",
357−-- "age"
358−-- ],
359−-- "type": "object"
360−-- }
361--
283--
362-- This package implements OpenAPI 3.0 spec, which supports @oneOf@ in schemas, allowing any sum types
284-- This package implements OpenAPI 3.0 spec, which supports @oneOf@ in schemas, allowing any sum types
363-- to be faithfully represented. All sum encodings supported by @aeson@ are supported here as well, with
285-- to be faithfully represented. All sum encodings supported by @aeson@ are supported here as well, with
@@ -368,50 +290,8 @@ import Data.OpenApi.Internal
368-- >>> data Error = ErrorNoUser { userId :: Int } | ErrorAccessDenied { requiredPermission :: String } deriving Generic
290-- >>> data Error = ErrorNoUser { userId :: Int } | ErrorAccessDenied { requiredPermission :: String } deriving Generic
369-- >>> instance ToJSON Error
291-- >>> instance ToJSON Error
370-- >>> instance ToSchema Error
292-- >>> instance ToSchema Error
371−-- >>> BSL.putStrLn $ encodePretty $ toSchema (Proxy :: Proxy Error)
293+-- >>> BSL.putStrLn $ encode $ toSchema (Proxy :: Proxy Error)
372−-- {
294+-- {"oneOf":[{"required":["userId","tag"],"type":"object","properties":{"tag":{"type":"string","enum":["ErrorNoUser"]},"userId":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}}},{"required":["requiredPermission","tag"],"type":"object","properties":{"tag":{"type":"string","enum":["ErrorAccessDenied"]},"requiredPermission":{"type":"string"}}}],"type":"object"}
373−-- "oneOf": [
374−-- {
375−-- "properties": {
376−-- "tag": {
377−-- "enum": [
378−-- "ErrorNoUser"
379−-- ],
380−-- "type": "string"
381−-- },
382−-- "userId": {
383−-- "maximum": 9223372036854775807,
384−-- "minimum": -9223372036854775808,
385−-- "type": "integer"
386−-- }
387−-- },
388−-- "required": [
389−-- "userId",
390−-- "tag"
391−-- ],
392−-- "type": "object"
393−-- },
394−-- {
395−-- "properties": {
396−-- "requiredPermission": {
397−-- "type": "string"
398−-- },
399−-- "tag": {
400−-- "enum": [
401−-- "ErrorAccessDenied"
402−-- ],
403−-- "type": "string"
404−-- }
405−-- },
406−-- "required": [
407−-- "requiredPermission",
408−-- "tag"
409−-- ],
410−-- "type": "object"
411−-- }
412−-- ],
413−-- "type": "object"
414−-- }
415
295
416-- $manipulation
296-- $manipulation
417-- Sometimes you have to work with an imported or generated @'Swagger'@.
297-- Sometimes you have to work with an imported or generated @'Swagger'@.
@@ -419,10 +299,10 @@ import Data.OpenApi.Internal
419-- for a type-level servant API.
299-- for a type-level servant API.
420--
300--
421-- Lenses and prisms can be used to manipulate such specification to add additional information, tags, extra responses, etc.
301-- Lenses and prisms can be used to manipulate such specification to add additional information, tags, extra responses, etc.
422−-- To facilitate common needs, @"Data.OpenApi.Operation"@ module provides useful helpers.
302+-- To facilitate common needs, @"Data.Swagger.Operation"@ module provides useful helpers.
423
303
424-- $validation
304-- $validation
425-- While @'ToParamSchema'@ and @'ToSchema'@ provide means to easily obtain schemas for Haskell types,
305-- While @'ToParamSchema'@ and @'ToSchema'@ provide means to easily obtain schemas for Haskell types,
426-- there is no static mechanism to ensure those instances correspond to the @'ToHttpApiData'@ or @'ToJSON'@ instances.
306-- there is no static mechanism to ensure those instances correspond to the @'ToHttpApiData'@ or @'ToJSON'@ instances.
427--
307--
428−-- @"Data.OpenApi.Schema.Validation"@ addresses @'ToJSON'@/@'ToSchema'@ validation.
308+-- @"Data.Swagger.Schema.Validation"@ addresses @'ToJSON'@/@'ToSchema'@ validation.
src/Data/OpenApi/Declare.hs → src/Data/Swagger/Declare.hsrenamed+2−2
@@ -4,12 +4,12 @@
4{-# LANGUAGE MultiParamTypeClasses #-}
4{-# LANGUAGE MultiParamTypeClasses #-}
5{-# LANGUAGE UndecidableInstances #-}
5{-# LANGUAGE UndecidableInstances #-}
6-- |
6-- |
7−-- Module: Data.OpenApi.Declare
7+-- Module: Data.Swagger.Declare
8-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
8-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
9-- Stability: experimental
9-- Stability: experimental
10--
10--
11-- Declare monad transformer and associated functions.
11-- Declare monad transformer and associated functions.
12−module Data.OpenApi.Declare where
12+module Data.Swagger.Declare where
13
13
14import Prelude ()
14import Prelude ()
15import Prelude.Compat
15import Prelude.Compat
src/Data/OpenApi/Internal.hs → src/Data/Swagger/Internal.hsrenamed+137−202
@@ -1,6 +1,6 @@
1−{-# LANGUAGE CPP #-}
2{-# LANGUAGE DataKinds #-}
1{-# LANGUAGE DataKinds #-}
3{-# LANGUAGE DeriveDataTypeable #-}
2{-# LANGUAGE DeriveDataTypeable #-}
3+{-# LANGUAGE DeriveFunctor #-}
4{-# LANGUAGE DeriveGeneric #-}
4{-# LANGUAGE DeriveGeneric #-}
5{-# LANGUAGE DeriveTraversable #-}
5{-# LANGUAGE DeriveTraversable #-}
6{-# LANGUAGE FlexibleContexts #-}
6{-# LANGUAGE FlexibleContexts #-}
@@ -14,7 +14,7 @@
14{-# LANGUAGE TemplateHaskell #-}
14{-# LANGUAGE TemplateHaskell #-}
15{-# LANGUAGE TypeFamilies #-}
15{-# LANGUAGE TypeFamilies #-}
16{-# LANGUAGE UndecidableInstances #-}
16{-# LANGUAGE UndecidableInstances #-}
17−module Data.OpenApi.Internal where
17+module Data.Swagger.Internal where
18
18
19import Prelude ()
19import Prelude ()
20import Prelude.Compat
20import Prelude.Compat
@@ -22,9 +22,6 @@ import Prelude.Compat
22import Control.Applicative
22import Control.Applicative
23import Control.Lens ((&), (.~), (?~))
23import Control.Lens ((&), (.~), (?~))
24import Data.Aeson hiding (Encoding)
24import Data.Aeson hiding (Encoding)
25−#if MIN_VERSION_aeson(2,0,0)
26−import qualified Data.Aeson.KeyMap as KeyMap
27−#endif
28import qualified Data.Aeson.Types as JSON
25import qualified Data.Aeson.Types as JSON
29import Data.Data (Constr, Data (..), DataType, Fixity (..), Typeable,
26import Data.Data (Constr, Data (..), DataType, Fixity (..), Typeable,
30 constrIndex, mkConstr, mkDataType)
27 constrIndex, mkConstr, mkDataType)
@@ -49,56 +46,58 @@ import Text.Read (readMaybe)
49import Data.HashMap.Strict.InsOrd (InsOrdHashMap)
46import Data.HashMap.Strict.InsOrd (InsOrdHashMap)
50import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
47import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
51
48
52−import Data.OpenApi.Aeson.Compat (deleteKey)
53−import Data.OpenApi.Internal.AesonUtils (AesonDefaultValue (..), HasSwaggerAesonOptions (..),
54− mkSwaggerAesonOptions, saoAdditionalPairs, saoSubObject,
55− sopSwaggerGenericParseJSON, sopSwaggerGenericToEncoding,
56− sopSwaggerGenericToJSON, sopSwaggerGenericToJSONWithOpts)
57−import Data.OpenApi.Internal.Utils
58import Generics.SOP.TH (deriveGeneric)
49import Generics.SOP.TH (deriveGeneric)
50+import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToJSON
51+ ,sopSwaggerGenericToJSONWithOpts
52+ ,sopSwaggerGenericParseJSON
53+ ,HasSwaggerAesonOptions(..)
54+ ,AesonDefaultValue(..)
55+ ,mkSwaggerAesonOptions
56+ ,saoAdditionalPairs
57+ ,saoSubObject)
58+import Data.Swagger.Internal.Utils
59+import Data.Swagger.Internal.AesonUtils (sopSwaggerGenericToEncoding)
59
60
60-- $setup
61-- $setup
61-- >>> :seti -XDataKinds
62-- >>> :seti -XDataKinds
62-- >>> import Data.Aeson
63-- >>> import Data.Aeson
63−-- >>> import Data.ByteString.Lazy.Char8 as BSL
64−-- >>> import Data.OpenApi.Internal.Utils
65
64
66-- | A list of definitions that can be used in references.
65-- | A list of definitions that can be used in references.
67type Definitions = InsOrdHashMap Text
66type Definitions = InsOrdHashMap Text
68
67
69-- | This is the root document object for the API specification.
68-- | This is the root document object for the API specification.
70−data OpenApi = OpenApi
69+data Swagger = Swagger
71 { -- | Provides metadata about the API.
70 { -- | Provides metadata about the API.
72 -- The metadata can be used by the clients if needed.
71 -- The metadata can be used by the clients if needed.
73− _openApiInfo :: Info
72+ _swaggerInfo :: Info
74
73
75 -- | An array of Server Objects, which provide connectivity information
74 -- | An array of Server Objects, which provide connectivity information
76 -- to a target server. If the servers property is not provided, or is an empty array,
75 -- to a target server. If the servers property is not provided, or is an empty array,
77 -- the default value would be a 'Server' object with a url value of @/@.
76 -- the default value would be a 'Server' object with a url value of @/@.
78− , _openApiServers :: [Server]
77+ , _swaggerServers :: [Server]
79
78
80 -- | The available paths and operations for the API.
79 -- | The available paths and operations for the API.
81− , _openApiPaths :: InsOrdHashMap FilePath PathItem
80+ , _swaggerPaths :: InsOrdHashMap FilePath PathItem
82
81
83 -- | An element to hold various schemas for the specification.
82 -- | An element to hold various schemas for the specification.
84− , _openApiComponents :: Components
83+ , _swaggerComponents :: Components
85
84
86 -- | A declaration of which security mechanisms can be used across the API.
85 -- | A declaration of which security mechanisms can be used across the API.
87 -- The list of values includes alternative security requirement objects that can be used.
86 -- The list of values includes alternative security requirement objects that can be used.
88 -- Only one of the security requirement objects need to be satisfied to authorize a request.
87 -- Only one of the security requirement objects need to be satisfied to authorize a request.
89 -- Individual operations can override this definition.
88 -- Individual operations can override this definition.
90 -- To make security optional, an empty security requirement can be included in the array.
89 -- To make security optional, an empty security requirement can be included in the array.
91− , _openApiSecurity :: [SecurityRequirement]
90+ , _swaggerSecurity :: [SecurityRequirement]
92
91
93 -- | A list of tags used by the specification with additional metadata.
92 -- | A list of tags used by the specification with additional metadata.
94 -- The order of the tags can be used to reflect on their order by the parsing tools.
93 -- The order of the tags can be used to reflect on their order by the parsing tools.
95 -- Not all tags that are used by the 'Operation' Object must be declared.
94 -- Not all tags that are used by the 'Operation' Object must be declared.
96 -- The tags that are not declared MAY be organized randomly or based on the tools' logic.
95 -- The tags that are not declared MAY be organized randomly or based on the tools' logic.
97 -- Each tag name in the list MUST be unique.
96 -- Each tag name in the list MUST be unique.
98− , _openApiTags :: InsOrdHashSet Tag
97+ , _swaggerTags :: InsOrdHashSet Tag
99
98
100 -- | Additional external documentation.
99 -- | Additional external documentation.
101− , _openApiExternalDocs :: Maybe ExternalDocs
100+ , _swaggerExternalDocs :: Maybe ExternalDocs
102 } deriving (Eq, Show, Generic, Data, Typeable)
101 } deriving (Eq, Show, Generic, Data, Typeable)
103
102
104-- | The object provides metadata about the API.
103-- | The object provides metadata about the API.
@@ -195,8 +194,8 @@ data Components = Components
195 , _componentsParameters :: Definitions Param
194 , _componentsParameters :: Definitions Param
196 , _componentsExamples :: Definitions Example
195 , _componentsExamples :: Definitions Example
197 , _componentsRequestBodies :: Definitions RequestBody
196 , _componentsRequestBodies :: Definitions RequestBody
198− , _componentsHeaders :: Definitions Header
197+ , _componentsHeader :: Definitions Header
199− , _componentsSecuritySchemes :: SecurityDefinitions
198+ , _componentsSecuritySchemes :: Definitions SecurityScheme
200 , _componentsLinks :: Definitions Link
199 , _componentsLinks :: Definitions Link
201 , _componentsCallbacks :: Definitions Callback
200 , _componentsCallbacks :: Definitions Callback
202 } deriving (Eq, Show, Generic, Data, Typeable)
201 } deriving (Eq, Show, Generic, Data, Typeable)
@@ -337,11 +336,9 @@ data RequestBody = RequestBody
337 -- | The content of the request body.
336 -- | The content of the request body.
338 -- The key is a media type or media type range and the value describes it.
337 -- The key is a media type or media type range and the value describes it.
339 -- For requests that match multiple keys, only the most specific key is applicable.
338 -- For requests that match multiple keys, only the most specific key is applicable.
340− -- e.g. @text/plain@ overrides @text/\*@
339+ -- e.g. @text/plain@ overrides @text/*@
341 , _requestBodyContent :: InsOrdHashMap MediaType MediaTypeObject
340 , _requestBodyContent :: InsOrdHashMap MediaType MediaTypeObject
342
341
343− -- | Determines if the request body is required in the request.
344− -- Defaults to 'False'.
345 , _requestBodyRequired :: Maybe Bool
342 , _requestBodyRequired :: Maybe Bool
346 } deriving (Eq, Show, Generic, Data, Typeable)
343 } deriving (Eq, Show, Generic, Data, Typeable)
347
344
@@ -394,7 +391,7 @@ data Encoding = Encoding
394 -- for other primitive types – @text/plain@; for object - @application/json@;
391 -- for other primitive types – @text/plain@; for object - @application/json@;
395 -- for array – the default is defined based on the inner type.
392 -- for array – the default is defined based on the inner type.
396 -- The value can be a specific media type (e.g. @application/json@),
393 -- The value can be a specific media type (e.g. @application/json@),
397− -- a wildcard media type (e.g. @image/\*@), or a comma-separated list of the two types.
394+ -- a wildcard media type (e.g. @image/*@), or a comma-separated list of the two types.
398 _encodingContentType :: Maybe MediaType
395 _encodingContentType :: Maybe MediaType
399
396
400 -- | A map allowing additional information to be provided as headers,
397 -- | A map allowing additional information to be provided as headers,
@@ -434,11 +431,11 @@ mimeListConstr :: Constr
434mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
431mimeListConstr = mkConstr mimeListDataType "MimeList" ["getMimeList"] Prefix
435
432
436mimeListDataType :: DataType
433mimeListDataType :: DataType
437−mimeListDataType = mkDataType "Data.OpenApi.MimeList" [mimeListConstr]
434+mimeListDataType = mkDataType "Data.Swagger.MimeList" [mimeListConstr]
438
435
439instance Data MimeList where
436instance Data MimeList where
440 gunfold k z c = case constrIndex c of
437 gunfold k z c = case constrIndex c of
441− 1 -> k (z (MimeList . map fromString))
438+ 1 -> k (z (\xs -> MimeList (map fromString xs)))
442 _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type MimeList."
439 _ -> error $ "Data.Data.gunfold: Constructor " ++ show c ++ " is not of type MimeList."
443 toConstr (MimeList _) = mimeListConstr
440 toConstr (MimeList _) = mimeListConstr
444 dataTypeOf _ = mimeListDataType
441 dataTypeOf _ = mimeListDataType
@@ -452,7 +449,7 @@ data Param = Param
452
449
453 -- | A brief description of the parameter.
450 -- | A brief description of the parameter.
454 -- This could contain examples of use.
451 -- This could contain examples of use.
455− -- CommonMark syntax MAY be used for rich text representation.
452+ -- GFM syntax can be used for rich text representation.
456 , _paramDescription :: Maybe Text
453 , _paramDescription :: Maybe Text
457
454
458 -- | Determines whether this parameter is mandatory.
455 -- | Determines whether this parameter is mandatory.
@@ -472,13 +469,6 @@ data Param = Param
472 -- a parameter with an empty value. Default value is @false@.
469 -- a parameter with an empty value. Default value is @false@.
473 , _paramAllowEmptyValue :: Maybe Bool
470 , _paramAllowEmptyValue :: Maybe Bool
474
471
475− -- | Determines whether the parameter value SHOULD allow reserved characters,
476− -- as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2)
477− -- @:/?#[]@!$&'()*+,;=@ to be included without percent-encoding.
478− -- This property only applies to parameters with an '_paramIn' value of 'ParamQuery'.
479− -- The default value is 'False'.
480− , _paramAllowReserved :: Maybe Bool
481−
482 -- | Parameter schema.
472 -- | Parameter schema.
483 , _paramSchema :: Maybe (Referenced Schema)
473 , _paramSchema :: Maybe (Referenced Schema)
484
474
@@ -509,10 +499,6 @@ data Param = Param
509 -- Furthermore, if referencing a schema that contains an example,
499 -- Furthermore, if referencing a schema that contains an example,
510 -- the examples value SHALL override the example provided by the schema.
500 -- the examples value SHALL override the example provided by the schema.
511 , _paramExamples :: InsOrdHashMap Text (Referenced Example)
501 , _paramExamples :: InsOrdHashMap Text (Referenced Example)
512−
513− -- TODO
514− -- _paramContent :: InsOrdHashMap MediaType MediaTypeObject
515− -- should be singleton. mutually exclusive with _paramSchema.
516 } deriving (Eq, Show, Generic, Data, Typeable)
502 } deriving (Eq, Show, Generic, Data, Typeable)
517
503
518data Example = Example
504data Example = Example
@@ -573,27 +559,27 @@ data Link = Link
573 , _linkServer :: Maybe Server
559 , _linkServer :: Maybe Server
574 } deriving (Eq, Show, Generic, Typeable, Data)
560 } deriving (Eq, Show, Generic, Typeable, Data)
575
561
576−-- | Items for @'OpenApiArray'@ schemas.
562+-- | Items for @'SwaggerArray'@ schemas.
577--
563--
578-- __Warning__: OpenAPI 3.0 does not support tuple arrays. However, OpenAPI 3.1 will, as
564-- __Warning__: OpenAPI 3.0 does not support tuple arrays. However, OpenAPI 3.1 will, as
579-- it will incorporate Json Schema mostly verbatim.
565-- it will incorporate Json Schema mostly verbatim.
580--
566--
581−-- @'OpenApiItemsObject'@ should be used to specify homogenous array @'Schema'@s.
567+-- @'SwaggerItemsObject'@ should be used to specify homogenous array @'Schema'@s.
582--
568--
583−-- @'OpenApiItemsArray'@ should be used to specify tuple @'Schema'@s.
569+-- @'SwaggerItemsArray'@ should be used to specify tuple @'Schema'@s.
584−data OpenApiItems where
570+data SwaggerItems where
585− OpenApiItemsObject :: Referenced Schema -> OpenApiItems
571+ SwaggerItemsObject :: Referenced Schema -> SwaggerItems
586− OpenApiItemsArray :: [Referenced Schema] -> OpenApiItems
572+ SwaggerItemsArray :: [Referenced Schema] -> SwaggerItems
587 deriving (Eq, Show, Typeable, Data)
573 deriving (Eq, Show, Typeable, Data)
588
574
589−data OpenApiType where
575+data SwaggerType where
590− OpenApiString :: OpenApiType
576+ SwaggerString :: SwaggerType
591− OpenApiNumber :: OpenApiType
577+ SwaggerNumber :: SwaggerType
592− OpenApiInteger :: OpenApiType
578+ SwaggerInteger :: SwaggerType
593− OpenApiBoolean :: OpenApiType
579+ SwaggerBoolean :: SwaggerType
594− OpenApiArray :: OpenApiType
580+ SwaggerArray :: SwaggerType
595− OpenApiNull :: OpenApiType
581+ SwaggerNull :: SwaggerType
596− OpenApiObject :: OpenApiType
582+ SwaggerObject :: SwaggerType
597 deriving (Eq, Show, Typeable, Generic, Data)
583 deriving (Eq, Show, Typeable, Generic, Data)
598
584
599data ParamLocation
585data ParamLocation
@@ -638,33 +624,9 @@ data Schema = Schema
638 , _schemaMaxProperties :: Maybe Integer
624 , _schemaMaxProperties :: Maybe Integer
639 , _schemaMinProperties :: Maybe Integer
625 , _schemaMinProperties :: Maybe Integer
640
626
641− , -- | Declares the value of the parameter that the server will use if none is provided,
627+ , _schemaParamSchema :: ParamSchema
642− -- for example a @"count"@ to control the number of results per page might default to @100@
643− -- if not supplied by the client in the request.
644− -- (Note: "default" has no meaning for required parameters.)
645− -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
646− _schemaDefault :: Maybe Value
647−
648− , _schemaType :: Maybe OpenApiType
649− , _schemaFormat :: Maybe Format
650− , _schemaItems :: Maybe OpenApiItems
651− , _schemaMaximum :: Maybe Scientific
652− , _schemaExclusiveMaximum :: Maybe Bool
653− , _schemaMinimum :: Maybe Scientific
654− , _schemaExclusiveMinimum :: Maybe Bool
655− , _schemaMaxLength :: Maybe Integer
656− , _schemaMinLength :: Maybe Integer
657− , _schemaPattern :: Maybe Pattern
658− , _schemaMaxItems :: Maybe Integer
659− , _schemaMinItems :: Maybe Integer
660− , _schemaUniqueItems :: Maybe Bool
661− , _schemaEnum :: Maybe [Value]
662− , _schemaMultipleOf :: Maybe Scientific
663 } deriving (Eq, Show, Generic, Data, Typeable)
628 } deriving (Eq, Show, Generic, Data, Typeable)
664
629
665−-- | Regex pattern for @string@ type.
666−type Pattern = Text
667−
668data Discriminator = Discriminator
630data Discriminator = Discriminator
669 { -- | The name of the property in the payload that will hold the discriminator value.
631 { -- | The name of the property in the payload that will hold the discriminator value.
670 _discriminatorPropertyName :: Text
632 _discriminatorPropertyName :: Text
@@ -680,9 +642,37 @@ data NamedSchema = NamedSchema
680 , _namedSchemaSchema :: Schema
642 , _namedSchemaSchema :: Schema
681 } deriving (Eq, Show, Generic, Data, Typeable)
643 } deriving (Eq, Show, Generic, Data, Typeable)
682
644
645+-- | Regex pattern for @string@ type.
646+type Pattern = Text
647+
648+data ParamSchema = ParamSchema
649+ { -- | Declares the value of the parameter that the server will use if none is provided,
650+ -- for example a @"count"@ to control the number of results per page might default to @100@
651+ -- if not supplied by the client in the request.
652+ -- (Note: "default" has no meaning for required parameters.)
653+ -- Unlike JSON Schema this value MUST conform to the defined type for this parameter.
654+ _paramSchemaDefault :: Maybe Value
655+
656+ , _paramSchemaType :: Maybe SwaggerType
657+ , _paramSchemaFormat :: Maybe Format
658+ , _paramSchemaItems :: Maybe SwaggerItems
659+ , _paramSchemaMaximum :: Maybe Scientific
660+ , _paramSchemaExclusiveMaximum :: Maybe Bool
661+ , _paramSchemaMinimum :: Maybe Scientific
662+ , _paramSchemaExclusiveMinimum :: Maybe Bool
663+ , _paramSchemaMaxLength :: Maybe Integer
664+ , _paramSchemaMinLength :: Maybe Integer
665+ , _paramSchemaPattern :: Maybe Pattern
666+ , _paramSchemaMaxItems :: Maybe Integer
667+ , _paramSchemaMinItems :: Maybe Integer
668+ , _paramSchemaUniqueItems :: Maybe Bool
669+ , _paramSchemaEnum :: Maybe [Value]
670+ , _paramSchemaMultipleOf :: Maybe Scientific
671+ } deriving (Eq, Show, Generic, Typeable, Data)
672+
683data Xml = Xml
673data Xml = Xml
684 { -- | Replaces the name of the element/attribute used for the described schema property.
674 { -- | Replaces the name of the element/attribute used for the described schema property.
685− -- When defined within the @'OpenApiItems'@ (items), it will affect the name of the individual XML elements within the list.
675+ -- When defined within the @'SwaggerItems'@ (items), it will affect the name of the individual XML elements within the list.
686 -- When defined alongside type being array (outside the items),
676 -- When defined alongside type being array (outside the items),
687 -- it will affect the wrapping element and only if wrapped is true.
677 -- it will affect the wrapping element and only if wrapped is true.
688 -- If wrapped is false, it will be ignored.
678 -- If wrapped is false, it will be ignored.
@@ -734,7 +724,7 @@ data Response = Response
734 -- | A map containing descriptions of potential response payloads.
724 -- | A map containing descriptions of potential response payloads.
735 -- The key is a media type or media type range and the value describes it.
725 -- The key is a media type or media type range and the value describes it.
736 -- For responses that match multiple keys, only the most specific key is applicable.
726 -- For responses that match multiple keys, only the most specific key is applicable.
737− -- e.g. @text/plain@ overrides @text/\*@.
727+ -- e.g. @text/plain@ overrides @text/*@.
738 , _responseContent :: InsOrdHashMap MediaType MediaTypeObject
728 , _responseContent :: InsOrdHashMap MediaType MediaTypeObject
739
729
740 -- | Maps a header name to its definition.
730 -- | Maps a header name to its definition.
@@ -759,20 +749,11 @@ newtype Callback = Callback (InsOrdHashMap Text PathItem)
759
749
760type HeaderName = Text
750type HeaderName = Text
761
751
762−-- | Header fields have the same meaning as for 'Param'.
752+-- TODO this is mostly a copy of 'Param'.
763−--
764−-- Style is always treated as 'StyleSimple', as it is the only value allowed for headers.
765data Header = Header
753data Header = Header
766 { -- | A short description of the header.
754 { -- | A short description of the header.
767 _headerDescription :: Maybe HeaderName
755 _headerDescription :: Maybe HeaderName
768
756
769− , _headerRequired :: Maybe Bool
770− , _headerDeprecated :: Maybe Bool
771− , _headerAllowEmptyValue :: Maybe Bool
772− , _headerExplode :: Maybe Bool
773− , _headerExample :: Maybe Value
774− , _headerExamples :: InsOrdHashMap Text (Referenced Example)
775−
776 , _headerSchema :: Maybe (Referenced Schema)
757 , _headerSchema :: Maybe (Referenced Schema)
777 } deriving (Eq, Show, Generic, Data, Typeable)
758 } deriving (Eq, Show, Generic, Data, Typeable)
778
759
@@ -797,17 +778,17 @@ type AuthorizationURL = Text
797-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
778-- | The token URL to be used for OAuth2 flow. This SHOULD be in the form of a URL.
798type TokenURL = Text
779type TokenURL = Text
799
780
800−newtype OAuth2ImplicitFlow
781+data OAuth2ImplicitFlow = OAuth2ImplicitFlow
801− = OAuth2ImplicitFlow {_oAuth2ImplicitFlowAuthorizationUrl :: AuthorizationURL}
782+ { _oAuth2ImplicitFlowAuthorizationUrl :: AuthorizationURL
802− deriving (Eq, Show, Generic, Data, Typeable)
783+ } deriving (Eq, Show, Generic, Data, Typeable)
803
784
804−newtype OAuth2PasswordFlow
785+data OAuth2PasswordFlow = OAuth2PasswordFlow
805− = OAuth2PasswordFlow {_oAuth2PasswordFlowTokenUrl :: TokenURL}
786+ { _oAuth2PasswordFlowTokenUrl :: TokenURL
806− deriving (Eq, Show, Generic, Data, Typeable)
787+ } deriving (Eq, Show, Generic, Data, Typeable)
807
788
808−newtype OAuth2ClientCredentialsFlow
789+data OAuth2ClientCredentialsFlow = OAuth2ClientCredentialsFlow
809− = OAuth2ClientCredentialsFlow {_oAuth2ClientCredentialsFlowTokenUrl :: TokenURL}
790+ { _oAuth2ClientCredentialsFlowTokenUrl :: TokenURL
810− deriving (Eq, Show, Generic, Data, Typeable)
791+ } deriving (Eq, Show, Generic, Data, Typeable)
811
792
812data OAuth2AuthorizationCodeFlow = OAuth2AuthorizationCodeFlow
793data OAuth2AuthorizationCodeFlow = OAuth2AuthorizationCodeFlow
813 { _oAuth2AuthorizationCodeFlowAuthorizationUrl :: AuthorizationURL
794 { _oAuth2AuthorizationCodeFlowAuthorizationUrl :: AuthorizationURL
@@ -840,50 +821,8 @@ data OAuth2Flows = OAuth2Flows
840 , _oAuth2FlowsAuthorizationCode :: Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)
821 , _oAuth2FlowsAuthorizationCode :: Maybe (OAuth2Flow OAuth2AuthorizationCodeFlow)
841 } deriving (Eq, Show, Generic, Data, Typeable)
822 } deriving (Eq, Show, Generic, Data, Typeable)
842
823
843−type BearerFormat = Text
844−
845−data HttpSchemeType
846− = HttpSchemeBearer (Maybe BearerFormat)
847− | HttpSchemeBasic
848− | HttpSchemeCustom Text
849− deriving (Eq, Show, Generic, Data, Typeable)
850−
851−-- |
852−--
853−-- >>> BSL.putStrLn $ encodePretty (SecuritySchemeHttp (HttpSchemeBearer Nothing))
854−-- {
855−-- "scheme": "bearer",
856−-- "type": "http"
857−-- }
858−--
859−-- >>> BSL.putStrLn $ encodePretty (SecuritySchemeHttp (HttpSchemeBearer (Just "jwt")))
860−-- {
861−-- "bearerFormat": "jwt",
862−-- "scheme": "bearer",
863−-- "type": "http"
864−-- }
865−--
866−-- >>> BSL.putStrLn $ encodePretty (SecuritySchemeHttp HttpSchemeBasic)
867−-- {
868−-- "scheme": "basic",
869−-- "type": "http"
870−-- }
871−--
872−-- >>> BSL.putStrLn $ encodePretty (SecuritySchemeHttp (HttpSchemeCustom "CANARY"))
873−-- {
874−-- "scheme": "CANARY",
875−-- "type": "http"
876−-- }
877−--
878−-- >>> BSL.putStrLn $ encodePretty (SecuritySchemeApiKey (ApiKeyParams "id" ApiKeyCookie))
879−-- {
880−-- "in": "cookie",
881−-- "name": "id",
882−-- "type": "apiKey"
883−-- }
884−--
885data SecuritySchemeType
824data SecuritySchemeType
886− = SecuritySchemeHttp HttpSchemeType
825+ = SecuritySchemeHttp
887 | SecuritySchemeApiKey ApiKeyParams
826 | SecuritySchemeApiKey ApiKeyParams
888 | SecuritySchemeOAuth2 OAuth2Flows
827 | SecuritySchemeOAuth2 OAuth2Flows
889 | SecuritySchemeOpenIdConnect URL
828 | SecuritySchemeOpenIdConnect URL
@@ -918,7 +857,7 @@ data Tag = Tag
918 _tagName :: TagName
857 _tagName :: TagName
919
858
920 -- | A short description for the tag.
859 -- | A short description for the tag.
921− -- [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
860+ -- GFM syntax can be used for rich text representation.
922 , _tagDescription :: Maybe Text
861 , _tagDescription :: Maybe Text
923
862
924 -- | Additional external documentation for this tag.
863 -- | Additional external documentation for this tag.
@@ -933,7 +872,7 @@ instance IsString Tag where
933-- | Allows referencing an external resource for extended documentation.
872-- | Allows referencing an external resource for extended documentation.
934data ExternalDocs = ExternalDocs
873data ExternalDocs = ExternalDocs
935 { -- | A short description of the target documentation.
874 { -- | A short description of the target documentation.
936− -- [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
875+ -- GFM syntax can be used for rich text representation.
937 _externalDocsDescription :: Maybe Text
876 _externalDocsDescription :: Maybe Text
938
877
939 -- | The URL for the target documentation.
878 -- | The URL for the target documentation.
@@ -980,7 +919,8 @@ deriveGeneric ''MediaTypeObject
980deriveGeneric ''Responses
919deriveGeneric ''Responses
981deriveGeneric ''SecurityScheme
920deriveGeneric ''SecurityScheme
982deriveGeneric ''Schema
921deriveGeneric ''Schema
983−deriveGeneric ''OpenApi
922+deriveGeneric ''ParamSchema
923+deriveGeneric ''Swagger
984deriveGeneric ''Example
924deriveGeneric ''Example
985deriveGeneric ''Encoding
925deriveGeneric ''Encoding
986deriveGeneric ''Link
926deriveGeneric ''Link
@@ -989,9 +929,9 @@ deriveGeneric ''Link
989-- Monoid instances
929-- Monoid instances
990-- =======================================================================
930-- =======================================================================
991
931
992−instance Semigroup OpenApi where
932+instance Semigroup Swagger where
993 (<>) = genericMappend
933 (<>) = genericMappend
994−instance Monoid OpenApi where
934+instance Monoid Swagger where
995 mempty = genericMempty
935 mempty = genericMempty
996 mappend = (<>)
936 mappend = (<>)
997
937
@@ -1025,6 +965,12 @@ instance Monoid Schema where
1025 mempty = genericMempty
965 mempty = genericMempty
1026 mappend = (<>)
966 mappend = (<>)
1027
967
968+instance Semigroup ParamSchema where
969+ (<>) = genericMappend
970+instance Monoid ParamSchema where
971+ mempty = genericMempty
972+ mappend = (<>)
973+
1028instance Semigroup Param where
974instance Semigroup Param where
1029 (<>) = genericMappend
975 (<>) = genericMappend
1030instance Monoid Param where
976instance Monoid Param where
@@ -1119,19 +1065,19 @@ instance SwaggerMonoid Info
1119instance SwaggerMonoid Components
1065instance SwaggerMonoid Components
1120instance SwaggerMonoid PathItem
1066instance SwaggerMonoid PathItem
1121instance SwaggerMonoid Schema
1067instance SwaggerMonoid Schema
1068+instance SwaggerMonoid ParamSchema
1122instance SwaggerMonoid Param
1069instance SwaggerMonoid Param
1123instance SwaggerMonoid Responses
1070instance SwaggerMonoid Responses
1124instance SwaggerMonoid Response
1071instance SwaggerMonoid Response
1125instance SwaggerMonoid ExternalDocs
1072instance SwaggerMonoid ExternalDocs
1126instance SwaggerMonoid Operation
1073instance SwaggerMonoid Operation
1127instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
1074instance (Eq a, Hashable a) => SwaggerMonoid (InsOrdHashSet a)
1128−instance SwaggerMonoid SecurityDefinitions
1129
1075
1130instance SwaggerMonoid MimeList
1076instance SwaggerMonoid MimeList
1131deriving instance SwaggerMonoid URL
1077deriving instance SwaggerMonoid URL
1132
1078
1133−instance SwaggerMonoid OpenApiType where
1079+instance SwaggerMonoid SwaggerType where
1134− swaggerMempty = OpenApiString
1080+ swaggerMempty = SwaggerString
1135 swaggerMappend _ y = y
1081 swaggerMappend _ y = y
1136
1082
1137instance SwaggerMonoid ParamLocation where
1083instance SwaggerMonoid ParamLocation where
@@ -1154,7 +1100,7 @@ instance Monoid a => SwaggerMonoid (Referenced a) where
1154instance ToJSON Style where
1100instance ToJSON Style where
1155 toJSON = genericToJSON (jsonPrefix "Style")
1101 toJSON = genericToJSON (jsonPrefix "Style")
1156
1102
1157−instance ToJSON OpenApiType where
1103+instance ToJSON SwaggerType where
1158 toJSON = genericToJSON (jsonPrefix "Swagger")
1104 toJSON = genericToJSON (jsonPrefix "Swagger")
1159
1105
1160instance ToJSON ParamLocation where
1106instance ToJSON ParamLocation where
@@ -1209,7 +1155,7 @@ instance ToJSON OAuth2AuthorizationCodeFlow where
1209instance FromJSON Style where
1155instance FromJSON Style where
1210 parseJSON = genericParseJSON (jsonPrefix "Style")
1156 parseJSON = genericParseJSON (jsonPrefix "Style")
1211
1157
1212−instance FromJSON OpenApiType where
1158+instance FromJSON SwaggerType where
1213 parseJSON = genericParseJSON (jsonPrefix "Swagger")
1159 parseJSON = genericParseJSON (jsonPrefix "Swagger")
1214
1160
1215instance FromJSON ParamLocation where
1161instance FromJSON ParamLocation where
@@ -1274,19 +1220,8 @@ instance ToJSON OAuth2Flows where
1274 toEncoding = sopSwaggerGenericToEncoding
1220 toEncoding = sopSwaggerGenericToEncoding
1275
1221
1276instance ToJSON SecuritySchemeType where
1222instance ToJSON SecuritySchemeType where
1277− toJSON (SecuritySchemeHttp ty) = case ty of
1223+ toJSON SecuritySchemeHttp
1278− HttpSchemeBearer mFmt ->
1279− object $ [ "type" .= ("http" :: Text)
1280− , "scheme" .= ("bearer" :: Text)
1281− ] <> maybe [] (\t -> ["bearerFormat" .= t]) mFmt
1282− HttpSchemeBasic ->
1283− object [ "type" .= ("http" :: Text)
1284− , "scheme" .= ("basic" :: Text)
1285− ]
1286− HttpSchemeCustom t ->
1287− object [ "type" .= ("http" :: Text)
1224+ = object [ "type" .= ("http" :: Text) ]
1288− , "scheme" .= t
1289− ]
1290 toJSON (SecuritySchemeApiKey params)
1225 toJSON (SecuritySchemeApiKey params)
1291 = toJSON params
1226 = toJSON params
1292 <+> object [ "type" .= ("apiKey" :: Text) ]
1227 <+> object [ "type" .= ("apiKey" :: Text) ]
@@ -1299,9 +1234,9 @@ instance ToJSON SecuritySchemeType where
1299 , "openIdConnectUrl" .= url
1234 , "openIdConnectUrl" .= url
1300 ]
1235 ]
1301
1236
1302−instance ToJSON OpenApi where
1237+instance ToJSON Swagger where
1303 toJSON a = sopSwaggerGenericToJSON a &
1238 toJSON a = sopSwaggerGenericToJSON a &
1304− if InsOrdHashMap.null (_openApiPaths a)
1239+ if InsOrdHashMap.null (_swaggerPaths a)
1305 then (<+> object ["paths" .= object []])
1240 then (<+> object ["paths" .= object []])
1306 else id
1241 else id
1307 toEncoding = sopSwaggerGenericToEncoding
1242 toEncoding = sopSwaggerGenericToEncoding
@@ -1315,8 +1250,8 @@ instance ToJSON SecurityScheme where
1315 toEncoding = sopSwaggerGenericToEncoding
1250 toEncoding = sopSwaggerGenericToEncoding
1316
1251
1317instance ToJSON Schema where
1252instance ToJSON Schema where
1318− toJSON = sopSwaggerGenericToJSONWithOpts $
1253+ toJSON = sopSwaggerGenericToJSON
1319− mkSwaggerAesonOptions "schema" & saoSubObject ?~ "items"
1254+ toEncoding = sopSwaggerGenericToEncoding
1320
1255
1321instance ToJSON Header where
1256instance ToJSON Header where
1322 toJSON = sopSwaggerGenericToJSON
1257 toJSON = sopSwaggerGenericToJSON
@@ -1325,21 +1260,17 @@ instance ToJSON Header where
1325-- | As for nullary schema for 0-arity type constructors, see
1260-- | As for nullary schema for 0-arity type constructors, see
1326-- <https://github.com/GetShopTV/swagger2/issues/167>.
1261-- <https://github.com/GetShopTV/swagger2/issues/167>.
1327--
1262--
1328−-- >>> BSL.putStrLn $ encodePretty (OpenApiItemsArray [])
1263+-- >>> encode (SwaggerItemsArray [])
1329−-- {
1330−-- "example": [],
1331−-- "items": {},
1332−-- "maxItems": 0
1264+-- "{\"example\":[],\"items\":{},\"maxItems\":0}"
1333−-- }
1334--
1265--
1335−instance ToJSON OpenApiItems where
1266+instance ToJSON SwaggerItems where
1336− toJSON (OpenApiItemsObject x) = object [ "items" .= x ]
1267+ toJSON (SwaggerItemsObject x) = object [ "items" .= x ]
1337− toJSON (OpenApiItemsArray []) = object
1268+ toJSON (SwaggerItemsArray []) = object
1338 [ "items" .= object []
1269 [ "items" .= object []
1339 , "maxItems" .= (0 :: Int)
1270 , "maxItems" .= (0 :: Int)
1340 , "example" .= Array mempty
1271 , "example" .= Array mempty
1341 ]
1272 ]
1342− toJSON (OpenApiItemsArray x) = object [ "items" .= x ]
1273+ toJSON (SwaggerItemsArray x) = object [ "items" .= x ]
1343
1274
1344instance ToJSON Components where
1275instance ToJSON Components where
1345 toJSON = sopSwaggerGenericToJSON
1276 toJSON = sopSwaggerGenericToJSON
@@ -1407,6 +1338,11 @@ instance ToJSON (Referenced Header) where toJSON = referencedToJSON "#/compone
1407instance ToJSON (Referenced Link) where toJSON = referencedToJSON "#/components/links/"
1338instance ToJSON (Referenced Link) where toJSON = referencedToJSON "#/components/links/"
1408instance ToJSON (Referenced Callback) where toJSON = referencedToJSON "#/components/callbacks/"
1339instance ToJSON (Referenced Callback) where toJSON = referencedToJSON "#/components/callbacks/"
1409
1340
1341+instance ToJSON ParamSchema where
1342+ -- TODO: this is a bit fishy, why we need sub object only in `ToJSON`?
1343+ toJSON = sopSwaggerGenericToJSONWithOpts $
1344+ mkSwaggerAesonOptions "paramSchema" & saoSubObject ?~ "items"
1345+
1410instance ToJSON AdditionalProperties where
1346instance ToJSON AdditionalProperties where
1411 toJSON (AdditionalPropertiesAllowed b) = toJSON b
1347 toJSON (AdditionalPropertiesAllowed b) = toJSON b
1412 toJSON (AdditionalPropertiesSchema s) = toJSON s
1348 toJSON (AdditionalPropertiesSchema s) = toJSON s
@@ -1439,19 +1375,14 @@ instance FromJSON SecuritySchemeType where
1439 parseJSON js@(Object o) = do
1375 parseJSON js@(Object o) = do
1440 (t :: Text) <- o .: "type"
1376 (t :: Text) <- o .: "type"
1441 case t of
1377 case t of
1442− "http" -> do
1443− scheme <- o .: "scheme"
1444− SecuritySchemeHttp <$> case scheme of
1378+ "http" -> pure SecuritySchemeHttp
1445− "bearer" -> HttpSchemeBearer <$> (o .:! "bearerFormat")
1446− "basic" -> pure HttpSchemeBasic
1447− t -> pure $ HttpSchemeCustom t
1448 "apiKey" -> SecuritySchemeApiKey <$> parseJSON js
1379 "apiKey" -> SecuritySchemeApiKey <$> parseJSON js
1449 "oauth2" -> SecuritySchemeOAuth2 <$> (o .: "flows")
1380 "oauth2" -> SecuritySchemeOAuth2 <$> (o .: "flows")
1450 "openIdConnect" -> SecuritySchemeOpenIdConnect <$> (o .: "openIdConnectUrl")
1381 "openIdConnect" -> SecuritySchemeOpenIdConnect <$> (o .: "openIdConnectUrl")
1451 _ -> empty
1382 _ -> empty
1452 parseJSON _ = empty
1383 parseJSON _ = empty
1453
1384
1454−instance FromJSON OpenApi where
1385+instance FromJSON Swagger where
1455 parseJSON = sopSwaggerGenericParseJSON
1386 parseJSON = sopSwaggerGenericParseJSON
1456
1387
1457instance FromJSON Server where
1388instance FromJSON Server where
@@ -1463,28 +1394,27 @@ instance FromJSON SecurityScheme where
1463instance FromJSON Schema where
1394instance FromJSON Schema where
1464 parseJSON = fmap nullaryCleanup . sopSwaggerGenericParseJSON
1395 parseJSON = fmap nullaryCleanup . sopSwaggerGenericParseJSON
1465 where nullaryCleanup :: Schema -> Schema
1396 where nullaryCleanup :: Schema -> Schema
1466− nullaryCleanup s =
1397+ nullaryCleanup s@Schema{_schemaParamSchema=ps} =
1467− if _schemaItems s == Just (OpenApiItemsArray [])
1398+ if _paramSchemaItems ps == Just (SwaggerItemsArray [])
1468 then s { _schemaExample = Nothing
1399 then s { _schemaExample = Nothing
1469− , _schemaMaxItems = Nothing
1400+ , _schemaParamSchema = ps { _paramSchemaMaxItems = Nothing } }
1470− }
1471 else s
1401 else s
1472
1402
1473instance FromJSON Header where
1403instance FromJSON Header where
1474 parseJSON = sopSwaggerGenericParseJSON
1404 parseJSON = sopSwaggerGenericParseJSON
1475
1405
1476−instance FromJSON OpenApiItems where
1406+instance FromJSON SwaggerItems where
1477 parseJSON js@(Object obj)
1407 parseJSON js@(Object obj)
1478− | null obj = pure $ OpenApiItemsArray [] -- Nullary schema.
1408+ | null obj = pure $ SwaggerItemsArray [] -- Nullary schema.
1479− | otherwise = OpenApiItemsObject <$> parseJSON js
1409+ | otherwise = SwaggerItemsObject <$> parseJSON js
1480− parseJSON js@(Array _) = OpenApiItemsArray <$> parseJSON js
1410+ parseJSON js@(Array _) = SwaggerItemsArray <$> parseJSON js
1481 parseJSON _ = empty
1411 parseJSON _ = empty
1482
1412
1483instance FromJSON Components where
1413instance FromJSON Components where
1484 parseJSON = sopSwaggerGenericParseJSON
1414 parseJSON = sopSwaggerGenericParseJSON
1485
1415
1486instance FromJSON MimeList where
1416instance FromJSON MimeList where
1487− parseJSON js = MimeList . map fromString <$> parseJSON js
1417+ parseJSON js = (MimeList . map fromString) <$> parseJSON js
1488
1418
1489instance FromJSON Param where
1419instance FromJSON Param where
1490 parseJSON = sopSwaggerGenericParseJSON
1420 parseJSON = sopSwaggerGenericParseJSON
@@ -1492,7 +1422,7 @@ instance FromJSON Param where
1492instance FromJSON Responses where
1422instance FromJSON Responses where
1493 parseJSON (Object o) = Responses
1423 parseJSON (Object o) = Responses
1494 <$> o .:? "default"
1424 <$> o .:? "default"
1495− <*> parseJSON (Object (deleteKey "default" o))
1425+ <*> (parseJSON (Object (HashMap.delete "default" o)))
1496 parseJSON _ = empty
1426 parseJSON _ = empty
1497
1427
1498instance FromJSON Example where
1428instance FromJSON Example where
@@ -1551,6 +1481,9 @@ instance FromJSON (Referenced Callback) where parseJSON = referencedParseJSON "#
1551instance FromJSON Xml where
1481instance FromJSON Xml where
1552 parseJSON = genericParseJSON (jsonPrefix "xml")
1482 parseJSON = genericParseJSON (jsonPrefix "xml")
1553
1483
1484+instance FromJSON ParamSchema where
1485+ parseJSON = sopSwaggerGenericParseJSON
1486+
1554instance FromJSON AdditionalProperties where
1487instance FromJSON AdditionalProperties where
1555 parseJSON (Bool b) = pure $ AdditionalPropertiesAllowed b
1488 parseJSON (Bool b) = pure $ AdditionalPropertiesAllowed b
1556 parseJSON js = AdditionalPropertiesSchema <$> parseJSON js
1489 parseJSON js = AdditionalPropertiesSchema <$> parseJSON js
@@ -1591,7 +1524,7 @@ instance HasSwaggerAesonOptions SecurityScheme where
1591 swaggerAesonOptions _ = mkSwaggerAesonOptions "securityScheme" & saoSubObject ?~ "type"
1524 swaggerAesonOptions _ = mkSwaggerAesonOptions "securityScheme" & saoSubObject ?~ "type"
1592instance HasSwaggerAesonOptions Schema where
1525instance HasSwaggerAesonOptions Schema where
1593 swaggerAesonOptions _ = mkSwaggerAesonOptions "schema" & saoSubObject ?~ "paramSchema"
1526 swaggerAesonOptions _ = mkSwaggerAesonOptions "schema" & saoSubObject ?~ "paramSchema"
1594−instance HasSwaggerAesonOptions OpenApi where
1527+instance HasSwaggerAesonOptions Swagger where
1595 swaggerAesonOptions _ = mkSwaggerAesonOptions "swagger" & saoAdditionalPairs .~ [("openapi", "3.0.0")]
1528 swaggerAesonOptions _ = mkSwaggerAesonOptions "swagger" & saoAdditionalPairs .~ [("openapi", "3.0.0")]
1596instance HasSwaggerAesonOptions Example where
1529instance HasSwaggerAesonOptions Example where
1597 swaggerAesonOptions _ = mkSwaggerAesonOptions "example"
1530 swaggerAesonOptions _ = mkSwaggerAesonOptions "example"
@@ -1601,8 +1534,12 @@ instance HasSwaggerAesonOptions Encoding where
1601instance HasSwaggerAesonOptions Link where
1534instance HasSwaggerAesonOptions Link where
1602 swaggerAesonOptions _ = mkSwaggerAesonOptions "link"
1535 swaggerAesonOptions _ = mkSwaggerAesonOptions "link"
1603
1536
1537+instance HasSwaggerAesonOptions ParamSchema where
1538+ swaggerAesonOptions _ = mkSwaggerAesonOptions "paramSchema"
1539+
1604instance AesonDefaultValue Server
1540instance AesonDefaultValue Server
1605instance AesonDefaultValue Components
1541instance AesonDefaultValue Components
1542+instance AesonDefaultValue ParamSchema
1606instance AesonDefaultValue OAuth2ImplicitFlow
1543instance AesonDefaultValue OAuth2ImplicitFlow
1607instance AesonDefaultValue OAuth2PasswordFlow
1544instance AesonDefaultValue OAuth2PasswordFlow
1608instance AesonDefaultValue OAuth2ClientCredentialsFlow
1545instance AesonDefaultValue OAuth2ClientCredentialsFlow
@@ -1610,10 +1547,8 @@ instance AesonDefaultValue OAuth2AuthorizationCodeFlow
1610instance AesonDefaultValue p => AesonDefaultValue (OAuth2Flow p)
1547instance AesonDefaultValue p => AesonDefaultValue (OAuth2Flow p)
1611instance AesonDefaultValue Responses
1548instance AesonDefaultValue Responses
1612instance AesonDefaultValue SecuritySchemeType
1549instance AesonDefaultValue SecuritySchemeType
1613−instance AesonDefaultValue OpenApiType
1550+instance AesonDefaultValue SwaggerType
1614instance AesonDefaultValue MimeList where defaultValue = Just mempty
1551instance AesonDefaultValue MimeList where defaultValue = Just mempty
1615instance AesonDefaultValue Info
1552instance AesonDefaultValue Info
1616instance AesonDefaultValue ParamLocation
1553instance AesonDefaultValue ParamLocation
1617instance AesonDefaultValue Link
1554instance AesonDefaultValue Link
1618−instance AesonDefaultValue SecurityDefinitions where
1619− defaultValue = Just mempty
src/Data/OpenApi/Internal/AesonUtils.hs → src/Data/Swagger/Internal/AesonUtils.hsrenamed+13−12
@@ -5,7 +5,7 @@
5{-# LANGUAGE ExplicitForAll #-}
5{-# LANGUAGE ExplicitForAll #-}
6{-# LANGUAGE TemplateHaskell #-}
6{-# LANGUAGE TemplateHaskell #-}
7{-# LANGUAGE UndecidableSuperClasses #-}
7{-# LANGUAGE UndecidableSuperClasses #-}
8−module Data.OpenApi.Internal.AesonUtils (
8+module Data.Swagger.Internal.AesonUtils (
9 -- * Generic functions
9 -- * Generic functions
10 AesonDefaultValue(..),
10 AesonDefaultValue(..),
11 sopSwaggerGenericToJSON,
11 sopSwaggerGenericToJSON,
@@ -27,7 +27,7 @@ import Prelude.Compat
27import Control.Applicative ((<|>))
27import Control.Applicative ((<|>))
28import Control.Lens (makeLenses, (^.))
28import Control.Lens (makeLenses, (^.))
29import Control.Monad (unless)
29import Control.Monad (unless)
30−import Data.Aeson (ToJSON(..), FromJSON(..), Value(..), Object, object, (.:), (.:?), (.!=), withObject, Encoding, pairs, (.=), Series)
30+import Data.Aeson (ToJSON(..), FromJSON(..), Value(..), Object, object, (.:), (.:?), (.!=), withObject)
31import Data.Aeson.Types (Parser, Pair)
31import Data.Aeson.Types (Parser, Pair)
32import Data.Char (toLower, isUpper)
32import Data.Char (toLower, isUpper)
33import Data.Foldable (traverse_)
33import Data.Foldable (traverse_)
@@ -36,11 +36,12 @@ import Data.Text (Text)
36import Generics.SOP
36import Generics.SOP
37
37
38import qualified Data.Text as T
38import qualified Data.Text as T
39+import qualified Data.HashMap.Strict as HM
39import qualified Data.Set as Set
40import qualified Data.Set as Set
40import qualified Data.HashMap.Strict.InsOrd as InsOrd
41import qualified Data.HashMap.Strict.InsOrd as InsOrd
41import qualified Data.HashSet.InsOrd as InsOrdHS
42import qualified Data.HashSet.InsOrd as InsOrdHS
42
43
43−import Data.OpenApi.Aeson.Compat (keyToString, objectToList, stringToKey)
44+import Data.Aeson (Encoding, pairs, (.=), Series)
44
45
45-------------------------------------------------------------------------------
46-------------------------------------------------------------------------------
46-- SwaggerAesonOptions
47-- SwaggerAesonOptions
@@ -48,7 +49,7 @@ import Data.OpenApi.Aeson.Compat (keyToString, objectToList, stringToKey)
48
49
49data SwaggerAesonOptions = SwaggerAesonOptions
50data SwaggerAesonOptions = SwaggerAesonOptions
50 { _saoPrefix :: String
51 { _saoPrefix :: String
51− , _saoAdditionalPairs :: [Pair]
52+ , _saoAdditionalPairs :: [(Text, Value)]
52 , _saoSubObject :: Maybe String
53 , _saoSubObject :: Maybe String
53 }
54 }
54
55
@@ -155,14 +156,14 @@ sopSwaggerGenericToJSON'' (SwaggerAesonOptions prefix _ sub) = go
155 go Nil Nil Nil = []
156 go Nil Nil Nil = []
156 go (I x :* xs) (FieldInfo name :* names) (def :* defs)
157 go (I x :* xs) (FieldInfo name :* names) (def :* defs)
157 | Just name' == sub = case json of
158 | Just name' == sub = case json of
158− Object m -> objectToList m ++ rest
159+ Object m -> HM.toList m ++ rest
159 Null -> rest
160 Null -> rest
160 _ -> error $ "sopSwaggerGenericToJSON: subjson is not an object: " ++ show json
161 _ -> error $ "sopSwaggerGenericToJSON: subjson is not an object: " ++ show json
161 -- If default value: omit it.
162 -- If default value: omit it.
162 | Just x == def =
163 | Just x == def =
163 rest
164 rest
164 | otherwise =
165 | otherwise =
165− (stringToKey name', json) : rest
166+ (T.pack name', json) : rest
166 where
167 where
167 json = toJSON x
168 json = toJSON x
168 name' = fieldNameModifier name
169 name' = fieldNameModifier name
@@ -196,11 +197,11 @@ sopSwaggerGenericParseJSON = withObject "Swagger Record Object" $ \obj ->
196 proxy = Proxy :: Proxy a
197 proxy = Proxy :: Proxy a
197 opts = swaggerAesonOptions proxy
198 opts = swaggerAesonOptions proxy
198
199
199− parseAdditionalField :: Object -> Pair -> Parser ()
200+ parseAdditionalField :: Object -> (Text, Value) -> Parser ()
200 parseAdditionalField obj (k, v) = do
201 parseAdditionalField obj (k, v) = do
201 v' <- obj .: k
202 v' <- obj .: k
202 unless (v == v') $ fail $
203 unless (v == v') $ fail $
203− "Additonal field don't match for key " ++ keyToString k
204+ "Additonal field don't match for key " ++ T.unpack k
204 ++ ": " ++ show v
205 ++ ": " ++ show v
205 ++ " /= " ++ show v'
206 ++ " /= " ++ show v'
206
207
@@ -231,8 +232,8 @@ sopSwaggerGenericParseJSON'' (SwaggerAesonOptions prefix _ sub) obj = go
231 -- Note: we might strip fields of outer structure.
232 -- Note: we might strip fields of outer structure.
232 cons <$> (withDef $ parseJSON $ Object obj) <*> rest
233 cons <$> (withDef $ parseJSON $ Object obj) <*> rest
233 | otherwise = case def of
234 | otherwise = case def of
234− Just def' -> cons <$> obj .:? stringToKey name' .!= def' <*> rest
235+ Just def' -> cons <$> obj .:? T.pack name' .!= def' <*> rest
235− Nothing -> cons <$> obj .: stringToKey name' <*> rest
236+ Nothing -> cons <$> obj .: T.pack name' <*> rest
236 where
237 where
237 cons h t = I h :* t
238 cons h t = I h :* t
238 name' = fieldNameModifier name
239 name' = fieldNameModifier name
@@ -295,14 +296,14 @@ sopSwaggerGenericToEncoding'' (SwaggerAesonOptions prefix _ sub) = go
295 go Nil Nil Nil = mempty
296 go Nil Nil Nil = mempty
296 go (I x :* xs) (FieldInfo name :* names) (def :* defs)
297 go (I x :* xs) (FieldInfo name :* names) (def :* defs)
297 | Just name' == sub = case toJSON x of
298 | Just name' == sub = case toJSON x of
298− Object m -> pairsToSeries (objectToList m) <> rest
299+ Object m -> pairsToSeries (HM.toList m) <> rest
299 Null -> rest
300 Null -> rest
300 _ -> error $ "sopSwaggerGenericToJSON: subjson is not an object: " ++ show (toJSON x)
301 _ -> error $ "sopSwaggerGenericToJSON: subjson is not an object: " ++ show (toJSON x)
301 -- If default value: omit it.
302 -- If default value: omit it.
302 | Just x == def =
303 | Just x == def =
303 rest
304 rest
304 | otherwise =
305 | otherwise =
305− (stringToKey name' .= x) <> rest
306+ (T.pack name' .= x) <> rest
306 where
307 where
307 name' = fieldNameModifier name
308 name' = fieldNameModifier name
308 rest = go xs names defs
309 rest = go xs names defs
src/Data/OpenApi/Internal/ParamSchema.hs → src/Data/Swagger/Internal/ParamSchema.hsrenamed+52−76
@@ -15,7 +15,7 @@
15{-# OPTIONS_GHC -Wno-redundant-constraints #-}
15{-# OPTIONS_GHC -Wno-redundant-constraints #-}
16-- For TypeErrors
16-- For TypeErrors
17{-# OPTIONS_GHC -Wno-unticked-promoted-constructors #-}
17{-# OPTIONS_GHC -Wno-unticked-promoted-constructors #-}
18−module Data.OpenApi.Internal.ParamSchema where
18+module Data.Swagger.Internal.ParamSchema where
19
19
20import Control.Lens
20import Control.Lens
21import Data.Aeson (ToJSON (..))
21import Data.Aeson (ToJSON (..))
@@ -41,40 +41,34 @@ import Data.Word
41import Data.UUID.Types (UUID)
41import Data.UUID.Types (UUID)
42import Web.Cookie (SetCookie)
42import Web.Cookie (SetCookie)
43
43
44−import Data.OpenApi.Internal
44+import Data.Swagger.Internal
45−import Data.OpenApi.Lens
45+import Data.Swagger.Lens
46−import Data.OpenApi.SchemaOptions
46+import Data.Swagger.SchemaOptions
47
47
48import qualified Data.ByteString as BS
48import qualified Data.ByteString as BS
49−import qualified Data.ByteString.Lazy.Char8 as BSL
49+import qualified Data.ByteString.Lazy as BSL
50import GHC.TypeLits (TypeError, ErrorMessage(..))
50import GHC.TypeLits (TypeError, ErrorMessage(..))
51
51
52-- | Default schema for binary data (any sequence of octets).
52-- | Default schema for binary data (any sequence of octets).
53−binarySchema :: Schema
53+binaryParamSchema :: ParamSchema
54−binarySchema = mempty
54+binaryParamSchema = mempty
55− & type_ ?~ OpenApiString
55+ & type_ ?~ SwaggerString
56 & format ?~ "binary"
56 & format ?~ "binary"
57
57
58-- | Default schema for binary data (base64 encoded).
58-- | Default schema for binary data (base64 encoded).
59−byteSchema :: Schema
59+byteParamSchema :: ParamSchema
60−byteSchema = mempty
60+byteParamSchema = mempty
61− & type_ ?~ OpenApiString
61+ & type_ ?~ SwaggerString
62 & format ?~ "byte"
62 & format ?~ "byte"
63
63
64-- | Default schema for password string.
64-- | Default schema for password string.
65-- @"password"@ format is used to hint UIs the input needs to be obscured.
65-- @"password"@ format is used to hint UIs the input needs to be obscured.
66−passwordSchema :: Schema
66+passwordParamSchema :: ParamSchema
67−passwordSchema = mempty
67+passwordParamSchema = mempty
68− & type_ ?~ OpenApiString
68+ & type_ ?~ SwaggerString
69 & format ?~ "password"
69 & format ?~ "password"
70
70
71−-- | Convert a type into a plain @'Schema'@.
71+-- | Convert a type into a plain @'ParamSchema'@.
72−--
73−-- In previous versions of the package there was a separate type called @ParamSchema@, which was
74−-- included in a greater 'Schema'. Now this is a single class, but distinction for schema generators
75−-- for "simple" types is preserved.
76−--
77−-- 'ToParamSchema' is suited only for primitive-like types without nested fields and such.
78--
72--
79-- An example type and instance:
73-- An example type and instance:
80--
74--
@@ -87,7 +81,7 @@ passwordSchema = mempty
87--
81--
88-- instance ToParamSchema Direction where
82-- instance ToParamSchema Direction where
89-- toParamSchema _ = mempty
83-- toParamSchema _ = mempty
90−-- & type_ ?~ OpenApiString
84+-- & type_ ?~ SwaggerString
91-- & enum_ ?~ [ \"Up\", \"Down\" ]
85-- & enum_ ?~ [ \"Up\", \"Down\" ]
92-- @
86-- @
93--
87--
@@ -112,26 +106,24 @@ passwordSchema = mempty
112class ToParamSchema a where
106class ToParamSchema a where
113 -- | Convert a type into a plain parameter schema.
107 -- | Convert a type into a plain parameter schema.
114 --
108 --
115− -- >>> BSL.putStrLn $ encodePretty $ toParamSchema (Proxy :: Proxy Integer)
109+ -- >>> encode $ toParamSchema (Proxy :: Proxy Integer)
116− -- {
117− -- "type": "integer"
110+ -- "{\"type\":\"integer\"}"
118− -- }
119− toParamSchema :: Proxy a -> Schema
111+ toParamSchema :: Proxy a -> ParamSchema
120− default toParamSchema :: (Generic a, GToParamSchema (Rep a)) => Proxy a -> Schema
112+ default toParamSchema :: (Generic a, GToParamSchema (Rep a)) => Proxy a -> ParamSchema
121 toParamSchema = genericToParamSchema defaultSchemaOptions
113 toParamSchema = genericToParamSchema defaultSchemaOptions
122
114
123instance {-# OVERLAPPING #-} ToParamSchema String where
115instance {-# OVERLAPPING #-} ToParamSchema String where
124− toParamSchema _ = mempty & type_ ?~ OpenApiString
116+ toParamSchema _ = mempty & type_ ?~ SwaggerString
125
117
126instance ToParamSchema Bool where
118instance ToParamSchema Bool where
127− toParamSchema _ = mempty & type_ ?~ OpenApiBoolean
119+ toParamSchema _ = mempty & type_ ?~ SwaggerBoolean
128
120
129instance ToParamSchema Integer where
121instance ToParamSchema Integer where
130− toParamSchema _ = mempty & type_ ?~ OpenApiInteger
122+ toParamSchema _ = mempty & type_ ?~ SwaggerInteger
131
123
132instance ToParamSchema Natural where
124instance ToParamSchema Natural where
133 toParamSchema _ = mempty
125 toParamSchema _ = mempty
134− & type_ ?~ OpenApiInteger
126+ & type_ ?~ SwaggerInteger
135 & minimum_ ?~ 0
127 & minimum_ ?~ 0
136 & exclusiveMinimum ?~ False
128 & exclusiveMinimum ?~ False
137
129
@@ -157,45 +149,41 @@ instance ToParamSchema Word64 where
157
149
158-- | Default plain schema for @'Bounded'@, @'Integral'@ types.
150-- | Default plain schema for @'Bounded'@, @'Integral'@ types.
159--
151--
160−-- >>> BSL.putStrLn $ encodePretty $ toParamSchemaBoundedIntegral (Proxy :: Proxy Int8)
152+-- >>> encode $ toParamSchemaBoundedIntegral (Proxy :: Proxy Int8)
161−-- {
162−-- "maximum": 127,
163−-- "minimum": -128,
164−-- "type": "integer"
153+-- "{\"maximum\":127,\"minimum\":-128,\"type\":\"integer\"}"
165−-- }
166−toParamSchemaBoundedIntegral :: forall a t. (Bounded a, Integral a) => Proxy a -> Schema
154+toParamSchemaBoundedIntegral :: forall a t. (Bounded a, Integral a) => Proxy a -> ParamSchema
167toParamSchemaBoundedIntegral _ = mempty
155toParamSchemaBoundedIntegral _ = mempty
168− & type_ ?~ OpenApiInteger
156+ & type_ ?~ SwaggerInteger
169 & minimum_ ?~ fromInteger (toInteger (minBound :: a))
157 & minimum_ ?~ fromInteger (toInteger (minBound :: a))
170 & maximum_ ?~ fromInteger (toInteger (maxBound :: a))
158 & maximum_ ?~ fromInteger (toInteger (maxBound :: a))
171
159
172instance ToParamSchema Char where
160instance ToParamSchema Char where
173 toParamSchema _ = mempty
161 toParamSchema _ = mempty
174− & type_ ?~ OpenApiString
162+ & type_ ?~ SwaggerString
175 & maxLength ?~ 1
163 & maxLength ?~ 1
176 & minLength ?~ 1
164 & minLength ?~ 1
177
165
178instance ToParamSchema Scientific where
166instance ToParamSchema Scientific where
179− toParamSchema _ = mempty & type_ ?~ OpenApiNumber
167+ toParamSchema _ = mempty & type_ ?~ SwaggerNumber
180
168
181instance HasResolution a => ToParamSchema (Fixed a) where
169instance HasResolution a => ToParamSchema (Fixed a) where
182 toParamSchema _ = mempty
170 toParamSchema _ = mempty
183− & type_ ?~ OpenApiNumber
171+ & type_ ?~ SwaggerNumber
184 & multipleOf ?~ (recip . fromInteger $ resolution (Proxy :: Proxy a))
172 & multipleOf ?~ (recip . fromInteger $ resolution (Proxy :: Proxy a))
185
173
186instance ToParamSchema Double where
174instance ToParamSchema Double where
187 toParamSchema _ = mempty
175 toParamSchema _ = mempty
188− & type_ ?~ OpenApiNumber
176+ & type_ ?~ SwaggerNumber
189 & format ?~ "double"
177 & format ?~ "double"
190
178
191instance ToParamSchema Float where
179instance ToParamSchema Float where
192 toParamSchema _ = mempty
180 toParamSchema _ = mempty
193− & type_ ?~ OpenApiNumber
181+ & type_ ?~ SwaggerNumber
194 & format ?~ "float"
182 & format ?~ "float"
195
183
196−timeParamSchema :: String -> Schema
184+timeParamSchema :: String -> ParamSchema
197timeParamSchema fmt = mempty
185timeParamSchema fmt = mempty
198− & type_ ?~ OpenApiString
186+ & type_ ?~ SwaggerString
199 & format ?~ T.pack fmt
187 & format ?~ T.pack fmt
200
188
201-- | Format @"date"@ corresponds to @yyyy-mm-dd@ format.
189-- | Format @"date"@ corresponds to @yyyy-mm-dd@ format.
@@ -216,9 +204,9 @@ instance ToParamSchema LocalTime where
216
204
217-- |
205-- |
218-- >>> toParamSchema (Proxy :: Proxy ZonedTime) ^. format
206-- >>> toParamSchema (Proxy :: Proxy ZonedTime) ^. format
219−-- Just "date-time"
207+-- Just "yyyy-mm-ddThh:MM:ss+hhMM"
220instance ToParamSchema ZonedTime where
208instance ToParamSchema ZonedTime where
221− toParamSchema _ = timeParamSchema "date-time"
209+ toParamSchema _ = timeParamSchema "yyyy-mm-ddThh:MM:ss+hhMM"
222
210
223-- |
211-- |
224-- >>> toParamSchema (Proxy :: Proxy UTCTime) ^. format
212-- >>> toParamSchema (Proxy :: Proxy UTCTime) ^. format
@@ -237,12 +225,12 @@ instance ToParamSchema TL.Text where
237
225
238instance ToParamSchema Version where
226instance ToParamSchema Version where
239 toParamSchema _ = mempty
227 toParamSchema _ = mempty
240− & type_ ?~ OpenApiString
228+ & type_ ?~ SwaggerString
241 & pattern ?~ "^\\d+(\\.\\d+)*$"
229 & pattern ?~ "^\\d+(\\.\\d+)*$"
242
230
243instance ToParamSchema SetCookie where
231instance ToParamSchema SetCookie where
244 toParamSchema _ = mempty
232 toParamSchema _ = mempty
245− & type_ ?~ OpenApiString
233+ & type_ ?~ SwaggerString
246
234
247type family ToParamSchemaByteStringError bs where
235type family ToParamSchemaByteStringError bs where
248 ToParamSchemaByteStringError bs = TypeError
236 ToParamSchemaByteStringError bs = TypeError
@@ -265,8 +253,8 @@ instance ToParamSchema a => ToParamSchema (Identity a) where toParamSchema _ = t
265
253
266instance ToParamSchema a => ToParamSchema [a] where
254instance ToParamSchema a => ToParamSchema [a] where
267 toParamSchema _ = mempty
255 toParamSchema _ = mempty
268− & type_ ?~ OpenApiArray
256+ & type_ ?~ SwaggerArray
269− & items ?~ OpenApiItemsObject (Inline $ toParamSchema (Proxy :: Proxy a))
257+ & items ?~ SwaggerItemsObject (Inline $ mempty & paramSchema .~ toParamSchema (Proxy :: Proxy a))
270
258
271instance ToParamSchema a => ToParamSchema (V.Vector a) where toParamSchema _ = toParamSchema (Proxy :: Proxy [a])
259instance ToParamSchema a => ToParamSchema (V.Vector a) where toParamSchema _ = toParamSchema (Proxy :: Proxy [a])
272instance ToParamSchema a => ToParamSchema (VP.Vector a) where toParamSchema _ = toParamSchema (Proxy :: Proxy [a])
260instance ToParamSchema a => ToParamSchema (VP.Vector a) where toParamSchema _ = toParamSchema (Proxy :: Proxy [a])
@@ -281,40 +269,29 @@ instance ToParamSchema a => ToParamSchema (HashSet a) where
281 toParamSchema _ = toParamSchema (Proxy :: Proxy (Set a))
269 toParamSchema _ = toParamSchema (Proxy :: Proxy (Set a))
282
270
283-- |
271-- |
284−-- >>> BSL.putStrLn $ encodePretty $ toParamSchema (Proxy :: Proxy ())
272+-- >>> encode $ toParamSchema (Proxy :: Proxy ())
285−-- {
286−-- "enum": [
273+-- "{\"type\":\"string\",\"enum\":[\"_\"]}"
287−-- "_"
288−-- ],
289−-- "type": "string"
290−-- }
291instance ToParamSchema () where
274instance ToParamSchema () where
292 toParamSchema _ = mempty
275 toParamSchema _ = mempty
293− & type_ ?~ OpenApiString
276+ & type_ ?~ SwaggerString
294 & enum_ ?~ ["_"]
277 & enum_ ?~ ["_"]
295
278
296instance ToParamSchema UUID where
279instance ToParamSchema UUID where
297 toParamSchema _ = mempty
280 toParamSchema _ = mempty
298− & type_ ?~ OpenApiString
281+ & type_ ?~ SwaggerString
299 & format ?~ "uuid"
282 & format ?~ "uuid"
300
283
301−-- | A configurable generic @'Schema'@ creator.
284+-- | A configurable generic @'ParamSchema'@ creator.
302--
285--
303-- >>> :set -XDeriveGeneric
286-- >>> :set -XDeriveGeneric
304-- >>> data Color = Red | Blue deriving Generic
287-- >>> data Color = Red | Blue deriving Generic
305−-- >>> BSL.putStrLn $ encodePretty $ genericToParamSchema defaultSchemaOptions (Proxy :: Proxy Color)
288+-- >>> encode $ genericToParamSchema defaultSchemaOptions (Proxy :: Proxy Color)
306−-- {
289+-- "{\"type\":\"string\",\"enum\":[\"Red\",\"Blue\"]}"
307−-- "enum": [
308−-- "Red",
309−-- "Blue"
310−-- ],
311−-- "type": "string"
312−-- }
313−genericToParamSchema :: forall a t. (Generic a, GToParamSchema (Rep a)) => SchemaOptions -> Proxy a -> Schema
290+genericToParamSchema :: forall a t. (Generic a, GToParamSchema (Rep a)) => SchemaOptions -> Proxy a -> ParamSchema
314genericToParamSchema opts _ = gtoParamSchema opts (Proxy :: Proxy (Rep a)) mempty
291genericToParamSchema opts _ = gtoParamSchema opts (Proxy :: Proxy (Rep a)) mempty
315
292
316class GToParamSchema (f :: * -> *) where
293class GToParamSchema (f :: * -> *) where
317− gtoParamSchema :: SchemaOptions -> Proxy f -> Schema -> Schema
294+ gtoParamSchema :: SchemaOptions -> Proxy f -> ParamSchema -> ParamSchema
318
295
319instance GToParamSchema f => GToParamSchema (D1 d f) where
296instance GToParamSchema f => GToParamSchema (D1 d f) where
320 gtoParamSchema opts _ = gtoParamSchema opts (Proxy :: Proxy f)
297 gtoParamSchema opts _ = gtoParamSchema opts (Proxy :: Proxy f)
@@ -332,14 +309,14 @@ instance (GEnumParamSchema f, GEnumParamSchema g) => GToParamSchema (f :+: g) wh
332 gtoParamSchema opts _ = genumParamSchema opts (Proxy :: Proxy (f :+: g))
309 gtoParamSchema opts _ = genumParamSchema opts (Proxy :: Proxy (f :+: g))
333
310
334class GEnumParamSchema (f :: * -> *) where
311class GEnumParamSchema (f :: * -> *) where
335− genumParamSchema :: SchemaOptions -> Proxy f -> Schema -> Schema
312+ genumParamSchema :: SchemaOptions -> Proxy f -> ParamSchema -> ParamSchema
336
313
337instance (GEnumParamSchema f, GEnumParamSchema g) => GEnumParamSchema (f :+: g) where
314instance (GEnumParamSchema f, GEnumParamSchema g) => GEnumParamSchema (f :+: g) where
338 genumParamSchema opts _ = genumParamSchema opts (Proxy :: Proxy f) . genumParamSchema opts (Proxy :: Proxy g)
315 genumParamSchema opts _ = genumParamSchema opts (Proxy :: Proxy f) . genumParamSchema opts (Proxy :: Proxy g)
339
316
340instance Constructor c => GEnumParamSchema (C1 c U1) where
317instance Constructor c => GEnumParamSchema (C1 c U1) where
341 genumParamSchema opts _ s = s
318 genumParamSchema opts _ s = s
342− & type_ ?~ OpenApiString
319+ & type_ ?~ SwaggerString
343 & enum_ %~ addEnumValue tag
320 & enum_ %~ addEnumValue tag
344 where
321 where
345 tag = toJSON (constructorTagModifier opts (conName (Proxy3 :: Proxy3 c f p)))
322 tag = toJSON (constructorTagModifier opts (conName (Proxy3 :: Proxy3 c f p)))
@@ -351,4 +328,3 @@ data Proxy3 a b c = Proxy3
351
328
352-- $setup
329-- $setup
353-- >>> import Data.Aeson (encode)
330-- >>> import Data.Aeson (encode)
354−-- >>> import Data.OpenApi.Internal.Utils
src/Data/OpenApi/Internal/Schema.hs → src/Data/Swagger/Internal/Schema.hsrenamed+140−383
@@ -1,17 +1,15 @@
1−{-# LANGUAGE CPP #-}
2{-# LANGUAGE ConstraintKinds #-}
1{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE DataKinds #-}
4{-# LANGUAGE DefaultSignatures #-}
2{-# LANGUAGE DefaultSignatures #-}
5{-# LANGUAGE FlexibleContexts #-}
3{-# LANGUAGE FlexibleContexts #-}
6{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FlexibleInstances #-}
7{-# LANGUAGE KindSignatures #-}
5{-# LANGUAGE KindSignatures #-}
6+{-# LANGUAGE DataKinds #-}
8{-# LANGUAGE OverloadedLists #-}
7{-# LANGUAGE OverloadedLists #-}
9{-# LANGUAGE OverloadedStrings #-}
8{-# LANGUAGE OverloadedStrings #-}
10{-# LANGUAGE PackageImports #-}
9{-# LANGUAGE PackageImports #-}
11{-# LANGUAGE PolyKinds #-}
10{-# LANGUAGE PolyKinds #-}
12{-# LANGUAGE ScopedTypeVariables #-}
11{-# LANGUAGE ScopedTypeVariables #-}
13{-# LANGUAGE TupleSections #-}
12{-# LANGUAGE TupleSections #-}
14−{-# LANGUAGE TypeApplications #-}
15{-# LANGUAGE TypeFamilies #-}
13{-# LANGUAGE TypeFamilies #-}
16{-# LANGUAGE TypeOperators #-}
14{-# LANGUAGE TypeOperators #-}
17{-# LANGUAGE TypeSynonymInstances #-}
15{-# LANGUAGE TypeSynonymInstances #-}
@@ -19,7 +17,7 @@
19{-# OPTIONS_GHC -Wno-redundant-constraints #-}
17{-# OPTIONS_GHC -Wno-redundant-constraints #-}
20-- For TypeErrors
18-- For TypeErrors
21{-# OPTIONS_GHC -Wno-unticked-promoted-constructors #-}
19{-# OPTIONS_GHC -Wno-unticked-promoted-constructors #-}
22−module Data.OpenApi.Internal.Schema where
20+module Data.Swagger.Internal.Schema where
23
21
24import Prelude ()
22import Prelude ()
25import Prelude.Compat
23import Prelude.Compat
@@ -42,7 +40,6 @@ import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
42import Data.Int
40import Data.Int
43import Data.IntSet (IntSet)
41import Data.IntSet (IntSet)
44import Data.IntMap (IntMap)
42import Data.IntMap (IntMap)
45−import Data.List (sort)
46import Data.List.NonEmpty.Compat (NonEmpty)
43import Data.List.NonEmpty.Compat (NonEmpty)
47import Data.Map (Map)
44import Data.Map (Map)
48import Data.Maybe (fromMaybe)
45import Data.Maybe (fromMaybe)
@@ -62,16 +59,14 @@ import Numeric.Natural.Compat (Natural)
62import Data.Word
59import Data.Word
63import GHC.Generics
60import GHC.Generics
64import qualified Data.UUID.Types as UUID
61import qualified Data.UUID.Types as UUID
65−import Type.Reflection (Typeable, typeRep)
66
62
67−import Data.OpenApi.Aeson.Compat (keyToText, objectKeys, toInsOrdHashMap)
68−import Data.OpenApi.Declare
63+import Data.Swagger.Declare
69−import Data.OpenApi.Internal
64+import Data.Swagger.Internal
70−import Data.OpenApi.Internal.ParamSchema (ToParamSchema (..))
65+import Data.Swagger.Internal.ParamSchema (ToParamSchema(..))
71−import Data.OpenApi.Internal.TypeShape
72−import Data.OpenApi.Lens hiding (name, schema)
66+import Data.Swagger.Lens hiding (name, schema)
73−import qualified Data.OpenApi.Lens as Swagger
67+import qualified Data.Swagger.Lens as Swagger
74−import Data.OpenApi.SchemaOptions
68+import Data.Swagger.SchemaOptions
69+import Data.Swagger.Internal.TypeShape
75
70
76import qualified Data.ByteString as BS
71import qualified Data.ByteString as BS
77import qualified Data.ByteString.Lazy.Char8 as BSL
72import qualified Data.ByteString.Lazy.Char8 as BSL
@@ -102,7 +97,7 @@ rename name (NamedSchema _ schema) = NamedSchema name schema
102--
97--
103-- import Control.Lens
98-- import Control.Lens
104-- import Data.Proxy
99-- import Data.Proxy
105−-- import Data.OpenApi
100+-- import Data.Swagger
106--
101--
107-- data Coord = Coord { x :: Double, y :: Double }
102-- data Coord = Coord { x :: Double, y :: Double }
108--
103--
@@ -110,7 +105,7 @@ rename name (NamedSchema _ schema) = NamedSchema name schema
110-- declareNamedSchema _ = do
105-- declareNamedSchema _ = do
111-- doubleSchema <- declareSchemaRef (Proxy :: Proxy Double)
106-- doubleSchema <- declareSchemaRef (Proxy :: Proxy Double)
112-- return $ NamedSchema (Just \"Coord\") $ mempty
107-- return $ NamedSchema (Just \"Coord\") $ mempty
113−-- & type_ ?~ OpenApiObject
108+-- & type_ ?~ SwaggerObject
114-- & properties .~
109-- & properties .~
115-- [ (\"x\", doubleSchema)
110-- [ (\"x\", doubleSchema)
116-- , (\"y\", doubleSchema)
111-- , (\"y\", doubleSchema)
@@ -136,7 +131,7 @@ rename name (NamedSchema _ schema) = NamedSchema name schema
136--
131--
137-- instance ToSchema Coord
132-- instance ToSchema Coord
138-- @
133-- @
139−class Typeable a => ToSchema a where
134+class ToSchema a where
140 -- | Convert a type into an optionally named schema
135 -- | Convert a type into an optionally named schema
141 -- together with all used definitions.
136 -- together with all used definitions.
142 -- Note that the schema itself is included in definitions
137 -- Note that the schema itself is included in definitions
@@ -158,19 +153,13 @@ declareSchema = fmap _namedSchemaSchema . declareNamedSchema
158--
153--
159-- >>> toNamedSchema (Proxy :: Proxy String) ^. name
154-- >>> toNamedSchema (Proxy :: Proxy String) ^. name
160-- Nothing
155-- Nothing
161−-- >>> BSL.putStrLn $ encodePretty (toNamedSchema (Proxy :: Proxy String) ^. schema)
156+-- >>> BSL.putStrLn $ encode (toNamedSchema (Proxy :: Proxy String) ^. schema)
162−-- {
163−-- "type": "string"
157+-- {"type":"string"}
164−-- }
165--
158--
166-- >>> toNamedSchema (Proxy :: Proxy Day) ^. name
159-- >>> toNamedSchema (Proxy :: Proxy Day) ^. name
167-- Just "Day"
160-- Just "Day"
168−-- >>> BSL.putStrLn $ encodePretty (toNamedSchema (Proxy :: Proxy Day) ^. schema)
161+-- >>> BSL.putStrLn $ encode (toNamedSchema (Proxy :: Proxy Day) ^. schema)
169−-- {
170−-- "example": "2016-07-22",
162+-- {"example":"2016-07-22","format":"date","type":"string"}
171−-- "format": "date",
172−-- "type": "string"
173−-- }
174toNamedSchema :: ToSchema a => Proxy a -> NamedSchema
163toNamedSchema :: ToSchema a => Proxy a -> NamedSchema
175toNamedSchema = undeclare . declareNamedSchema
164toNamedSchema = undeclare . declareNamedSchema
176
165
@@ -186,35 +175,22 @@ schemaName = _namedSchemaName . toNamedSchema
186
175
187-- | Convert a type into a schema.
176-- | Convert a type into a schema.
188--
177--
189−-- >>> BSL.putStrLn $ encodePretty $ toSchema (Proxy :: Proxy Int8)
178+-- >>> BSL.putStrLn $ encode $ toSchema (Proxy :: Proxy Int8)
190−-- {
191−-- "maximum": 127,
192−-- "minimum": -128,
193−-- "type": "integer"
179+-- {"maximum":127,"minimum":-128,"type":"integer"}
194−-- }
195--
180--
196−-- >>> BSL.putStrLn $ encodePretty $ toSchema (Proxy :: Proxy [Day])
181+-- >>> BSL.putStrLn $ encode $ toSchema (Proxy :: Proxy [Day])
197−-- {
198−-- "items": {
199−-- "$ref": "#/components/schemas/Day"
182+-- {"items":{"$ref":"#/components/schemas/Day"},"type":"array"}
200−-- },
201−-- "type": "array"
202−-- }
203toSchema :: ToSchema a => Proxy a -> Schema
183toSchema :: ToSchema a => Proxy a -> Schema
204toSchema = _namedSchemaSchema . toNamedSchema
184toSchema = _namedSchemaSchema . toNamedSchema
205
185
206-- | Convert a type into a referenced schema if possible.
186-- | Convert a type into a referenced schema if possible.
207-- Only named schemas can be referenced, nameless schemas are inlined.
187-- Only named schemas can be referenced, nameless schemas are inlined.
208--
188--
209−-- >>> BSL.putStrLn $ encodePretty $ toSchemaRef (Proxy :: Proxy Integer)
189+-- >>> BSL.putStrLn $ encode $ toSchemaRef (Proxy :: Proxy Integer)
210−-- {
211−-- "type": "integer"
190+-- {"type":"integer"}
212−-- }
213--
191--
214−-- >>> BSL.putStrLn $ encodePretty $ toSchemaRef (Proxy :: Proxy Day)
192+-- >>> BSL.putStrLn $ encode $ toSchemaRef (Proxy :: Proxy Day)
215−-- {
216−-- "$ref": "#/components/schemas/Day"
193+-- {"$ref":"#/components/schemas/Day"}
217−-- }
218toSchemaRef :: ToSchema a => Proxy a -> Referenced Schema
194toSchemaRef :: ToSchema a => Proxy a -> Referenced Schema
219toSchemaRef = undeclare . declareSchemaRef
195toSchemaRef = undeclare . declareSchemaRef
220
196
@@ -282,15 +258,8 @@ inlineAllSchemas = inlineSchemasWhen (const True)
282
258
283-- | Convert a type into a schema without references.
259-- | Convert a type into a schema without references.
284--
260--
285−-- >>> BSL.putStrLn $ encodePretty $ toInlinedSchema (Proxy :: Proxy [Day])
261+-- >>> BSL.putStrLn $ encode $ toInlinedSchema (Proxy :: Proxy [Day])
286−-- {
287−-- "items": {
288−-- "example": "2016-07-22",
262+-- {"items":{"example":"2016-07-22","format":"date","type":"string"},"type":"array"}
289−-- "format": "date",
290−-- "type": "string"
291−-- },
292−-- "type": "array"
293−-- }
294--
263--
295-- __WARNING:__ @'toInlinedSchema'@ will produce infinite schema
264-- __WARNING:__ @'toInlinedSchema'@ will produce infinite schema
296-- when inlining recursive schemas.
265-- when inlining recursive schemas.
@@ -320,67 +289,41 @@ inlineNonRecursiveSchemas defs = inlineSchemasWhen nonRecursive defs
320 traverse_ usedNames (InsOrdHashMap.lookup name defs)
289 traverse_ usedNames (InsOrdHashMap.lookup name defs)
321 Inline subschema -> usedNames subschema
290 Inline subschema -> usedNames subschema
322
291
292+-- | Default schema for binary data (any sequence of octets).
293+binarySchema :: Schema
294+binarySchema = mempty
295+ & type_ ?~ SwaggerString
296+ & format ?~ "binary"
297+
298+-- | Default schema for binary data (base64 encoded).
299+byteSchema :: Schema
300+byteSchema = mempty
301+ & type_ ?~ SwaggerString
302+ & format ?~ "byte"
303+
304+-- | Default schema for password string.
305+-- @"password"@ format is used to hint UIs the input needs to be obscured.
306+passwordSchema :: Schema
307+passwordSchema = mempty
308+ & type_ ?~ SwaggerString
309+ & format ?~ "password"
310+
323-- | Make an unrestrictive sketch of a @'Schema'@ based on a @'ToJSON'@ instance.
311-- | Make an unrestrictive sketch of a @'Schema'@ based on a @'ToJSON'@ instance.
324-- Produced schema can be used for further refinement.
312-- Produced schema can be used for further refinement.
325--
313--
326−-- >>> BSL.putStrLn $ encodePretty $ sketchSchema "hello"
314+-- >>> BSL.putStrLn $ encode $ sketchSchema "hello"
327−-- {
328−-- "example": "hello",
315+-- {"example":"hello","type":"string"}
329−-- "type": "string"
330−-- }
331--
316--
332−-- >>> BSL.putStrLn $ encodePretty $ sketchSchema (1, 2, 3)
317+-- >>> BSL.putStrLn $ encode $ sketchSchema (1, 2, 3)
333−-- {
334−-- "example": [
335−-- 1,
336−-- 2,
337−-- 3
338−-- ],
339−-- "items": {
340−-- "type": "number"
318+-- {"example":[1,2,3],"items":{"type":"number"},"type":"array"}
341−-- },
342−-- "type": "array"
343−-- }
344--
319--
345−-- >>> BSL.putStrLn $ encodePretty $ sketchSchema ("Jack", 25)
320+-- >>> BSL.putStrLn $ encode $ sketchSchema ("Jack", 25)
346−-- {
321+-- {"example":["Jack",25],"items":[{"type":"string"},{"type":"number"}],"type":"array"}
347−-- "example": [
348−-- "Jack",
349−-- 25
350−-- ],
351−-- "items": [
352−-- {
353−-- "type": "string"
354−-- },
355−-- {
356−-- "type": "number"
357−-- }
358−-- ],
359−-- "type": "array"
360−-- }
361--
322--
362-- >>> data Person = Person { name :: String, age :: Int } deriving (Generic)
323-- >>> data Person = Person { name :: String, age :: Int } deriving (Generic)
363-- >>> instance ToJSON Person
324-- >>> instance ToJSON Person
364−-- >>> BSL.putStrLn $ encodePretty $ sketchSchema (Person "Jack" 25)
325+-- >>> BSL.putStrLn $ encode $ sketchSchema (Person "Jack" 25)
365−-- {
326+-- {"required":["age","name"],"properties":{"age":{"type":"number"},"name":{"type":"string"}},"example":{"age":25,"name":"Jack"},"type":"object"}
366−-- "example": {
367−-- "age": 25,
368−-- "name": "Jack"
369−-- },
370−-- "properties": {
371−-- "age": {
372−-- "type": "number"
373−-- },
374−-- "name": {
375−-- "type": "string"
376−-- }
377−-- },
378−-- "required": [
379−-- "age",
380−-- "name"
381−-- ],
382−-- "type": "object"
383−-- }
384sketchSchema :: ToJSON a => a -> Schema
327sketchSchema :: ToJSON a => a -> Schema
385sketchSchema = sketch . toJSON
328sketchSchema = sketch . toJSON
386 where
329 where
@@ -388,15 +331,15 @@ sketchSchema = sketch . toJSON
388 sketch js@(Bool _) = go js
331 sketch js@(Bool _) = go js
389 sketch js = go js & example ?~ js
332 sketch js = go js & example ?~ js
390
333
391− go Null = mempty & type_ ?~ OpenApiNull
334+ go Null = mempty & type_ ?~ SwaggerNull
392− go (Bool _) = mempty & type_ ?~ OpenApiBoolean
335+ go (Bool _) = mempty & type_ ?~ SwaggerBoolean
393− go (String _) = mempty & type_ ?~ OpenApiString
336+ go (String _) = mempty & type_ ?~ SwaggerString
394− go (Number _) = mempty & type_ ?~ OpenApiNumber
337+ go (Number _) = mempty & type_ ?~ SwaggerNumber
395 go (Array xs) = mempty
338 go (Array xs) = mempty
396− & type_ ?~ OpenApiArray
339+ & type_ ?~ SwaggerArray
397 & items ?~ case ischema of
340 & items ?~ case ischema of
398− Just s -> OpenApiItemsObject (Inline s)
341+ Just s -> SwaggerItemsObject (Inline s)
399− _ -> OpenApiItemsArray (map Inline ys)
342+ _ -> SwaggerItemsArray (map Inline ys)
400 where
343 where
401 ys = map go (V.toList xs)
344 ys = map go (V.toList xs)
402 allSame = and ((zipWith (==)) ys (tail ys))
345 allSame = and ((zipWith (==)) ys (tail ys))
@@ -405,178 +348,64 @@ sketchSchema = sketch . toJSON
405 (z:_) | allSame -> Just z
348 (z:_) | allSame -> Just z
406 _ -> Nothing
349 _ -> Nothing
407 go (Object o) = mempty
350 go (Object o) = mempty
408− & type_ ?~ OpenApiObject
351+ & type_ ?~ SwaggerObject
409− & required .~ sort (objectKeys o)
352+ & required .~ HashMap.keys o
410− & properties .~ fmap (Inline . go) (toInsOrdHashMap o)
353+ & properties .~ fmap (Inline . go) (InsOrdHashMap.fromHashMap o)
411
354
412-- | Make a restrictive sketch of a @'Schema'@ based on a @'ToJSON'@ instance.
355-- | Make a restrictive sketch of a @'Schema'@ based on a @'ToJSON'@ instance.
413-- Produced schema uses as much constraints as possible.
356-- Produced schema uses as much constraints as possible.
414--
357--
415−-- >>> BSL.putStrLn $ encodePretty $ sketchStrictSchema "hello"
358+-- >>> BSL.putStrLn $ encode $ sketchStrictSchema "hello"
416−-- {
359+-- {"maxLength":5,"pattern":"hello","minLength":5,"type":"string","enum":["hello"]}
417−-- "enum": [
418−-- "hello"
419−-- ],
420−-- "maxLength": 5,
421−-- "minLength": 5,
422−-- "pattern": "hello",
423−-- "type": "string"
424−-- }
425--
360--
426−-- >>> BSL.putStrLn $ encodePretty $ sketchStrictSchema (1, 2, 3)
361+-- >>> BSL.putStrLn $ encode $ sketchStrictSchema (1, 2, 3)
427−-- {
362+-- {"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]]}
428−-- "enum": [
429−-- [
430−-- 1,
431−-- 2,
432−-- 3
433−-- ]
434−-- ],
435−-- "items": [
436−-- {
437−-- "enum": [
438−-- 1
439−-- ],
440−-- "maximum": 1,
441−-- "minimum": 1,
442−-- "multipleOf": 1,
443−-- "type": "number"
444−-- },
445−-- {
446−-- "enum": [
447−-- 2
448−-- ],
449−-- "maximum": 2,
450−-- "minimum": 2,
451−-- "multipleOf": 2,
452−-- "type": "number"
453−-- },
454−-- {
455−-- "enum": [
456−-- 3
457−-- ],
458−-- "maximum": 3,
459−-- "minimum": 3,
460−-- "multipleOf": 3,
461−-- "type": "number"
462−-- }
463−-- ],
464−-- "maxItems": 3,
465−-- "minItems": 3,
466−-- "type": "array",
467−-- "uniqueItems": true
468−-- }
469--
363--
470−-- >>> BSL.putStrLn $ encodePretty $ sketchStrictSchema ("Jack", 25)
364+-- >>> BSL.putStrLn $ encode $ sketchStrictSchema ("Jack", 25)
471−-- {
365+-- {"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]]}
472−-- "enum": [
473−-- [
474−-- "Jack",
475−-- 25
476−-- ]
477−-- ],
478−-- "items": [
479−-- {
480−-- "enum": [
481−-- "Jack"
482−-- ],
483−-- "maxLength": 4,
484−-- "minLength": 4,
485−-- "pattern": "Jack",
486−-- "type": "string"
487−-- },
488−-- {
489−-- "enum": [
490−-- 25
491−-- ],
492−-- "maximum": 25,
493−-- "minimum": 25,
494−-- "multipleOf": 25,
495−-- "type": "number"
496−-- }
497−-- ],
498−-- "maxItems": 2,
499−-- "minItems": 2,
500−-- "type": "array",
501−-- "uniqueItems": true
502−-- }
503--
366--
504-- >>> data Person = Person { name :: String, age :: Int } deriving (Generic)
367-- >>> data Person = Person { name :: String, age :: Int } deriving (Generic)
505-- >>> instance ToJSON Person
368-- >>> instance ToJSON Person
506−-- >>> BSL.putStrLn $ encodePretty $ sketchStrictSchema (Person "Jack" 25)
369+-- >>> BSL.putStrLn $ encode $ sketchStrictSchema (Person "Jack" 25)
507−-- {
370+-- {"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"}]}
508−-- "enum": [
509−-- {
510−-- "age": 25,
511−-- "name": "Jack"
512−-- }
513−-- ],
514−-- "maxProperties": 2,
515−-- "minProperties": 2,
516−-- "properties": {
517−-- "age": {
518−-- "enum": [
519−-- 25
520−-- ],
521−-- "maximum": 25,
522−-- "minimum": 25,
523−-- "multipleOf": 25,
524−-- "type": "number"
525−-- },
526−-- "name": {
527−-- "enum": [
528−-- "Jack"
529−-- ],
530−-- "maxLength": 4,
531−-- "minLength": 4,
532−-- "pattern": "Jack",
533−-- "type": "string"
534−-- }
535−-- },
536−-- "required": [
537−-- "age",
538−-- "name"
539−-- ],
540−-- "type": "object"
541−-- }
542sketchStrictSchema :: ToJSON a => a -> Schema
371sketchStrictSchema :: ToJSON a => a -> Schema
543sketchStrictSchema = go . toJSON
372sketchStrictSchema = go . toJSON
544 where
373 where
545− go Null = mempty & type_ ?~ OpenApiNull
374+ go Null = mempty & type_ ?~ SwaggerNull
546 go js@(Bool _) = mempty
375 go js@(Bool _) = mempty
547− & type_ ?~ OpenApiBoolean
376+ & type_ ?~ SwaggerBoolean
548 & enum_ ?~ [js]
377 & enum_ ?~ [js]
549 go js@(String s) = mempty
378 go js@(String s) = mempty
550− & type_ ?~ OpenApiString
379+ & type_ ?~ SwaggerString
551 & maxLength ?~ fromIntegral (T.length s)
380 & maxLength ?~ fromIntegral (T.length s)
552 & minLength ?~ fromIntegral (T.length s)
381 & minLength ?~ fromIntegral (T.length s)
553 & pattern ?~ s
382 & pattern ?~ s
554 & enum_ ?~ [js]
383 & enum_ ?~ [js]
555 go js@(Number n) = mempty
384 go js@(Number n) = mempty
556− & type_ ?~ OpenApiNumber
385+ & type_ ?~ SwaggerNumber
557 & maximum_ ?~ n
386 & maximum_ ?~ n
558 & minimum_ ?~ n
387 & minimum_ ?~ n
559 & multipleOf ?~ n
388 & multipleOf ?~ n
560 & enum_ ?~ [js]
389 & enum_ ?~ [js]
561 go js@(Array xs) = mempty
390 go js@(Array xs) = mempty
562− & type_ ?~ OpenApiArray
391+ & type_ ?~ SwaggerArray
563 & maxItems ?~ fromIntegral sz
392 & maxItems ?~ fromIntegral sz
564 & minItems ?~ fromIntegral sz
393 & minItems ?~ fromIntegral sz
565− & items ?~ OpenApiItemsArray (map (Inline . go) (V.toList xs))
394+ & items ?~ SwaggerItemsArray (map (Inline . go) (V.toList xs))
566 & uniqueItems ?~ allUnique
395 & uniqueItems ?~ allUnique
567 & enum_ ?~ [js]
396 & enum_ ?~ [js]
568 where
397 where
569 sz = length xs
398 sz = length xs
570 allUnique = sz == HashSet.size (HashSet.fromList (V.toList xs))
399 allUnique = sz == HashSet.size (HashSet.fromList (V.toList xs))
571 go js@(Object o) = mempty
400 go js@(Object o) = mempty
572− & type_ ?~ OpenApiObject
401+ & type_ ?~ SwaggerObject
573− & required .~ sort names
402+ & required .~ names
574− & properties .~ fmap (Inline . go) (toInsOrdHashMap o)
403+ & properties .~ fmap (Inline . go) (InsOrdHashMap.fromHashMap o)
575 & maxProperties ?~ fromIntegral (length names)
404 & maxProperties ?~ fromIntegral (length names)
576 & minProperties ?~ fromIntegral (length names)
405 & minProperties ?~ fromIntegral (length names)
577 & enum_ ?~ [js]
406 & enum_ ?~ [js]
578 where
407 where
579− names = objectKeys o
408+ names = HashMap.keys o
580
409
581class GToSchema (f :: * -> *) where
410class GToSchema (f :: * -> *) where
582 gdeclareNamedSchema :: SchemaOptions -> Proxy f -> Schema -> Declare (Definitions Schema) NamedSchema
411 gdeclareNamedSchema :: SchemaOptions -> Proxy f -> Schema -> Declare (Definitions Schema) NamedSchema
@@ -585,8 +414,8 @@ instance {-# OVERLAPPABLE #-} ToSchema a => ToSchema [a] where
585 declareNamedSchema _ = do
414 declareNamedSchema _ = do
586 ref <- declareSchemaRef (Proxy :: Proxy a)
415 ref <- declareSchemaRef (Proxy :: Proxy a)
587 return $ unnamed $ mempty
416 return $ unnamed $ mempty
588− & type_ ?~ OpenApiArray
417+ & type_ ?~ SwaggerArray
589− & items ?~ OpenApiItemsObject ref
418+ & items ?~ SwaggerItemsObject ref
590
419
591instance {-# OVERLAPPING #-} ToSchema String where declareNamedSchema = plain . paramSchemaToSchema
420instance {-# OVERLAPPING #-} ToSchema String where declareNamedSchema = plain . paramSchemaToSchema
592instance ToSchema Bool where declareNamedSchema = plain . paramSchemaToSchema
421instance ToSchema Bool where declareNamedSchema = plain . paramSchemaToSchema
@@ -611,7 +440,7 @@ instance ToSchema Scientific where declareNamedSchema = plain . paramSchemaToSc
611instance ToSchema Double where declareNamedSchema = plain . paramSchemaToSchema
440instance ToSchema Double where declareNamedSchema = plain . paramSchemaToSchema
612instance ToSchema Float where declareNamedSchema = plain . paramSchemaToSchema
441instance ToSchema Float where declareNamedSchema = plain . paramSchemaToSchema
613
442
614−instance (Typeable (Fixed a), HasResolution a) => ToSchema (Fixed a) where declareNamedSchema = plain . paramSchemaToSchema
443+instance HasResolution a => ToSchema (Fixed a) where declareNamedSchema = plain . paramSchemaToSchema
615
444
616instance ToSchema a => ToSchema (Maybe a) where
445instance ToSchema a => ToSchema (Maybe a) where
617 declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy a)
446 declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy a)
@@ -628,22 +457,16 @@ instance ToSchema UUID.UUID where
628 declareNamedSchema p = pure $ named "UUID" $ paramSchemaToSchema p
457 declareNamedSchema p = pure $ named "UUID" $ paramSchemaToSchema p
629 & example ?~ toJSON (UUID.toText UUID.nil)
458 & example ?~ toJSON (UUID.toText UUID.nil)
630
459
631−instance (ToSchema a, ToSchema b) => ToSchema (a, b) where
460+instance (ToSchema a, ToSchema b) => ToSchema (a, b)
632− declareNamedSchema = fmap unname . genericDeclareNamedSchema defaultSchemaOptions
633−instance (ToSchema a, ToSchema b, ToSchema c) => ToSchema (a, b, c) where
461+instance (ToSchema a, ToSchema b, ToSchema c) => ToSchema (a, b, c)
634− declareNamedSchema = fmap unname . genericDeclareNamedSchema defaultSchemaOptions
635−instance (ToSchema a, ToSchema b, ToSchema c, ToSchema d) => ToSchema (a, b, c, d) where
462+instance (ToSchema a, ToSchema b, ToSchema c, ToSchema d) => ToSchema (a, b, c, d)
636− declareNamedSchema = fmap unname . genericDeclareNamedSchema defaultSchemaOptions
637−instance (ToSchema a, ToSchema b, ToSchema c, ToSchema d, ToSchema e) => ToSchema (a, b, c, d, e) where
463+instance (ToSchema a, ToSchema b, ToSchema c, ToSchema d, ToSchema e) => ToSchema (a, b, c, d, e)
638− declareNamedSchema = fmap unname . genericDeclareNamedSchema defaultSchemaOptions
639−instance (ToSchema a, ToSchema b, ToSchema c, ToSchema d, ToSchema e, ToSchema f) => ToSchema (a, b, c, d, e, f) where
464+instance (ToSchema a, ToSchema b, ToSchema c, ToSchema d, ToSchema e, ToSchema f) => ToSchema (a, b, c, d, e, f)
640− declareNamedSchema = fmap unname . genericDeclareNamedSchema defaultSchemaOptions
641−instance (ToSchema a, ToSchema b, ToSchema c, ToSchema d, ToSchema e, ToSchema f, ToSchema g) => ToSchema (a, b, c, d, e, f, g) where
465+instance (ToSchema a, ToSchema b, ToSchema c, ToSchema d, ToSchema e, ToSchema f, ToSchema g) => ToSchema (a, b, c, d, e, f, g)
642− declareNamedSchema = fmap unname . genericDeclareNamedSchema defaultSchemaOptions
643
466
644timeSchema :: T.Text -> Schema
467timeSchema :: T.Text -> Schema
645timeSchema fmt = mempty
468timeSchema fmt = mempty
646− & type_ ?~ OpenApiString
469+ & type_ ?~ SwaggerString
647 & format ?~ fmt
470 & format ?~ fmt
648
471
649-- | Format @"date"@ corresponds to @yyyy-mm-dd@ format.
472-- | Format @"date"@ corresponds to @yyyy-mm-dd@ format.
@@ -658,7 +481,7 @@ instance ToSchema LocalTime where
658 declareNamedSchema _ = pure $ named "LocalTime" $ timeSchema "yyyy-mm-ddThh:MM:ss"
481 declareNamedSchema _ = pure $ named "LocalTime" $ timeSchema "yyyy-mm-ddThh:MM:ss"
659 & example ?~ toJSON (LocalTime (fromGregorian 2016 7 22) (TimeOfDay 7 40 0))
482 & example ?~ toJSON (LocalTime (fromGregorian 2016 7 22) (TimeOfDay 7 40 0))
660
483
661−-- | Format @"date-time"@ corresponds to @yyyy-mm-ddThh:MM:ss(Z|+hh:MM)@ format.
484+-- | Format @"date"@ corresponds to @yyyy-mm-ddThh:MM:ss(Z|+hh:MM)@ format.
662instance ToSchema ZonedTime where
485instance ToSchema ZonedTime where
663 declareNamedSchema _ = pure $ named "ZonedTime" $ timeSchema "date-time"
486 declareNamedSchema _ = pure $ named "ZonedTime" $ timeSchema "date-time"
664 & example ?~ toJSON (ZonedTime (LocalTime (fromGregorian 2016 7 22) (TimeOfDay 7 40 0)) (hoursToTimeZone 3))
487 & example ?~ toJSON (ZonedTime (LocalTime (fromGregorian 2016 7 22) (TimeOfDay 7 40 0)) (hoursToTimeZone 3))
@@ -690,7 +513,7 @@ instance ToSchemaByteStringError BSL.ByteString => ToSchema BSL.ByteString where
690instance ToSchema IntSet where declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy (Set Int))
513instance ToSchema IntSet where declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy (Set Int))
691
514
692-- | NOTE: This schema does not account for the uniqueness of keys.
515-- | NOTE: This schema does not account for the uniqueness of keys.
693−instance (ToSchema a) => ToSchema (IntMap a) where
516+instance ToSchema a => ToSchema (IntMap a) where
694 declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy [(Int, a)])
517 declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy [(Int, a)])
695
518
696instance (ToJSONKey k, ToSchema k, ToSchema v) => ToSchema (Map k v) where
519instance (ToJSONKey k, ToSchema k, ToSchema v) => ToSchema (Map k v) where
@@ -701,7 +524,7 @@ instance (ToJSONKey k, ToSchema k, ToSchema v) => ToSchema (Map k v) where
701 declareObjectMapSchema = do
524 declareObjectMapSchema = do
702 schema <- declareSchemaRef (Proxy :: Proxy v)
525 schema <- declareSchemaRef (Proxy :: Proxy v)
703 return $ unnamed $ mempty
526 return $ unnamed $ mempty
704− & type_ ?~ OpenApiObject
527+ & type_ ?~ SwaggerObject
705 & additionalProperties ?~ AdditionalPropertiesSchema schema
528 & additionalProperties ?~ AdditionalPropertiesSchema schema
706
529
707instance (ToJSONKey k, ToSchema k, ToSchema v) => ToSchema (HashMap k v) where
530instance (ToJSONKey k, ToSchema k, ToSchema v) => ToSchema (HashMap k v) where
@@ -709,7 +532,7 @@ instance (ToJSONKey k, ToSchema k, ToSchema v) => ToSchema (HashMap k v) where
709
532
710instance {-# OVERLAPPING #-} ToSchema Object where
533instance {-# OVERLAPPING #-} ToSchema Object where
711 declareNamedSchema _ = pure $ NamedSchema (Just "Object") $ mempty
534 declareNamedSchema _ = pure $ NamedSchema (Just "Object") $ mempty
712− & type_ ?~ OpenApiObject
535+ & type_ ?~ SwaggerObject
713 & description ?~ "Arbitrary JSON object."
536 & description ?~ "Arbitrary JSON object."
714 & additionalProperties ?~ AdditionalPropertiesAllowed True
537 & additionalProperties ?~ AdditionalPropertiesAllowed True
715
538
@@ -746,15 +569,11 @@ instance ToSchema a => ToSchema (Identity a) where declareNamedSchema _ = declar
746
569
747-- | Default schema for @'Bounded'@, @'Integral'@ types.
570-- | Default schema for @'Bounded'@, @'Integral'@ types.
748--
571--
749−-- >>> BSL.putStrLn $ encodePretty $ toSchemaBoundedIntegral (Proxy :: Proxy Int16)
572+-- >>> BSL.putStrLn $ encode $ toSchemaBoundedIntegral (Proxy :: Proxy Int16)
750−-- {
751−-- "maximum": 32767,
573+-- {"maximum":32767,"minimum":-32768,"type":"integer"}
752−-- "minimum": -32768,
753−-- "type": "integer"
754−-- }
755toSchemaBoundedIntegral :: forall a. (Bounded a, Integral a) => Proxy a -> Schema
574toSchemaBoundedIntegral :: forall a. (Bounded a, Integral a) => Proxy a -> Schema
756toSchemaBoundedIntegral _ = mempty
575toSchemaBoundedIntegral _ = mempty
757− & type_ ?~ OpenApiInteger
576+ & type_ ?~ SwaggerInteger
758 & minimum_ ?~ fromInteger (toInteger (minBound :: a))
577 & minimum_ ?~ fromInteger (toInteger (minBound :: a))
759 & maximum_ ?~ fromInteger (toInteger (maxBound :: a))
578 & maximum_ ?~ fromInteger (toInteger (maxBound :: a))
760
579
@@ -783,27 +602,8 @@ genericDeclareNamedSchemaNewtype opts f proxy = genericNameSchema opts proxy <$>
783-- >>> instance ToSchema ButtonState
602-- >>> instance ToSchema ButtonState
784-- >>> instance ToJSONKey ButtonState where toJSONKey = toJSONKeyText (T.pack . show)
603-- >>> instance ToJSONKey ButtonState where toJSONKey = toJSONKeyText (T.pack . show)
785-- >>> type ImageUrl = T.Text
604-- >>> type ImageUrl = T.Text
786−-- >>> BSL.putStrLn $ encodePretty $ toSchemaBoundedEnumKeyMapping (Proxy :: Proxy (Map ButtonState ImageUrl))
605+-- >>> BSL.putStrLn $ encode $ toSchemaBoundedEnumKeyMapping (Proxy :: Proxy (Map ButtonState ImageUrl))
787−-- {
606+-- {"properties":{"Neutral":{"type":"string"},"Focus":{"type":"string"},"Active":{"type":"string"},"Hover":{"type":"string"},"Disabled":{"type":"string"}},"type":"object"}
788−-- "properties": {
789−-- "Active": {
790−-- "type": "string"
791−-- },
792−-- "Disabled": {
793−-- "type": "string"
794−-- },
795−-- "Focus": {
796−-- "type": "string"
797−-- },
798−-- "Hover": {
799−-- "type": "string"
800−-- },
801−-- "Neutral": {
802−-- "type": "string"
803−-- }
804−-- },
805−-- "type": "object"
806−-- }
807--
607--
808-- Note: this is only useful when @key@ is encoded with 'ToJSONKeyText'.
608-- Note: this is only useful when @key@ is encoded with 'ToJSONKeyText'.
809-- If it is encoded with 'ToJSONKeyValue' then a regular schema for @[(key, value)]@ is used.
609-- If it is encoded with 'ToJSONKeyValue' then a regular schema for @[(key, value)]@ is used.
@@ -811,15 +611,15 @@ declareSchemaBoundedEnumKeyMapping :: forall map key value.
811 (Bounded key, Enum key, ToJSONKey key, ToSchema key, ToSchema value)
611 (Bounded key, Enum key, ToJSONKey key, ToSchema key, ToSchema value)
812 => Proxy (map key value) -> Declare (Definitions Schema) Schema
612 => Proxy (map key value) -> Declare (Definitions Schema) Schema
813declareSchemaBoundedEnumKeyMapping _ = case toJSONKey :: ToJSONKeyFunction key of
613declareSchemaBoundedEnumKeyMapping _ = case toJSONKey :: ToJSONKeyFunction key of
814− ToJSONKeyText getKey _ -> objectSchema getKey
614+ ToJSONKeyText keyToText _ -> objectSchema keyToText
815 ToJSONKeyValue _ _ -> declareSchema (Proxy :: Proxy [(key, value)])
615 ToJSONKeyValue _ _ -> declareSchema (Proxy :: Proxy [(key, value)])
816 where
616 where
817− objectSchema getKey = do
617+ objectSchema keyToText = do
818 valueRef <- declareSchemaRef (Proxy :: Proxy value)
618 valueRef <- declareSchemaRef (Proxy :: Proxy value)
819 let allKeys = [minBound..maxBound :: key]
619 let allKeys = [minBound..maxBound :: key]
820− mkPair k = (keyToText $ getKey k, valueRef)
620+ mkPair k = (keyToText k, valueRef)
821 return $ mempty
621 return $ mempty
822− & type_ ?~ OpenApiObject
622+ & type_ ?~ SwaggerObject
823 & properties .~ InsOrdHashMap.fromList (map mkPair allKeys)
623 & properties .~ InsOrdHashMap.fromList (map mkPair allKeys)
824
624
825-- | A 'Schema' for a mapping with 'Bounded' 'Enum' keys.
625-- | A 'Schema' for a mapping with 'Bounded' 'Enum' keys.
@@ -830,27 +630,8 @@ declareSchemaBoundedEnumKeyMapping _ = case toJSONKey :: ToJSONKeyFunction key o
830-- >>> instance ToSchema ButtonState
630-- >>> instance ToSchema ButtonState
831-- >>> instance ToJSONKey ButtonState where toJSONKey = toJSONKeyText (T.pack . show)
631-- >>> instance ToJSONKey ButtonState where toJSONKey = toJSONKeyText (T.pack . show)
832-- >>> type ImageUrl = T.Text
632-- >>> type ImageUrl = T.Text
833−-- >>> BSL.putStrLn $ encodePretty $ toSchemaBoundedEnumKeyMapping (Proxy :: Proxy (Map ButtonState ImageUrl))
633+-- >>> BSL.putStrLn $ encode $ toSchemaBoundedEnumKeyMapping (Proxy :: Proxy (Map ButtonState ImageUrl))
834−-- {
634+-- {"properties":{"Neutral":{"type":"string"},"Focus":{"type":"string"},"Active":{"type":"string"},"Hover":{"type":"string"},"Disabled":{"type":"string"}},"type":"object"}
835−-- "properties": {
836−-- "Active": {
837−-- "type": "string"
838−-- },
839−-- "Disabled": {
840−-- "type": "string"
841−-- },
842−-- "Focus": {
843−-- "type": "string"
844−-- },
845−-- "Hover": {
846−-- "type": "string"
847−-- },
848−-- "Neutral": {
849−-- "type": "string"
850−-- }
851−-- },
852−-- "type": "object"
853−-- }
854--
635--
855-- Note: this is only useful when @key@ is encoded with 'ToJSONKeyText'.
636-- Note: this is only useful when @key@ is encoded with 'ToJSONKeyText'.
856-- If it is encoded with 'ToJSONKeyValue' then a regular schema for @[(key, value)]@ is used.
637-- If it is encoded with 'ToJSONKeyValue' then a regular schema for @[(key, value)]@ is used.
@@ -860,7 +641,7 @@ toSchemaBoundedEnumKeyMapping :: forall map key value.
860toSchemaBoundedEnumKeyMapping = flip evalDeclare mempty . declareSchemaBoundedEnumKeyMapping
641toSchemaBoundedEnumKeyMapping = flip evalDeclare mempty . declareSchemaBoundedEnumKeyMapping
861
642
862-- | A configurable generic @'Schema'@ creator.
643-- | A configurable generic @'Schema'@ creator.
863−genericDeclareSchema :: (Generic a, GToSchema (Rep a), Typeable a) =>
644+genericDeclareSchema :: (Generic a, GToSchema (Rep a)) =>
864 SchemaOptions -> Proxy a -> Declare (Definitions Schema) Schema
645 SchemaOptions -> Proxy a -> Declare (Definitions Schema) Schema
865genericDeclareSchema opts proxy = _namedSchemaSchema <$> genericDeclareNamedSchema opts proxy
646genericDeclareSchema opts proxy = _namedSchemaSchema <$> genericDeclareNamedSchema opts proxy
866
647
@@ -868,24 +649,9 @@ genericDeclareSchema opts proxy = _namedSchemaSchema <$> genericDeclareNamedSche
868-- This function applied to @'defaultSchemaOptions'@
649-- This function applied to @'defaultSchemaOptions'@
869-- is used as the default for @'declareNamedSchema'@
650-- is used as the default for @'declareNamedSchema'@
870-- when the type is an instance of @'Generic'@.
651-- when the type is an instance of @'Generic'@.
871−--
872−-- Default implementation will use the name from 'Typeable' instance, including concrete
873−-- instantioations of type variables.
874−--
875−-- For example:
876−--
877−-- >>> _namedSchemaName $ undeclare $ genericDeclareNamedSchema defaultSchemaOptions (Proxy :: Proxy (Either Int Bool))
878−-- Just "Either_Int_Bool"
879−genericDeclareNamedSchema :: forall a. (Generic a, GToSchema (Rep a), Typeable a) =>
652+genericDeclareNamedSchema :: forall a. (Generic a, GToSchema (Rep a)) =>
880 SchemaOptions -> Proxy a -> Declare (Definitions Schema) NamedSchema
653 SchemaOptions -> Proxy a -> Declare (Definitions Schema) NamedSchema
881−genericDeclareNamedSchema opts _ =
882− rename (Just $ T.pack name) <$> gdeclareNamedSchema opts (Proxy :: Proxy (Rep a)) mempty
654+genericDeclareNamedSchema opts _ = gdeclareNamedSchema opts (Proxy :: Proxy (Rep a)) mempty
883− where
884− unspace ' ' = '_'
885− unspace x = x
886− orig = fmap unspace $ show $ typeRep @a
887− name = datatypeNameModifier opts orig
888−
889
655
890-- | Derive a 'Generic'-based name for a datatype and assign it to a given 'Schema'.
656-- | Derive a 'Generic'-based name for a datatype and assign it to a given 'Schema'.
891genericNameSchema :: forall a d f.
657genericNameSchema :: forall a d f.
@@ -901,19 +667,19 @@ gdatatypeSchemaName opts _ = case orig of
901 orig = datatypeName (Proxy3 :: Proxy3 d f a)
667 orig = datatypeName (Proxy3 :: Proxy3 d f a)
902 name = datatypeNameModifier opts orig
668 name = datatypeNameModifier opts orig
903
669
904−-- | Construct 'NamedSchema' usinng 'ToParamSchema'.
670+-- | Lift a plain @'ParamSchema'@ into a model @'NamedSchema'@.
905paramSchemaToNamedSchema :: (ToParamSchema a, Generic a, Rep a ~ D1 d f, Datatype d) =>
671paramSchemaToNamedSchema :: (ToParamSchema a, Generic a, Rep a ~ D1 d f, Datatype d) =>
906 SchemaOptions -> Proxy a -> NamedSchema
672 SchemaOptions -> Proxy a -> NamedSchema
907paramSchemaToNamedSchema opts proxy = genericNameSchema opts proxy (paramSchemaToSchema proxy)
673paramSchemaToNamedSchema opts proxy = genericNameSchema opts proxy (paramSchemaToSchema proxy)
908
674
909−-- | Construct 'Schema' usinng 'ToParamSchema'.
675+-- | Lift a plain @'ParamSchema'@ into a model @'Schema'@.
910paramSchemaToSchema :: ToParamSchema a => Proxy a -> Schema
676paramSchemaToSchema :: ToParamSchema a => Proxy a -> Schema
911−paramSchemaToSchema = toParamSchema
677+paramSchemaToSchema proxy = mempty & paramSchema .~ toParamSchema proxy
912
678
913nullarySchema :: Schema
679nullarySchema :: Schema
914nullarySchema = mempty
680nullarySchema = mempty
915− & type_ ?~ OpenApiArray
681+ & type_ ?~ SwaggerArray
916− & items ?~ OpenApiItemsArray []
682+ & items ?~ SwaggerItemsArray []
917
683
918gtoNamedSchema :: GToSchema f => SchemaOptions -> Proxy f -> NamedSchema
684gtoNamedSchema :: GToSchema f => SchemaOptions -> Proxy f -> NamedSchema
919gtoNamedSchema opts proxy = undeclare $ gdeclareNamedSchema opts proxy mempty
685gtoNamedSchema opts proxy = undeclare $ gdeclareNamedSchema opts proxy mempty
@@ -943,15 +709,12 @@ instance (Selector s, GToSchema f, GToSchema (S1 s f)) => GToSchema (C1 c (S1 s
943 | unwrapUnaryRecords opts = fieldSchema
709 | unwrapUnaryRecords opts = fieldSchema
944 | otherwise =
710 | otherwise =
945 case schema ^. items of
711 case schema ^. items of
946− Just (OpenApiItemsArray [_]) -> fieldSchema
712+ Just (SwaggerItemsArray [_]) -> fieldSchema
947 _ -> do
713 _ -> do
948− -- We have to run recordSchema instead of just using its defs,
714+ declare defs
949− -- since those can be recursive and will lead to infinite loop,
950− -- see https://github.com/biocad/openapi3/pull/37
951− NamedSchema _ schema' <- recordSchema
952− return (unnamed schema')
715+ return (unnamed schema)
953 where
716 where
954− (_, NamedSchema _ schema) = runDeclare recordSchema mempty
717+ (defs, NamedSchema _ schema) = runDeclare recordSchema mempty
955 recordSchema = gdeclareNamedSchema opts (Proxy :: Proxy (S1 s f)) s
718 recordSchema = gdeclareNamedSchema opts (Proxy :: Proxy (S1 s f)) s
956 fieldSchema = gdeclareNamedSchema opts (Proxy :: Proxy f) s
719 fieldSchema = gdeclareNamedSchema opts (Proxy :: Proxy f) s
957
720
@@ -974,10 +737,10 @@ gdeclareSchemaRef opts proxy = do
974 return $ Ref (Reference name)
737 return $ Ref (Reference name)
975 _ -> Inline <$> gdeclareSchema opts proxy
738 _ -> Inline <$> gdeclareSchema opts proxy
976
739
977−appendItem :: Referenced Schema -> Maybe OpenApiItems -> Maybe OpenApiItems
740+appendItem :: Referenced Schema -> Maybe SwaggerItems -> Maybe SwaggerItems
978−appendItem x Nothing = Just (OpenApiItemsArray [x])
741+appendItem x Nothing = Just (SwaggerItemsArray [x])
979−appendItem x (Just (OpenApiItemsArray xs)) = Just (OpenApiItemsArray (xs ++ [x]))
742+appendItem x (Just (SwaggerItemsArray xs)) = Just (SwaggerItemsArray (xs ++ [x]))
980−appendItem _ _ = error "GToSchema.appendItem: cannot append to OpenApiItemsObject"
743+appendItem _ _ = error "GToSchema.appendItem: cannot append to SwaggerItemsObject"
981
744
982withFieldSchema :: forall proxy s f. (Selector s, GToSchema f) =>
745withFieldSchema :: forall proxy s f. (Selector s, GToSchema f) =>
983 SchemaOptions -> proxy s f -> Bool -> Schema -> Declare (Definitions Schema) Schema
746 SchemaOptions -> proxy s f -> Bool -> Schema -> Declare (Definitions Schema) Schema
@@ -986,12 +749,12 @@ withFieldSchema opts _ isRequiredField schema = do
986 return $
749 return $
987 if T.null fname
750 if T.null fname
988 then schema
751 then schema
989− & type_ ?~ OpenApiArray
752+ & type_ ?~ SwaggerArray
990 & items %~ appendItem ref
753 & items %~ appendItem ref
991 & maxItems %~ Just . maybe 1 (+1) -- increment maxItems
754 & maxItems %~ Just . maybe 1 (+1) -- increment maxItems
992 & minItems %~ Just . maybe 1 (+1) -- increment minItems
755 & minItems %~ Just . maybe 1 (+1) -- increment minItems
993 else schema
756 else schema
994− & type_ ?~ OpenApiObject
757+ & type_ ?~ SwaggerObject
995 & properties . at fname ?~ ref
758 & properties . at fname ?~ ref
996 & if isRequiredField
759 & if isRequiredField
997 then required %~ (++ [fname])
760 then required %~ (++ [fname])
@@ -1026,14 +789,14 @@ gdeclareNamedSumSchema opts proxy _
1026 | otherwise = do
789 | otherwise = do
1027 (schemas, _) <- runWriterT declareSumSchema
790 (schemas, _) <- runWriterT declareSumSchema
1028 return $ unnamed $ mempty
791 return $ unnamed $ mempty
1029− & type_ ?~ OpenApiObject
792+ & type_ ?~ SwaggerObject
1030 & oneOf ?~ (snd <$> schemas)
793 & oneOf ?~ (snd <$> schemas)
1031 where
794 where
1032 declareSumSchema = gsumToSchema opts proxy
795 declareSumSchema = gsumToSchema opts proxy
1033 (sumSchemas, All allNullary) = undeclare (runWriterT declareSumSchema)
796 (sumSchemas, All allNullary) = undeclare (runWriterT declareSumSchema)
1034
797
1035 toStringTag schemas = mempty
798 toStringTag schemas = mempty
1036− & type_ ?~ OpenApiString
799+ & type_ ?~ SwaggerString
1037 & enum_ ?~ map (String . fst) sumSchemas
800 & enum_ ?~ map (String . fst) sumSchemas
1038
801
1039type AllNullary = All
802type AllNullary = All
@@ -1055,15 +818,15 @@ gsumConToSchemaWith ref opts _ = (tag, schema)
1055 case ref of
818 case ref of
1056 -- If subschema is an object and constructor is a record, we add tag directly
819 -- If subschema is an object and constructor is a record, we add tag directly
1057 -- to the record, as Aeson does it.
820 -- to the record, as Aeson does it.
1058− Just (Inline sub) | sub ^. type_ == Just OpenApiObject && isRecord -> Inline $ sub
821+ Just (Inline sub) | sub ^. type_ == Just SwaggerObject && isRecord -> Inline $ sub
1059 & required <>~ [T.pack tagField]
822 & required <>~ [T.pack tagField]
1060− & properties . at (T.pack tagField) ?~ (Inline $ mempty & type_ ?~ OpenApiString & enum_ ?~ [String tag])
823+ & properties . at (T.pack tagField) ?~ (Inline $ mempty & type_ ?~ SwaggerString & enum_ ?~ [String tag])
1061
824
1062 -- If it is not a record, we need to put subschema into "contents" field.
825 -- If it is not a record, we need to put subschema into "contents" field.
1063 _ | not isRecord -> Inline $ mempty
826 _ | not isRecord -> Inline $ mempty
1064− & type_ ?~ OpenApiObject
827+ & type_ ?~ SwaggerObject
1065 & required .~ [T.pack tagField]
828 & required .~ [T.pack tagField]
1066− & properties . at (T.pack tagField) ?~ (Inline $ mempty & type_ ?~ OpenApiString & enum_ ?~ [String tag])
829+ & properties . at (T.pack tagField) ?~ (Inline $ mempty & type_ ?~ SwaggerString & enum_ ?~ [String tag])
1067 -- If constructor is nullary, there is no content.
830 -- If constructor is nullary, there is no content.
1068 & case ref of
831 & case ref of
1069 Just r -> (properties . at (T.pack contentsField) ?~ r) . (required <>~ [T.pack contentsField])
832 Just r -> (properties . at (T.pack contentsField) ?~ r) . (required <>~ [T.pack contentsField])
@@ -1071,17 +834,17 @@ gsumConToSchemaWith ref opts _ = (tag, schema)
1071
834
1072 -- In the remaining cases we combine "tag" object and "contents" object using allOf.
835 -- In the remaining cases we combine "tag" object and "contents" object using allOf.
1073 _ -> Inline $ mempty
836 _ -> Inline $ mempty
1074− & type_ ?~ OpenApiObject
837+ & type_ ?~ SwaggerObject
1075 & allOf ?~ [Inline $ mempty
838 & allOf ?~ [Inline $ mempty
1076− & type_ ?~ OpenApiObject
839+ & type_ ?~ SwaggerObject
1077 & required .~ (T.pack tagField : if isRecord then [] else [T.pack contentsField])
840 & required .~ (T.pack tagField : if isRecord then [] else [T.pack contentsField])
1078− & properties . at (T.pack tagField) ?~ (Inline $ mempty & type_ ?~ OpenApiString & enum_ ?~ [String tag])]
841+ & properties . at (T.pack tagField) ?~ (Inline $ mempty & type_ ?~ SwaggerString & enum_ ?~ [String tag])]
1079 & if isRecord
842 & if isRecord
1080 then allOf . _Just <>~ [refOrNullary]
843 then allOf . _Just <>~ [refOrNullary]
1081− else allOf . _Just <>~ [Inline $ mempty & type_ ?~ OpenApiObject & properties . at (T.pack contentsField) ?~ refOrNullary]
844+ else allOf . _Just <>~ [Inline $ mempty & type_ ?~ SwaggerObject & properties . at (T.pack contentsField) ?~ refOrNullary]
1082 UntaggedValue -> refOrEnum -- Aeson encodes nullary constructors as strings in this case.
845 UntaggedValue -> refOrEnum -- Aeson encodes nullary constructors as strings in this case.
1083 ObjectWithSingleField -> Inline $ mempty
846 ObjectWithSingleField -> Inline $ mempty
1084− & type_ ?~ OpenApiObject
847+ & type_ ?~ SwaggerObject
1085 & required .~ [tag]
848 & required .~ [tag]
1086 & properties . at tag ?~ refOrNullary
849 & properties . at tag ?~ refOrNullary
1087 TwoElemArray -> error "unrepresentable in OpenAPI 3"
850 TwoElemArray -> error "unrepresentable in OpenAPI 3"
@@ -1089,7 +852,7 @@ gsumConToSchemaWith ref opts _ = (tag, schema)
1089 tag = T.pack (constructorTagModifier opts (conName (Proxy3 :: Proxy3 c f p)))
852 tag = T.pack (constructorTagModifier opts (conName (Proxy3 :: Proxy3 c f p)))
1090 isRecord = conIsRecord (Proxy3 :: Proxy3 c f p)
853 isRecord = conIsRecord (Proxy3 :: Proxy3 c f p)
1091 refOrNullary = fromMaybe (Inline nullarySchema) ref
854 refOrNullary = fromMaybe (Inline nullarySchema) ref
1092− refOrEnum = fromMaybe (Inline $ mempty & type_ ?~ OpenApiString & enum_ ?~ [String tag]) ref
855+ refOrEnum = fromMaybe (Inline $ mempty & type_ ?~ SwaggerString & enum_ ?~ [String tag]) ref
1093
856
1094gsumConToSchema :: (GToSchema (C1 c f), Constructor c) =>
857gsumConToSchema :: (GToSchema (C1 c f), Constructor c) =>
1095 SchemaOptions -> Proxy (C1 c f) -> Declare (Definitions Schema) [(T.Text, Referenced Schema)]
858 SchemaOptions -> Proxy (C1 c f) -> Declare (Definitions Schema) [(T.Text, Referenced Schema)]
@@ -1114,13 +877,7 @@ data Proxy2 a b = Proxy2
1114
877
1115data Proxy3 a b c = Proxy3
878data Proxy3 a b c = Proxy3
1116
879
1117−{- $setup
880+-- $setup
1118−>>> import Data.OpenApi
881+-- >>> import Data.Swagger
1119−>>> import Data.Aeson (encode)
882+-- >>> import Data.Aeson (encode)
1120−>>> import Data.Aeson.Types (toJSONKeyText)
883+-- >>> import Data.Aeson.Types (toJSONKeyText)
1121−>>> import Data.OpenApi.Internal.Utils
1122−>>> :set -XScopedTypeVariables
1123−>>> :set -XDeriveAnyClass
1124−>>> :set -XStandaloneDeriving
1125−>>> :set -XTypeApplications
1126−-}
src/Data/OpenApi/Internal/Schema/Validation.hs → src/Data/Swagger/Internal/Schema/Validation.hsrenamed+79−85
@@ -1,5 +1,4 @@
1{-# OPTIONS_GHC -Wall #-}
1{-# OPTIONS_GHC -Wall #-}
2−{-# LANGUAGE CPP #-}
3{-# LANGUAGE DataKinds #-}
2{-# LANGUAGE DataKinds #-}
4{-# LANGUAGE DeriveFunctor #-}
3{-# LANGUAGE DeriveFunctor #-}
5{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FlexibleInstances #-}
@@ -15,14 +14,14 @@
15{-# LANGUAGE UndecidableInstances #-}
14{-# LANGUAGE UndecidableInstances #-}
16{-# LANGUAGE ViewPatterns #-}
15{-# LANGUAGE ViewPatterns #-}
17-- |
16-- |
18−-- Module: Data.OpenApi.Internal.Schema.Validation
17+-- Module: Data.Swagger.Internal.Schema.Validation
19-- Copyright: (c) 2015 GetShopTV
18-- Copyright: (c) 2015 GetShopTV
20-- License: BSD3
19-- License: BSD3
21-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
20-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
22-- Stability: experimental
21-- Stability: experimental
23--
22--
24-- Validate JSON values with Swagger Schema.
23-- Validate JSON values with Swagger Schema.
25−module Data.OpenApi.Internal.Schema.Validation where
24+module Data.Swagger.Internal.Schema.Validation where
26
25
27import Prelude ()
26import Prelude ()
28import Prelude.Compat
27import Prelude.Compat
@@ -32,14 +31,11 @@ import Control.Lens hiding (allOf)
32import Control.Monad (forM, forM_, when)
31import Control.Monad (forM, forM_, when)
33
32
34import Data.Aeson hiding (Result)
33import Data.Aeson hiding (Result)
35−#if MIN_VERSION_aeson(2,0,0)
34+import Data.Aeson.Encode.Pretty (encodePretty)
36−import qualified Data.Aeson.KeyMap as KeyMap
37−#endif
38import Data.Foldable (for_, sequenceA_,
35import Data.Foldable (for_, sequenceA_,
39 traverse_)
36 traverse_)
40−#if !MIN_VERSION_aeson(2,0,0)
41import Data.HashMap.Strict (HashMap)
37import Data.HashMap.Strict (HashMap)
42−#endif
38+import qualified Data.HashMap.Strict as HashMap
43import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
39import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
44import qualified "unordered-containers" Data.HashSet as HashSet
40import qualified "unordered-containers" Data.HashSet as HashSet
45import Data.Maybe (fromMaybe)
41import Data.Maybe (fromMaybe)
@@ -52,12 +48,10 @@ import qualified Data.Text.Lazy.Encoding as TL
52import Data.Vector (Vector)
48import Data.Vector (Vector)
53import qualified Data.Vector as Vector
49import qualified Data.Vector as Vector
54
50
55−import Data.OpenApi.Aeson.Compat (hasKey, keyToText, lookupKey, objectToList)
56−import Data.OpenApi.Declare
51+import Data.Swagger.Declare
57−import Data.OpenApi.Internal
52+import Data.Swagger.Internal
58−import Data.OpenApi.Internal.Schema
53+import Data.Swagger.Internal.Schema
59−import Data.OpenApi.Internal.Utils
54+import Data.Swagger.Lens
60−import Data.OpenApi.Lens
61
55
62-- | Validate @'ToJSON'@ instance matches @'ToSchema'@ for a given value.
56-- | Validate @'ToJSON'@ instance matches @'ToSchema'@ for a given value.
63-- This can be used with QuickCheck to ensure those instances are coherent:
57-- This can be used with QuickCheck to ensure those instances are coherent:
@@ -109,33 +103,33 @@ validateToJSONWithPatternChecker checker = validateJSONWithPatternChecker checke
109-- <BLANKLINE>
103-- <BLANKLINE>
110-- Swagger Schema:
104-- Swagger Schema:
111-- {
105-- {
112−-- "properties": {
113−-- "name": {
114−-- "type": "string"
115−-- },
116−-- "phone": {
117−-- "$ref": "#/components/schemas/Phone"
118−-- }
119−-- },
120-- "required": [
106-- "required": [
121-- "name",
107-- "name",
122-- "phone"
108-- "phone"
123-- ],
109-- ],
124−-- "type": "object"
110+-- "type": "object",
111+-- "properties": {
112+-- "phone": {
113+-- "$ref": "#/components/schemas/Phone"
114+-- },
115+-- "name": {
116+-- "type": "string"
117+-- }
118+-- }
125-- }
119-- }
126-- <BLANKLINE>
120-- <BLANKLINE>
127-- Swagger Description Context:
121-- Swagger Description Context:
128-- {
122-- {
129-- "Phone": {
123-- "Phone": {
124+-- "required": [
125+-- "value"
126+-- ],
127+-- "type": "object",
130-- "properties": {
128-- "properties": {
131-- "value": {
129-- "value": {
132-- "type": "string"
130-- "type": "string"
133-- }
131-- }
134−-- },
132+-- }
135−-- "required": [
136−-- "value"
137−-- ],
138−-- "type": "object"
139-- }
133-- }
140-- }
134-- }
141-- <BLANKLINE>
135-- <BLANKLINE>
@@ -211,7 +205,7 @@ instance Monad Result where
211
205
212-- | Validation configuration.
206-- | Validation configuration.
213data Config = Config
207data Config = Config
214− { -- | Pattern checker for @'_schemaPattern'@ validation.
208+ { -- | Pattern checker for @'_paramSchemaPattern'@ validation.
215 configPatternChecker :: Pattern -> Text -> Bool
209 configPatternChecker :: Pattern -> Text -> Bool
216 -- | Schema definitions in scope to resolve references.
210 -- | Schema definitions in scope to resolve references.
217 , configDefinitions :: Definitions Schema
211 , configDefinitions :: Definitions Schema
@@ -306,32 +300,38 @@ validateWithSchemaRef (Inline s) js = sub s (validateWithSchema js)
306validateWithSchema :: Value -> Validation Schema ()
300validateWithSchema :: Value -> Validation Schema ()
307validateWithSchema val = do
301validateWithSchema val = do
308 validateSchemaType val
302 validateSchemaType val
303+ sub_ paramSchema $ validateEnum val
304+
305+-- | Validate JSON @'Value'@ with Swagger @'ParamSchema'@.
306+validateWithParamSchema :: Value -> Validation ParamSchema ()
307+validateWithParamSchema val = do
308+ validateParamSchemaType val
309 validateEnum val
309 validateEnum val
310
310
311−validateInteger :: Scientific -> Validation Schema ()
311+validateInteger :: Scientific -> Validation ParamSchema ()
312validateInteger n = do
312validateInteger n = do
313 when (not (isInteger n)) $
313 when (not (isInteger n)) $
314 invalid ("not an integer")
314 invalid ("not an integer")
315 validateNumber n
315 validateNumber n
316
316
317−validateNumber :: Scientific -> Validation Schema ()
317+validateNumber :: Scientific -> Validation ParamSchema ()
318validateNumber n = withConfig $ \_cfg -> withSchema $ \sch -> do
318validateNumber n = withConfig $ \_cfg -> withSchema $ \sch -> do
319 let exMax = Just True == sch ^. exclusiveMaximum
319 let exMax = Just True == sch ^. exclusiveMaximum
320 exMin = Just True == sch ^. exclusiveMinimum
320 exMin = Just True == sch ^. exclusiveMinimum
321
321
322 check maximum_ $ \m ->
322 check maximum_ $ \m ->
323 when (if exMax then (n >= m) else (n > m)) $
323 when (if exMax then (n >= m) else (n > m)) $
324− invalid ("value " ++ show n ++ " exceeds maximum (should be " ++ (if exMax then "<" else "<=") ++ show m ++ ")")
324+ invalid ("value " ++ show n ++ " exceeds maximum (should be " ++ if exMax then "<" else "<=" ++ show m ++ ")")
325
325
326 check minimum_ $ \m ->
326 check minimum_ $ \m ->
327 when (if exMin then (n <= m) else (n < m)) $
327 when (if exMin then (n <= m) else (n < m)) $
328− invalid ("value " ++ show n ++ " falls below minimum (should be " ++ (if exMin then ">" else ">=") ++ show m ++ ")")
328+ invalid ("value " ++ show n ++ " falls below minimum (should be " ++ if exMin then ">" else ">=" ++ show m ++ ")")
329
329
330 check multipleOf $ \k ->
330 check multipleOf $ \k ->
331 when (not (isInteger (n / k))) $
331 when (not (isInteger (n / k))) $
332 invalid ("expected a multiple of " ++ show k ++ " but got " ++ show n)
332 invalid ("expected a multiple of " ++ show k ++ " but got " ++ show n)
333
333
334−validateString :: Text -> Validation Schema ()
334+validateString :: Text -> Validation ParamSchema ()
335validateString s = do
335validateString s = do
336 check maxLength $ \n ->
336 check maxLength $ \n ->
337 when (len > fromInteger n) $
337 when (len > fromInteger n) $
@@ -348,7 +348,7 @@ validateString s = do
348 where
348 where
349 len = Text.length s
349 len = Text.length s
350
350
351−validateArray :: Vector Value -> Validation Schema ()
351+validateArray :: Vector Value -> Validation ParamSchema ()
352validateArray xs = do
352validateArray xs = do
353 check maxItems $ \n ->
353 check maxItems $ \n ->
354 when (len > fromInteger n) $
354 when (len > fromInteger n) $
@@ -359,8 +359,8 @@ validateArray xs = do
359 invalid ("array is too short (size should be >=" ++ show n ++ ")")
359 invalid ("array is too short (size should be >=" ++ show n ++ ")")
360
360
361 check items $ \case
361 check items $ \case
362− OpenApiItemsObject itemSchema -> traverse_ (validateWithSchemaRef itemSchema) xs
362+ SwaggerItemsObject itemSchema -> traverse_ (validateWithSchemaRef itemSchema) xs
363− OpenApiItemsArray itemSchemas -> do
363+ SwaggerItemsArray itemSchemas -> do
364 when (len /= length itemSchemas) $
364 when (len /= length itemSchemas) $
365 invalid ("array size is invalid (should be exactly " ++ show (length itemSchemas) ++ ")")
365 invalid ("array size is invalid (should be exactly " ++ show (length itemSchemas) ++ ")")
366 sequenceA_ (zipWith validateWithSchemaRef itemSchemas (Vector.toList xs))
366 sequenceA_ (zipWith validateWithSchemaRef itemSchemas (Vector.toList xs))
@@ -372,16 +372,10 @@ validateArray xs = do
372 len = Vector.length xs
372 len = Vector.length xs
373 allUnique = len == HashSet.size (HashSet.fromList (Vector.toList xs))
373 allUnique = len == HashSet.size (HashSet.fromList (Vector.toList xs))
374
374
375−validateObject ::
376−#if MIN_VERSION_aeson(2,0,0)
377− KeyMap.KeyMap Value
378−#else
379− HashMap Text Value
375+validateObject :: HashMap Text Value -> Validation Schema ()
380−#endif
381− -> Validation Schema ()
382validateObject o = withSchema $ \sch ->
376validateObject o = withSchema $ \sch ->
383 case sch ^. discriminator of
377 case sch ^. discriminator of
384− Just (Discriminator pname types) -> case fromJSON <$> lookupKey pname o of
378+ Just (Discriminator pname types) -> case fromJSON <$> HashMap.lookup pname o of
385 Just (Success pvalue) ->
379 Just (Success pvalue) ->
386 let ref = fromMaybe pvalue $ InsOrdHashMap.lookup pvalue types
380 let ref = fromMaybe pvalue $ InsOrdHashMap.lookup pvalue types
387 -- TODO ref may be name or reference
381 -- TODO ref may be name or reference
@@ -400,15 +394,15 @@ validateObject o = withSchema $ \sch ->
400 validateRequired
394 validateRequired
401 validateProps
395 validateProps
402 where
396 where
403− size = fromIntegral (length o)
397+ size = fromIntegral (HashMap.size o)
404
398
405 validateRequired = withSchema $ \sch -> traverse_ validateReq (sch ^. required)
399 validateRequired = withSchema $ \sch -> traverse_ validateReq (sch ^. required)
406 validateReq n =
400 validateReq n =
407− when (not (hasKey n o)) $
401+ when (not (HashMap.member n o)) $
408 invalid ("property " ++ show n ++ " is required, but not found in " ++ show (encode o))
402 invalid ("property " ++ show n ++ " is required, but not found in " ++ show (encode o))
409
403
410 validateProps = withSchema $ \sch -> do
404 validateProps = withSchema $ \sch -> do
411− for_ (objectToList o) $ \(keyToText -> k, v) ->
405+ for_ (HashMap.toList o) $ \(k, v) ->
412 case v of
406 case v of
413 Null | not (k `elem` (sch ^. required)) -> valid -- null is fine for non-required property
407 Null | not (k `elem` (sch ^. required)) -> valid -- null is fine for non-required property
414 _ ->
408 _ ->
@@ -424,7 +418,7 @@ validateObject o = withSchema $ \sch ->
424 unknownProperty pname = invalid $
418 unknownProperty pname = invalid $
425 "property " <> show pname <> " is found in JSON value, but it is not mentioned in Swagger schema"
419 "property " <> show pname <> " is found in JSON value, but it is not mentioned in Swagger schema"
426
420
427−validateEnum :: Value -> Validation Schema ()
421+validateEnum :: Value -> Validation ParamSchema ()
428validateEnum val = do
422validateEnum val = do
429 check enum_ $ \xs ->
423 check enum_ $ \xs ->
430 when (val `notElem` xs) $
424 when (val `notElem` xs) $
@@ -435,10 +429,10 @@ validateEnum val = do
435-- This is like 'inferParamSchemaTypes', but also works for objects:
429-- This is like 'inferParamSchemaTypes', but also works for objects:
436--
430--
437-- >>> inferSchemaTypes <$> decode "{\"minProperties\": 1}"
431-- >>> inferSchemaTypes <$> decode "{\"minProperties\": 1}"
438−-- Just [OpenApiObject]
432+-- Just [SwaggerObject]
439−inferSchemaTypes :: Schema -> [OpenApiType]
433+inferSchemaTypes :: Schema -> [SwaggerType]
440−inferSchemaTypes sch = inferParamSchemaTypes sch ++
434+inferSchemaTypes sch = inferParamSchemaTypes (sch ^. paramSchema) ++
441− [ OpenApiObject | any ($ sch)
435+ [ SwaggerObject | any ($ sch)
442 [ has (additionalProperties._Just)
436 [ has (additionalProperties._Just)
443 , has (maxProperties._Just)
437 , has (maxProperties._Just)
444 , has (minProperties._Just)
438 , has (minProperties._Just)
@@ -448,30 +442,30 @@ inferSchemaTypes sch = inferParamSchemaTypes sch ++
448-- | Infer schema type based on used properties.
442-- | Infer schema type based on used properties.
449--
443--
450-- >>> inferSchemaTypes <$> decode "{\"minLength\": 2}"
444-- >>> inferSchemaTypes <$> decode "{\"minLength\": 2}"
451−-- Just [OpenApiString]
445+-- Just [SwaggerString]
452--
446--
453-- >>> inferSchemaTypes <$> decode "{\"maxItems\": 0}"
447-- >>> inferSchemaTypes <$> decode "{\"maxItems\": 0}"
454−-- Just [OpenApiArray]
448+-- Just [SwaggerArray]
455--
449--
456−-- From numeric properties 'OpenApiInteger' type is inferred.
450+-- From numeric properties 'SwaggerInteger' type is inferred.
457−-- If you want 'OpenApiNumber' instead, you must specify it explicitly.
451+-- If you want 'SwaggerNumber' instead, you must specify it explicitly.
458--
452--
459-- >>> inferSchemaTypes <$> decode "{\"minimum\": 1}"
453-- >>> inferSchemaTypes <$> decode "{\"minimum\": 1}"
460−-- Just [OpenApiInteger]
454+-- Just [SwaggerInteger]
461−inferParamSchemaTypes :: Schema -> [OpenApiType]
455+inferParamSchemaTypes :: ParamSchema -> [SwaggerType]
462inferParamSchemaTypes sch = concat
456inferParamSchemaTypes sch = concat
463− [ [ OpenApiArray | any ($ sch)
457+ [ [ SwaggerArray | any ($ sch)
464 [ has (items._Just)
458 [ has (items._Just)
465 , has (maxItems._Just)
459 , has (maxItems._Just)
466 , has (minItems._Just)
460 , has (minItems._Just)
467 , has (uniqueItems._Just) ] ]
461 , has (uniqueItems._Just) ] ]
468− , [ OpenApiInteger | any ($ sch)
462+ , [ SwaggerInteger | any ($ sch)
469 [ has (exclusiveMaximum._Just)
463 [ has (exclusiveMaximum._Just)
470 , has (exclusiveMinimum._Just)
464 , has (exclusiveMinimum._Just)
471 , has (maximum_._Just)
465 , has (maximum_._Just)
472 , has (minimum_._Just)
466 , has (minimum_._Just)
473 , has (multipleOf._Just) ] ]
467 , has (multipleOf._Just) ] ]
474− , [ OpenApiString | any ($ sch)
468+ , [ SwaggerString | any ($ sch)
475 [ has (maxLength._Just)
469 [ has (maxLength._Just)
476 , has (minLength._Just)
470 , has (minLength._Just)
477 , has (pattern._Just) ] ]
471 , has (pattern._Just) ] ]
@@ -495,30 +489,30 @@ validateSchemaType val = withSchema $ \sch ->
495
489
496 _ ->
490 _ ->
497 case (sch ^. type_, val) of
491 case (sch ^. type_, val) of
498− (Just OpenApiNull, Null) -> valid
492+ (Just SwaggerNull, Null) -> valid
499− (Just OpenApiBoolean, Bool _) -> valid
493+ (Just SwaggerBoolean, Bool _) -> valid
500− (Just OpenApiInteger, Number n) -> validateInteger n
494+ (Just SwaggerInteger, Number n) -> sub_ paramSchema (validateInteger n)
501− (Just OpenApiNumber, Number n) -> validateNumber n
495+ (Just SwaggerNumber, Number n) -> sub_ paramSchema (validateNumber n)
502− (Just OpenApiString, String s) -> validateString s
496+ (Just SwaggerString, String s) -> sub_ paramSchema (validateString s)
503− (Just OpenApiArray, Array xs) -> validateArray xs
497+ (Just SwaggerArray, Array xs) -> sub_ paramSchema (validateArray xs)
504− (Just OpenApiObject, Object o) -> validateObject o
498+ (Just SwaggerObject, Object o) -> validateObject o
505 (Nothing, Null) -> valid
499 (Nothing, Null) -> valid
506 (Nothing, Bool _) -> valid
500 (Nothing, Bool _) -> valid
507 -- Number by default
501 -- Number by default
508− (Nothing, Number n) -> validateNumber n
502+ (Nothing, Number n) -> sub_ paramSchema (validateNumber n)
509− (Nothing, String s) -> validateString s
503+ (Nothing, String s) -> sub_ paramSchema (validateString s)
510− (Nothing, Array xs) -> validateArray xs
504+ (Nothing, Array xs) -> sub_ paramSchema (validateArray xs)
511 (Nothing, Object o) -> validateObject o
505 (Nothing, Object o) -> validateObject o
512 bad -> invalid $ "expected JSON value of type " ++ showType bad
506 bad -> invalid $ "expected JSON value of type " ++ showType bad
513
507
514−validateParamSchemaType :: Value -> Validation Schema ()
508+validateParamSchemaType :: Value -> Validation ParamSchema ()
515validateParamSchemaType val = withSchema $ \sch ->
509validateParamSchemaType val = withSchema $ \sch ->
516 case (sch ^. type_, val) of
510 case (sch ^. type_, val) of
517− (Just OpenApiBoolean, Bool _) -> valid
511+ (Just SwaggerBoolean, Bool _) -> valid
518− (Just OpenApiInteger, Number n) -> validateInteger n
512+ (Just SwaggerInteger, Number n) -> validateInteger n
519− (Just OpenApiNumber, Number n) -> validateNumber n
513+ (Just SwaggerNumber, Number n) -> validateNumber n
520− (Just OpenApiString, String s) -> validateString s
514+ (Just SwaggerString, String s) -> validateString s
521− (Just OpenApiArray, Array xs) -> validateArray xs
515+ (Just SwaggerArray, Array xs) -> validateArray xs
522 (Nothing, Bool _) -> valid
516 (Nothing, Bool _) -> valid
523 -- Number by default
517 -- Number by default
524 (Nothing, Number n) -> validateNumber n
518 (Nothing, Number n) -> validateNumber n
@@ -526,11 +520,11 @@ validateParamSchemaType val = withSchema $ \sch ->
526 (Nothing, Array xs) -> validateArray xs
520 (Nothing, Array xs) -> validateArray xs
527 bad -> invalid $ "expected JSON value of type " ++ showType bad
521 bad -> invalid $ "expected JSON value of type " ++ showType bad
528
522
529−showType :: (Maybe OpenApiType, Value) -> String
523+showType :: (Maybe SwaggerType, Value) -> String
530showType (Just ty, _) = show ty
524showType (Just ty, _) = show ty
531−showType (Nothing, Null) = "OpenApiNull"
525+showType (Nothing, Null) = "SwaggerNull"
532−showType (Nothing, Bool _) = "OpenApiBoolean"
526+showType (Nothing, Bool _) = "SwaggerBoolean"
533−showType (Nothing, Number _) = "OpenApiNumber"
527+showType (Nothing, Number _) = "SwaggerNumber"
534−showType (Nothing, String _) = "OpenApiString"
528+showType (Nothing, String _) = "SwaggerString"
535−showType (Nothing, Array _) = "OpenApiArray"
529+showType (Nothing, Array _) = "SwaggerArray"
536−showType (Nothing, Object _) = "OpenApiObject"
530+showType (Nothing, Object _) = "SwaggerObject"
src/Data/OpenApi/Internal/TypeShape.hs → src/Data/Swagger/Internal/TypeShape.hsrenamed+1−1
@@ -4,7 +4,7 @@
4{-# LANGUAGE TypeOperators #-}
4{-# LANGUAGE TypeOperators #-}
5{-# LANGUAGE UndecidableInstances #-}
5{-# LANGUAGE UndecidableInstances #-}
6
6
7−module Data.OpenApi.Internal.TypeShape where
7+module Data.Swagger.Internal.TypeShape where
8
8
9import Data.Proxy
9import Data.Proxy
10import GHC.Generics
10import GHC.Generics
src/Data/OpenApi/Internal/Utils.hs → src/Data/Swagger/Internal/Utils.hsrenamed+1−6
@@ -4,7 +4,7 @@
4{-# LANGUAGE OverloadedStrings #-}
4{-# LANGUAGE OverloadedStrings #-}
5{-# LANGUAGE RankNTypes #-}
5{-# LANGUAGE RankNTypes #-}
6{-# LANGUAGE TypeOperators #-}
6{-# LANGUAGE TypeOperators #-}
7−module Data.OpenApi.Internal.Utils where
7+module Data.Swagger.Internal.Utils where
8
8
9import Prelude ()
9import Prelude ()
10import Prelude.Compat
10import Prelude.Compat
@@ -13,8 +13,6 @@ import Control.Lens ((&), (%~))
13import Control.Lens.TH
13import Control.Lens.TH
14import Data.Aeson
14import Data.Aeson
15import Data.Aeson.Types
15import Data.Aeson.Types
16−import qualified Data.Aeson.Encode.Pretty as P
17−import qualified Data.ByteString.Lazy as BSL
18import Data.Char
16import Data.Char
19import Data.Data
17import Data.Data
20import Data.Hashable (Hashable)
18import Data.Hashable (Hashable)
@@ -134,6 +132,3 @@ instance SwaggerMonoid (Maybe a) where
134 swaggerMempty = Nothing
132 swaggerMempty = Nothing
135 swaggerMappend x Nothing = x
133 swaggerMappend x Nothing = x
136 swaggerMappend _ y = y
134 swaggerMappend _ y = y
137−
138−encodePretty :: ToJSON a => a -> BSL.ByteString
139−encodePretty = P.encodePretty' $ P.defConfig { P.confCompare = P.compare }
src/Data/OpenApi/Lens.hs → src/Data/Swagger/Lens.hsrenamed+58−48
@@ -10,25 +10,27 @@
10{-# LANGUAGE UndecidableInstances #-}
10{-# LANGUAGE UndecidableInstances #-}
11{-# OPTIONS_GHC -fno-warn-orphans #-}
11{-# OPTIONS_GHC -fno-warn-orphans #-}
12-- |
12-- |
13−-- Module: Data.OpenApi.Lens
13+-- Module: Data.Swagger.Lens
14-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
14-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
15-- Stability: experimental
15-- Stability: experimental
16--
16--
17-- Lenses and prisms for Swagger.
17-- Lenses and prisms for Swagger.
18−module Data.OpenApi.Lens where
18+module Data.Swagger.Lens where
19
19
20import Control.Lens
20import Control.Lens
21import Data.Aeson (Value)
21import Data.Aeson (Value)
22import Data.Scientific (Scientific)
22import Data.Scientific (Scientific)
23−import Data.OpenApi.Internal
23+import Data.Swagger.Internal
24−import Data.OpenApi.Internal.Utils
24+import Data.Swagger.Internal.Utils
25import Data.Text (Text)
25import Data.Text (Text)
26
26
27-- * Classy lenses
27-- * Classy lenses
28
28
29−makeFields ''OpenApi
29+makeFields ''Swagger
30makeFields ''Components
30makeFields ''Components
31makeFields ''Server
31makeFields ''Server
32+-- conflict with enum of ParamSchema
33+--makeLensesWith swaggerFieldRules ''ServerVariable
32makeFields ''RequestBody
34makeFields ''RequestBody
33makeFields ''MediaTypeObject
35makeFields ''MediaTypeObject
34makeFields ''Info
36makeFields ''Info
@@ -41,6 +43,7 @@ makeLensesWith swaggerFieldRules ''Param
41makeFields ''Header
43makeFields ''Header
42makeLensesWith swaggerFieldRules ''Schema
44makeLensesWith swaggerFieldRules ''Schema
43makeFields ''NamedSchema
45makeFields ''NamedSchema
46+makeLensesWith swaggerFieldRules ''ParamSchema
44makeFields ''Xml
47makeFields ''Xml
45makeLensesWith swaggerFieldRules ''Responses
48makeLensesWith swaggerFieldRules ''Responses
46makeFields ''Response
49makeFields ''Response
@@ -64,24 +67,24 @@ makePrisms ''SecuritySchemeType
64-- ** 'Referenced' prisms
67-- ** 'Referenced' prisms
65makePrisms ''Referenced
68makePrisms ''Referenced
66
69
67−-- ** 'OpenApiItems' prisms
70+-- ** 'SwaggerItems' prisms
68
71
69−_OpenApiItemsArray :: Review OpenApiItems [Referenced Schema]
72+_SwaggerItemsArray :: Review SwaggerItems [Referenced Schema]
70−_OpenApiItemsArray
73+_SwaggerItemsArray
71− = unto (\x -> OpenApiItemsArray x)
74+ = unto (\x -> SwaggerItemsArray x)
72{- \x -> case x of
75{- \x -> case x of
73− OpenApiItemsPrimitive c p -> Left (OpenApiItemsPrimitive c p)
76+ SwaggerItemsPrimitive c p -> Left (SwaggerItemsPrimitive c p)
74− OpenApiItemsObject o -> Left (OpenApiItemsObject o)
77+ SwaggerItemsObject o -> Left (SwaggerItemsObject o)
75− OpenApiItemsArray a -> Right a
78+ SwaggerItemsArray a -> Right a
76-}
79-}
77
80
78−_OpenApiItemsObject :: Review OpenApiItems (Referenced Schema)
81+_SwaggerItemsObject :: Review SwaggerItems (Referenced Schema)
79−_OpenApiItemsObject
82+_SwaggerItemsObject
80− = unto (\x -> OpenApiItemsObject x)
83+ = unto (\x -> SwaggerItemsObject x)
81{- \x -> case x of
84{- \x -> case x of
82− OpenApiItemsPrimitive c p -> Left (OpenApiItemsPrimitive c p)
85+ SwaggerItemsPrimitive c p -> Left (SwaggerItemsPrimitive c p)
83− OpenApiItemsObject o -> Right o
86+ SwaggerItemsObject o -> Right o
84− OpenApiItemsArray a -> Left (OpenApiItemsArray a)
87+ SwaggerItemsArray a -> Left (SwaggerItemsArray a)
85-}
88-}
86
89
87-- =============================================================
90-- =============================================================
@@ -99,68 +102,75 @@ instance At Responses where at n = responses . at n
99instance Ixed Operation where ix n = responses . ix n
102instance Ixed Operation where ix n = responses . ix n
100instance At Operation where at n = responses . at n
103instance At Operation where at n = responses . at n
101
104
102−instance HasType NamedSchema (Maybe OpenApiType) where type_ = schema.type_
105+instance HasParamSchema NamedSchema ParamSchema where paramSchema = schema.paramSchema
106+
107+-- HasType instances
108+instance HasType Schema (Maybe SwaggerType) where type_ = paramSchema.type_
109+instance HasType NamedSchema (Maybe SwaggerType) where type_ = paramSchema.type_
110+
111+-- HasDefault instances
112+instance HasDefault Schema (Maybe Value) where default_ = paramSchema.default_
103
113
104-- OVERLAPPABLE instances
114-- OVERLAPPABLE instances
105
115
106instance
116instance
107 {-# OVERLAPPABLE #-}
117 {-# OVERLAPPABLE #-}
108− HasSchema s Schema
118+ HasParamSchema s ParamSchema
109 => HasFormat s (Maybe Format) where
119 => HasFormat s (Maybe Format) where
110− format = schema.format
120+ format = paramSchema.format
111
121
112instance
122instance
113 {-# OVERLAPPABLE #-}
123 {-# OVERLAPPABLE #-}
114− HasSchema s Schema
124+ HasParamSchema s ParamSchema
115− => HasItems s (Maybe OpenApiItems) where
125+ => HasItems s (Maybe SwaggerItems) where
116− items = schema.items
126+ items = paramSchema.items
117
127
118instance
128instance
119 {-# OVERLAPPABLE #-}
129 {-# OVERLAPPABLE #-}
120− HasSchema s Schema
130+ HasParamSchema s ParamSchema
121 => HasMaximum s (Maybe Scientific) where
131 => HasMaximum s (Maybe Scientific) where
122− maximum_ = schema.maximum_
132+ maximum_ = paramSchema.maximum_
123
133
124−instance {-# OVERLAPPABLE #-} HasSchema s Schema
134+instance {-# OVERLAPPABLE #-} HasParamSchema s ParamSchema
125 => HasExclusiveMaximum s (Maybe Bool) where
135 => HasExclusiveMaximum s (Maybe Bool) where
126− exclusiveMaximum = schema.exclusiveMaximum
136+ exclusiveMaximum = paramSchema.exclusiveMaximum
127
137
128−instance {-# OVERLAPPABLE #-} HasSchema s Schema
138+instance {-# OVERLAPPABLE #-} HasParamSchema s ParamSchema
129 => HasMinimum s (Maybe Scientific) where
139 => HasMinimum s (Maybe Scientific) where
130− minimum_ = schema.minimum_
140+ minimum_ = paramSchema.minimum_
131
141
132−instance {-# OVERLAPPABLE #-} HasSchema s Schema
142+instance {-# OVERLAPPABLE #-} HasParamSchema s ParamSchema
133 => HasExclusiveMinimum s (Maybe Bool) where
143 => HasExclusiveMinimum s (Maybe Bool) where
134− exclusiveMinimum = schema.exclusiveMinimum
144+ exclusiveMinimum = paramSchema.exclusiveMinimum
135
145
136−instance {-# OVERLAPPABLE #-} HasSchema s Schema
146+instance {-# OVERLAPPABLE #-} HasParamSchema s ParamSchema
137 => HasMaxLength s (Maybe Integer) where
147 => HasMaxLength s (Maybe Integer) where
138− maxLength = schema.maxLength
148+ maxLength = paramSchema.maxLength
139
149
140−instance {-# OVERLAPPABLE #-} HasSchema s Schema
150+instance {-# OVERLAPPABLE #-} HasParamSchema s ParamSchema
141 => HasMinLength s (Maybe Integer) where
151 => HasMinLength s (Maybe Integer) where
142− minLength = schema.minLength
152+ minLength = paramSchema.minLength
143
153
144−instance {-# OVERLAPPABLE #-} HasSchema s Schema
154+instance {-# OVERLAPPABLE #-} HasParamSchema s ParamSchema
145 => HasPattern s (Maybe Text) where
155 => HasPattern s (Maybe Text) where
146− pattern = schema.pattern
156+ pattern = paramSchema.pattern
147
157
148−instance {-# OVERLAPPABLE #-} HasSchema s Schema
158+instance {-# OVERLAPPABLE #-} HasParamSchema s ParamSchema
149 => HasMaxItems s (Maybe Integer) where
159 => HasMaxItems s (Maybe Integer) where
150− maxItems = schema.maxItems
160+ maxItems = paramSchema.maxItems
151
161
152−instance {-# OVERLAPPABLE #-} HasSchema s Schema
162+instance {-# OVERLAPPABLE #-} HasParamSchema s ParamSchema
153 => HasMinItems s (Maybe Integer) where
163 => HasMinItems s (Maybe Integer) where
154− minItems = schema.minItems
164+ minItems = paramSchema.minItems
155
165
156−instance {-# OVERLAPPABLE #-} HasSchema s Schema
166+instance {-# OVERLAPPABLE #-} HasParamSchema s ParamSchema
157 => HasUniqueItems s (Maybe Bool) where
167 => HasUniqueItems s (Maybe Bool) where
158− uniqueItems = schema.uniqueItems
168+ uniqueItems = paramSchema.uniqueItems
159
169
160−instance {-# OVERLAPPABLE #-} HasSchema s Schema
170+instance {-# OVERLAPPABLE #-} HasParamSchema s ParamSchema
161 => HasEnum s (Maybe [Value]) where
171 => HasEnum s (Maybe [Value]) where
162− enum_ = schema.enum_
172+ enum_ = paramSchema.enum_
163
173
164−instance {-# OVERLAPPABLE #-} HasSchema s Schema
174+instance {-# OVERLAPPABLE #-} HasParamSchema s ParamSchema
165 => HasMultipleOf s (Maybe Scientific) where
175 => HasMultipleOf s (Maybe Scientific) where
166− multipleOf = schema.multipleOf
176+ multipleOf = paramSchema.multipleOf
src/Data/OpenApi/Operation.hs → src/Data/Swagger/Operation.hsrenamed+29−136
@@ -1,13 +1,13 @@
1{-# LANGUAGE RankNTypes #-}
1{-# LANGUAGE RankNTypes #-}
2-- |
2-- |
3−-- Module: Data.OpenApi.Operation
3+-- Module: Data.Swagger.Operation
4-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
4-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
5-- Stability: experimental
5-- Stability: experimental
6--
6--
7-- Helper traversals and functions for Swagger operations manipulations.
7-- Helper traversals and functions for Swagger operations manipulations.
8-- These might be useful when you already have Swagger specification
8-- These might be useful when you already have Swagger specification
9-- generated by something else.
9-- generated by something else.
10−module Data.OpenApi.Operation (
10+module Data.Swagger.Operation (
11 -- * Operation traversals
11 -- * Operation traversals
12 allOperations,
12 allOperations,
13 operationsOf,
13 operationsOf,
@@ -42,10 +42,10 @@ import qualified Data.Set as Set
42import Data.Text (Text)
42import Data.Text (Text)
43import Network.HTTP.Media (MediaType)
43import Network.HTTP.Media (MediaType)
44
44
45−import Data.OpenApi.Declare
45+import Data.Swagger.Declare
46−import Data.OpenApi.Internal
46+import Data.Swagger.Internal
47−import Data.OpenApi.Lens
47+import Data.Swagger.Lens
48−import Data.OpenApi.Schema
48+import Data.Swagger.Schema
49
49
50import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
50import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
51import qualified Data.HashSet.InsOrd as InsOrdHS
51import qualified Data.HashSet.InsOrd as InsOrdHS
@@ -55,17 +55,14 @@ import qualified Data.HashSet.InsOrd as InsOrdHS
55-- >>> import Data.Proxy
55-- >>> import Data.Proxy
56-- >>> import Data.Time
56-- >>> import Data.Time
57-- >>> import qualified Data.ByteString.Lazy.Char8 as BSL
57-- >>> import qualified Data.ByteString.Lazy.Char8 as BSL
58−-- >>> import Data.OpenApi.Internal.Utils
59
58
60-- | Prepend path piece to all operations of the spec.
59-- | Prepend path piece to all operations of the spec.
61-- Leading and trailing slashes are trimmed/added automatically.
60-- Leading and trailing slashes are trimmed/added automatically.
62--
61--
63−-- >>> let api = (mempty :: OpenApi) & paths .~ [("/info", mempty)]
62+-- >>> let api = (mempty :: Swagger) & paths .~ [("/info", mempty)]
64−-- >>> BSL.putStrLn $ encodePretty $ prependPath "user/{user_id}" api ^. paths
63+-- >>> BSL.putStrLn $ encode $ prependPath "user/{user_id}" api ^. paths
65−-- {
66−-- "/user/{user_id}/info": {}
64+-- {"/user/{user_id}/info":{}}
67−-- }
68−prependPath :: FilePath -> OpenApi -> OpenApi
65+prependPath :: FilePath -> Swagger -> Swagger
69prependPath path = paths %~ InsOrdHashMap.mapKeys (path </>)
66prependPath path = paths %~ InsOrdHashMap.mapKeys (path </>)
70 where
67 where
71 x </> y = case trim y of
68 x </> y = case trim y of
@@ -75,7 +72,7 @@ prependPath path = paths %~ InsOrdHashMap.mapKeys (path </>)
75 trim = dropWhile (== '/') . dropWhileEnd (== '/')
72 trim = dropWhile (== '/') . dropWhileEnd (== '/')
76
73
77-- | All operations of a Swagger spec.
74-- | All operations of a Swagger spec.
78−allOperations :: Traversal' OpenApi Operation
75+allOperations :: Traversal' Swagger Operation
79allOperations = paths.traverse.template
76allOperations = paths.traverse.template
80
77
81-- | @'operationsOf' sub@ will traverse only those operations
78-- | @'operationsOf' sub@ will traverse only those operations
@@ -83,66 +80,13 @@ allOperations = paths.traverse.template
83-- by both path and method.
80-- by both path and method.
84--
81--
85-- >>> let ok = (mempty :: Operation) & at 200 ?~ "OK"
82-- >>> let ok = (mempty :: Operation) & at 200 ?~ "OK"
86−-- >>> let api = (mempty :: OpenApi) & paths .~ [("/user", mempty & get ?~ ok & post ?~ ok)]
83+-- >>> let api = (mempty :: Swagger) & paths .~ [("/user", mempty & get ?~ ok & post ?~ ok)]
87−-- >>> let sub = (mempty :: OpenApi) & paths .~ [("/user", mempty & get ?~ mempty)]
84+-- >>> let sub = (mempty :: Swagger) & paths .~ [("/user", mempty & get ?~ mempty)]
88−-- >>> BSL.putStrLn $ encodePretty api
85+-- >>> BSL.putStrLn $ encode api
89−-- {
86+-- {"openapi":"3.0.0","info":{"version":"","title":""},"paths":{"/user":{"get":{"responses":{"200":{"description":"OK"}}},"post":{"responses":{"200":{"description":"OK"}}}}},"components":{}}
90−-- "components": {},
91−-- "info": {
92−-- "title": "",
93−-- "version": ""
94−-- },
95−-- "openapi": "3.0.0",
96−-- "paths": {
97−-- "/user": {
98−-- "get": {
99−-- "responses": {
100−-- "200": {
101−-- "description": "OK"
102−-- }
103−-- }
104−-- },
105−-- "post": {
106−-- "responses": {
107−-- "200": {
108−-- "description": "OK"
109−-- }
110−-- }
111−-- }
112−-- }
113−-- }
114−-- }
115−-- >>> BSL.putStrLn $ encodePretty $ api & operationsOf sub . at 404 ?~ "Not found"
87+-- >>> BSL.putStrLn $ encode $ api & operationsOf sub . at 404 ?~ "Not found"
116−-- {
88+-- {"openapi":"3.0.0","info":{"version":"","title":""},"paths":{"/user":{"get":{"responses":{"404":{"description":"Not found"},"200":{"description":"OK"}}},"post":{"responses":{"200":{"description":"OK"}}}}},"components":{}}
117−-- "components": {},
118−-- "info": {
119−-- "title": "",
120−-- "version": ""
121−-- },
122−-- "openapi": "3.0.0",
123−-- "paths": {
124−-- "/user": {
125−-- "get": {
126−-- "responses": {
127−-- "200": {
128−-- "description": "OK"
129−-- },
130−-- "404": {
131−-- "description": "Not found"
132−-- }
133−-- }
134−-- },
135−-- "post": {
136−-- "responses": {
137−-- "200": {
138−-- "description": "OK"
139−-- }
140−-- }
141−-- }
142−-- }
143−-- }
144−-- }
145−operationsOf :: OpenApi -> Traversal' OpenApi Operation
89+operationsOf :: Swagger -> Traversal' Swagger Operation
146operationsOf sub = paths.itraversed.withIndex.subops
90operationsOf sub = paths.itraversed.withIndex.subops
147 where
91 where
148 -- | Traverse operations that correspond to paths and methods of the sub API.
92 -- | Traverse operations that correspond to paths and methods of the sub API.
@@ -164,12 +108,12 @@ operationsOf sub = paths.itraversed.withIndex.subops
164-- @
108-- @
165-- 'applyTags' = 'applyTagsFor' 'allOperations'
109-- 'applyTags' = 'applyTagsFor' 'allOperations'
166-- @
110-- @
167−applyTags :: [Tag] -> OpenApi -> OpenApi
111+applyTags :: [Tag] -> Swagger -> Swagger
168applyTags = applyTagsFor allOperations
112applyTags = applyTagsFor allOperations
169
113
170-- | Apply tags to a part of Swagger spec and update the global
114-- | Apply tags to a part of Swagger spec and update the global
171-- list of tags.
115-- list of tags.
172−applyTagsFor :: Traversal' OpenApi Operation -> [Tag] -> OpenApi -> OpenApi
116+applyTagsFor :: Traversal' Swagger Operation -> [Tag] -> Swagger -> Swagger
173applyTagsFor ops ts swag = swag
117applyTagsFor ops ts swag = swag
174 & ops . tags %~ (<> InsOrdHS.fromList (map _tagName ts))
118 & ops . tags %~ (<> InsOrdHS.fromList (map _tagName ts))
175 & tags %~ (<> InsOrdHS.fromList ts)
119 & tags %~ (<> InsOrdHS.fromList ts)
@@ -179,26 +123,8 @@ applyTagsFor ops ts swag = swag
179--
123--
180-- FIXME doc
124-- FIXME doc
181--
125--
182−-- >>> BSL.putStrLn $ encodePretty $ runDeclare (declareResponse "application/json" (Proxy :: Proxy Day)) mempty
126+-- >>> BSL.putStrLn $ encode $ runDeclare (declareResponse "application/json" (Proxy :: Proxy Day)) mempty
183−-- [
127+-- [{"Day":{"example":"2016-07-22","format":"date","type":"string"}},{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Day"}}}}]
184−-- {
185−-- "Day": {
186−-- "example": "2016-07-22",
187−-- "format": "date",
188−-- "type": "string"
189−-- }
190−-- },
191−-- {
192−-- "content": {
193−-- "application/json": {
194−-- "schema": {
195−-- "$ref": "#/components/schemas/Day"
196−-- }
197−-- }
198−-- },
199−-- "description": ""
200−-- }
201−-- ]
202declareResponse :: ToSchema a => MediaType -> Proxy a -> Declare (Definitions Schema) Response
128declareResponse :: ToSchema a => MediaType -> Proxy a -> Declare (Definitions Schema) Response
203declareResponse cType proxy = do
129declareResponse cType proxy = do
204 s <- declareSchemaRef proxy
130 s <- declareSchemaRef proxy
@@ -215,46 +141,13 @@ declareResponse cType proxy = do
215--
141--
216-- Example:
142-- Example:
217--
143--
218−-- >>> let api = (mempty :: OpenApi) & paths .~ [("/user", mempty & get ?~ mempty)]
144+-- >>> let api = (mempty :: Swagger) & paths .~ [("/user", mempty & get ?~ mempty)]
219-- >>> let res = declareResponse "application/json" (Proxy :: Proxy Day)
145-- >>> let res = declareResponse "application/json" (Proxy :: Proxy Day)
220−-- >>> BSL.putStrLn $ encodePretty $ api & setResponse 200 res
146+-- >>> BSL.putStrLn $ encode $ api & setResponse 200 res
221−-- {
147+-- {"openapi":"3.0.0","info":{"version":"","title":""},"paths":{"/user":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Day"}}},"description":""}}}}},"components":{"schemas":{"Day":{"example":"2016-07-22","format":"date","type":"string"}}}}
222−-- "components": {
223−-- "schemas": {
224−-- "Day": {
225−-- "example": "2016-07-22",
226−-- "format": "date",
227−-- "type": "string"
228−-- }
229−-- }
230−-- },
231−-- "info": {
232−-- "title": "",
233−-- "version": ""
234−-- },
235−-- "openapi": "3.0.0",
236−-- "paths": {
237−-- "/user": {
238−-- "get": {
239−-- "responses": {
240−-- "200": {
241−-- "content": {
242−-- "application/json": {
243−-- "schema": {
244−-- "$ref": "#/components/schemas/Day"
245−-- }
246−-- }
247−-- },
248−-- "description": ""
249−-- }
250−-- }
251−-- }
252−-- }
253−-- }
254−-- }
255--
148--
256-- See also @'setResponseWith'@.
149-- See also @'setResponseWith'@.
257−setResponse :: HttpStatusCode -> Declare (Definitions Schema) Response -> OpenApi -> OpenApi
150+setResponse :: HttpStatusCode -> Declare (Definitions Schema) Response -> Swagger -> Swagger
258setResponse = setResponseFor allOperations
151setResponse = setResponseFor allOperations
259
152
260-- | Set or update response for all operations.
153-- | Set or update response for all operations.
@@ -268,7 +161,7 @@ setResponse = setResponseFor allOperations
268-- @
161-- @
269--
162--
270-- See also @'setResponse'@.
163-- See also @'setResponse'@.
271−setResponseWith :: (Response -> Response -> Response) -> HttpStatusCode -> Declare (Definitions Schema) Response -> OpenApi -> OpenApi
164+setResponseWith :: (Response -> Response -> Response) -> HttpStatusCode -> Declare (Definitions Schema) Response -> Swagger -> Swagger
272setResponseWith = setResponseForWith allOperations
165setResponseWith = setResponseForWith allOperations
273
166
274-- | Set response for specified operations.
167-- | Set response for specified operations.
@@ -277,7 +170,7 @@ setResponseWith = setResponseForWith allOperations
277-- If the response already exists it will be overwritten.
170-- If the response already exists it will be overwritten.
278--
171--
279-- See also @'setResponseForWith'@.
172-- See also @'setResponseForWith'@.
280−setResponseFor :: Traversal' OpenApi Operation -> HttpStatusCode -> Declare (Definitions Schema) Response -> OpenApi -> OpenApi
173+setResponseFor :: Traversal' Swagger Operation -> HttpStatusCode -> Declare (Definitions Schema) Response -> Swagger -> Swagger
281setResponseFor ops code dres swag = swag
174setResponseFor ops code dres swag = swag
282 & components.schemas %~ (<> defs)
175 & components.schemas %~ (<> defs)
283 & ops . at code ?~ Inline res
176 & ops . at code ?~ Inline res
@@ -291,7 +184,7 @@ setResponseFor ops code dres swag = swag
291-- then just the new response is used.
184-- then just the new response is used.
292--
185--
293-- See also @'setResponseFor'@.
186-- See also @'setResponseFor'@.
294−setResponseForWith :: Traversal' OpenApi Operation -> (Response -> Response -> Response) -> HttpStatusCode -> Declare (Definitions Schema) Response -> OpenApi -> OpenApi
187+setResponseForWith :: Traversal' Swagger Operation -> (Response -> Response -> Response) -> HttpStatusCode -> Declare (Definitions Schema) Response -> Swagger -> Swagger
295setResponseForWith ops f code dres swag = swag
188setResponseForWith ops f code dres swag = swag
296 & components.schemas %~ (<> defs)
189 & components.schemas %~ (<> defs)
297 & ops . at code %~ Just . Inline . combine
190 & ops . at code %~ Just . Inline . combine
src/Data/OpenApi/Optics.hs → src/Data/Swagger/Optics.hsrenamed+153−90
@@ -7,7 +7,7 @@
7{-# LANGUAGE UndecidableInstances #-}
7{-# LANGUAGE UndecidableInstances #-}
8{-# OPTIONS_GHC -fno-warn-orphans #-}
8{-# OPTIONS_GHC -fno-warn-orphans #-}
9-- |
9-- |
10−-- Module: Data.OpenApi.Optics
10+-- Module: Data.Swagger.Optics
11-- Maintainer: Andrzej Rybczak <andrzej@rybczak.net>
11-- Maintainer: Andrzej Rybczak <andrzej@rybczak.net>
12-- Stability: experimental
12-- Stability: experimental
13--
13--
@@ -19,98 +19,53 @@
19-- >>> :set -XOverloadedLabels
19-- >>> :set -XOverloadedLabels
20-- >>> import qualified Data.ByteString.Lazy.Char8 as BSL
20-- >>> import qualified Data.ByteString.Lazy.Char8 as BSL
21--
21--
22−-- Example from the "Data.OpenApi" module using @optics@:
22+-- Example from the "Data.Swagger" module using @optics@:
23--
23--
24-- >>> :{
24-- >>> :{
25−-- BSL.putStrLn $ encodePretty $ (mempty :: OpenApi)
25+-- BSL.putStrLn $ encode $ (mempty :: Swagger)
26−-- & #components % #schemas .~ [ ("User", mempty & #type ?~ OpenApiString) ]
26+-- & #components % #schemas .~ [ ("User", mempty & #type ?~ SwaggerString) ]
27-- & #paths .~
27-- & #paths .~
28-- [ ("/user", mempty & #get ?~ (mempty
28-- [ ("/user", mempty & #get ?~ (mempty
29-- & at 200 ?~ ("OK" & #_Inline % #content % at "application/json" ?~ (mempty & #schema ?~ Ref (Reference "User")))
29-- & at 200 ?~ ("OK" & #_Inline % #content % at "application/json" ?~ (mempty & #schema ?~ Ref (Reference "User")))
30-- & at 404 ?~ "User info not found")) ]
30-- & at 404 ?~ "User info not found")) ]
31-- :}
31-- :}
32−-- {
32+-- {"openapi":"3.0.0","info":{"version":"","title":""},"paths":{"/user":{"get":{"responses":{"404":{"description":"User info not found"},"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK"}}}}},"components":{"schemas":{"User":{"type":"string"}}}}
33−-- "components": {
34−-- "schemas": {
35−-- "User": {
36−-- "type": "string"
37−-- }
38−-- }
39−-- },
40−-- "info": {
41−-- "title": "",
42−-- "version": ""
43−-- },
44−-- "openapi": "3.0.0",
45−-- "paths": {
46−-- "/user": {
47−-- "get": {
48−-- "responses": {
49−-- "200": {
50−-- "content": {
51−-- "application/json": {
52−-- "schema": {
53−-- "$ref": "#/components/schemas/User"
54−-- }
55−-- }
56−-- },
57−-- "description": "OK"
58−-- },
59−-- "404": {
60−-- "description": "User info not found"
61−-- }
62−-- }
63−-- }
64−-- }
65−-- }
66−-- }
67--
33--
68-- For convenience optics are defined as /labels/. It means that field accessor
34-- For convenience optics are defined as /labels/. It means that field accessor
69-- names can be overloaded for different types. One such common field is
35-- names can be overloaded for different types. One such common field is
70-- @#description@. Many components of a Swagger specification can have
36-- @#description@. Many components of a Swagger specification can have
71-- descriptions, and you can use the same name for them:
37-- descriptions, and you can use the same name for them:
72--
38--
73−-- >>> BSL.putStrLn $ encodePretty $ (mempty :: Response) & #description .~ "No content"
39+-- >>> BSL.putStrLn $ encode $ (mempty :: Response) & #description .~ "No content"
74−-- {
75−-- "description": "No content"
40+-- {"description":"No content"}
76−-- }
77-- >>> :{
41-- >>> :{
78−-- BSL.putStrLn $ encodePretty $ (mempty :: Schema)
42+-- BSL.putStrLn $ encode $ (mempty :: Schema)
79−-- & #type ?~ OpenApiBoolean
43+-- & #type ?~ SwaggerBoolean
80-- & #description ?~ "To be or not to be"
44-- & #description ?~ "To be or not to be"
81-- :}
45-- :}
82−-- {
83−-- "description": "To be or not to be",
46+-- {"description":"To be or not to be","type":"boolean"}
84−-- "type": "boolean"
85−-- }
86--
47--
87-- Additionally, to simplify working with @'Response'@, both @'Operation'@ and
48-- Additionally, to simplify working with @'Response'@, both @'Operation'@ and
88-- @'Responses'@ have direct access to it via @'Optics.Core.At.at'@. Example:
49-- @'Responses'@ have direct access to it via @'Optics.Core.At.at'@. Example:
89--
50--
90-- >>> :{
51-- >>> :{
91−-- BSL.putStrLn $ encodePretty $ (mempty :: Operation)
52+-- BSL.putStrLn $ encode $ (mempty :: Operation)
92-- & at 404 ?~ "Not found"
53-- & at 404 ?~ "Not found"
93-- :}
54-- :}
94−-- {
95−-- "responses": {
96−-- "404": {
97−-- "description": "Not found"
55+-- {"responses":{"404":{"description":"Not found"}}}
98−-- }
99−-- }
100−-- }
56+--
101−module Data.OpenApi.Optics () where
57+module Data.Swagger.Optics () where
102
58
103import Data.Aeson (Value)
59import Data.Aeson (Value)
104import Data.Scientific (Scientific)
60import Data.Scientific (Scientific)
105−import Data.OpenApi.Internal
61+import Data.Swagger.Internal
106−import Data.OpenApi.Internal.Utils
107import Data.Text (Text)
62import Data.Text (Text)
108import Optics.Core
63import Optics.Core
109import Optics.TH
64import Optics.TH
110
65
111-- Lenses
66-- Lenses
112
67
113−makeFieldLabels ''OpenApi
68+makeFieldLabels ''Swagger
114makeFieldLabels ''Components
69makeFieldLabels ''Components
115makeFieldLabels ''Server
70makeFieldLabels ''Server
116makeFieldLabels ''ServerVariable
71makeFieldLabels ''ServerVariable
@@ -126,6 +81,7 @@ makeFieldLabels ''Param
126makeFieldLabels ''Header
81makeFieldLabels ''Header
127makeFieldLabels ''Schema
82makeFieldLabels ''Schema
128makeFieldLabels ''NamedSchema
83makeFieldLabels ''NamedSchema
84+makeFieldLabels ''ParamSchema
129makeFieldLabels ''Xml
85makeFieldLabels ''Xml
130makeFieldLabels ''Responses
86makeFieldLabels ''Responses
131makeFieldLabels ''Response
87makeFieldLabels ''Response
@@ -148,30 +104,30 @@ makeFieldLabels ''Link
148makePrismLabels ''SecuritySchemeType
104makePrismLabels ''SecuritySchemeType
149makePrismLabels ''Referenced
105makePrismLabels ''Referenced
150
106
151−-- OpenApiItems prisms
107+-- SwaggerItems prisms
152
108
153instance
109instance
154 ( a ~ [Referenced Schema]
110 ( a ~ [Referenced Schema]
155 , b ~ [Referenced Schema]
111 , b ~ [Referenced Schema]
156− ) => LabelOptic "_OpenApiItemsArray"
112+ ) => LabelOptic "_SwaggerItemsArray"
157 A_Review
113 A_Review
158− OpenApiItems
114+ SwaggerItems
159− OpenApiItems
115+ SwaggerItems
160 a
116 a
161 b where
117 b where
162− labelOptic = unto (\x -> OpenApiItemsArray x)
118+ labelOptic = unto (\x -> SwaggerItemsArray x)
163 {-# INLINE labelOptic #-}
119 {-# INLINE labelOptic #-}
164
120
165instance
121instance
166 ( a ~ Referenced Schema
122 ( a ~ Referenced Schema
167 , b ~ Referenced Schema
123 , b ~ Referenced Schema
168− ) => LabelOptic "_OpenApiItemsObject"
124+ ) => LabelOptic "_SwaggerItemsObject"
169 A_Review
125 A_Review
170− OpenApiItems
126+ SwaggerItems
171− OpenApiItems
127+ SwaggerItems
172 a
128 a
173 b where
129 b where
174− labelOptic = unto (\x -> OpenApiItemsObject x)
130+ labelOptic = unto (\x -> SwaggerItemsObject x)
175 {-# INLINE labelOptic #-}
131 {-# INLINE labelOptic #-}
176
132
177-- =============================================================
133-- =============================================================
@@ -197,132 +153,239 @@ instance At Operation where
197 at n = #responses % at n
153 at n = #responses % at n
198 {-# INLINE at #-}
154 {-# INLINE at #-}
199
155
156+-- #paramSchema
157+
158+instance
159+ ( a ~ ParamSchema
160+ , b ~ ParamSchema
161+ ) => LabelOptic "paramSchema" A_Lens NamedSchema NamedSchema a b where
162+ labelOptic = #schema % #paramSchema
163+ {-# INLINE labelOptic #-}
164+
200-- #type
165-- #type
201
166
202instance
167instance
203− ( a ~ Maybe OpenApiType
168+ ( a ~ Maybe SwaggerType
204− , b ~ Maybe OpenApiType
169+ , b ~ Maybe SwaggerType
170+ ) => LabelOptic "type" A_Lens Schema Schema a b where
171+ labelOptic = #paramSchema % #type
172+ {-# INLINE labelOptic #-}
173+
174+instance
175+ ( a ~ Maybe SwaggerType
176+ , b ~ Maybe SwaggerType
205 ) => LabelOptic "type" A_Lens NamedSchema NamedSchema a b where
177 ) => LabelOptic "type" A_Lens NamedSchema NamedSchema a b where
206− labelOptic = #schema % #type
178+ labelOptic = #paramSchema % #type
207 {-# INLINE labelOptic #-}
179 {-# INLINE labelOptic #-}
208
180
209-- #default
181-- #default
210
182
183+instance
184+ ( a ~ Maybe Value, b ~ Maybe Value
185+ ) => LabelOptic "default" A_Lens Schema Schema a b where
186+ labelOptic = #paramSchema % #default
187+ {-# INLINE labelOptic #-}
188+
211instance
189instance
212 ( a ~ Maybe Value, b ~ Maybe Value
190 ( a ~ Maybe Value, b ~ Maybe Value
213 ) => LabelOptic "default" A_Lens NamedSchema NamedSchema a b where
191 ) => LabelOptic "default" A_Lens NamedSchema NamedSchema a b where
214− labelOptic = #schema % #default
192+ labelOptic = #paramSchema % #default
215 {-# INLINE labelOptic #-}
193 {-# INLINE labelOptic #-}
216
194
217-- #format
195-- #format
218
196
197+instance
198+ ( a ~ Maybe Format, b ~ Maybe Format
199+ ) => LabelOptic "format" A_Lens Schema Schema a b where
200+ labelOptic = #paramSchema % #format
201+ {-# INLINE labelOptic #-}
202+
219instance
203instance
220 ( a ~ Maybe Format, b ~ Maybe Format
204 ( a ~ Maybe Format, b ~ Maybe Format
221 ) => LabelOptic "format" A_Lens NamedSchema NamedSchema a b where
205 ) => LabelOptic "format" A_Lens NamedSchema NamedSchema a b where
222− labelOptic = #schema % #format
206+ labelOptic = #paramSchema % #format
223 {-# INLINE labelOptic #-}
207 {-# INLINE labelOptic #-}
224
208
225-- #items
209-- #items
226
210
227instance
211instance
228− ( a ~ Maybe OpenApiItems
212+ ( a ~ Maybe SwaggerItems
229− , b ~ Maybe OpenApiItems
213+ , b ~ Maybe SwaggerItems
214+ ) => LabelOptic "items" A_Lens Schema Schema a b where
215+ labelOptic = #paramSchema % #items
216+ {-# INLINE labelOptic #-}
217+
218+instance
219+ ( a ~ Maybe SwaggerItems
220+ , b ~ Maybe SwaggerItems
230 ) => LabelOptic "items" A_Lens NamedSchema NamedSchema a b where
221 ) => LabelOptic "items" A_Lens NamedSchema NamedSchema a b where
231− labelOptic = #schema % #items
222+ labelOptic = #paramSchema % #items
232 {-# INLINE labelOptic #-}
223 {-# INLINE labelOptic #-}
233
224
234-- #maximum
225-- #maximum
235
226
227+instance
228+ ( a ~ Maybe Scientific, b ~ Maybe Scientific
229+ ) => LabelOptic "maximum" A_Lens Schema Schema a b where
230+ labelOptic = #paramSchema % #maximum
231+ {-# INLINE labelOptic #-}
232+
236instance
233instance
237 ( a ~ Maybe Scientific, b ~ Maybe Scientific
234 ( a ~ Maybe Scientific, b ~ Maybe Scientific
238 ) => LabelOptic "maximum" A_Lens NamedSchema NamedSchema a b where
235 ) => LabelOptic "maximum" A_Lens NamedSchema NamedSchema a b where
239− labelOptic = #schema % #maximum
236+ labelOptic = #paramSchema % #maximum
240 {-# INLINE labelOptic #-}
237 {-# INLINE labelOptic #-}
241
238
242-- #exclusiveMaximum
239-- #exclusiveMaximum
243
240
241+instance
242+ ( a ~ Maybe Bool, b ~ Maybe Bool
243+ ) => LabelOptic "exclusiveMaximum" A_Lens Schema Schema a b where
244+ labelOptic = #paramSchema % #exclusiveMaximum
245+ {-# INLINE labelOptic #-}
246+
244instance
247instance
245 ( a ~ Maybe Bool, b ~ Maybe Bool
248 ( a ~ Maybe Bool, b ~ Maybe Bool
246 ) => LabelOptic "exclusiveMaximum" A_Lens NamedSchema NamedSchema a b where
249 ) => LabelOptic "exclusiveMaximum" A_Lens NamedSchema NamedSchema a b where
247− labelOptic = #schema % #exclusiveMaximum
250+ labelOptic = #paramSchema % #exclusiveMaximum
248 {-# INLINE labelOptic #-}
251 {-# INLINE labelOptic #-}
249
252
250-- #minimum
253-- #minimum
251
254
255+instance
256+ ( a ~ Maybe Scientific, b ~ Maybe Scientific
257+ ) => LabelOptic "minimum" A_Lens Schema Schema a b where
258+ labelOptic = #paramSchema % #minimum
259+ {-# INLINE labelOptic #-}
260+
252instance
261instance
253 ( a ~ Maybe Scientific, b ~ Maybe Scientific
262 ( a ~ Maybe Scientific, b ~ Maybe Scientific
254 ) => LabelOptic "minimum" A_Lens NamedSchema NamedSchema a b where
263 ) => LabelOptic "minimum" A_Lens NamedSchema NamedSchema a b where
255− labelOptic = #schema % #minimum
264+ labelOptic = #paramSchema % #minimum
256 {-# INLINE labelOptic #-}
265 {-# INLINE labelOptic #-}
257
266
258-- #exclusiveMinimum
267-- #exclusiveMinimum
259
268
269+instance
270+ ( a ~ Maybe Bool, b ~ Maybe Bool
271+ ) => LabelOptic "exclusiveMinimum" A_Lens Schema Schema a b where
272+ labelOptic = #paramSchema % #exclusiveMinimum
273+ {-# INLINE labelOptic #-}
274+
260instance
275instance
261 ( a ~ Maybe Bool, b ~ Maybe Bool
276 ( a ~ Maybe Bool, b ~ Maybe Bool
262 ) => LabelOptic "exclusiveMinimum" A_Lens NamedSchema NamedSchema a b where
277 ) => LabelOptic "exclusiveMinimum" A_Lens NamedSchema NamedSchema a b where
263− labelOptic = #schema % #exclusiveMinimum
278+ labelOptic = #paramSchema % #exclusiveMinimum
264 {-# INLINE labelOptic #-}
279 {-# INLINE labelOptic #-}
265
280
266-- #maxLength
281-- #maxLength
267
282
283+instance
284+ ( a ~ Maybe Integer, b ~ Maybe Integer
285+ ) => LabelOptic "maxLength" A_Lens Schema Schema a b where
286+ labelOptic = #paramSchema % #maxLength
287+ {-# INLINE labelOptic #-}
288+
268instance
289instance
269 ( a ~ Maybe Integer, b ~ Maybe Integer
290 ( a ~ Maybe Integer, b ~ Maybe Integer
270 ) => LabelOptic "maxLength" A_Lens NamedSchema NamedSchema a b where
291 ) => LabelOptic "maxLength" A_Lens NamedSchema NamedSchema a b where
271− labelOptic = #schema % #maxLength
292+ labelOptic = #paramSchema % #maxLength
272 {-# INLINE labelOptic #-}
293 {-# INLINE labelOptic #-}
273
294
274-- #minLength
295-- #minLength
275
296
297+instance
298+ ( a ~ Maybe Integer, b ~ Maybe Integer
299+ ) => LabelOptic "minLength" A_Lens Schema Schema a b where
300+ labelOptic = #paramSchema % #minLength
301+ {-# INLINE labelOptic #-}
302+
276instance
303instance
277 ( a ~ Maybe Integer, b ~ Maybe Integer
304 ( a ~ Maybe Integer, b ~ Maybe Integer
278 ) => LabelOptic "minLength" A_Lens NamedSchema NamedSchema a b where
305 ) => LabelOptic "minLength" A_Lens NamedSchema NamedSchema a b where
279− labelOptic = #schema % #minLength
306+ labelOptic = #paramSchema % #minLength
280 {-# INLINE labelOptic #-}
307 {-# INLINE labelOptic #-}
281
308
282-- #pattern
309-- #pattern
283
310
311+instance
312+ ( a ~ Maybe Text, b ~ Maybe Text
313+ ) => LabelOptic "pattern" A_Lens Schema Schema a b where
314+ labelOptic = #paramSchema % #pattern
315+ {-# INLINE labelOptic #-}
316+
284instance
317instance
285 ( a ~ Maybe Text, b ~ Maybe Text
318 ( a ~ Maybe Text, b ~ Maybe Text
286 ) => LabelOptic "pattern" A_Lens NamedSchema NamedSchema a b where
319 ) => LabelOptic "pattern" A_Lens NamedSchema NamedSchema a b where
287− labelOptic = #schema % #pattern
320+ labelOptic = #paramSchema % #pattern
288 {-# INLINE labelOptic #-}
321 {-# INLINE labelOptic #-}
289
322
290-- #maxItems
323-- #maxItems
291
324
325+instance
326+ ( a ~ Maybe Integer, b ~ Maybe Integer
327+ ) => LabelOptic "maxItems" A_Lens Schema Schema a b where
328+ labelOptic = #paramSchema % #maxItems
329+ {-# INLINE labelOptic #-}
330+
292instance
331instance
293 ( a ~ Maybe Integer, b ~ Maybe Integer
332 ( a ~ Maybe Integer, b ~ Maybe Integer
294 ) => LabelOptic "maxItems" A_Lens NamedSchema NamedSchema a b where
333 ) => LabelOptic "maxItems" A_Lens NamedSchema NamedSchema a b where
295− labelOptic = #schema % #maxItems
334+ labelOptic = #paramSchema % #maxItems
296 {-# INLINE labelOptic #-}
335 {-# INLINE labelOptic #-}
297
336
298-- #minItems
337-- #minItems
299
338
339+instance
340+ ( a ~ Maybe Integer, b ~ Maybe Integer
341+ ) => LabelOptic "minItems" A_Lens Schema Schema a b where
342+ labelOptic = #paramSchema % #minItems
343+ {-# INLINE labelOptic #-}
344+
300instance
345instance
301 ( a ~ Maybe Integer, b ~ Maybe Integer
346 ( a ~ Maybe Integer, b ~ Maybe Integer
302 ) => LabelOptic "minItems" A_Lens NamedSchema NamedSchema a b where
347 ) => LabelOptic "minItems" A_Lens NamedSchema NamedSchema a b where
303− labelOptic = #schema % #minItems
348+ labelOptic = #paramSchema % #minItems
304 {-# INLINE labelOptic #-}
349 {-# INLINE labelOptic #-}
305
350
306-- #uniqueItems
351-- #uniqueItems
307
352
353+instance
354+ ( a ~ Maybe Bool, b ~ Maybe Bool
355+ ) => LabelOptic "uniqueItems" A_Lens Schema Schema a b where
356+ labelOptic = #paramSchema % #uniqueItems
357+ {-# INLINE labelOptic #-}
358+
308instance
359instance
309 ( a ~ Maybe Bool, b ~ Maybe Bool
360 ( a ~ Maybe Bool, b ~ Maybe Bool
310 ) => LabelOptic "uniqueItems" A_Lens NamedSchema NamedSchema a b where
361 ) => LabelOptic "uniqueItems" A_Lens NamedSchema NamedSchema a b where
311− labelOptic = #schema % #uniqueItems
362+ labelOptic = #paramSchema % #uniqueItems
312 {-# INLINE labelOptic #-}
363 {-# INLINE labelOptic #-}
313
364
314-- #enum
365-- #enum
315
366
367+instance
368+ ( a ~ Maybe [Value], b ~ Maybe [Value]
369+ ) => LabelOptic "enum" A_Lens Schema Schema a b where
370+ labelOptic = #paramSchema % #enum
371+ {-# INLINE labelOptic #-}
372+
316instance
373instance
317 ( a ~ Maybe [Value], b ~ Maybe [Value]
374 ( a ~ Maybe [Value], b ~ Maybe [Value]
318 ) => LabelOptic "enum" A_Lens NamedSchema NamedSchema a b where
375 ) => LabelOptic "enum" A_Lens NamedSchema NamedSchema a b where
319− labelOptic = #schema % #enum
376+ labelOptic = #paramSchema % #enum
320 {-# INLINE labelOptic #-}
377 {-# INLINE labelOptic #-}
321
378
322-- #multipleOf
379-- #multipleOf
323
380
381+instance
382+ ( a ~ Maybe Scientific, b ~ Maybe Scientific
383+ ) => LabelOptic "multipleOf" A_Lens Schema Schema a b where
384+ labelOptic = #paramSchema % #multipleOf
385+ {-# INLINE labelOptic #-}
386+
324instance
387instance
325 ( a ~ Maybe Scientific, b ~ Maybe Scientific
388 ( a ~ Maybe Scientific, b ~ Maybe Scientific
326 ) => LabelOptic "multipleOf" A_Lens NamedSchema NamedSchema a b where
389 ) => LabelOptic "multipleOf" A_Lens NamedSchema NamedSchema a b where
327− labelOptic = #schema % #multipleOf
390+ labelOptic = #paramSchema % #multipleOf
328 {-# INLINE labelOptic #-}
391 {-# INLINE labelOptic #-}
src/Data/OpenApi/ParamSchema.hs → src/Data/Swagger/ParamSchema.hsrenamed+7−7
@@ -1,10 +1,10 @@
1-- |
1-- |
2−-- Module: Data.OpenApi.ParamSchema
2+-- Module: Data.Swagger.ParamSchema
3-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
3-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
4-- Stability: experimental
4-- Stability: experimental
5--
5--
6-- Types and functions for working with Swagger parameter schema.
6-- Types and functions for working with Swagger parameter schema.
7−module Data.OpenApi.ParamSchema (
7+module Data.Swagger.ParamSchema (
8 -- * Encoding
8 -- * Encoding
9 ToParamSchema(..),
9 ToParamSchema(..),
10
10
@@ -13,14 +13,14 @@ module Data.OpenApi.ParamSchema (
13 toParamSchemaBoundedIntegral,
13 toParamSchemaBoundedIntegral,
14
14
15 -- * Schema templates
15 -- * Schema templates
16− passwordSchema,
16+ passwordParamSchema,
17− binarySchema,
17+ binaryParamSchema,
18− byteSchema,
18+ byteParamSchema,
19
19
20 -- * Generic encoding configuration
20 -- * Generic encoding configuration
21 SchemaOptions(..),
21 SchemaOptions(..),
22 defaultSchemaOptions,
22 defaultSchemaOptions,
23) where
23) where
24
24
25−import Data.OpenApi.Internal.ParamSchema
25+import Data.Swagger.Internal.ParamSchema
26−import Data.OpenApi.SchemaOptions
26+import Data.Swagger.SchemaOptions
src/Data/OpenApi/Schema.hs → src/Data/Swagger/Schema.hsrenamed+9−4
@@ -1,10 +1,10 @@
1-- |
1-- |
2−-- Module: Data.OpenApi.Schema
2+-- Module: Data.Swagger.Schema
3-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
3-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
4-- Stability: experimental
4-- Stability: experimental
5--
5--
6-- Types and functions for working with Swagger schema.
6-- Types and functions for working with Swagger schema.
7−module Data.OpenApi.Schema (
7+module Data.Swagger.Schema (
8 -- * Encoding
8 -- * Encoding
9 ToSchema(..),
9 ToSchema(..),
10 declareSchema,
10 declareSchema,
@@ -32,6 +32,11 @@ module Data.OpenApi.Schema (
32 paramSchemaToNamedSchema,
32 paramSchemaToNamedSchema,
33 paramSchemaToSchema,
33 paramSchemaToSchema,
34
34
35+ -- * Schema templates
36+ passwordSchema,
37+ binarySchema,
38+ byteSchema,
39+
35 -- * Sketching @'Schema'@s using @'ToJSON'@
40 -- * Sketching @'Schema'@s using @'ToJSON'@
36 sketchSchema,
41 sketchSchema,
37 sketchStrictSchema,
42 sketchStrictSchema,
@@ -48,5 +53,5 @@ module Data.OpenApi.Schema (
48 fromAesonOptions,
53 fromAesonOptions,
49) where
54) where
50
55
51−import Data.OpenApi.Internal.Schema
56+import Data.Swagger.Internal.Schema
52−import Data.OpenApi.SchemaOptions
57+import Data.Swagger.SchemaOptions
src/Data/OpenApi/Schema/Generator.hs → src/Data/Swagger/Schema/Generator.hsrenamed+15−17
@@ -2,7 +2,7 @@
2{-# LANGUAGE OverloadedLists #-}
2{-# LANGUAGE OverloadedLists #-}
3{-# LANGUAGE ScopedTypeVariables #-}
3{-# LANGUAGE ScopedTypeVariables #-}
4
4
5−module Data.OpenApi.Schema.Generator where
5+module Data.Swagger.Schema.Generator where
6
6
7import Prelude ()
7import Prelude ()
8import Prelude.Compat
8import Prelude.Compat
@@ -16,22 +16,20 @@ import Data.Maybe
16import Data.Proxy
16import Data.Proxy
17import Data.Scientific
17import Data.Scientific
18import qualified Data.Set as S
18import qualified Data.Set as S
19−import Data.OpenApi
19+import Data.Swagger
20−import Data.OpenApi.Declare
20+import Data.Swagger.Declare
21−import Data.OpenApi.Internal.Schema.Validation (inferSchemaTypes)
21+import Data.Swagger.Internal.Schema.Validation (inferSchemaTypes)
22import qualified Data.Text as T
22import qualified Data.Text as T
23import qualified Data.Vector as V
23import qualified Data.Vector as V
24import Test.QuickCheck (arbitrary)
24import Test.QuickCheck (arbitrary)
25import Test.QuickCheck.Gen
25import Test.QuickCheck.Gen
26import Test.QuickCheck.Property
26import Test.QuickCheck.Property
27
27
28−import Data.OpenApi.Aeson.Compat (fromInsOrdHashMap)
29−
30-- | Note: 'schemaGen' may 'error', if schema type is not specified,
28-- | Note: 'schemaGen' may 'error', if schema type is not specified,
31-- and cannot be inferred.
29-- and cannot be inferred.
32schemaGen :: Definitions Schema -> Schema -> Gen Value
30schemaGen :: Definitions Schema -> Schema -> Gen Value
33schemaGen _ schema
31schemaGen _ schema
34− | Just cases <- schema ^. enum_ = elements cases
32+ | Just cases <- schema ^. paramSchema . enum_ = elements cases
35schemaGen defns schema
33schemaGen defns schema
36 | Just variants <- schema ^. oneOf = schemaGen defns =<< elements (dereference defns <$> variants)
34 | Just variants <- schema ^. oneOf = schemaGen defns =<< elements (dereference defns <$> variants)
37schemaGen defns schema =
35schemaGen defns schema =
@@ -41,25 +39,25 @@ schemaGen defns schema =
41 [ inferredType ] -> schemaGen defns (schema & type_ ?~ inferredType)
39 [ inferredType ] -> schemaGen defns (schema & type_ ?~ inferredType)
42 -- Gen is not MonadFail
40 -- Gen is not MonadFail
43 _ -> error "unable to infer schema type"
41 _ -> error "unable to infer schema type"
44− Just OpenApiBoolean -> Bool <$> elements [True, False]
42+ Just SwaggerBoolean -> Bool <$> elements [True, False]
45− Just OpenApiNull -> pure Null
43+ Just SwaggerNull -> pure Null
46− Just OpenApiNumber
44+ Just SwaggerNumber
47 | Just min <- schema ^. minimum_
45 | Just min <- schema ^. minimum_
48 , Just max <- schema ^. maximum_ ->
46 , Just max <- schema ^. maximum_ ->
49 Number . fromFloatDigits <$>
47 Number . fromFloatDigits <$>
50 choose (toRealFloat min, toRealFloat max :: Double)
48 choose (toRealFloat min, toRealFloat max :: Double)
51 | otherwise -> Number .fromFloatDigits <$> (arbitrary :: Gen Double)
49 | otherwise -> Number .fromFloatDigits <$> (arbitrary :: Gen Double)
52− Just OpenApiInteger
50+ Just SwaggerInteger
53 | Just min <- schema ^. minimum_
51 | Just min <- schema ^. minimum_
54 , Just max <- schema ^. maximum_ ->
52 , Just max <- schema ^. maximum_ ->
55 Number . fromInteger <$>
53 Number . fromInteger <$>
56 choose (truncate min, truncate max)
54 choose (truncate min, truncate max)
57 | otherwise -> Number . fromInteger <$> arbitrary
55 | otherwise -> Number . fromInteger <$> arbitrary
58− Just OpenApiArray
56+ Just SwaggerArray
59 | Just 0 <- schema ^. maxLength -> pure $ Array V.empty
57 | Just 0 <- schema ^. maxLength -> pure $ Array V.empty
60 | Just items <- schema ^. items ->
58 | Just items <- schema ^. items ->
61 case items of
59 case items of
62− OpenApiItemsObject ref -> do
60+ SwaggerItemsObject ref -> do
63 size <- getSize
61 size <- getSize
64 let itemSchema = dereference defns ref
62 let itemSchema = dereference defns ref
65 minLength' = fromMaybe 0 $ fromInteger <$> schema ^. minItems
63 minLength' = fromMaybe 0 $ fromInteger <$> schema ^. minItems
@@ -67,17 +65,17 @@ schemaGen defns schema =
67 arrayLength <- choose (minLength', max minLength' maxLength')
65 arrayLength <- choose (minLength', max minLength' maxLength')
68 generatedArray <- vectorOf arrayLength $ schemaGen defns itemSchema
66 generatedArray <- vectorOf arrayLength $ schemaGen defns itemSchema
69 return . Array $ V.fromList generatedArray
67 return . Array $ V.fromList generatedArray
70− OpenApiItemsArray refs ->
68+ SwaggerItemsArray refs ->
71 let itemGens = schemaGen defns . dereference defns <$> refs
69 let itemGens = schemaGen defns . dereference defns <$> refs
72 in fmap (Array . V.fromList) $ sequence itemGens
70 in fmap (Array . V.fromList) $ sequence itemGens
73− Just OpenApiString -> do
71+ Just SwaggerString -> do
74 size <- getSize
72 size <- getSize
75 let minLength' = fromMaybe 0 $ fromInteger <$> schema ^. minLength
73 let minLength' = fromMaybe 0 $ fromInteger <$> schema ^. minLength
76 let maxLength' = fromMaybe size $ fromInteger <$> schema ^. maxLength
74 let maxLength' = fromMaybe size $ fromInteger <$> schema ^. maxLength
77 length <- choose (minLength', max minLength' maxLength')
75 length <- choose (minLength', max minLength' maxLength')
78 str <- vectorOf length arbitrary
76 str <- vectorOf length arbitrary
79 return . String $ T.pack str
77 return . String $ T.pack str
80− Just OpenApiObject -> do
78+ Just SwaggerObject -> do
81 size <- getSize
79 size <- getSize
82 let props = dereference defns <$> schema ^. properties
80 let props = dereference defns <$> schema ^. properties
83 reqKeys = S.fromList $ schema ^. required
81 reqKeys = S.fromList $ schema ^. required
@@ -97,7 +95,7 @@ schemaGen defns schema =
97 return . M.fromList $ zip additionalKeys (repeat . schemaGen defns $ dereference defns addlSchema)
95 return . M.fromList $ zip additionalKeys (repeat . schemaGen defns $ dereference defns addlSchema)
98 _ -> return []
96 _ -> return []
99 x <- sequence $ gens <> additionalGens
97 x <- sequence $ gens <> additionalGens
100− return . Object $ fromInsOrdHashMap x
98+ return . Object $ M.toHashMap x
101
99
102dereference :: Definitions a -> Referenced a -> a
100dereference :: Definitions a -> Referenced a -> a
103dereference _ (Inline a) = a
101dereference _ (Inline a) = a
src/Data/OpenApi/Schema/Validation.hs → src/Data/Swagger/Schema/Validation.hsrenamed+7−7
@@ -1,10 +1,10 @@
1-- |
1-- |
2−-- Module: Data.OpenApi.Schema.Validation
2+-- Module: Data.Swagger.Schema.Validation
3-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
3-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
4-- Stability: experimental
4-- Stability: experimental
5--
5--
6-- Validate JSON values with Swagger Schema.
6-- Validate JSON values with Swagger Schema.
7−module Data.OpenApi.Schema.Validation (
7+module Data.Swagger.Schema.Validation (
8 -- * How to use validation
8 -- * How to use validation
9 -- $howto
9 -- $howto
10
10
@@ -29,13 +29,13 @@ module Data.OpenApi.Schema.Validation (
29 validateJSONWithPatternChecker,
29 validateJSONWithPatternChecker,
30) where
30) where
31
31
32−import Data.OpenApi.Internal.Schema.Validation
32+import Data.Swagger.Internal.Schema.Validation
33
33
34-- $setup
34-- $setup
35-- >>> import Control.Lens
35-- >>> import Control.Lens
36-- >>> import Data.Aeson
36-- >>> import Data.Aeson
37-- >>> import Data.Proxy
37-- >>> import Data.Proxy
38−-- >>> import Data.OpenApi
38+-- >>> import Data.Swagger
39-- >>> import GHC.Generics
39-- >>> import GHC.Generics
40-- >>> :set -XDeriveGeneric
40-- >>> :set -XDeriveGeneric
41
41
@@ -71,11 +71,11 @@ import Data.OpenApi.Internal.Schema.Validation
71-- generally fails for @null@ JSON:
71-- generally fails for @null@ JSON:
72--
72--
73-- >>> validateToJSON (Nothing :: Maybe String)
73-- >>> validateToJSON (Nothing :: Maybe String)
74−-- ["expected JSON value of type OpenApiString"]
74+-- ["expected JSON value of type SwaggerString"]
75-- >>> validateToJSON ([Just "hello", Nothing] :: [Maybe String])
75-- >>> validateToJSON ([Just "hello", Nothing] :: [Maybe String])
76−-- ["expected JSON value of type OpenApiString"]
76+-- ["expected JSON value of type SwaggerString"]
77-- >>> validateToJSON (123, Nothing :: Maybe String)
77-- >>> validateToJSON (123, Nothing :: Maybe String)
78−-- ["expected JSON value of type OpenApiString"]
78+-- ["expected JSON value of type SwaggerString"]
79--
79--
80-- However, when @'Maybe' a@ is a type of a record field,
80-- However, when @'Maybe' a@ is a type of a record field,
81-- validation takes @'required'@ property of the @'Schema'@
81-- validation takes @'required'@ property of the @'Schema'@
src/Data/OpenApi/SchemaOptions.hs → src/Data/Swagger/SchemaOptions.hsrenamed+2−2
@@ -1,11 +1,11 @@
1{-# LANGUAGE RecordWildCards #-}
1{-# LANGUAGE RecordWildCards #-}
2-- |
2-- |
3−-- Module: Data.OpenApi.SchemaOptions
3+-- Module: Data.Swagger.SchemaOptions
4-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
4-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
5-- Stability: experimental
5-- Stability: experimental
6--
6--
7-- Generic deriving options for @'ToParamSchema'@ and @'ToSchema'@.
7-- Generic deriving options for @'ToParamSchema'@ and @'ToSchema'@.
8−module Data.OpenApi.SchemaOptions where
8+module Data.Swagger.SchemaOptions where
9
9
10import qualified Data.Aeson.Types as Aeson
10import qualified Data.Aeson.Types as Aeson
11
11
stack.yaml+1−1
@@ -1,4 +1,4 @@
1−resolver: lts-16.31
1+resolver: lts-15.1
2packages:
2packages:
3- '.'
3- '.'
4extra-deps:
4extra-deps:
openapi3.cabal → swagger2.cabalrenamed+52−62
@@ -1,22 +1,22 @@
1cabal-version: >=1.10
1cabal-version: >=1.10
2−name: openapi3
2+name: swagger2
3−version: 3.2.2
3+version: 2.6.1
4
4
5−synopsis: OpenAPI 3.0 data model
5+synopsis: Swagger 2.0 data model
6−category: Web, Swagger, OpenApi
6+category: Web, Swagger
7description:
7description:
8− This library is intended to be used for decoding and encoding OpenAPI 3.0 API
8+ This library is intended to be used for decoding and encoding Swagger 2.0 API
9 specifications as well as manipulating them.
9 specifications as well as manipulating them.
10 .
10 .
11− The original OpenAPI 3.0 specification is available at http://swagger.io/specification/.
11+ The original Swagger 2.0 specification is available at http://swagger.io/specification/.
12
12
13−homepage: https://github.com/biocad/openapi3
13+homepage: https://github.com/GetShopTV/swagger2
14−bug-reports: https://github.com/biocad/openapi3/issues
14+bug-reports: https://github.com/GetShopTV/swagger2/issues
15license: BSD3
15license: BSD3
16license-file: LICENSE
16license-file: LICENSE
17−author: Nickolay Kudasov, Maxim Koltsov
17+author: Nickolay Kudasov
18−maintainer: nickolay@getshoptv.com, kolmax94@gmail.com
18+maintainer: nickolay@getshoptv.com
19−copyright: (c) 2015-2016, GetShopTV, (c) 2020, Biocad
19+copyright: (c) 2015-2016, GetShopTV
20build-type: Custom
20build-type: Custom
21extra-source-files:
21extra-source-files:
22 README.md
22 README.md
@@ -25,10 +25,8 @@ extra-source-files:
25tested-with:
25tested-with:
26 GHC ==8.4.4
26 GHC ==8.4.4
27 || ==8.6.5
27 || ==8.6.5
28− || ==8.8.4
28+ || ==8.8.3
29− || ==8.10.7
29+ || ==8.10.1
30− || ==9.0.2
31− || ==9.2.2
32
30
33custom-setup
31custom-setup
34 setup-depends:
32 setup-depends:
@@ -37,56 +35,54 @@ custom-setup
37library
35library
38 hs-source-dirs: src
36 hs-source-dirs: src
39 exposed-modules:
37 exposed-modules:
40− Data.OpenApi
38+ Data.Swagger
41− Data.OpenApi.Declare
39+ Data.Swagger.Declare
42− Data.OpenApi.Lens
40+ Data.Swagger.Lens
43− Data.OpenApi.Operation
41+ Data.Swagger.Operation
44− Data.OpenApi.Optics
42+ Data.Swagger.Optics
45− Data.OpenApi.ParamSchema
43+ Data.Swagger.ParamSchema
46− Data.OpenApi.Schema
44+ Data.Swagger.Schema
47− Data.OpenApi.Schema.Generator
45+ Data.Swagger.Schema.Generator
48− Data.OpenApi.Schema.Validation
46+ Data.Swagger.Schema.Validation
49− Data.OpenApi.SchemaOptions
47+ Data.Swagger.SchemaOptions
50
48
51 -- internal modules
49 -- internal modules
52− Data.OpenApi.Internal
50+ Data.Swagger.Internal
53− Data.OpenApi.Internal.Schema
51+ Data.Swagger.Internal.Schema
54− Data.OpenApi.Internal.Schema.Validation
52+ Data.Swagger.Internal.Schema.Validation
55− Data.OpenApi.Internal.ParamSchema
53+ Data.Swagger.Internal.ParamSchema
56− Data.OpenApi.Internal.Utils
54+ Data.Swagger.Internal.Utils
57− Data.OpenApi.Internal.AesonUtils
55+ Data.Swagger.Internal.AesonUtils
58− Data.OpenApi.Internal.TypeShape
56+ Data.Swagger.Internal.TypeShape
59−
60− Data.OpenApi.Aeson.Compat
61
57
62 -- GHC boot libraries
58 -- GHC boot libraries
63 build-depends:
59 build-depends:
64− base >=4.11.1.0 && <4.17
60+ base >=4.11.1.0 && <4.15
65− , bytestring >=0.10.8.2 && <0.12
61+ , bytestring >=0.10.8.2 && <0.11
66 , containers >=0.5.11.0 && <0.7
62 , containers >=0.5.11.0 && <0.7
67− , template-haskell >=2.13.0.0 && <2.19
63+ , template-haskell >=2.13.0.0 && <2.17
68− , time >=1.8.0.2 && <1.14
64+ , time >=1.8.0.2 && <1.10
69 , transformers >=0.5.5.0 && <0.6
65 , transformers >=0.5.5.0 && <0.6
70
66
71 build-depends:
67 build-depends:
72 mtl >=2.2.2 && <2.3
68 mtl >=2.2.2 && <2.3
73− , text >=1.2.3.1 && <2.1
69+ , text >=1.2.3.1 && <1.3
74
70
75 -- other dependencies
71 -- other dependencies
76 build-depends:
72 build-depends:
77− base-compat-batteries >=0.11.1 && <0.13
73+ base-compat-batteries >=0.11.1 && <0.12
78− , aeson >=1.4.2.0 && <1.6 || >=2.0.1.0 && < 2.1
74+ , aeson >=1.4.2.0 && <1.6
79 , aeson-pretty >=0.8.7 && <0.9
75 , aeson-pretty >=0.8.7 && <0.9
80 -- cookie 0.4.3 is needed by GHC 7.8 due to time>=1.4 constraint
76 -- cookie 0.4.3 is needed by GHC 7.8 due to time>=1.4 constraint
81 , cookie >=0.4.3 && <0.5
77 , cookie >=0.4.3 && <0.5
82 , generics-sop >=0.5.1.0 && <0.6
78 , generics-sop >=0.5.1.0 && <0.6
83− , hashable >=1.2.7.0 && <1.5
79+ , hashable >=1.2.7.0 && <1.4
84 , http-media >=0.8.0.0 && <0.9
80 , http-media >=0.8.0.0 && <0.9
85 , insert-ordered-containers >=0.2.3 && <0.3
81 , insert-ordered-containers >=0.2.3 && <0.3
86− , lens >=4.16.1 && <5.2
82+ , lens >=4.16.1 && <4.20
87 , network >=2.6.3.5 && <3.2
83 , network >=2.6.3.5 && <3.2
88− , optics-core >=0.2 && <0.5
84+ , optics-core >=0.2 && <0.4
89− , optics-th >=0.2 && <0.5
85+ , optics-th >=0.2 && <0.4
90 , scientific >=0.3.6.2 && <0.4
86 , scientific >=0.3.6.2 && <0.4
91 , unordered-containers >=0.2.9.0 && <0.3
87 , unordered-containers >=0.2.9.0 && <0.3
92 , uuid-types >=1.0.3 && <1.1
88 , uuid-types >=1.0.3 && <1.1
@@ -104,7 +100,7 @@ test-suite spec
104 -- We need aeson's toEncoding for doctests too
100 -- We need aeson's toEncoding for doctests too
105 build-depends:
101 build-depends:
106 base
102 base
107− , QuickCheck
103+ , swagger2
108 , aeson
104 , aeson
109 , base-compat-batteries
105 , base-compat-batteries
110 , bytestring
106 , bytestring
@@ -113,32 +109,32 @@ test-suite spec
113 , insert-ordered-containers
109 , insert-ordered-containers
114 , lens
110 , lens
115 , mtl
111 , mtl
116− , openapi3
117 , template-haskell
112 , template-haskell
118 , text
113 , text
119 , time
114 , time
120 , unordered-containers
115 , unordered-containers
121 , vector
116 , vector
117+ , QuickCheck
122
118
123 -- test-suite only dependencies
119 -- test-suite only dependencies
124 build-depends:
120 build-depends:
125− hspec >=2.5.5 && <2.10
121+ hspec >=2.5.5 && <2.8
126 , HUnit >=1.6.0.0 && <1.7
122 , HUnit >=1.6.0.0 && <1.7
127 , quickcheck-instances >=0.3.19 && <0.14
123 , quickcheck-instances >=0.3.19 && <0.14
128 , utf8-string >=1.0.1.1 && <1.1
124 , utf8-string >=1.0.1.1 && <1.1
129
125
130 -- https://github.com/haskell/cabal/issues/3708
126 -- https://github.com/haskell/cabal/issues/3708
131 build-tool-depends:
127 build-tool-depends:
132− hspec-discover:hspec-discover >=2.5.5 && <2.10
128+ hspec-discover:hspec-discover >=2.5.5 && <2.8
133
129
134 other-modules:
130 other-modules:
135 SpecCommon
131 SpecCommon
136− Data.OpenApiSpec
132+ Data.SwaggerSpec
137− Data.OpenApi.CommonTestTypes
133+ Data.Swagger.CommonTestTypes
138− Data.OpenApi.ParamSchemaSpec
134+ Data.Swagger.ParamSchemaSpec
139− Data.OpenApi.SchemaSpec
135+ Data.Swagger.SchemaSpec
140− Data.OpenApi.Schema.ValidationSpec
136+ Data.Swagger.Schema.ValidationSpec
141− Data.OpenApi.Schema.GeneratorSpec
137+ Data.Swagger.Schema.GeneratorSpec
142 default-language: Haskell2010
138 default-language: Haskell2010
143
139
144test-suite doctests
140test-suite doctests
@@ -149,12 +145,6 @@ test-suite doctests
149 main-is: doctests.hs
145 main-is: doctests.hs
150 type: exitcode-stdio-1.0
146 type: exitcode-stdio-1.0
151
147
152−executable example
153− hs-source-dirs: examples
154− main-is: hackage.hs
155− default-language: Haskell2010
156− build-depends: base, aeson, lens, openapi3, text
157−
158source-repository head
148source-repository head
159 type: git
149 type: git
160− location: https://github.com/biocad/openapi3.git
150+ location: https://github.com/GetShopTV/swagger2.git
test/Data/OpenApi/CommonTestTypes.hs → test/Data/Swagger/CommonTestTypes.hsrenamed+2−125
@@ -2,7 +2,7 @@
2{-# LANGUAGE QuasiQuotes #-}
2{-# LANGUAGE QuasiQuotes #-}
3{-# LANGUAGE ScopedTypeVariables #-}
3{-# LANGUAGE ScopedTypeVariables #-}
4
4
5−module Data.OpenApi.CommonTestTypes where
5+module Data.Swagger.CommonTestTypes where
6
6
7import Prelude ()
7import Prelude ()
8import Prelude.Compat
8import Prelude.Compat
@@ -18,7 +18,7 @@ import qualified Data.Text as Text
18import Data.Word
18import Data.Word
19import GHC.Generics
19import GHC.Generics
20
20
21−import Data.OpenApi
21+import Data.Swagger
22
22
23-- ========================================================================
23-- ========================================================================
24-- Unit type
24-- Unit type
@@ -863,129 +863,6 @@ singleMaybeFieldSchemaJSON = [aesonQQ|
863}
863}
864|]
864|]
865
865
866−-- ========================================================================
867−-- Natural Language (single field data with recursive fields)
868−-- ========================================================================
869−
870−data Predicate
871− = PredicateNoun Noun
872− | PredicateOmitted Omitted
873− deriving (Eq, Ord, Read, Show, Generic)
874−instance ToJSON Predicate
875−instance ToSchema Predicate
876−
877−data Noun
878− = Noun
879− { nounSurf :: LangWord
880− , nounModify :: [Modifier]
881− }
882− deriving (Eq, Ord, Read, Show, Generic)
883−instance ToJSON Noun
884−instance ToSchema Noun
885−
886−data LangWord
887− = LangWord
888− { langWordSurf :: String
889− , langWordBase :: String
890− }
891− deriving (Eq, Ord, Read, Show, Generic)
892−instance ToJSON LangWord
893−instance ToSchema LangWord
894−
895−data Modifier
896− = ModifierNoun Noun
897− | ModifierOmitted Omitted
898− deriving (Eq, Ord, Read, Show, Generic)
899−instance ToJSON Modifier
900−instance ToSchema Modifier
901−
902−newtype Omitted
903− = Omitted
904− { omittedModify :: [Modifier]
905− }
906− deriving (Eq, Ord, Read, Show, Generic)
907−instance ToJSON Omitted
908−instance ToSchema Omitted
909−
910−predicateSchemaDeclareJSON :: Value
911−predicateSchemaDeclareJSON = [aesonQQ|
912−[
913− {
914− "Predicate": {
915− "oneOf": [
916− {
917− "properties": {
918− "contents": { "$ref": "#/components/schemas/Noun" },
919− "tag": { "enum": ["PredicateNoun"], "type": "string" }
920− },
921− "required": ["tag", "contents"],
922− "type": "object"
923− },
924− {
925− "properties": {
926− "contents": { "$ref": "#/components/schemas/Omitted" },
927− "tag": { "enum": ["PredicateOmitted"], "type": "string" }
928− },
929− "required": ["tag", "contents"],
930− "type": "object"
931− }
932− ],
933− "type": "object"
934− },
935− "Noun": {
936− "properties": {
937− "nounModify": {
938− "items": { "$ref": "#/components/schemas/Modifier" },
939− "type": "array"
940− },
941− "nounSurf": { "$ref": "#/components/schemas/LangWord" }
942− },
943− "required": ["nounSurf", "nounModify"],
944− "type": "object"
945− },
946− "LangWord": {
947− "properties": {
948− "langWordBase": { "type": "string" },
949− "langWordSurf": { "type": "string" }
950− },
951− "required": ["langWordSurf", "langWordBase"],
952− "type": "object"
953− },
954− "Modifier": {
955− "oneOf": [
956− {
957− "properties": {
958− "contents": { "$ref": "#/components/schemas/Noun" },
959− "tag": { "enum": ["ModifierNoun"], "type": "string" }
960− },
961− "required": ["tag", "contents"],
962− "type": "object"
963− },
964− {
965− "properties": {
966− "contents": { "$ref": "#/components/schemas/Omitted" },
967− "tag": { "enum": ["ModifierOmitted"], "type": "string" }
968− },
969− "required": ["tag", "contents"],
970− "type": "object"
971− }
972− ],
973− "type": "object"
974− },
975− "Omitted": {
976− "properties": {
977− "omittedModify": {
978− "items": { "$ref": "#/components/schemas/Modifier" },
979− "type": "array"
980− }
981− },
982− "required": ["omittedModify"],
983− "type": "object"
984− }
985− },
986− { "$ref": "#/components/schemas/Predicate" }
987−]
988−|]
989
866
990-- ========================================================================
867-- ========================================================================
991-- TimeOfDay
868-- TimeOfDay
test/Data/OpenApi/ParamSchemaSpec.hs → test/Data/Swagger/ParamSchemaSpec.hsrenamed+4−4
@@ -4,7 +4,7 @@
4{-# LANGUAGE TemplateHaskell #-}
4{-# LANGUAGE TemplateHaskell #-}
5{-# LANGUAGE QuasiQuotes #-}
5{-# LANGUAGE QuasiQuotes #-}
6{-# LANGUAGE OverloadedStrings #-}
6{-# LANGUAGE OverloadedStrings #-}
7−module Data.OpenApi.ParamSchemaSpec where
7+module Data.Swagger.ParamSchemaSpec where
8
8
9import Data.Aeson
9import Data.Aeson
10import Data.Aeson.QQ.Simple
10import Data.Aeson.QQ.Simple
@@ -12,9 +12,9 @@ import Data.Char
12import Data.Proxy
12import Data.Proxy
13import GHC.Generics
13import GHC.Generics
14
14
15−import Data.OpenApi
15+import Data.Swagger
16
16
17−import Data.OpenApi.CommonTestTypes
17+import Data.Swagger.CommonTestTypes
18import SpecCommon
18import SpecCommon
19import Test.Hspec
19import Test.Hspec
20import Data.Time.LocalTime
20import Data.Time.LocalTime
@@ -22,7 +22,7 @@ import Data.Time.LocalTime
22import qualified Data.HashMap.Strict as HM
22import qualified Data.HashMap.Strict as HM
23
23
24checkToParamSchema :: ToParamSchema a => Proxy a -> Value -> Spec
24checkToParamSchema :: ToParamSchema a => Proxy a -> Value -> Spec
25−checkToParamSchema proxy js = (toParamSchema proxy :: Schema) <=> js
25+checkToParamSchema proxy js = (toParamSchema proxy :: ParamSchema) <=> js
26
26
27spec :: Spec
27spec :: Spec
28spec = do
28spec = do
test/Data/OpenApi/Schema/GeneratorSpec.hs → test/Data/Swagger/Schema/GeneratorSpec.hsrenamed+7−7
@@ -1,13 +1,13 @@
1{-# LANGUAGE OverloadedLists #-}
1{-# LANGUAGE OverloadedLists #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3{-# LANGUAGE PackageImports #-}
3{-# LANGUAGE PackageImports #-}
4−module Data.OpenApi.Schema.GeneratorSpec where
4+module Data.Swagger.Schema.GeneratorSpec where
5
5
6import Prelude ()
6import Prelude ()
7import Prelude.Compat
7import Prelude.Compat
8
8
9−import Data.OpenApi
9+import Data.Swagger
10−import Data.OpenApi.Schema.Generator
10+import Data.Swagger.Schema.Generator
11
11
12import Control.Lens.Operators
12import Control.Lens.Operators
13import Data.Aeson
13import Data.Aeson
@@ -103,7 +103,7 @@ instance FromJSON WrongType where
103instance ToSchema WrongType where
103instance ToSchema WrongType where
104 declareNamedSchema _ = return . NamedSchema (Just "WrongType") $
104 declareNamedSchema _ = return . NamedSchema (Just "WrongType") $
105 mempty
105 mempty
106− & type_ ?~ OpenApiObject
106+ & type_ ?~ SwaggerObject
107
107
108
108
109data MissingRequired = MissingRequired
109data MissingRequired = MissingRequired
@@ -123,7 +123,7 @@ instance ToSchema MissingRequired where
123 boolSchema <- declareSchemaRef (Proxy :: Proxy Bool)
123 boolSchema <- declareSchemaRef (Proxy :: Proxy Bool)
124 return . NamedSchema (Just "MissingRequired") $
124 return . NamedSchema (Just "MissingRequired") $
125 mempty
125 mempty
126− & type_ ?~ OpenApiObject
126+ & type_ ?~ SwaggerObject
127 & properties .~ [("propA", stringSchema)
127 & properties .~ [("propA", stringSchema)
128 ,("propB", boolSchema)
128 ,("propB", boolSchema)
129 ]
129 ]
@@ -145,7 +145,7 @@ instance ToSchema MissingProperty where
145 stringSchema <- declareSchemaRef (Proxy :: Proxy String)
145 stringSchema <- declareSchemaRef (Proxy :: Proxy String)
146 return . NamedSchema (Just "MissingProperty") $
146 return . NamedSchema (Just "MissingProperty") $
147 mempty
147 mempty
148− & type_ ?~ OpenApiObject
148+ & type_ ?~ SwaggerObject
149 & properties .~ [("propC", stringSchema)]
149 & properties .~ [("propC", stringSchema)]
150 & required .~ ["propC"]
150 & required .~ ["propC"]
151
151
@@ -163,6 +163,6 @@ instance ToSchema WrongPropType where
163 boolSchema <- declareSchemaRef (Proxy :: Proxy Bool)
163 boolSchema <- declareSchemaRef (Proxy :: Proxy Bool)
164 return . NamedSchema (Just "WrongPropType") $
164 return . NamedSchema (Just "WrongPropType") $
165 mempty
165 mempty
166− & type_ ?~ OpenApiObject
166+ & type_ ?~ SwaggerObject
167 & properties .~ [("propE", boolSchema)]
167 & properties .~ [("propE", boolSchema)]
168 & required .~ ["propE"]
168 & required .~ ["propE"]
test/Data/OpenApi/Schema/ValidationSpec.hs → test/Data/Swagger/Schema/ValidationSpec.hsrenamed+10−27
@@ -1,18 +1,13 @@
1−{-# LANGUAGE CPP #-}
2{-# LANGUAGE DeriveGeneric #-}
1{-# LANGUAGE DeriveGeneric #-}
3{-# LANGUAGE PackageImports #-}
2{-# LANGUAGE PackageImports #-}
4{-# LANGUAGE RecordWildCards #-}
3{-# LANGUAGE RecordWildCards #-}
5{-# LANGUAGE ScopedTypeVariables #-}
4{-# LANGUAGE ScopedTypeVariables #-}
6{-# OPTIONS_GHC -fno-warn-orphans #-}
5{-# OPTIONS_GHC -fno-warn-orphans #-}
7−module Data.OpenApi.Schema.ValidationSpec where
6+module Data.Swagger.Schema.ValidationSpec where
8
7
9import Control.Applicative
8import Control.Applicative
10import Control.Lens ((&), (.~), (?~))
9import Control.Lens ((&), (.~), (?~))
11import Data.Aeson
10import Data.Aeson
12−#if MIN_VERSION_aeson(2,0,0)
13−import qualified Data.Aeson.Key as Key
14−import qualified Data.Aeson.KeyMap as KeyMap
15−#endif
16import Data.Aeson.Types
11import Data.Aeson.Types
17import Data.Hashable (Hashable)
12import Data.Hashable (Hashable)
18import Data.HashMap.Strict (HashMap)
13import Data.HashMap.Strict (HashMap)
@@ -33,9 +28,8 @@ import Data.Version (Version)
33import Data.Word
28import Data.Word
34import GHC.Generics
29import GHC.Generics
35
30
36−import Data.OpenApi
31+import Data.Swagger
37−import Data.OpenApi.Declare
32+import Data.Swagger.Declare
38−import Data.OpenApi.Aeson.Compat (stringToKey)
39
33
40import Test.Hspec
34import Test.Hspec
41import Test.Hspec.QuickCheck
35import Test.Hspec.QuickCheck
@@ -130,9 +124,9 @@ instance Arbitrary Person where
130
124
131invalidPersonToJSON :: Person -> Value
125invalidPersonToJSON :: Person -> Value
132invalidPersonToJSON Person{..} = object
126invalidPersonToJSON Person{..} = object
133− [ stringToKey "personName" .= toJSON name
127+ [ T.pack "personName" .= toJSON name
134− , stringToKey "personPhone" .= toJSON phone
128+ , T.pack "personPhone" .= toJSON phone
135− , stringToKey "personEmail" .= toJSON email
129+ , T.pack "personEmail" .= toJSON email
136 ]
130 ]
137
131
138-- ========================================================================
132-- ========================================================================
@@ -196,7 +190,7 @@ instance Arbitrary MyRoseTree where
196data Light = NoLight | LightFreq Double | LightColor Color deriving (Show, Generic)
190data Light = NoLight | LightFreq Double | LightColor Color deriving (Show, Generic)
197
191
198instance ToSchema Light where
192instance ToSchema Light where
199− declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions { Data.OpenApi.sumEncoding = ObjectWithSingleField }
193+ declareNamedSchema = genericDeclareNamedSchema defaultSchemaOptions { Data.Swagger.sumEncoding = ObjectWithSingleField }
200
194
201instance ToJSON Light where
195instance ToJSON Light where
202 toJSON = genericToJSON defaultOptions { Data.Aeson.Types.sumEncoding = ObjectWithSingleField }
196 toJSON = genericToJSON defaultOptions { Data.Aeson.Types.sumEncoding = ObjectWithSingleField }
@@ -221,7 +215,7 @@ instance ToJSON LightTaggedObject where
221
215
222instance ToSchema LightTaggedObject where
216instance ToSchema LightTaggedObject where
223 declareNamedSchema _ =
217 declareNamedSchema _ =
224− genericDeclareNamedSchema defaultSchemaOptions { Data.OpenApi.sumEncoding = defaultTaggedObject } (Proxy :: Proxy Light)
218+ genericDeclareNamedSchema defaultSchemaOptions { Data.Swagger.sumEncoding = defaultTaggedObject } (Proxy :: Proxy Light)
225
219
226instance Arbitrary LightTaggedObject where
220instance Arbitrary LightTaggedObject where
227 arbitrary = LightTaggedObject <$> arbitrary
221 arbitrary = LightTaggedObject <$> arbitrary
@@ -234,7 +228,7 @@ instance ToJSON LightUntaggedValue where
234
228
235instance ToSchema LightUntaggedValue where
229instance ToSchema LightUntaggedValue where
236 declareNamedSchema _ =
230 declareNamedSchema _ =
237− genericDeclareNamedSchema defaultSchemaOptions { Data.OpenApi.sumEncoding = UntaggedValue } (Proxy :: Proxy Light)
231+ genericDeclareNamedSchema defaultSchemaOptions { Data.Swagger.sumEncoding = UntaggedValue } (Proxy :: Proxy Light)
238
232
239instance Arbitrary LightUntaggedValue where
233instance Arbitrary LightUntaggedValue where
240 arbitrary = LightUntaggedValue <$> arbitrary
234 arbitrary = LightUntaggedValue <$> arbitrary
@@ -283,7 +277,7 @@ instance ToJSON FreeForm where
283
277
284instance ToSchema FreeForm where
278instance ToSchema FreeForm where
285 declareNamedSchema _ = pure $ NamedSchema (Just $ T.pack "FreeForm") $ mempty
279 declareNamedSchema _ = pure $ NamedSchema (Just $ T.pack "FreeForm") $ mempty
286− & type_ ?~ OpenApiObject
280+ & type_ ?~ SwaggerObject
287 & additionalProperties ?~ AdditionalPropertiesAllowed True
281 & additionalProperties ?~ AdditionalPropertiesAllowed True
288
282
289instance Arbitrary FreeForm where
283instance Arbitrary FreeForm where
@@ -301,8 +295,6 @@ instance Eq ZonedTime where
301-- Arbitrary instance for Data.Aeson.Value
295-- Arbitrary instance for Data.Aeson.Value
302-- ========================================================================
296-- ========================================================================
303
297
304−-- These instances were introduces in aeson upstream in 2.0.3
305−#if !MIN_VERSION_aeson(2,0,3)
306instance Arbitrary Value where
298instance Arbitrary Value where
307 -- Weights are almost random
299 -- Weights are almost random
308 -- Uniform oneof tends not to build complex objects cause of recursive call.
300 -- Uniform oneof tends not to build complex objects cause of recursive call.
@@ -313,12 +305,3 @@ instance Arbitrary Value where
313 , (3, Number <$> arbitrary)
305 , (3, Number <$> arbitrary)
314 , (3, Bool <$> arbitrary)
306 , (3, Bool <$> arbitrary)
315 , (1, return Null) ]
307 , (1, return Null) ]
316−
317−#if MIN_VERSION_aeson(2,0,0)
318−instance Arbitrary v => Arbitrary (KeyMap.KeyMap v) where
319− arbitrary = KeyMap.fromList <$> arbitrary
320−
321−instance Arbitrary Key.Key where
322− arbitrary = Key.fromText <$> arbitrary
323−#endif
324−#endif
test/Data/OpenApi/SchemaSpec.hs → test/Data/Swagger/SchemaSpec.hsrenamed+4−8
@@ -2,7 +2,7 @@
2{-# LANGUAGE ScopedTypeVariables #-}
2{-# LANGUAGE ScopedTypeVariables #-}
3{-# LANGUAGE TemplateHaskell #-}
3{-# LANGUAGE TemplateHaskell #-}
4{-# LANGUAGE QuasiQuotes #-}
4{-# LANGUAGE QuasiQuotes #-}
5−module Data.OpenApi.SchemaSpec where
5+module Data.Swagger.SchemaSpec where
6
6
7import Prelude ()
7import Prelude ()
8import Prelude.Compat
8import Prelude.Compat
@@ -14,10 +14,10 @@ import Data.Proxy
14import Data.Set (Set)
14import Data.Set (Set)
15import qualified Data.Text as Text
15import qualified Data.Text as Text
16
16
17−import Data.OpenApi
17+import Data.Swagger
18−import Data.OpenApi.Declare
18+import Data.Swagger.Declare
19
19
20−import Data.OpenApi.CommonTestTypes
20+import Data.Swagger.CommonTestTypes
21import SpecCommon
21import SpecCommon
22import Test.Hspec
22import Test.Hspec
23
23
@@ -59,9 +59,6 @@ checkInlinedRecSchema proxy js = inlineNonRecursiveSchemas defs s <=> js
59 where
59 where
60 (defs, s) = runDeclare (declareSchema proxy) mempty
60 (defs, s) = runDeclare (declareSchema proxy) mempty
61
61
62−checkToSchemaDeclare :: (HasCallStack, ToSchema a) => Proxy a -> Value -> Spec
63−checkToSchemaDeclare proxy js = runDeclare (declareSchemaRef proxy) mempty <=> js
64−
65spec :: Spec
62spec :: Spec
66spec = do
63spec = do
67 describe "Generic ToSchema" $ do
64 describe "Generic ToSchema" $ do
@@ -81,7 +78,6 @@ spec = do
81 context "UserId (non-record newtype)" $ checkToSchema (Proxy :: Proxy UserId) userIdSchemaJSON
78 context "UserId (non-record newtype)" $ checkToSchema (Proxy :: Proxy UserId) userIdSchemaJSON
82 context "Player (unary record)" $ checkToSchema (Proxy :: Proxy Player) playerSchemaJSON
79 context "Player (unary record)" $ checkToSchema (Proxy :: Proxy Player) playerSchemaJSON
83 context "SingleMaybeField (unary record with Maybe)" $ checkToSchema (Proxy :: Proxy SingleMaybeField) singleMaybeFieldSchemaJSON
80 context "SingleMaybeField (unary record with Maybe)" $ checkToSchema (Proxy :: Proxy SingleMaybeField) singleMaybeFieldSchemaJSON
84− context "Natural Language (single field data with recursive fields)" $ checkToSchemaDeclare (Proxy :: Proxy Predicate) predicateSchemaDeclareJSON
85 context "Players (inlining schema)" $ checkToSchema (Proxy :: Proxy Players) playersSchemaJSON
81 context "Players (inlining schema)" $ checkToSchema (Proxy :: Proxy Players) playersSchemaJSON
86 context "MyRoseTree (datatypeNameModifier)" $ checkToSchema (Proxy :: Proxy MyRoseTree) myRoseTreeSchemaJSON
82 context "MyRoseTree (datatypeNameModifier)" $ checkToSchema (Proxy :: Proxy MyRoseTree) myRoseTreeSchemaJSON
87 context "MyRoseTree' (datatypeNameModifier)" $ checkToSchema (Proxy :: Proxy MyRoseTree') myRoseTreeSchemaJSON'
83 context "MyRoseTree' (datatypeNameModifier)" $ checkToSchema (Proxy :: Proxy MyRoseTree') myRoseTreeSchemaJSON'
test/Data/OpenApiSpec.hs → test/Data/SwaggerSpec.hsrenamed+36−52
@@ -2,7 +2,7 @@
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3{-# LANGUAGE ScopedTypeVariables #-}
3{-# LANGUAGE ScopedTypeVariables #-}
4{-# LANGUAGE QuasiQuotes #-}
4{-# LANGUAGE QuasiQuotes #-}
5−module Data.OpenApiSpec where
5+module Data.SwaggerSpec where
6
6
7import Prelude ()
7import Prelude ()
8import Prelude.Compat
8import Prelude.Compat
@@ -15,7 +15,7 @@ import Data.HashMap.Strict (HashMap)
15import qualified Data.HashSet.InsOrd as InsOrdHS
15import qualified Data.HashSet.InsOrd as InsOrdHS
16import Data.Text (Text)
16import Data.Text (Text)
17
17
18−import Data.OpenApi
18+import Data.Swagger
19import SpecCommon
19import SpecCommon
20import Test.Hspec hiding (example)
20import Test.Hspec hiding (example)
21
21
@@ -42,13 +42,9 @@ spec = do
42 context "Todo Example" $ swaggerExample <=> swaggerExampleJSON
42 context "Todo Example" $ swaggerExample <=> swaggerExampleJSON
43 context "PetStore Example" $ do
43 context "PetStore Example" $ do
44 it "decodes successfully" $ do
44 it "decodes successfully" $ do
45− fromJSON petstoreExampleJSON `shouldSatisfy` (\x -> case x of Success (_ :: OpenApi) -> True; _ -> False)
45+ fromJSON petstoreExampleJSON `shouldSatisfy` (\x -> case x of Success (_ :: Swagger) -> True; _ -> False)
46 it "roundtrips: fmap toJSON . fromJSON" $ do
46 it "roundtrips: fmap toJSON . fromJSON" $ do
47− (toJSON :: OpenApi -> Value) <$> fromJSON petstoreExampleJSON `shouldBe` Success petstoreExampleJSON
47+ (toJSON :: Swagger -> Value) <$> fromJSON petstoreExampleJSON `shouldBe` Success petstoreExampleJSON
48− context "Security schemes" $ do
49− it "merged correctly" $ do
50− let merged = oAuth2SecurityDefinitionsReadOpenApi <> oAuth2SecurityDefinitionsWriteOpenApi
51− merged `shouldBe` oAuth2SecurityDefinitionsOpenApi
52
48
53main :: IO ()
49main :: IO ()
54main = hspec spec
50main = hspec spec
@@ -136,15 +132,15 @@ operationExample = mempty
136 & description ?~ "ID of pet that needs to be updated"
132 & description ?~ "ID of pet that needs to be updated"
137 & required ?~ True
133 & required ?~ True
138 & in_ .~ ParamPath
134 & in_ .~ ParamPath
139− & schema ?~ Inline (mempty & type_ ?~ OpenApiString))]
135+ & schema ?~ Inline (mempty & type_ ?~ SwaggerString))]
140 & requestBody ?~ Inline (
136 & requestBody ?~ Inline (
141 mempty & content . at "application/x-www-form-urlencoded" ?~ (mempty & schema ?~ (Inline (mempty
137 mempty & content . at "application/x-www-form-urlencoded" ?~ (mempty & schema ?~ (Inline (mempty
142 & properties . at "petId" ?~ Inline (mempty
138 & properties . at "petId" ?~ Inline (mempty
143 & description ?~ "Updated name of the pet"
139 & description ?~ "Updated name of the pet"
144− & type_ ?~ OpenApiString)
140+ & type_ ?~ SwaggerString)
145 & properties . at "status" ?~ Inline (mempty
141 & properties . at "status" ?~ Inline (mempty
146 & description ?~ "Updated status of the pet"
142 & description ?~ "Updated status of the pet"
147− & type_ ?~ OpenApiString)))))
143+ & type_ ?~ SwaggerString)))))
148 & at 200 ?~ "Pet updated."
144 & at 200 ?~ "Pet updated."
149 & at 405 ?~ "Invalid input"
145 & at 405 ?~ "Invalid input"
150 & security .~ [SecurityRequirement [("petstore_auth", ["write:pets", "read:pets"])]]
146 & security .~ [SecurityRequirement [("petstore_auth", ["write:pets", "read:pets"])]]
@@ -212,7 +208,7 @@ operationExampleJSON = [aesonQQ|
212
208
213schemaPrimitiveExample :: Schema
209schemaPrimitiveExample :: Schema
214schemaPrimitiveExample = mempty
210schemaPrimitiveExample = mempty
215− & type_ ?~ OpenApiString
211+ & type_ ?~ SwaggerString
216 & format ?~ "email"
212 & format ?~ "email"
217
213
218schemaPrimitiveExampleJSON :: Value
214schemaPrimitiveExampleJSON :: Value
@@ -225,14 +221,14 @@ schemaPrimitiveExampleJSON = [aesonQQ|
225
221
226schemaSimpleModelExample :: Schema
222schemaSimpleModelExample :: Schema
227schemaSimpleModelExample = mempty
223schemaSimpleModelExample = mempty
228− & type_ ?~ OpenApiObject
224+ & type_ ?~ SwaggerObject
229 & required .~ [ "name" ]
225 & required .~ [ "name" ]
230 & properties .~
226 & properties .~
231− [ ("name", Inline (mempty & type_ ?~ OpenApiString))
227+ [ ("name", Inline (mempty & type_ ?~ SwaggerString))
232 , ("address", Ref (Reference "Address"))
228 , ("address", Ref (Reference "Address"))
233 , ("age", Inline $ mempty
229 , ("age", Inline $ mempty
234 & minimum_ ?~ 0
230 & minimum_ ?~ 0
235− & type_ ?~ OpenApiInteger
231+ & type_ ?~ SwaggerInteger
236 & format ?~ "int32" ) ]
232 & format ?~ "int32" ) ]
237
233
238schemaSimpleModelExampleJSON :: Value
234schemaSimpleModelExampleJSON :: Value
@@ -257,8 +253,8 @@ schemaSimpleModelExampleJSON = [aesonQQ|
257
253
258schemaModelDictExample :: Schema
254schemaModelDictExample :: Schema
259schemaModelDictExample = mempty
255schemaModelDictExample = mempty
260− & type_ ?~ OpenApiObject
256+ & type_ ?~ SwaggerObject
261− & additionalProperties ?~ AdditionalPropertiesSchema (Inline (mempty & type_ ?~ OpenApiString))
257+ & additionalProperties ?~ AdditionalPropertiesSchema (Inline (mempty & type_ ?~ SwaggerString))
262
258
263schemaModelDictExampleJSON :: Value
259schemaModelDictExampleJSON :: Value
264schemaModelDictExampleJSON = [aesonQQ|
260schemaModelDictExampleJSON = [aesonQQ|
@@ -272,7 +268,7 @@ schemaModelDictExampleJSON = [aesonQQ|
272
268
273schemaAdditionalExample :: Schema
269schemaAdditionalExample :: Schema
274schemaAdditionalExample = mempty
270schemaAdditionalExample = mempty
275− & type_ ?~ OpenApiObject
271+ & type_ ?~ SwaggerObject
276 & additionalProperties ?~ AdditionalPropertiesAllowed True
272 & additionalProperties ?~ AdditionalPropertiesAllowed True
277
273
278schemaAdditionalExampleJSON :: Value
274schemaAdditionalExampleJSON :: Value
@@ -285,13 +281,13 @@ schemaAdditionalExampleJSON = [aesonQQ|
285
281
286schemaWithExampleExample :: Schema
282schemaWithExampleExample :: Schema
287schemaWithExampleExample = mempty
283schemaWithExampleExample = mempty
288− & type_ ?~ OpenApiObject
284+ & type_ ?~ SwaggerObject
289 & properties .~
285 & properties .~
290 [ ("id", Inline $ mempty
286 [ ("id", Inline $ mempty
291− & type_ ?~ OpenApiInteger
287+ & type_ ?~ SwaggerInteger
292 & format ?~ "int64" )
288 & format ?~ "int64" )
293 , ("name", Inline $ mempty
289 , ("name", Inline $ mempty
294− & type_ ?~ OpenApiString) ]
290+ & type_ ?~ SwaggerString) ]
295 & required .~ [ "name" ]
291 & required .~ [ "name" ]
296 & example ?~ [aesonQQ|
292 & example ?~ [aesonQQ|
297 {
293 {
@@ -330,19 +326,19 @@ schemaWithExampleExampleJSON = [aesonQQ|
330definitionsExample :: HashMap Text Schema
326definitionsExample :: HashMap Text Schema
331definitionsExample =
327definitionsExample =
332 [ ("Category", mempty
328 [ ("Category", mempty
333− & type_ ?~ OpenApiObject
329+ & type_ ?~ SwaggerObject
334 & properties .~
330 & properties .~
335 [ ("id", Inline $ mempty
331 [ ("id", Inline $ mempty
336− & type_ ?~ OpenApiInteger
332+ & type_ ?~ SwaggerInteger
337 & format ?~ "int64")
333 & format ?~ "int64")
338− , ("name", Inline (mempty & type_ ?~ OpenApiString)) ] )
334+ , ("name", Inline (mempty & type_ ?~ SwaggerString)) ] )
339 , ("Tag", mempty
335 , ("Tag", mempty
340− & type_ ?~ OpenApiObject
336+ & type_ ?~ SwaggerObject
341 & properties .~
337 & properties .~
342 [ ("id", Inline $ mempty
338 [ ("id", Inline $ mempty
343− & type_ ?~ OpenApiInteger
339+ & type_ ?~ SwaggerInteger
344 & format ?~ "int64")
340 & format ?~ "int64")
345− , ("name", Inline (mempty & type_ ?~ OpenApiString)) ] ) ]
341+ , ("name", Inline (mempty & type_ ?~ SwaggerString)) ] ) ]
346
342
347definitionsExampleJSON :: Value
343definitionsExampleJSON :: Value
348definitionsExampleJSON = [aesonQQ|
344definitionsExampleJSON = [aesonQQ|
@@ -386,7 +382,7 @@ paramsDefinitionExample =
386 & required ?~ True
382 & required ?~ True
387 & in_ .~ ParamQuery
383 & in_ .~ ParamQuery
388 & schema ?~ Inline (mempty
384 & schema ?~ Inline (mempty
389− & type_ ?~ OpenApiInteger
385+ & type_ ?~ SwaggerInteger
390 & format ?~ "int32" ))
386 & format ?~ "int32" ))
391 , ("limitParam", mempty
387 , ("limitParam", mempty
392 & name .~ "limit"
388 & name .~ "limit"
@@ -394,7 +390,7 @@ paramsDefinitionExample =
394 & required ?~ True
390 & required ?~ True
395 & in_ .~ ParamQuery
391 & in_ .~ ParamQuery
396 & schema ?~ Inline (mempty
392 & schema ?~ Inline (mempty
397− & type_ ?~ OpenApiInteger
393+ & type_ ?~ SwaggerInteger
398 & format ?~ "int32" )) ]
394 & format ?~ "int32" )) ]
399
395
400paramsDefinitionExampleJSON :: Value
396paramsDefinitionExampleJSON :: Value
@@ -445,7 +441,7 @@ responsesDefinitionExampleJSON = [aesonQQ|
445|]
441|]
446
442
447-- =======================================================================
443-- =======================================================================
448−-- Security Definition object
444+-- Responses Definition object
449-- =======================================================================
445-- =======================================================================
450
446
451securityDefinitionsExample :: SecurityDefinitions
447securityDefinitionsExample :: SecurityDefinitions
@@ -531,23 +527,11 @@ oAuth2SecurityDefinitionsExampleJSON = [aesonQQ|
531}
527}
532|]
528|]
533
529
534−oAuth2SecurityDefinitionsReadOpenApi :: OpenApi
535−oAuth2SecurityDefinitionsReadOpenApi =
536− mempty & components . securitySchemes .~ oAuth2SecurityDefinitionsReadExample
537−
538−oAuth2SecurityDefinitionsWriteOpenApi :: OpenApi
539−oAuth2SecurityDefinitionsWriteOpenApi =
540− mempty & components . securitySchemes .~ oAuth2SecurityDefinitionsWriteExample
541−
542−oAuth2SecurityDefinitionsOpenApi :: OpenApi
543−oAuth2SecurityDefinitionsOpenApi =
544− mempty & components . securitySchemes .~ oAuth2SecurityDefinitionsExample
545−
546-- =======================================================================
530-- =======================================================================
547-- Swagger object
531-- Swagger object
548-- =======================================================================
532-- =======================================================================
549
533
550−emptyPathsFieldExample :: OpenApi
534+emptyPathsFieldExample :: Swagger
551emptyPathsFieldExample = mempty
535emptyPathsFieldExample = mempty
552
536
553emptyPathsFieldExampleJSON :: Value
537emptyPathsFieldExampleJSON :: Value
@@ -560,7 +544,7 @@ emptyPathsFieldExampleJSON = [aesonQQ|
560}
544}
561|]
545|]
562
546
563−swaggerExample :: OpenApi
547+swaggerExample :: Swagger
564swaggerExample = mempty
548swaggerExample = mempty
565 -- & basePath ?~ "/"
549 -- & basePath ?~ "/"
566 -- & schemes ?~ [Http]
550 -- & schemes ?~ [Http]
@@ -575,7 +559,7 @@ swaggerExample = mempty
575 & description .~ "OK"
559 & description .~ "OK"
576 & content . at "application/json" ?~ (mempty
560 & content . at "application/json" ?~ (mempty
577 & schema ?~ Inline (mempty
561 & schema ?~ Inline (mempty
578− & type_ ?~ OpenApiObject
562+ & type_ ?~ SwaggerObject
579 & example ?~ [aesonQQ|
563 & example ?~ [aesonQQ|
580 {
564 {
581 "created": 100,
565 "created": 100,
@@ -584,9 +568,9 @@ swaggerExample = mempty
584 & description ?~ "This is some real Todo right here"
568 & description ?~ "This is some real Todo right here"
585 & properties .~
569 & properties .~
586 [ ("created", Inline $ mempty
570 [ ("created", Inline $ mempty
587− & type_ ?~ OpenApiInteger
571+ & type_ ?~ SwaggerInteger
588 & format ?~ "int32")
572 & format ?~ "int32")
589− , ("description", Inline (mempty & type_ ?~ OpenApiString))])))
573+ , ("description", Inline (mempty & type_ ?~ SwaggerString))])))
590 & parameters .~
574 & parameters .~
591 [ Inline $ mempty
575 [ Inline $ mempty
592 & required ?~ True
576 & required ?~ True
@@ -594,7 +578,7 @@ swaggerExample = mempty
594 & description ?~ "TodoId param"
578 & description ?~ "TodoId param"
595 & in_ .~ ParamPath
579 & in_ .~ ParamPath
596 & schema ?~ Inline (mempty
580 & schema ?~ Inline (mempty
597− & type_ ?~ OpenApiString ) ]
581+ & type_ ?~ SwaggerString ) ]
598 & tags .~ InsOrdHS.fromList [ "todo" ] ))
582 & tags .~ InsOrdHS.fromList [ "todo" ] ))
599
583
600swaggerExampleJSON :: Value
584swaggerExampleJSON :: Value
@@ -933,14 +917,14 @@ petstoreExampleJSON = [aesonQQ|
933
917
934compositionSchemaExample :: Schema
918compositionSchemaExample :: Schema
935compositionSchemaExample = mempty
919compositionSchemaExample = mempty
936− & type_ ?~ OpenApiObject
920+ & type_ ?~ SwaggerObject
937− & Data.OpenApi.allOf ?~ [
921+ & Data.Swagger.allOf ?~ [
938 Ref (Reference "Other")
922 Ref (Reference "Other")
939 , Inline (mempty
923 , Inline (mempty
940− & type_ ?~ OpenApiObject
924+ & type_ ?~ SwaggerObject
941 & properties .~
925 & properties .~
942 [ ("greet", Inline $ mempty
926 [ ("greet", Inline $ mempty
943− & type_ ?~ OpenApiString) ])
927+ & type_ ?~ SwaggerString) ])
944 ]
928 ]
945
929
946compositionSchemaExampleJSON :: Value
930compositionSchemaExampleJSON :: Value
test/SpecCommon.hs+8
@@ -8,6 +8,14 @@ import qualified Data.Vector as Vector
8
8
9import Test.Hspec
9import Test.Hspec
10
10
11+isSubJSON :: Value -> Value -> Bool
12+isSubJSON Null _ = True
13+isSubJSON (Object x) (Object y) = HashMap.keys x == HashMap.keys i && F.and i
14+ where
15+ i = HashMap.intersectionWith isSubJSON x y
16+isSubJSON (Array xs) (Array ys) = Vector.length xs == Vector.length ys && F.and (Vector.zipWith isSubJSON xs ys)
17+isSubJSON x y = x == y
18+
11(<=>) :: (Eq a, Show a, ToJSON a, FromJSON a, HasCallStack) => a -> Value -> Spec
19(<=>) :: (Eq a, Show a, ToJSON a, FromJSON a, HasCallStack) => a -> Value -> Spec
12x <=> js = do
20x <=> js = do
13 it "encodes correctly" $ do
21 it "encodes correctly" $ do