Skip to content

Releases: swagger-api/swagger-ui

Swagger-UI 2.2.5 Released!

27 Sep 01:55
Compare
Choose a tag to compare

Update to address a bug in swagger-js where schemes are sometimes not honored.

Swagger-UI 2.2.4 Released!

20 Sep 16:52
Compare
Choose a tag to compare

Fixed an issue where query parameters without default values were being shown as undefined.

Swagger-UI 2.2.3 Released!

01 Sep 16:27
Compare
Choose a tag to compare

Minor update to Swagger-UI that brings better handling of XSS vulnerabilities using the excellent sanitize-html project.

Swagger-UI 2.2.2 Released!

24 Aug 16:05
Compare
Choose a tag to compare

Small fix to address overly-aggressive escaping of model signatures #2350.

While at it...

  • Added composer.json file #2347
  • Added Catalan translation #2351

Please see detailed release notes here!

Swagger-UI 2.2.1 Released!

23 Aug 23:12
Compare
Choose a tag to compare

A new version of swagger-ui has been released, and contains major functionality enhancements as well as a ton of performance fixes. Oh, we fixed some bugs, too.

Upgrade notes!

Please note! There are updates in the parent index.html which are required for using 2.2.1. Please compare the included libraries from your container with those in the swagger-ui distribution!

New features

  • Integrated authentication! Now your basic auth, apiKey, OAuth 2.0 Implicit security definitions are automatically rendered in the UI #1923, #1922, #1889
  • Updated Handlebars! Now using Handlebars 4.0.0 #2306
  • Highlight pack updated #2235
  • Security fixes prevent XSS injections #1866, #1865, #1864, #1863, #1617, #1154, #830

Enhancements

  • Speed improvements with large spec files, references #2292, #2198
  • Better checking for invalid specs #2258
  • File upload improvements #2251
  • Updated curl file upload command #2178
  • Added filename in download headers #1991
  • More translations #2066
  • OAuth redirect_url added #2056
  • Latest swagger-js #2244, #2223
  • :port removed from curl sample #2236

Bug Fixes

  • Fixed issue with $ref and external files #2304
  • Content-Type header sometimes not sent in request #2242
  • Arrays of primitives in formData now correctly sent
  • Authorize bugs: cancel button (#2238), logout button #2193,
  • OPTIONS javascript issue resolved #2207
  • XML rendering issues #2191, #2167, #2077, #2067, #1982, #1931, #1918, #1901
  • Boolean parameters causing rendering issues #2190
  • OAuth scopes #2150
  • IE issues #2144, #2063, #2002
  • Basic auth now works with no password(?) #2114
  • Curl makes funny characters #2113, #1978
  • Auth sends headers corectly #2075
  • Gulp tasks updated #2227
  • Some cases have wrong produces/consumes headers #2042
  • Title not used as model name by default #2029
  • Rendering fails with missing supportedSubmitMethods #1949
  • Rendering nested refs #1943, #1859
  • Enum values not displayed in response class #1907
  • Open external docs in new tab/window #1899

Please share your feedback, issues, chocolates as you see fit.

Swagger-ui 2.1.4 has been released!

06 Jan 22:28
Compare
Choose a tag to compare

A new version of swagger-ui has been released, and contains fixes, enhancements, and unicorns.

Enhancements

  • Updated swagger-client to 2.1.10, allowing better support for references, composition, rendering of complex models
  • Added translation files for French, Italian, Japanese, Polish, Russian, Turkish (#1631, #1717, #1725, #1843, #1844, #1559). Also more translation elements (#1521)
  • A JSON editor has been added to make it easier to edit and supply JSON payloads (#1589)
  • Better OAuth support (#1648)
  • Client credentials flow (#1825)
  • LESS refactoring makes it much easier to edit style (#1756)

Deprecations

  • Please note that rendering in the swagger-js client will be removed in 2.2.x releases (see #1248). These methods will be removed, and are being logged to console in the mean time.

Swagger-ui 2.1.3 has been released!

19 Sep 19:14
Compare
Choose a tag to compare

This release updates swagger-client to v2.1.5 to address a number of issues and enhancements.

  • We are also adding support for simplified Chinese translation via #1611.

Swagger-ui 2.1.2 has been released!

20 Aug 06:00
Compare
Choose a tag to compare

This minor fix addresses #1553 which provides support for parameter macros through swagger-js

Swagger-ui 2.1.1 has been released!

04 Aug 19:09
Compare
Choose a tag to compare

Minor features and helpful bug fixes have been addressed in this release.

Notable Features

All the goodness of swagger-js-2.1.2
#1343, #1402, #1448 allow override of authorization headers with operation parameters
#1093 support for relative references
#830 fix for XSS
#1324 oauth2 fixes, client secret support

Notable bug fixes

#1397, #1447 addressed asCurl Content-Type
#1152 fixed bug with 1.2 model properties being shown as optional
#1394 IE11 default value fixed
#966 fixed boolean parameter handling

Swagger-UI 2.1.0 Released!

09 Jun 13:57
Compare
Choose a tag to compare

This is the first formal release of swagger-ui with 2.0 spec support. Many thanks to the community for furthering the development of swagger!

Usage notes

Initialization of swagger-ui should be consistent with previous 2.1.x-M versions.

Major changes

With the updated swagger-js, swagger-ui now supports relative references, yaml, and composition support. Please see the swagger-js release notes. In addition to updates to the features to support swagger spec 2.0, the UI does not need to be globally referenced, which means you can deploy multiple instances in a single page.

Notable features

  • Passing options to Operation#execute: 4764d33, c84202c
  • Proper support for array parameters af39ae0
  • Add API-Key to onComplete callback #1170
  • Correct handling of empty (201) responses #1173
  • Improved handling of enum types #391, #1113
  • Support for multiple instances #1086
  • Display request headers for sent requests #693
  • Added tags for 508 compliance #1021
  • Show cUrl output for “try it now” functionality #1315

Notable bug fixes

  • Protocol detected from window.location if not specified e127bf3
  • OAuth settings correctly set e127bf3, #1134
  • Apply authorizations after UI is loaded 44f2005, #1160
  • JS Error on file upload with jQuery #1132
  • Responses with type text/plain were not correctly displayed #1109
  • Fixed handling for boolean types #1191
  • Improved handling of empty/missing content-type header in downloaded responses #1122
  • HTTP Basic Auth support regression #1171
  • Fixed parameter sorting in UI #1280
  • Fixed XSS vulnerability #1262