Swagger-UI 3.6.0 Released!

🏃This version includes a significant performance improvement thanks to a change in Swagger-Client. Large, $ref-dense definitions should get to initial render more quickly!

We're continuing to make performance improvements, so head over to #1919 if you're having troubles.

Interface changes: OAuth2 requests are now subject to request and response interception.

• Feature: added support for OAS3 path and operation-level server definitions (via #3972)
• Improvement: removed Try-It-Out download link requirement that the response have a Content-Length (via #3895)
• Improvement: connected OAuth2 requests to requestInterceptor and responseInterceptor configuration options.
• Improvement: added type examples for header definitions (via #3967)
• Bugfix: parameter validation now tolerates OAS3 parameters that lack a schema property
• Bugfix: paremeter enums, especially with Boolean types, now display more accurately (via #3964)

Version Diff

Swagger-UI 3.5.0 Released!

Interface changes: added showExtensions configuration option - defaults to false. This means that your model extension values will be hidden unless you set showExtensions, which is a small breaking change (major version bump omitted).

• Feature: added showExtensions configuration option to control display of vendor extensions in Operations and Parameters (via #3868)
• Improvement: added dist/oauth2-redirect.html asset to swagger-ui module (via #3942)
• Improvement: added close button to Authorization modal (via #3939)
• Bugfix: IE11 compatibility improved by polyfilling String.prototype.startsWith (via #3930)
• Bugfix: Schema object not property is now correctly rendered according to the OpenAPI specification (via #3941)
• Bugfix: multiple flow security scheme checkboxes are now id'd uniquely (via #3929)
• Bugfix: externalDocs rendering is now passed the correct data type (via #3938)

Version Diff

Swagger-UI 3.4.5 Released!

This release includes performance improvements that should make Swagger-UI more responsive with large API definitions after the initial rendering of the definition.

Interface changes: none.

• Improvement: better Markdown styling (via #3897 and #3909)
• Improvement: better deprecated schema styling (via #3919)
• Improvement: react-split-pane version bump for React 16 compatibility (via #3894)
• Bugfix: request body content type switcher updates example values correctly (plus some performance freebies, via #3922)
• Bugfix: Callback display now expands as it should (via #3926)
• Bugfix: name property is displayed in Authorization modal for type: apiKey schemes (via #3927)
• Bugfix: OAuth2 scopes are now single-encoded... instead of double. (via #3840)
• Performance: sat new OperationContainer component in front of each Operation (via #3597)
• Performance: added update checks and more PureComponents in order to cut down on re-render time (via #3599)
• Housekeeping: added mapStateToProps interface for container components (via #3565)

Version Diff

Swagger-UI 3.4.4 Released!

This release includes performance improvements that should make Swagger-UI more responsive with large API definitions after the initial rendering of the definition.

Interface changes: none.

• Performance: Operation no longer triggers complete re-renders all the time (via #3885)
• Performance: Model component is now more judicious about when it re-renders (via #3878)
• Improvement: react-collapse and react-motion dependency constraints now resolve to versions compatible with React 15 and 16 (via #3880)
• Improvement: validation errors are now shown on hover of the validation input that has an error (via #3825)
• Improvement: removed explicit width from Model property display (via #3884)
• Bugfix: Operation Authorize button now displays operation-applicable security schemes when viewing an OAS 3.0 definition (via #3870)
• Bugfix: parameter value 0 (number) now passes required value validation (via #3889)
• Housekeeping: misc. PropTypes warning fixes (via #3875)
• Housekeeping: Topbar element map item key warning fix (via #3872)
• Housekeeping: added Enzyme tests for ObjectModel (via #3869)

Version Diff

Swagger-UI 3.4.3 Released!

Interface changes: validatorUrl: null configuration works again. Pardon the interruption!

• Improvement: raised minimum react and react-dom versions to 15.6.2, ensuring that we always use an MIT-licensed version (via #3805)
• Improvement: added pattern validator to validateParameter (via #3798)
• Improvement: modified validateParameter's logic so that its output is more helpful (via #3839
• Improvement: switched to a new XML beautifier that fixes a large XML response rendering bottleneck (via #3862)
• Improvement: added CSS property to Execute button animation that should lighten the animation's CPU impact (via #3807)
• Improvement: exposed configuration value management to Redux state (via #3813)
• Improvement: refactored SCSS color values into variables (via #3769)
• Improvement: refactored Primitive and Array Model property display into a new Property component, which will be useful for extending model display (via #3861)
• Improvement: added hasHost spec selector for OAS 3.0 (via #3815)
• Bugfix: corrected a sanitizer issue that caused validatorUrl: null configurations to break (via #3852)
• Bugfix: removed extraneous in field for OAS 3.0 Bearer authorizations (via #3844)
• Housekeeping: updated version checking documentation for clarity (via #3854)
• Housekeeping: started caching node_modules for CI builds (via #3845)

Version Diff

Swagger-UI 3.4.2 Released!

Interface changes: none.

⚠️ This UI release includes a security fix. If you use Swagger-UI to load untrusted API definitions, we recommend upgrading to this version.

• Bugfix: filter out malicious schemes in user-supplied hrefs (via #3848)

Swagger-UI 3.4.1 Released!

Interface changes: none.

• Bugfix: Authorize button is no longer displayed within an OAS 3.0 definition if no security schemes are defined (via #3831)
• Bugfix: interceptors are now being handed off to resolver calls correctly, allowing $ref fetches to be intercepted by UI's interceptor options (via #3830)
• Bugfix: Docker image now references SWAGGER_JSON location with a relative reference (via #3810)
• Bugfix: parameter enums now set the first possible value by default when trying out an OAS 3.0 operation (via #3833)
• Bugfix: authorizable definitions are now updated correctly when a different definition is loaded (via #3834)
• Housekeeping: linter no longer allows exclusive tests (describe.only, it.only) which could have resulted in merging bad code (via #3799)
• Housekeeping: added a Pull Request template (via #3829)

Version Diff

Swagger-UI 3.4.0 Released!

Interface changes: none.

• Feature: many OpenAPI 3.0 authentication schemes are now supported (via #3780)
• Improvement: display on mobile is now bearable (via #3746)
• Bugfix: Markdown links are no longer stripped of their hrefs (via #3768)
• Bugfix: response text is no longer the same color as its background (via #3790)
• Bugfix: OpenAPI 3.0 array parameter inputs are now displayed correctly (via #3796)
• Bugfix: requestInterceptor and responseInterceptor options now intercept definition and $ref download requests (via swagger-api/swagger-js#1161)
• Housekeeping: source maps are MOAR helpful (via #3793)

Known issue: OAuth2 security schemes with multiple flows display their state jointly - authorizing one appears to authorize them all. This should not affect your ability to use the flows to authorize requests.

Version Diff

Swagger-UI 3.3.2 Released!

Interface changes: none.

• Improvement: requestInterceptor and responseInterceptor now intercept API definition fetches, and provide a req.loadSpec flag for isolating those requests (via #3738)
• Improvement: empty Try-It-Out responses no longer render as Unknown response type (via #3736)
• Bugfix: rendered Markdown no longer has a margin around it, allowing better alignment of the Responses table (via #3646)
• Bugfix: improved OpenAPI 3.0 parameter value validation (via #3751)
• Bugfix: Authorization locks now display correctly, fixing a regression first present in v3.3.0, released two weeks ago (via #3755)

Version Diff

Swagger-UI 3.3.1 Released!

This hotfix release patches an issue with OpenAPI 3.0 requestBody rendering (see #3718).