All notable changes will be documented in this file. Swagger Express Middleware adheres to Semantic Versioning.
v4.0.0 (2020-03-24)
- Moved from a high security risk version of multer to a more up-to-date version to remove a high-security risk dependency
- This library change resulted in some API breaking changes to the library:
- CHANGE: Files downloaded to disk are not saved with the extension in the name so Content-Type may need to be set manually or based on the File object since it can not be inferred from the downloaded filename
- The File object created from multer is a little different:
- For compatibility
extensionis backfilled. - the
nameproperty on File is nowfilenameand doesn't include a file extension - the
bufferproperty on File is only present ifinMemoryorstorage: memoryStorageis used. - the
truncatedproperty on File is no longer present. Instead, an error is sent through thenextfunction of middleware
- For compatibility
- multipart opts have changed significantly
- Old vs New
- See MemoryStorage if you were previously using
inMemory: true, thoughinMemoryoption has been recreated, it may be removed in the future. - See Error handling for more info on how to recreate certain functionality.
- As with previous versions extra files provided to swagger routes will 413 and any files coming in outside of the swagger routes will be passed through multer. The 413 functionality was recreated like so.
- Indexed params are placed in exactly the index specified so
foo[0]=A&foo[2]=Bresults in a param likefoo: ["A", undefined, "B"]whereas previously it would have been["A", "B"], example here
v3.0.0 (2020-03-15)
-
Moved Swagger Express Middleware to the @APIDevTools scope on NPM
-
The "swagger-express-middleware" NPM package is now just a wrapper around the scoped "@apidevtools/swagger-express-middleware" package
v2.0.0 (2018-12-13)
- Dropped support for Node 0.10 through 8.0.0
v1.0.0 (2018-10-06)
Initial release 🎉