Scalar API Reference release notes

1.62.0 (2026-06-26)

API Reference UI localization, AsyncAPI protocol filters, and custom legal links

This release adds built-in localization support for seven languages with automatic RTL layout for Arabic, introduces protocol and server filters to AsyncAPI navigation, and ships an OpenAPI extension for custom legal links.

• Configure API Reference UI language with built-in English, Russian, Spanish, French, German, Simplified Chinese, and Arabic translations, plus automatic RTL direction for Arabic locales
• Filter AsyncAPI sidebar navigation by protocol and server to narrow down operations reachable over a selected protocol or server
• Render custom legal links (privacy policy, imprint) in the introduction using the new x-scalar-links OpenAPI extension
• Request and response example pickers now sync across operations—selecting an example on one operation selects it on every operation that defines it
• Show propertyNames type and format constraints (like string · uuid) for map keys in schema documentation

Read full release notes

1.61.0 (2026-06-22)

AsyncAPI operations, messages, and protocols now render inline

This release brings AsyncAPI documentation to parity with dedicated AsyncAPI tools by rendering operations and their message payloads inside each channel. Server and protocol labels now appear throughout, making it clear which servers and transports each channel and message uses.

• AsyncAPI operations and their messages (with payload and header schemas) now render nested inside each channel in both modern and classic layouts
• Channel headers show which servers they are available on and their protocols, while message headers display every protocol they are carried over
• New requestBuilt client plugin hook and onRequestBuilt callback expose the exact fetch Request sent over the wire, enabling request signing with accurate body hashes
• Fixed oneOf and anyOf being dropped when nested inside allOf, so composition variants now render alongside merged base properties
• Object properties factored out alongside composition keywords (anyOf, oneOf, allOf, not) now render correctly instead of being hidden

Read full release notes

1.60.0 (2026-06-17)

Plugin view slots, sidebar customization, and layout polish

This release adds a new plugin extension point at the top of your documentation and lets plugin views appear in the sidebar. It also ships a handful of fixes that improve deep linking, schema rendering, and responsive layout behavior.

• Plugins can now inject components before the introduction section with the new content.start view slot
• Plugin views can opt in to sidebar navigation with the sidebar visibility option
• Deep links to nested schema properties now expand collapsed sections and scroll into view automatically
• The introduction loading skeleton now mirrors the real layout so the page does not jump when your document loads
• Fixed sidebar overlap at exactly 1000px wide by aligning mobile and desktop breakpoints

Read full release notes

1.59.3 (2026-06-11)

Path item references, redirects, and SDK tab sync

This release fixes rendering when path items use component references, improves navigation for custom section labels, and syncs SDK installation tabs with code examples across all operations.

• Operations now appear correctly when OpenAPI path items reference components.pathItems instead of inlining methods
• Old model bookmarks automatically redirect to custom section slugs when you have renamed the models section
• Selecting a language in SDK installation tabs now switches every operation's code sample to that language
• Empty info link lists no longer push down the download button on mobile

Read full release notes

1.59.2 (2026-06-09)

Restore deprecated source field for SDK installation commands

The deprecated source field on x-scalar-sdk-installation is now supported again for backward compatibility. When present, it is automatically appended to the description as a fenced code block, or used on its own when there is no description. The description field remains the recommended way to document installation commands.

Read full release notes

1.59.1 (2026-06-09)

Fixed examples panel layout in operation view

Read full release notes

1.59.0 (2026-06-08)

AsyncAPI server and channel parameters, CSP nonce support, and expanded schemas

This release brings full AsyncAPI server selection and channel parameter rendering to the API reference, adds Content Security Policy support with a nonce option for strict script-src, and introduces an expandAllSchemaProperties configuration to show nested properties by default.

• AsyncAPI channel address parameters are now rendered in the API reference, showing their enum, default, and example values alongside operation parameters
• A server selector for AsyncAPI documents displays constructed connection URLs and persists selection and variable changes to the workspace store
• Pass a nonce option to run the API reference under a strict script-src Content Security Policy with no unsafe-inline or unsafe-eval
• The new expandAllSchemaProperties configuration expands nested schema properties by default while keeping manual collapse controls available
• Custom SDK installation instructions from x-scalar-sdk-installation now render in the introduction card with support for rich Markdown and multiple code blocks per language

Read full release notes

1.58.0 (2026-06-01)

AsyncAPI support and improved bundle performance

This release brings AsyncAPI documents closer to feature parity with OpenAPI. AsyncAPI specs now render schemas as Models, display channels in the content area, and surface introduction headings in the sidebar and search. We also shipped a new ESM standalone bundle with code splitting that reduces the initial load by over 500 KB.

• AsyncAPI schemas render as Models in the sidebar, content, and search alongside OpenAPI schemas
• AsyncAPI channels appear in the content area with their address and description, grouped by tags when configured
• New ESM standalone bundle with code splitting drops initial load from 3.32 MB to 2.73 MB by lazy-loading the API client modal and icon library
• Configure the Models section label with modelsSectionLabel to use OpenAPI-style Schemas terminology or custom labels
• Customize the browser tab title with setPageTitle, called whenever the section in view changes

Read full release notes

1.57.5 (2026-05-27)

Response content type selector works with expanded responses

When every response is expanded by default, the content type picker now stays above the response body and remains clickable.

Read full release notes

1.57.3 (2026-05-21)

Custom fetch support and clearer schema examples

You can now pass a custom fetch implementation through API Reference configuration so Test Request calls honor options like credentials. Schema examples also render more reliably for null, whitespace-only, and value or externalValue shapes.

• Added customFetch configuration and deprecated the previous fetch option with an automatic migration path.
• Fixed rendering for null, whitespace-only, and value or externalValue schema examples.

Read full release notes

1.57.2 (2026-05-15)

Security badge layout stays intact

The security badge no longer shrinks in tight layouts, so operation headers stay readable on smaller screens.

Read full release notes

1.57.0 (2026-05-14)

AsyncAPI support, better search, and cleaner teardown

API Reference now treats AsyncAPI documents as first-class citizens alongside OpenAPI, with clearer badges, download labels, and improved search across polymorphic schemas.

• Added AsyncAPI badges and a Download AsyncAPI Document action.
• Improved search ranking for parameters, request bodies, and model fields, including oneOf, anyOf, and allOf schemas.
• Fixed listener leaks when createApiReference instances are destroyed repeatedly.
• Raised the mobile sidebar z-index so it stays above page content.
• Resolved $ref values in additionalProperties before rendering schemas.

Read full release notes