Swagger-UI 3.12.1 Released!

Interface changes: none.

Changelog:

• improvement: validator image hides until it is loaded (via #4287)
• improvement: html sanitizer allows image src to be data: scheme (via #4236)
• improvement: model properties and metadata more reliably sit on their own lines (via #4236)

Swagger-UI 3.12.0 Released!

Interface changes: none.

Changelog:

• feature: read Swagger 2.0 non-body parameter x-example fields and use them as initial values (via #3538)
• improvement: urls and deepLinking options now play well together, by using location.replaceState to update the urls.primaryName setting in the browser query string (via #4181)
• improvement: filter is now housed within a plugin, which allows custom filtering logic through the plugin system (via #4255)
• improvement: generate more sensible example values when using anyOf and oneOf (via #4136)
• improvement: add Close button to OAuth dialog, rename Done to Close elsewhere (via #4212)
• improvement: add button to reset request body value when the user modifies it (via #4185)
• fix: blob file download in internet explorer (via #4256)
• fix: try-it-out consumes value regression (#4265)
• fix: callback display regression, by using complete spec path to request resolved subtrees (via #4272)
• fix: remote $ref resolution regression, by passing baseDoc to Swagger-Client (via #4273)
• fix: deeplinked operation resolution on page load (via #4281)
• dependency: upgraded to [email protected] to solve a fatal error experienced by a small subset of users (via #4270)

Swagger-UI 3.11.0 Released!

This release includes significant improvements to Swagger-UI's performance. The concept of an entirely-resolved spec representation has been done away with in favor of resolved subtrees: as the user expands operations and models in Swagger-UI, work is done to resolve only the parts needed for display. This allows us to do initial renders more quickly and paves the way for a more responsive editing experience in Swagger-Editor.

As a result, there are some breaking changes to various private APIs (mostly spec facilities that focus on the resolved state). If you run custom plugins that rely on that data, you'll want to check for compatibility before upgrading.

As a reminder: breaking private API changes result in a minor version bump, not a major bump.

Interface changes:

• defaultModelsExpandDepth behavior has changed; the default 1 value now leaves all models collapsed for performance reasons related to the new lazy resolution.
• specResolved is no longer updated by default; plugins that rely on it should move to specJson or specJsonWithResolvedSubtrees.

Changelog:

• feature: lazy resolver (via #4249)
• improvement: show OAuth error message when auth fails (via #4058)
• fix: allow more valid GUIDs (via #4252)
• fix: bump lodash dependency due to potential vulnerability (via #4224)

Swagger-UI 3.10.0 Released!

Interface changes: added supportedSubmitMethods option to public API.

Changelog:

• feature: supportedSubmitMethods option for disabling Try-It-Out based on operation method (via #4186)
• improvement: allow more HTML attributes to pass through the HTML sanitizer (via #4194)
• improvement: remove CPU-taxing Execute button animation (#4204)
• improvement: visibility & accessibility (via #4202)
• bugfix: use mutated URL for request URL in live response display (via #4117)

Swagger-UI 3.9.3 Released!

Interface changes: none.

• Improvement (a11y): add titles and ARIA labels to elements (via #4130, 4127)
• Bugfix (rendering): improve spacing and punctuation in parameter enum display (via #4144)
• Bugfix (rendering): right-align tag expand/collapse button, even when the tag has no description (via #4129)
• Bugfix (try-it-out): surface parameter validation error messages to OAS3 users (via #4162)

Swagger-UI 3.9.2 Released!

Interface changes: none.

• Improvement: allow urls option to be specified in Docker (via #4044)
• Improvement: give Content-Disposition: attachment priority over Content-Type when choosing to display or offer download of a response (via #4140)
• Performance: remove produces/consumes default setters from OperationContainer (via #4137)
• Bugfix: support cross-frame object reference quirk in IE11 (#4128)
• Bugfix: force border-box box styling in main stylesheet (via #4121)
• Bugfix: bail out Servers selection component to the first server if the currently selected server URL becomes invalid (via #4139)

Swagger-UI 3.9.1 Released!

Interface changes: none.

• Enhancement (docker): added a symlink to the nginx directry so swagger.json can be modified within the container (via #4024)
• Enhancement (packaging): swagger-ui npm module now includes Standalone Preset (via #4101)
• Enhancement (try-it-out): added extraction of quoted file name from Content-Disposition header (via #4035)
• Enhancement (docker): added option to serve Swagger-UI on a custom port within the container (via #4086)
• Bugfix: removed extraneous required prop in ModelCollapse that was causing Proptypes errors in users' React projects (via #4100)
• Bugfix: format: uuid is no longer case-sensitive (via #4102)

Swagger-UI 3.9.0 Released!

Interface changes: one core plugin API change, no public API changes.

Introduced a breaking function signature change to errActions.newThrownErr action creator (from (err, action) to (err)) and err_new_thrown_err action payload (stopped nesting error content under error key in payload, now the error is the payload).

• Feature: added error catcher for statePlugin interfaces; prevents errors in plugin code from crashing entire application instance (via #4067)
  • The only downside to this is that some errors are now a bit harder to trace! Set a breakpoint at console.error and walk down the stack to see what's going wrong.
• Feature: display error content when definition/config load fails (via #4069)
• Feature: display parameter enums, defaults, and examples when not in Try-It-Out mode (via #3977)
• Improvement: added hasOwnProperty checks to a handful of for...in loops (via #4043)
• Improvement: now using nginx location to set Docker base url instead of moving things around the filesystem (via #4073)
• Improvement: brought parameter model property description styling in line with styling for.... everything else (via #4075)
• Bugfix: check for Promise on global/window object, which makes IE11 a very happy browser (via #4077)
• Housekeeping: used zopflipng to compress PNG assets in repo (via #4037)
• Housekeeping: added maintainer documentation for PR merging workflow (via #4076)

Swagger-UI 3.8.1 Released!

• Bugfix: added this binding to afterLoad plugin interface to expose raw plugin context (via #4059)
• Performance regression fix: Models section no longer makes wasteful renders due to specPath inequality (via #4060)

Swagger-UI 3.8.0 Released!

Interface changes:

• plugins may now expose an afterLoad method in order to make changes to the top-level system after the plugin is merged into the system.
• the undocumented initialState parameter now allows removal of default keys by setting its value to undefined in the parameter.

---

• Feature: afterLoad plugin interface is now available (via #4049)
• Bugfix: non-object values are no longer sent to updateJsonSpec from parseToJson (via #1596)
• Bugfix: path-level parameters no longer create empty default tag groups (via #4051)