diff --git a/package.json b/package.json index 6488462275..646d112d1f 100644 --- a/package.json +++ b/package.json @@ -162,6 +162,7 @@ "jest": "27.5.1", "lint-staged": "13.0.3", "nock": "13.2.9", + "openapi-enforcer": "^1.21.0", "prettier": "2.7.1", "proxyquire": "2.1.3", "source-map-support": "0.5.21", diff --git a/src/test/e2e/api/openapi/openapi.e2e.test.ts b/src/test/e2e/api/openapi/openapi.e2e.test.ts index ab40fe249a..a3440668f7 100644 --- a/src/test/e2e/api/openapi/openapi.e2e.test.ts +++ b/src/test/e2e/api/openapi/openapi.e2e.test.ts @@ -1,6 +1,7 @@ import { setupApp } from '../../helpers/test-helper'; import dbInit from '../../helpers/database-init'; import getLogger from '../../../fixtures/no-logger'; +import enforcer from 'openapi-enforcer'; let app; let db; @@ -36,3 +37,20 @@ test('should serve the OpenAPI spec', async () => { expect(res.body).toMatchSnapshot(); }); }); + +test('the generated OpenAPI spec is valid', async () => { + const { body } = await app.request + .get('/docs/openapi.json') + .expect('Content-Type', /json/) + .expect(200); + + const [openapi, error, warning] = await enforcer(body, { + fullResult: true, + }); + + if (error !== undefined) console.error(error); + if (warning !== undefined) console.warn(warning); + if (openapi !== undefined) console.log('Document is valid'); + + expect(openapi).toBeTruthy(); +}); diff --git a/yarn.lock b/yarn.lock index 66919d6700..17e07e3a6a 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2664,6 +2664,11 @@ dotenv@^5.0.1: resolved "https://registry.npmjs.org/dotenv/-/dotenv-5.0.1.tgz" integrity sha512-4As8uPrjfwb7VXC+WnLCbXK7y+Ueb2B3zgNCePYfhxS1PYeaO1YTeplffTEcbfLhvFNGLAz90VvJs9yomG7bow== +drange@^1.0.2: + version "1.1.1" + resolved "https://registry.yarnpkg.com/drange/-/drange-1.1.1.tgz#b2aecec2aab82fcef11dbbd7b9e32b83f8f6c0b8" + integrity sha512-pYxfDYpued//QpnLIm4Avk7rsNtAtQkUES2cwAYSvD/wd2pKD71gN2Ebj3e7klzXwjocvE8c5vx/1fxwpqmSxA== + duplexer@~0.1.1: version "0.1.2" resolved "https://registry.npmjs.org/duplexer/-/duplexer-0.1.2.tgz" @@ -5954,6 +5959,14 @@ onetime@^6.0.0: dependencies: mimic-fn "^4.0.0" +openapi-enforcer@^1.21.0: + version "1.21.0" + resolved "https://registry.yarnpkg.com/openapi-enforcer/-/openapi-enforcer-1.21.0.tgz#5fa86fcbf57cf649ff195cb9a4f5c884a83c91db" + integrity sha512-5wUTQguI/xTq1a7gzi71X7IBzXw7Aw1fHLMDTVjPg3TrlYsYzMATjAaH80mfB91uptWIJYRPNptM3+uh4tW2pg== + dependencies: + js-yaml "^4.1.0" + randexp "^0.5.3" + openapi-types@^12.0.0: version "12.0.0" resolved "https://registry.yarnpkg.com/openapi-types/-/openapi-types-12.0.0.tgz#458a99d048f9eae1c067e15d56a8bfb3726041f1" @@ -6478,6 +6491,14 @@ quick-lru@^5.1.1: resolved "https://registry.npmjs.org/quick-lru/-/quick-lru-5.1.1.tgz" integrity sha512-WuyALRjWPDGtt/wzJiadO5AXY+8hZ80hVpe6MyivgraREW751X3SbhRvG3eLKOYN+8VEvqLcf3wdnt44Z4S4SA== +randexp@^0.5.3: + version "0.5.3" + resolved "https://registry.yarnpkg.com/randexp/-/randexp-0.5.3.tgz#f31c2de3148b30bdeb84b7c3f59b0ebb9fec3738" + integrity sha512-U+5l2KrcMNOUPYvazA3h5ekF80FHTUG+87SEAmHZmolh1M+i/WyTCxVzmi+tidIa1tM4BSe8g2Y/D3loWDjj+w== + dependencies: + drange "^1.0.2" + ret "^0.2.0" + random-bytes@~1.0.0: version "1.0.0" resolved "https://registry.npmjs.org/random-bytes/-/random-bytes-1.0.0.tgz" @@ -6730,6 +6751,11 @@ restore-cursor@^3.1.0: onetime "^5.1.0" signal-exit "^3.0.2" +ret@^0.2.0: + version "0.2.2" + resolved "https://registry.yarnpkg.com/ret/-/ret-0.2.2.tgz#b6861782a1f4762dce43402a71eb7a283f44573c" + integrity sha512-M0b3YWQs7R3Z917WRQy1HHA7Ba7D8hvZg6UE5mLykJxQVE2ju0IXbGlaHPPlkY+WN7wFP+wUMXmBFA0aV6vYGQ== + ret@~0.1.10: version "0.1.15" resolved "https://registry.npmjs.org/ret/-/ret-0.1.15.tgz"