diff --git a/package.json b/package.json index 4bb88bf796..eca2f1d44f 100644 --- a/package.json +++ b/package.json @@ -135,6 +135,8 @@ "devDependencies": { "@apidevtools/swagger-parser": "10.1.0", "@babel/core": "7.18.13", + "@swc/core": "1.2.246", + "@swc/jest": "0.2.22", "@types/bcryptjs": "2.4.2", "@types/cors": "2.8.12", "@types/express": "4.17.13", @@ -171,13 +173,12 @@ "jest": "29.0.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", "superagent": "8.0.0", "supertest": "6.2.4", - "@swc/core": "1.2.246", - "@swc/jest": "0.2.22", "ts-node": "10.9.1", "tsc-watch": "5.0.3", "typescript": "4.8.2" diff --git a/src/lib/openapi/spec/set-ui-config-schema.ts b/src/lib/openapi/spec/set-ui-config-schema.ts index 27f7153a2d..c566b46f80 100644 --- a/src/lib/openapi/spec/set-ui-config-schema.ts +++ b/src/lib/openapi/spec/set-ui-config-schema.ts @@ -12,7 +12,6 @@ export const setUiConfigSchema = { properties: { frontendApiOrigins: { type: 'array', - additionalProperties: false, items: { type: 'string' }, }, }, diff --git a/src/test/e2e/api/openapi/openapi.e2e.test.ts b/src/test/e2e/api/openapi/openapi.e2e.test.ts index 6378b59fe2..af121c3d51 100644 --- a/src/test/e2e/api/openapi/openapi.e2e.test.ts +++ b/src/test/e2e/api/openapi/openapi.e2e.test.ts @@ -2,6 +2,7 @@ import { setupApp } from '../../helpers/test-helper'; import dbInit from '../../helpers/database-init'; import getLogger from '../../../fixtures/no-logger'; import SwaggerParser from '@apidevtools/swagger-parser'; +import enforcer from 'openapi-enforcer'; let app; let db; @@ -52,4 +53,17 @@ test('the generated OpenAPI spec is valid', async () => { console.error(err); return false; } + + const [openapi, error, warning] = await enforcer(body, { + fullResult: true, + }); + + if (error !== undefined) { + console.error(error); + } + if (warning !== undefined) { + // some of these _should_ probably be dealt with at some point. + console.warn(warning); + } + if (openapi !== undefined) console.log('Document is valid'); }); diff --git a/yarn.lock b/yarn.lock index f45ff6ede1..76a02b2c0c 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2740,6 +2740,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" @@ -5468,6 +5473,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" @@ -5926,6 +5939,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" @@ -6140,6 +6161,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== + retry@^0.12.0: version "0.12.0" resolved "https://registry.npmjs.org/retry/-/retry-0.12.0.tgz"