Swagger UI 3.23.5 Released!

This release includes a fix to our Markdown parsing implementation that should resolve display issues with certain Markdown strings.

Changelog

• fix: remove problematic Markdown optimization (via #5520)

Swagger UI 3.23.4 Released!

Changelog

• housekeeping: @kyleshockey/js-yaml -> js-yaml (via #5511)
• housekeeping: more npm audit resolutions (via #5509)
• housekeeping: non-breaking dependency updates (via #5515)

Swagger UI 3.23.3 Released!

This release resolves an undeclared dependency issue visible in [email protected] due to usage of @babel/runtime-corejs2. No source changes were made.

See #5505 for more information.

Swagger UI 3.23.2 Released!

This release includes improvements to our Docker container permissions, bug fixes for OpenAPI 3.0 rendering of Responses and Request Bodies, and resolution of most npm audit warnings visible to consumers.

Channgelog

• improvement: allow Swagger UI Docker containers to run as non-root users (via #5476)
• fix: empty ModelExample rendering in a Response w/o content (via #5504)
• fix: use null as a notSetValue for examplesForMediaType (via #5503)
• housekeeping: resolve (almost) all npm audit warnings (via #5457)

Swagger UI 3.23.1 Released!

This release fixes a couple of minor regressions introduced in v3.23.0, and also includes improvements to our module sizes and sourcemap quality.

Changelog

• fix: Swagger 2.0 Response.examples (via #5464 + #5465)
• fix: enum Select crashes when selecting the empty value (via #5463)
• housekeeping: upgrade to webpack@4 (via #5454)
• housekeeping: upgrade to babel@7 (via #5450)

Note: [email protected] was unpublished due to a bad build being pushed to npm. It will be updated again with the next release of Swagger UI.

Swagger UI 3.23.0 Released!

This release includes support for OpenAPI 3.0's Examples Object within Parameter, Request Body, and Response Objects.

Changelog

• feature: Multiple Examples for OpenAPI 3 Parameters, Request Bodies, and Responses (via #5427)

Internal API notes

Several things have moved around internally.

If you make heavy use of the Plugin API, this may be of concern to you:

• the Parameterscomponent no longer has a wrapComponent in OpenAPI 3.0. Version-specific logic is now contained within one component.
• ParameterRow now needs oas3Actions and oas3Selectors as props.
• Response now needs path and method as props.
• Responses' shouldComponentUpdate check has been removed, it now re-renders as the Redux store changes.
• RequestBodyEditor has been heavily modified. It is no longer aware of the underlying request body or schema, and only concerns itself with the string value being edited. It will now also update its own internal state if the value prop given to it changes.

Swagger UI 3.22.3 Released!

No source changes.

This release moves Swagger UI to [email protected].

Swagger UI 3.22.2 Released!

Changelog

• improvement: OAS3 $ref friendly-name regex in model.jsx (via #5334)
• improvement: add isShown check to 's prop expanded logic (via #5331)
• improvement: relax schema description styling so Markdown can be effective (via #5340)
• security: CVE-2018-20834 (non-user-facing, via #5368)

Swagger UI 3.22.1 Released!

[email protected] lacked the changes that were advertised for it in that version - specifically, docExpansion support was missing.

[email protected] is now available with the new changes. See #5294 for more information.

Changelog

• improvement: error message when rendering XML example (via #5253)
• fix: refuse to render non-string Markdown field values (via #5295)

Swagger UI 3.22.0 Released!

This release introduces a new configuration option (withCredentials) which allows control of Swagger UI's underlying Fetch/XHR instance's credential inclusion mode. You may find this option helpful if your API requires an authentication/authorization scheme that Swagger UI doesn't directly support, but can be handled out-of-band by your browser.

Also notable: GitHub Flavored Markdown table syntax is now supported in our OpenAPI 3 Markdown parser, swagger-ui-react's underlying UI system object is now exposed in the onComplete prop callback, react-addons-perf is removed from our dependencies to avoid BSD+Patents licensing, and we've improved how Markdown is rendered across Swagger UI.

Changelog

• feature: add withCredentials configuration key (via #5149)
• improvement: expose system object in swagger-ui-react's onComplete callback (via #5221)
• improvement: support GFM table syntax in OpenAPI 3.0 (via #5224)
• improvement: expose docExpansion as a prop in swagger-ui-react (via #5242)
• fix: Markdown styling nits and inconsistencies (via #5235)
• fix: generate gzipped Docker assets at runtime (via #5219)
• housekeeping: bump minimum Cypress version (via #5233)
• housekeeping: remove react-addons-perf dependency (via #5229)
• housekeeping: fix typo in README (via #5246)