Swagger-UI 3.1.0 Released!

This is our first release of Swagger-UI with OAS3.0 support!

Interface changes: Config keys are no longer filtered, so plugins are able to create new configs without Swagger-UI's core being involved.

• Feature: Support for rendering OpenAPI 3.0 specs (#3083 via #3482)
• Bugfix: Required array parameters no longer break Try-It-Out (#3414 via #3453)

Known Limitations:

• The Try it Out functionality is currently not implemented for OAS3.0.
• Support for form-data request body payloads for OAS3.0 is not fully implemented.
• Some parts of OAS3.0 may not fully render. Please report issues.

Version Diff

Swagger-UI 3.0.21 Released (Hotfix)

This release is a hotfix to solve a regression introduced in 3.0.20 that broke Try It Out functionality in several cases.

Swagger-UI 3.0.20 Released!

Interface changes:

• Bugfix: use correct field name for grant request body in OAuth2 Password flow (via #3404)
• Bugfix: models expand/collapse arrows work correctly (#3422 via #3439)
• Bugfix: required parameters without a value no longer break requests (#3414, #3407 via #3427)
• Bugfix: fromJSOrdered doesn't adopt length property of object (via #3420)
• Bugfix: adopt first scheme of a spec when it changes, more reliably (#3405 via #3411)
• Bugfix: don't allow name global in iframes to inject data into a model (#3424 via #3425, #3442)
• Bugfix: images in response bodies are correctly displayed (#3435 via #3441)
• Improvement: include apis preset by default, unless the user supplies their own presets (via #3389)
• Improvement: display required sub-objects more clearly (#3100 via #3345)
• Improvement: links in response descriptions stand out more (#3434 via #3440)
• Chore: fix typo, parseSeach -> parseSearch (via #3399)
• Chore: add security contact information to README (via #3401)
• Chore: add deepLinking option to README (via #3402)
• Chore: css build process changes (#3329, via #3352)
• Chore: remove dead path translator code (via #3412)
• Chore: enable deep linking feature by default in dist/index.html (via #3423)

Version Diff

Swagger-UI 3.0.19 Released!

Interface changes: Added deepLinking, tagsSorter, maxRows and filter configuration options.

• Feature: maxRows configuration option (via #3196)
• Feature: filter configuration option for filtering by tag, plus a filter input (via #3196)
• Feature: tagsSorter configuration option (#3022 via #3303)
• Feature: deep linking into tags and operations (#2884 via #3388)
• Improvement: get model components via getComponent so problems are caught by render try/catch (#3102 via #3331)
• Improvement: window.versions information is more robust (#3300 via #3356)
• Improvement: display title in nested models, and make the titles clickable (#2926 via #3355)
• Bug fix: use consumes value first when selecting a request content type (#3375 via #3377)
• Bug fix: check for null/undefined values when validating parameters (#3361 via #3363)
• Bug fix: enable line breaks in Markdown fields (#3078 via #3353)
• Bug fix: render externalDocs descriptions as Markdown (#3384 via #3391)
• Bug fix: added missing method name to swagger-ui-dist default export (via #3390)

Version Diff

Swagger-UI 3.0.18 Released!

This is a big release! It contains two weeks of effort on the project, including several community contributions.

Interface changes: Added urls and urls.primaryName configuration options.

• Feature: switch between multiple provided specs with a dropdown menu (#3103, #2891 via #3261)

• Improvement: disabled example response values where type: file (via #3266)

• Improvement: non-object models reveal their names (#2947 via #3298)

• Improvement: display required file inputs as such in Try-It-Out (#3309 via #3332)

• Bug fix: schemes dropdown now reliably updates when a new spec is loaded via the Topbar (#3166 via #3317; superseded by #3136 via #3295)

• Bug fix: example response JSON values are no longer being minified and escaped (#3256 via #3297)

• Bug fix: boolean example values respect defaults (#3289 via #3293)

• Bug fix: parameters with default: 0 will pass Try-It-Out validation with default value (#3299 via #3306)

• Bug fix: 4xx and 5xx errors in Try-It-Out will display their headers and body (#3072 via #3294)

• Bug fix: specs with more than 8 tags will retain their tag order for display (#3022 via #3324)

• Bug fix: swagger-ui-dist can now be loaded into Node environments again (#3291 via #3336)

• Bug fix: remove Cryllic non-ASCII character from CSS (#3104 via #3350)

• Bug fix: non-JSON parameters no longer get treated as if they are JSON in Try-It-Out (#3271 via #3346)

• Tooling: migrated to Webpack 2 (via #3312)

• Tooling: added Autoprefixer for better cross-browser styling (#3334 via #3344)

Version Diff

Swagger-UI 3.0.17 Released!

Interface changes: None

• Locked dependency for swagger-client to exact version. This should be a transparent change.
• Removed babel-polyfill dependency. This should make it easier to use Swagger-UI in projects that also use babel-polyfill. (via #2599)
• Fixed untranspiled arrow function syntax in swagger-ui-dist-package/absolute-path.js that would cause problems with Node < 4.0.0 (via #3264)
• Explicitly pinned yaml-js@0.2.0 in order to pick up an upstream fix that should improve our compatibility with projects that use Webpack 2.0+ (via #3281)
• Fixed a bug where empty Markdown source text would cause the UI to render undefined as text.

Version Diff

Swagger-UI 3.0.16 Released!

Interface changes: None.

• Fixes an error in swagger-ui-dist (see #3253).
• No code changes to Swagger-UI itself.

Version Diff

Swagger-UI 3.0.15 Released!

Interface changes:

• cURL command display in Try-It-Out is now readonly (see #3211)
• Response errors are now displayed in Try-It-Out (see #3076)
• Model descriptions now support Markdown (see #3236)
• Composite models now display their own name more reliably (see #3250)
• Pretty-print response example values (#3238)
• Support formBody file upload in cURL command display
• Add absolutePath method to swagger-ui-dist for static serving use-cases (see #3211)

Version Diff

Swagger-UI 3.0.14 Released!

Interface changes: Added docExpansion and displayOperationId options.

• Bumped base Docker image to alpine:3.5.
• Added copy-spec step to the Docker build process (#3179)
• clear class was removed and pulse CSS animation was renamed to prevent collisions with third-party libraries.
• Fixed over-ambitious double escaping of JSON strings in Markdown bodies.
• Fixed an issue in Access Code OAuth flow (#3172)
• Fixed an issue in Password OAuth2 flow (#3191)

Version Diff

Swagger-UI 3.0.12 Released!

Interface changes:

• Improvement: add modelPropertyMacro and parameterMacro callback functions (#3067 via #3130)
• Bugfix: make tag expand/collapse clickable area larger (via #3116)
• Improvement: add entry point for swagger-ui-dist package (via #3126, #3133)

Version Diff