[Snyk] Upgrade swagger-jsdoc from 4.0.0 to 5.0.1

[snyk-bot]

Snyk has created this PR to upgrade swagger-jsdoc from 4.0.0 to 5.0.1.

ℹ️ Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.

---

• The recommended version is 8 versions ahead of your current version.
• The recommended version was released 5 months ago, on 2020-10-28.

Release notes

Package name: swagger-jsdoc

• 4.3.2 - 2020-10-28
  

  ⚠️Patch containing breaking changes!!!⚠️

  Unfortunately, the automated publishing script wrongly published this patch instead of v5 https://github.com/Surnet/swagger-jsdoc/releases/tag/v5.0.0

  Please ignore this update and bump to major or do stay at 4.3.1 until updating your tags as mentioned in #220

• 4.3.1 - 2020-10-22
  

  bump version

• 4.3.0 - 2020-10-13
  

  It's now possible to include your .coffee files into the result swagger specification.

  Example:

  swagger-jsdoc.js -d example/v2/swaggerDef.js example/v2/route.coffee

• 4.2.3 - 2020-10-08
  

  • add jest

  • refactor tests to match linting suggestions

  • refactor cli test

  • migrate test for openapi compatibility

  • migrate test for openapi compatibility

  • refactor test for example app v2

  • migrate helpers

  • reorganize addDataToSwaggerObject

  • move lib-specific test to the right place

  • rename

  • rename fixtures to files

  • migrate open api spec

  • remove unnecessary line

  • move v2 example files

  • update .editorconfig file

  • remove mocha

  • attempt to respect nvmrc

  • attempt to respect nvmrc

  • attempt to respect nvmrc

  • set node version

  • set 10

  • try a matrix instead

  • try snapshot update

  • update tests

  • update github workflow

• 4.2.2 - 2020-10-08
  

  make a test with patch version (#217)

• 4.2.1 - 2020-10-08
  

  update github workflow

• 4.2.0 - 2020-09-25
  
  • It's now possible to annotate code with @ openapi instead of @ swagger #200
  • improved error messages for inputs #208
• 4.1.0 - 2020-09-25
  

  Upgrade dependencies to solve security vulnerabilities.

• 4.0.0 - 2020-03-22
  

  Node version 8 aka Carbon is no longer supported. Please refer to this information regarding release. Version 3 of swagger-jsdoc is still available at branch v3, but will not be maintained any more.

  Please use Node version 10 aka Dubnium or higher.

from swagger-jsdoc GitHub release notes

Commit messages

Package name: swagger-jsdoc

• 391c997 chore: refactor helpers (Feature: Allow user to download the list of phone numbers that were invalid #220)
• b95f784 bump version
• bf44557 add back coverage ignore-s
• c3cdcc5 refactor cli a bit
• 2b7d6a8 add specs for public functions
• 105f461 coverage for yaml malformatting
• 1f2d9d6 increase coverage for initial error handling
• 9058113 remove deprecated coverage ignore lines
• 0d66d5c remove @ requires
• 068581a remove unnecessary @ function annotations
• a19d7e0 remove @ module definition
• fe97fee remove vscode settings
• 41c410f feat: add coffeescript support (Deduplicate recipients #52)
• 0bfe3dc chore: use jest over mocha (fix: Add OTP validation #214)
• a0ad333 make a test with patch version (Mobile view for landing page #217)
• e3a670b update github workflow
• 3017902 update docs
• 8e9da9b remove circle ci
• 2644db6 update readme
• 57d9097 Add github actions (Store creds frontend #213)
• 98d7cf4 Update version
• b84f5f7 add openapi jsdoc annotation with test (feat: Allow empty params in csv file #200)
• e42c894 Better describing errors (refactor: restore sequelizeLoader to consistent format #208)
• f508180 Update dependencies

Compare

---

Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open upgrade PRs.

For more information:

🧐 View latest project report

🛠 Adjust upgrade PR settings

🔕 Ignore this dependency or unsubscribe from future upgrade PRs

[lamkeewei]

this breaks our current swagger docs. will need to look a little into what's wrong before upgrading

[zwliew]

The issue has been fixed. It happened because the deprecated 'path' property was removed in v4.3.2/v5.0.0 (they are equivalent). I've replaced it with the 'paths' prop.

v4.3.2 also removed some other deprecated props, but none of them are currently being used in the codebase.

I've verified that this works by placing my local docs and the staging docs side-by-side to compare. Both display the same API endpoints.