Swagger-UI 2.2.3 Released!

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

Swagger-UI 2.2.2 Released!

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!

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!

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!

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!

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

Swagger-ui 2.1.1 has been released!

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!

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

Swagger-UI 2.1.0-M2 Released!

This is a major overhaul of Swagger-UI internals. Many thanks to @mohsen1 (via @apigee) for driving this release which includes both feature work for Swagger spec 2.0 support as well as infrastructure changes to make the project both easier to enhance and maintain. Without this support, the release would not have been possible.

In 2.1.0-M2, we have moved from coffeescript to pure javascript (#961, #1027). We have also moved to gulp for building and Swagger-UI is now AMD-compliant. Much of the Swagger-UI work is delegated to the Swagger-JS project.

Usage notes

As with swagger-js, there are major internal changes in the handling of 1.x Swagger specifications. Now, all 1.x specifications are converted to 2.0, which means multiple base paths are no longer supported in Swagger UI. Please see the Swagger-JS release notes for more details.

Notable enhancements

#152, #498, #600 Rich response types supported, including image, audio, and download.
#199, #222, #902, #955 support for multiple instances in a single page
#618 examples for 2.0 specs now shown in sample area
#573 pass documentation location in URL for easier sharing
#463 improved model samples with deep hierarchy
#362 improved loading speed by > 1000x
#359 improved build process, now fully platform independent
#781 removed global variables
#777 refactored into single library
#683 added externalDocs into UI
#672 display enum values in models
#621, #1078 remote references for operations, responses
#1057 markdown rendering of descriptions

Notable bug fixes

#524 state parameter passed in oauth2 requests
#554 fixed allowable values (enum) in parameters
#858, #802 reserved words as tag names are now gracefully handled
#696 proper sorting of response codes
#994 / in tags breaking shebang

Limitations

There are some unimplemented features of the swagger 2.0 specification in this release. Please see the Milestones and Issues for the final 2.1.0 release.

Swagger-UI v2.1.8-M1 Released!

Several minor fixes and a big upgrade to support remote spec definitions! Read more about what's supported in the Swagger Spec.

New features

• Remote references, provided in swagger-js-2.1.9-M1 #621
• Example objects in operations #618

Issues addressed

• Full tag support for operations
• Descriptions not appearing correctly #932
• Models with deep references are truncated #463