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 default1
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 tospecJson
orspecJsonWithResolvedSubtrees
.
Changelog: