Add API key authentication to Swagger UI #257
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
h4l-yup
reviewed
Apr 17, 2024
| @@ -71,7 +71,7 @@ async function bootstrap() { | |||
| `, | |||
| ) | |||
| .setVersion('1.0.0') | |||
| .addApiKey({ type: 'apiKey', name: 'x-api-key', in: 'header' }) | |||
| .addApiKey({ type: 'apiKey', name: 'x-api-key', in: 'header' }, 'apiKey') | |||
There was a problem hiding this comment.
Thanks for your contribution.
Can you add same .addApiKey({ type: 'apiKey', name: 'x-api-key', in: 'header' }, 'apiKey') code to adminDocumentConfig as well in line 55?
It seems feedback creation API in admin API needs it.
There was a problem hiding this comment.
Yes I will do it.:)
|
I will change base branch from When your PR is merged to |
h4l-yup
approved these changes
Apr 17, 2024
h4l-yup
added a commit
that referenced
this pull request
May 28, 2024
* docs: CONTRIBUTING.md * fix: improve Windows build experience (#215) * fix to improve Windows build experience * improve readability --------- Co-authored-by: Carson <yupyup.kim@linecorp.com> * add: Chinese(ZH) and German(DE) language (#216) Co-authored-by: Carson <yupyup.kim@linecorp.com> * fix: increase help image resolution in image setting (#218) fix: change help image in image setting * feat: webhook (#217) * feat: webhook setting prototype * feat: webhook API * feat: webhook setting * feat: webhook setting ui (#207) * feat: webhook setting ui * feat: add label * feat: web hook api history * fix: remove webhook test and webhookevent enum * feat: webhook call * fix: webhook sending data format (#211) * fix: webhook sending data format * docs: webhook guide * feat: webhook description (#210) * feat: webhook tooltip and change toggling event type * fix: webhook tooltip * fix: webhook event daa cell * fix: toggle * fix: toggle * fix: guide url * fix: validateEvent method --------- Co-authored-by: chiol <chiyoung.jeong@linecorp.com> * chore(deps): bump typeorm from 0.3.17 to 0.3.20 (#167) Bumps [typeorm](https://github.com/typeorm/typeorm) from 0.3.17 to 0.3.20. - [Release notes](https://github.com/typeorm/typeorm/releases) - [Changelog](https://github.com/typeorm/typeorm/blob/master/CHANGELOG.md) - [Commits](typeorm/typeorm@0.3.17...0.3.20) --- updated-dependencies: - dependency-name: typeorm dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump undici from 5.26.3 to 5.28.3 (#183) Bumps [undici](https://github.com/nodejs/undici) from 5.26.3 to 5.28.3. - [Release notes](https://github.com/nodejs/undici/releases) - [Commits](nodejs/undici@v5.26.3...v5.28.3) --- updated-dependencies: - dependency-name: undici dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Carson <yupyup.kim@linecorp.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump @nestjs/platform-fastify from 10.2.7 to 10.3.3 (#187) Bumps [@nestjs/platform-fastify](https://github.com/nestjs/nest/tree/HEAD/packages/platform-fastify) from 10.2.7 to 10.3.3. - [Release notes](https://github.com/nestjs/nest/releases) - [Commits](https://github.com/nestjs/nest/commits/v10.3.3/packages/platform-fastify) --- updated-dependencies: - dependency-name: "@nestjs/platform-fastify" dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps-dev): bump @nestjs/schematics from 10.0.2 to 10.1.1 (#209) Bumps [@nestjs/schematics](https://github.com/nestjs/schematics) from 10.0.2 to 10.1.1. - [Release notes](https://github.com/nestjs/schematics/releases) - [Changelog](https://github.com/nestjs/schematics/blob/master/.release-it.json) - [Commits](nestjs/schematics@10.0.2...10.1.1) --- updated-dependencies: - dependency-name: "@nestjs/schematics" dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump @nestjs/platform-express from 10.2.7 to 10.3.3 (#206) Bumps [@nestjs/platform-express](https://github.com/nestjs/nest/tree/HEAD/packages/platform-express) from 10.2.7 to 10.3.3. - [Release notes](https://github.com/nestjs/nest/releases) - [Commits](https://github.com/nestjs/nest/commits/v10.3.3/packages/platform-express) --- updated-dependencies: - dependency-name: "@nestjs/platform-express" dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Carson <yupyup.kim@linecorp.com> * feat: scheduler lock for schedule jobs (#214) * feat: scheduler lock for schedule jobs * fix: tests * fix: cron job time * fix: validateEvent on webhook * fix: validateEvent on webhook * fix: language (#220) * fix: language files (de, en, zh) * fix: e2e tests * docs: api (#221) * refactor: unit tests (#222) * refactor: tests * refactor: code service test * refactor: channel service test * refactor: field service test * refactor: option service test * fix: user repository stub - user type should be GENERAL if there is no specific type * refactor: issue, field, feedback service tests * fix: tooltip, feedback space and newline and disable key in field setting (#223) * fix: remote portal in tooltip, add whitespace-pre-lin in feedback detail * fix: disable key in field setting * fix: wrong words (#235) tabel -> table * chore(deps-dev): bump @types/jest from 29.5.6 to 29.5.12 (#228) Bumps [@types/jest](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/jest) from 29.5.6 to 29.5.12. - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases) - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/jest) --- updated-dependencies: - dependency-name: "@types/jest" dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * fix: npm script to run on Windows and Ubuntu without errors (#231) * fix various npm script to work on Windows and Ubuntu * fix build error * apply Prettier format * update yarn from 1.22.19 to 4.1.1 * update GitHub Action for newer Yarn v4 * update GitHub Action for newer Yarn v4 * update GitHub Action for newer Yarn v4 * update GitHub Action for newer Yarn v4 * update GitHub Action for newer Yarn v4 - add yarn cache clean * update GitHub Action for newer Yarn v4 - remove cache check * add dependencies for api:test pass * fix intervalCount to have positive value always * add yarn v2 update in steps * add tabWidth 2 and useTabs to false. * fix: yarn.lock * fix: yarn.lock * fix: yarn.lock --------- Co-authored-by: Carson <yupyup.kim@linecorp.com> * feat: feedback pre wrap (#236) * fix: css * fix: min width in issue table * change package manager to pnpm and upgrade all packages (#242) * merge develop branch * merge develop branch * merge develop branch * merge develop branch * upgrade all packages * upgrade all packages * upgrade all packages * fix dockerfile * fix e2e workflow * fix eslint base.js * remove .turbo in .dockerignore * fix e2e workflow * fix readme * add source-map-support in dockerfile * add react dev dependencies * chore(deps): bump joi from 17.12.2 to 17.12.3 (#247) Bumps [joi](https://github.com/hapijs/joi) from 17.12.2 to 17.12.3. - [Commits](hapijs/joi@v17.12.2...v17.12.3) --- updated-dependencies: - dependency-name: joi dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps-dev): bump @types/supertest from 2.0.16 to 6.0.2 (#251) Bumps [@types/supertest](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/supertest) from 2.0.16 to 6.0.2. - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases) - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/supertest) --- updated-dependencies: - dependency-name: "@types/supertest" dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump eslint-config-turbo from 1.13.0 to 1.13.2 (#248) Bumps [eslint-config-turbo](https://github.com/vercel/turbo/tree/HEAD/packages/eslint-config-turbo) from 1.13.0 to 1.13.2. - [Release notes](https://github.com/vercel/turbo/releases) - [Changelog](https://github.com/vercel/turbo/blob/main/release.md) - [Commits](https://github.com/vercel/turbo/commits/v1.13.2/packages/eslint-config-turbo) --- updated-dependencies: - dependency-name: eslint-config-turbo dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps-dev): bump @types/react from 18.2.73 to 18.2.78 (#256) Bumps [@types/react](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/react) from 18.2.73 to 18.2.78. - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases) - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/react) --- updated-dependencies: - dependency-name: "@types/react" dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Add API key authentication to Swagger UI (#257) * Add API key authentication to Swagger UI * feat : Add API key adminDocuemntConfig --------- Co-authored-by: Carson <yupyup.kim@linecorp.com> * change permissions (#254) * remove redundant permission and set permission dependency * fix e2e test --------- Co-authored-by: Carson <yupyup.kim@linecorp.com> * upgrade packages (#262) * Fixes #42 (#253) * add api key help in api key setting * change api key help * chore(deps): bump framer-motion from 10.18.0 to 11.1.7 (#259) Bumps [framer-motion](https://github.com/framer/motion) from 10.18.0 to 11.1.7. - [Changelog](https://github.com/framer/motion/blob/main/CHANGELOG.md) - [Commits](framer/motion@v10.18.0...v11.1.7) --- updated-dependencies: - dependency-name: framer-motion dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps-dev): bump postcss-import from 15.1.0 to 16.1.0 (#260) Bumps [postcss-import](https://github.com/postcss/postcss-import) from 15.1.0 to 16.1.0. - [Release notes](https://github.com/postcss/postcss-import/releases) - [Changelog](https://github.com/postcss/postcss-import/blob/master/CHANGELOG.md) - [Commits](postcss/postcss-import@15.1.0...16.1.0) --- updated-dependencies: - dependency-name: postcss-import dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * improved german translation (#265) * chore(deps): bump @fastify/static from 6.12.0 to 7.0.3 (#269) Bumps [@fastify/static](https://github.com/fastify/fastify-static) from 6.12.0 to 7.0.3. - [Release notes](https://github.com/fastify/fastify-static/releases) - [Commits](fastify/fastify-static@v6.12.0...v7.0.3) --- updated-dependencies: - dependency-name: "@fastify/static" dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * feat: field property (#276) * feat: field property (READ_ONLY, EDITABLE) (#264) - deprecate field type * feat: field property (READ_ONLY, EDITABLE) in Client (#274) * change field type to field property * fix api key help card * fix field save modal * fix minor bugs * fix datepicker ui * fix: createdAt can be an input of feedback creation * fix: e2e --------- Co-authored-by: Chiyoung Jeong <chiyoung.jeong@linecorp.com> * chore(deps): bump eslint-plugin-react-hooks from 4.6.0 to 4.6.2 (#277) Bumps [eslint-plugin-react-hooks](https://github.com/facebook/react/tree/HEAD/packages/eslint-plugin-react-hooks) from 4.6.0 to 4.6.2. - [Release notes](https://github.com/facebook/react/releases) - [Changelog](https://github.com/facebook/react/blob/main/packages/eslint-plugin-react-hooks/CHANGELOG.md) - [Commits](https://github.com/facebook/react/commits/HEAD/packages/eslint-plugin-react-hooks) --- updated-dependencies: - dependency-name: eslint-plugin-react-hooks dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump reflect-metadata from 0.1.14 to 0.2.2 (#270) Bumps [reflect-metadata](https://github.com/rbuckton/reflect-metadata) from 0.1.14 to 0.2.2. - [Release notes](https://github.com/rbuckton/reflect-metadata/releases) - [Changelog](https://github.com/rbuckton/reflect-metadata/blob/main/tsconfig-release.json) - [Commits](https://github.com/rbuckton/reflect-metadata/commits) --- updated-dependencies: - dependency-name: reflect-metadata dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps-dev): bump @types/node from 20.8.8 to 20.12.12 (#280) Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 20.8.8 to 20.12.12. - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases) - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node) --- updated-dependencies: - dependency-name: "@types/node" dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * fix: webhook duplication check (#282) - webhook can be created with same urls * fix editing role bug (#283) * fix: change setting query state for field setting confirm popup (#284) change setting query state * fix: webhook setting permission and web minor bugs (#287) * fix: check permission in webhook setting * fix: issue field in preview table * fix: field setting table default field in create channel * fix: smtp optional * remove console.log * chore(deps): bump axios from 1.6.8 to 1.7.2 (#286) Bumps [axios](https://github.com/axios/axios) from 1.6.8 to 1.7.2. - [Release notes](https://github.com/axios/axios/releases) - [Changelog](https://github.com/axios/axios/blob/v1.x/CHANGELOG.md) - [Commits](axios/axios@v1.6.8...v1.7.2) --- updated-dependencies: - dependency-name: axios dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps-dev): bump @types/nodemailer from 6.4.14 to 6.4.15 (#285) Bumps [@types/nodemailer](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/nodemailer) from 6.4.14 to 6.4.15. - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases) - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/nodemailer) --- updated-dependencies: - dependency-name: "@types/nodemailer" dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: YoungjaeKim <youngjaekim@linecorp.com> Co-authored-by: Chiyoung Jeong <chiyoung.jeong@linecorp.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: P.Elley <samjegal@gmail.com> Co-authored-by: Daniel Lim <lahuman@daum.net> Co-authored-by: Yannick Groß <gyr2fe@bosch.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added authentication support to Swagger UI configuration.
Thank you for considering this addition.