Skip to content

Swagger-UI 3.11.0 Released!

Compare
Choose a tag to compare
@shockey shockey released this 24 Feb 09:09
· 2987 commits to master since this release
e41067b

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)