Scalar Changelog

1.1.38 (2026-10-05)

Mon, 05 Oct 2026 00:00:00 GMT

1.73.0 (2026-10-05)

Mon, 05 Oct 2026 00:00:00 GMT

Featured client tabs, visible extensions, and better schema composition

Choose which HTTP clients appear as tabs in your API documentation, show OpenAPI extensions without plugins, and control how many request body properties display by default. Plus improvements to nested schema composition and floating UI styling.

Add featuredClients to choose which HTTP clients are shown as tabs in the Client Libraries block, and in which order
Add showExtensions to display selected OpenAPI extensions on operations, parameters, response headers, and schema fields without a custom plugin
Add hideModelNames to show structural types instead of model names in schema labels and operation headings
Add maxVisibleRequestBodyProperties to control the initial request body property limit with a count of hidden properties
Keep nested allOf object fields and choice groups inside their named property, with recursive references rendering as leaves

Read full release notes

1.1.37 (2026-10-02)

Fri, 02 Oct 2026 00:00:00 GMT

1.72.4 (2026-10-02)

Fri, 02 Oct 2026 00:00:00 GMT

Better accessibility and fixes for discriminator schemas and CDN caching

This release improves keyboard navigation and screen reader support for code blocks, fixes a visual bug where discriminator oneOf variants composed with allOf were rendering duplicated content, and resolves an issue where cached ESM entry points could fail to load chunks after a new release.

Code blocks now announce their language to screen readers (for example, "Code sample: Shell cURL") and copy buttons have stable accessible names in all states
Pressing Space in multiselect comboboxes like the auth scheme picker now toggles the active option instead of hiding the list when the search is empty
Discriminator oneOf variants that use allOf to compose their base schema no longer render duplicate selectors, fields, or descriptions
The ESM entry point now pins itself to its release version when loading chunks from CDN URLs, preventing 404 errors when a cached entry point tries to fetch chunks from a newer release
Custom self-hosted paths and popular CDN hosts like jsDelivr and UNPKG continue to work without changes

Read full release notes

1.1.36 (2026-09-30)

Wed, 30 Sep 2026 00:00:00 GMT

1.72.3 (2026-09-30)

Wed, 30 Sep 2026 00:00:00 GMT

Search performance improvements and parameter display fixes

This release brings substantial search performance improvements and fixes several display issues in the API Reference. Search operations are now faster through optimized schema traversal and reduced computation overhead.

Search is up to 28% faster when opening search and up to 30% faster during typing by optimizing schema field collection and skipping unused match range calculations
Nested properties of expanded query parameters now display with proper indentation under their parent objects and arrays
Authentication dropdowns are hidden when only one required option is available, streamlining the interface while keeping credential inputs visible
Response examples now display correctly when multiple media types normalize to the same MIME type, preserving distinct content for each variant
Configuration updates skip unchanged document fields during change detection, reducing unnecessary processing overhead

Read full release notes

1.1.35 (2026-09-29)

Tue, 29 Sep 2026 00:00:00 GMT

1.72.2 (2026-09-29)

Tue, 29 Sep 2026 00:00:00 GMT

Improved accessibility and contrast across themes

This release addresses findings from an external accessibility audit, improving screen reader semantics, keyboard navigation, and color contrast across the reference and all shipped themes.

Text and focus rings now meet WCAG contrast minimums in the default light theme and nine presets
Screen readers announce correct selection states, response status meanings, and collapsible section structure
Keyboard focus rings are visible on all interactive controls including the response copy button
Schema tree toggles and property copy buttons meet the 24px minimum touch target size in narrow layouts
The powered by Scalar link now includes UTM parameters to identify which integration visitors came from

Read full release notes

1.1.34 (2026-09-25)

Fri, 25 Sep 2026 00:00:00 GMT

1.72.1 (2026-09-25)

Fri, 25 Sep 2026 00:00:00 GMT

XML generation improvements and navigation fixes

This release introduces schema-aware XML example generation across the reference documentation, with proper support for attributes, namespaces, and OpenAPI 3.2 features. Navigation in themed layouts now scrolls correctly to selected operations.

XML examples now preserve attributes, namespaces, and element structure consistently across request bodies, response examples, code snippets, and mock responses
Authentication tooltips show clear headings with readable scheme types, API key locations and names, and formatted descriptions
Fixed sidebar navigation scrolling past operations in themes with decorative backgrounds like Kepler and Deep Space
Nested objects composed from multiple allOf schemas now display with proper indentation instead of merging fields into the parent level
Mock server XML responses include X-Scalar-XML-Error header when generation fails, with detailed diagnostics for troubleshooting

Read full release notes

0.17.0 (2026-09-25)

Fri, 25 Sep 2026 00:00:00 GMT

Schema-aware XML generation and AsyncAPI security hardening

Mock server XML responses now preserve attributes, namespaces, and proper element structure from OpenAPI schemas. AsyncAPI reference resolution is now restricted to safe locations.

XML mock responses now serialize using schema metadata instead of json2xml, preserving attributes, namespaces, and root element names from your OpenAPI document.
Mock server returns X-Scalar-XML-Error header when XML generation fails, helping you debug schema issues.
AsyncAPI external references are now restricted to the source directory and public network addresses for improved security.
Existing XML response snapshots may need updating to match the new schema-aware output format.

Read full release notes

1.1.33 (2026-09-24)

Thu, 24 Sep 2026 00:00:00 GMT

1.72.0 (2026-09-24)

Thu, 24 Sep 2026 00:00:00 GMT

OpenAPI 3.2 query string and custom HTTP method support

This release adds OpenAPI 3.2 support for querystring parameters and custom HTTP methods (additionalOperations), plus fixes for discriminator labels, parameter examples, and server-side rendering hydration.

Querystring parameters are now editable, validated, and rendered in requests and code samples, with proper handling of percent encoding and mixed query parameter types.
Custom HTTP methods defined in additionalOperations appear in navigation and can be sent from the API client, preserving their case throughout requests and code examples.
Parameter examples using dataValue or serializedValue are now honored in the editor, outgoing requests, and generated snippets without double encoding.
Discriminator mapping values appear beside schema names in oneOf and anyOf selectors, making it clear which payload value selects each schema.
SDK code samples can now be linked to request examples using optional example and contentType fields, with unavailable samples showing localized status messages.

Read full release notes

0.16.0 (2026-09-24)

Thu, 24 Sep 2026 00:00:00 GMT

OpenAPI 3.2 querystring parameters and custom HTTP methods

This release adds support for OpenAPI 3.2 features including whole-query parameters and document-defined HTTP methods like PURGE or NOTIFY.

Querystring parameters can now be validated and handled in custom request handlers, with full support for JSON, text, and form content from the entire query string.
Custom HTTP methods defined in additionalOperations are now supported with case-sensitive routing and CORS preflight responses.
The mock server preserves custom method capitalization when routing requests to your handlers.
Boolean false schemas are now correctly preserved in validation, rejecting every value as specified in your OpenAPI document.

Read full release notes

1.1.32 (2026-09-22)

Tue, 22 Sep 2026 00:00:00 GMT

1.71.0 (2026-09-22)

Tue, 22 Sep 2026 00:00:00 GMT

Streaming schemas, collapsible parameters, and copy operations as Markdown

This release adds OpenAPI 3.2 streaming support with generated framed examples, a new option to collapse parameter lists, and a Copy as Markdown button for operations and webhooks. The API Client now loads on demand and supports eight languages.

Support OpenAPI 3.2 streaming item schemas with framed JSON Lines, JSON Sequence, and server-sent events examples across request bodies, responses, and code snippets.
Add Copy as Markdown buttons to operations and webhooks in both layouts, converting resolved OpenAPI documents to Markdown on demand.
Add expandAllParameters option (defaults to true) to start operation parameters collapsed and expand each one on click for cleaner long parameter lists.
Load the API Client modal and agent chat only when first opened instead of at startup, reducing initial bundle size by about 28 percent for read-only configurations.
Localize the embedded API Client in eight languages (English, Russian, Spanish, French, German, Simplified Chinese, Arabic, and Portuguese) with override support through configuration.

Read full release notes

0.12.35 (2026-09-22)

Tue, 22 Sep 2026 00:00:00 GMT

Faster startup and smarter OpenAPI reference resolution

This release makes the agent chat load faster by deferring the API client modal until you actually need it. We also improved how relative references resolve in OpenAPI 3.2 documents, honoring the $self identifier and preserving authored reference spellings.

The API client modal now loads on demand when you open a request, saving 292 KB (28%) on initial page load.
Added support for OpenAPI 3.2 $self to resolve relative references against the document's declared identity instead of its network location.
Preserved authored reference spellings through partial bundles and editable exports, so schema labels and anchors keep their existing behavior.
URI resolution now correctly handles root-relative URLs, protocol-relative URLs, query strings, and fragments across all bundler workflows.

Read full release notes

0.15.0 (2026-09-22)

Tue, 22 Sep 2026 00:00:00 GMT

OpenAPI 3.2 streaming, OAuth device authorization, and WebSocket v2

This release adds OpenAPI 3.2 support across the mock server, including streaming responses with itemSchema and OAuth device authorization flows. WebSocket handling has been upgraded to Hono Node server v2.

Generate finite SSE, JSON Lines, NDJSON, and JSON Sequence mock responses from OpenAPI 3.2 itemSchema definitions.
Support OAuth device authorization flows with verification codes, token polling, and mock approval endpoints.
Generate the correct primitive and array branches for anyOf and oneOf schemas, preserving the selected shape in mock HTTP responses.
Upgrade to Hono Node server v2 for WebSocket support. AsyncAPI callers must pass websocket to serve() instead of calling injectWebSocket().
Preserve semantics when upgrading to OpenAPI 3.2, with compatibility diagnostics for descriptions requiring author decisions.

Read full release notes

1.1.31 (2026-09-21)

Mon, 21 Sep 2026 00:00:00 GMT

1.70.0 (2026-09-21)

Mon, 21 Sep 2026 00:00:00 GMT

Search multi-document selectors, lazy-load external examples, and better deep linking

This release adds filtering and keyboard navigation to the multi-document API selector, making large references easier to navigate. External examples now load on demand instead of at startup, and deep links scroll correctly even when your app has sticky headers.

Filter API documents by title with keyboard navigation in the multi-document selector
Load external examples only when visible or opened in Test Request, improving performance for large APIs
Deep-linked headings now appear below sticky or fixed headers instead of scrolling behind them
Show response example summaries and descriptions alongside their payloads
Generate AsyncAPI payload examples from JSON Schema when no explicit example is provided

Read full release notes

0.14.4 (2026-09-21)

Mon, 21 Sep 2026 00:00:00 GMT

Polish and bug fixes shipped

Read full release notes

1.1.29 (2026-09-18)

Fri, 18 Sep 2026 00:00:00 GMT

1.69.1 (2026-09-18)

Fri, 18 Sep 2026 00:00:00 GMT

OAuth2 metadata discovery and environment defaults

This release adds OAuth2 authorization server metadata discovery for OpenAPI 3.2, fixes environment variable resolution in API references, and renders new display fields from the OpenAPI 3.2 specification.

OAuth2 metadata URLs now fetch authorization server metadata to discover flows and endpoints while preserving explicit configuration
Environment variable defaults from OpenAPI documents now apply correctly in the reference and Test Request client
Response summaries, server names in server selectors, and deprecated security scheme strikethroughs now render for OpenAPI 3.2 documents
Fixed the API client modal getting stuck on a placeholder state when reopening a document's first operation after the document re-synced

Read full release notes

0.14.2 (2026-09-18)

Fri, 18 Sep 2026 00:00:00 GMT

OAuth2 metadata discovery for local development

The mock server now serves OAuth2 authorization server metadata at the configured URL, advertising local mock endpoints and the grants and scopes you have defined.

Serve OAuth2 metadata at the declared oauth2MetadataUrl with local mock endpoints and configured grants and scopes.
Normalize absolute OAuth token URLs to route paths when registering mock authentication routes.
Warn when OAuth2 metadata routes collide with declared API paths to help catch configuration issues early.

Read full release notes

1.1.28 (2026-09-16)

Wed, 16 Sep 2026 00:00:00 GMT

1.69.0 (2026-09-16)

Wed, 16 Sep 2026 00:00:00 GMT

Tree layout, shared localization engine, and response hooks

This release introduces a new tree layout for schema rendering with continuous depth rails and inline disclosure controls, ships a shared localization engine across packages, and adds response interception hooks for API references.

Schema renderer now uses a tree layout with depth rails, inline type tokens, and one disclosure grammar across parameters, headers, callbacks, and AsyncAPI messages.
Deep links and expand-all now work across every surface through a per-reference expansion store, with keyboard navigation available behind the schemaKeyboardNav flag.
Localization moves to a shared @scalar/localization package. Schema-related translation keys migrate from common.* to schema.* (e.g., common.nullable becomes schema.nullable).
Response hooks can now replace the response before the client processes it, and the onResponseReceived callback ships for API references.
Discriminator-based variant selectors render consistently for array items and object properties, with inherited fields shown once instead of twice.

Read full release notes

0.14.1 (2026-09-16)

Wed, 16 Sep 2026 00:00:00 GMT

Mock server now serves deprecated response schemas and supports HTTP QUERY

The mock server no longer returns empty bodies for deprecated response schemas. It now correctly generates values for deprecated fields and message payloads, matching real API behavior. HTTP QUERY requests are now allowed in CORS preflight responses.

Deprecated response schemas are now served with generated content instead of empty bodies.
AsyncAPI deprecated message payloads generate realistic data instead of sending null.
Response headers that generate no value are skipped rather than being deleted.
HTTP QUERY method is now supported in default CORS preflight responses.

Read full release notes

1.1.27 (2026-09-07)

Mon, 07 Sep 2026 00:00:00 GMT

1.68.0 (2026-09-07)

Mon, 07 Sep 2026 00:00:00 GMT

Default request body view and composition label improvements

You can now open the request body editor in Form view by default, and schema composition selectors show clearer labels for array types that reference models.

Set defaultRequestBodyView: 'form' in config or use the x-scalar-default-request-body-view extension to start in Form view instead of Raw.
Array branches in schema composition selectors now show the referenced model name (for example, ResourceObject[] instead of the generic array object[]).

Read full release notes

0.14.0 (2026-09-07)

Mon, 07 Sep 2026 00:00:00 GMT

Custom handler and seed code now runs in a secure sandbox

This release hardens the mock server against security risks. Custom handler and seed code is now isolated in a WebAssembly sandbox, and OpenAPI references are protected from server-side request forgery and unauthorized file access.

Custom x-handler and x-seed code now runs in a QuickJS WebAssembly sandbox with memory and time limits, preventing access to the Node.js host.
OpenAPI $ref resolution is now hardened to block private networks, loopback addresses, and metadata endpoints.
Local file references are confined to the document's own directory, preventing unauthorized file reads.
The store, faker, req, res, schema, and seed APIs continue to work as before in the sandbox.
Faker methods that take callbacks (like faker.helpers.multiple) are no longer supported due to sandbox boundaries.

Read full release notes

1.1.26 (2026-08-28)

Fri, 28 Aug 2026 00:00:00 GMT

1.67.0 (2026-08-28)

Fri, 28 Aug 2026 00:00:00 GMT

Better heading hierarchy and response example syncing

This release fixes how heading levels work when rendering blocks on their own (like in docs sites), synchronizes response examples with the content type selector, and polishes several schema display issues.

Heading levels now resolve from the page outline instead of being hardcoded, so an operation rendered alone starts at h1
Response examples now reflect the content type selected in the response dropdown
oneOf selector labels now show each variant's own name instead of repeating the shared base name
OAuth scopes section only renders for oauth2 and openIdConnect schemes, not for http or apiKey schemes
Pattern hover chip moved next to Example chip so it no longer collides with constraints

Read full release notes

0.13.0 (2026-08-28)

Fri, 28 Aug 2026 00:00:00 GMT

Server-Sent Events support and improved error diagnostics

The mock server now streams text/event-stream responses as real Server-Sent Events, returns structured JSON errors that name the failed operation, and validates recursive schemas correctly.

Server-Sent Events responses are now streamed with proper data: line framing instead of buffered as a single JSON body.
Named examples in SSE responses are sent as a sequence of events in declaration order.
Unhandled errors return structured JSON with the operation method, path, and operationId instead of plain-text 500 responses.
Request validation now works for recursive schemas instead of silently falling open.
Path keys with query strings or special routing characters are properly escaped and matched against incoming requests.

Read full release notes

1.1.25 (2026-08-20)

Thu, 20 Aug 2026 00:00:00 GMT

1.1.24 (2026-08-20)

Thu, 20 Aug 2026 00:00:00 GMT

1.66.1 (2026-08-20)

Thu, 20 Aug 2026 00:00:00 GMT

Polish and bug fixes

Read full release notes

1.66.0 (2026-08-20)

Thu, 20 Aug 2026 00:00:00 GMT

Crawlable navigation and OpenAPI 3.2 nested tags

Navigation entries are now real anchor links that search engines can discover, and the API reference supports OpenAPI 3.2 tag nesting for multi-level hierarchies.

Sidebar navigation renders as anchor links instead of buttons, so entries can be opened in a new tab and are crawlable with path routing enabled
Server-rendered HTML includes a hidden flat list of all sidebar URLs so crawlers can discover every operation and model without executing JavaScript
OpenAPI 3.2 nested tags are now supported through the native parent field, building arbitrary-depth hierarchies with sticky breadcrumb navigation in the modern layout
Schema pattern constraints now appear as hover dropdowns instead of truncated inline text, making long regex patterns fully readable
Standalone browser build now ships with source maps for easier debugging, and a short CDN URL is available at /esm.js

Read full release notes

0.12.28 (2026-08-20)

Thu, 20 Aug 2026 00:00:00 GMT

Security and infrastructure improvements

Read full release notes

0.12.27 (2026-08-20)

Thu, 20 Aug 2026 00:00:00 GMT

Polish and bug fixes shipped

Read full release notes

0.12.13 (2026-08-20)

Thu, 20 Aug 2026 00:00:00 GMT

Package republished with npm trusted publishing

Read full release notes

1.1.22 (2026-08-13)

Thu, 13 Aug 2026 00:00:00 GMT

1.65.0 (2026-08-13)

Thu, 13 Aug 2026 00:00:00 GMT

AsyncAPI component exports and model link fixes

This release exports AsyncAPI content components so you can render individual channels, operations, and messages on their own pages. It also fixes several issues with model name links that appeared clickable but scrolled nowhere.

Export AsyncAPI content components (AsyncApiChannel, AsyncApiOperation, AsyncApiMessage) from @scalar/api-reference/components
Model names now render as plain text when the models section is hidden or the referenced model is hidden via x-internal
Fix model name links for schemas grouped under a tag via x-tags so clicking them scrolls to the correct model
Model names are no longer clickable when the reference points to parameters, responses, or external files instead of schemas
Webhooks now show a webhook icon in search results to distinguish them from regular operations

Read full release notes

0.12.25 (2026-08-13)

Thu, 13 Aug 2026 00:00:00 GMT

Better international input and NDJSON response rendering

Fixed Enter key sending messages too early when typing Japanese, Chinese, or Korean text on macOS Chrome and Safari.
NDJSON responses now render as pretty-printed JSON records instead of showing as a binary file.
Removed a debug log statement that fired every time you toggled the response view.

Read full release notes

1.1.21 (2026-08-07)

Fri, 07 Aug 2026 00:00:00 GMT

1.64.1 (2026-08-07)

Fri, 07 Aug 2026 00:00:00 GMT

Security hardening and accessibility improvements

This release hardens the API reference against untrusted OpenAPI documents, resolves critical accessibility violations, and fixes several rendering issues including duplicate enum values and recursive discriminator schemas.

Dangerous URLs from OpenAPI documents (like javascript: links) are now sanitized to prevent script execution when clicked
Fixed ARIA violations in the sidebar and client tabs to improve screen reader accessibility
Array parameters with enum items no longer list their values twice
Discriminator schemas that reference their base type no longer render recursively
Selected server is now preserved when the configuration is updated

Read full release notes

1.1.20 (2026-07-31)

Fri, 31 Jul 2026 00:00:00 GMT

1.64.0 (2026-07-31)

Fri, 31 Jul 2026 00:00:00 GMT

Plugin loading from URLs, improved schema composition, and accessibility fixes

This release introduces a new pluginUrls configuration option so integrations that pass JSON configuration can load plugins without custom bundles. Schema rendering now properly handles sibling properties in allOf compositions and multiple oneOf/anyOf groups, while accessibility improvements include proper ARIA attributes and print styles.

New pluginUrls configuration option allows loading API Reference plugins from URLs, enabling JSON-based integrations like Docker and server-side frameworks to use plugins without replacing the entire bundle
OAuth scopes required for an operation now appear as a dedicated section below the description instead of only inside the Auth Required badge popover
Schemas with multiple oneOf or anyOf groups under allOf now render every group with its own selector in position, rather than silently dropping all but the first
Sibling properties next to a single-member allOf are now preserved and merged with the base schema, fixing cases where fields and titles were lost
Print styles flatten the reference into document flow so saving to PDF no longer renders expanded content over following text or truncates long examples

Read full release notes

1.63.0 (2026-07-20)

Mon, 20 Jul 2026 00:00:00 GMT

SDK installation instructions now available for custom layouts

Consumers building custom reference layouts from blocks can now render SDK installation instructions again. The SdkInstallationInstructions component and getRenderableSdks helper are now exported from @scalar/api-reference/blocks.

Exported SdkInstallationInstructions component from blocks entry point
Exported getRenderableSdks helper for custom layouts that render x-scalar-sdk-installation

Read full release notes

1.1.19 (2026-07-16)

Thu, 16 Jul 2026 00:00:00 GMT

1.1.18 (2026-07-16)

Thu, 16 Jul 2026 00:00:00 GMT

1.62.9 (2026-07-16)

Thu, 16 Jul 2026 00:00:00 GMT

Updated package README with refreshed platform overview

Read full release notes

1.62.8 (2026-07-16)

Thu, 16 Jul 2026 00:00:00 GMT

Border radius scale now derives from a single variable

Setting --scalar-radius to zero now produces a fully square interface. Previously, larger radius tokens were independent, so rounded corners persisted on components using --scalar-radius-lg, --scalar-radius-xl, or rounded-full even when the base radius was set to zero.

All border radius tokens now derive from --scalar-radius, so overriding one variable rescales the entire interface
Setting --scalar-radius: 0 now removes all rounded corners across the UI
Added --scalar-radius-2xl (12px) and --scalar-radius-3xl (16px) tokens to fill out the scale
Added --scalar-radius-full token for pill shapes and circles
All default values remain unchanged, so existing themes render identically unless you were relying on independent radius tokens

Read full release notes

0.12.22 (2026-07-16)

Thu, 16 Jul 2026 00:00:00 GMT

Updated package README with refreshed platform overview

Read full release notes

0.12.21 (2026-07-16)

Thu, 16 Jul 2026 00:00:00 GMT

Border radius now scales from a single variable

Setting --scalar-radius now rescales every corner in the interface, including larger radii and pills. Previously, overriding the base radius left some corners rounded because tokens were independent.

All border radius tokens now derive from --scalar-radius, so setting it to 0 squares off the entire interface
Two new tokens, --scalar-radius-2xl (12px) and --scalar-radius-3xl (16px), fill out the scale
The rounded-2xl and rounded-3xl Tailwind utilities now work correctly
Default values are unchanged, so existing themes render identically unless you were overriding --scalar-radius alone

Read full release notes

0.12.7 (2026-07-16)

Thu, 16 Jul 2026 00:00:00 GMT

Updated README with refreshed Scalar platform overview

Read full release notes

1.1.16 (2026-07-15)

Wed, 15 Jul 2026 00:00:00 GMT

1.62.6 (2026-07-15)

Wed, 15 Jul 2026 00:00:00 GMT

AsyncAPI authentication and plugin auth fixes

AsyncAPI documents now render document-wide authentication with the same interactive selector used for OpenAPI. The plugin auth accessor now correctly reads credentials from the client store.

AsyncAPI documents now render document-wide authentication in the introduction with full input UI for shared scheme types (HTTP, OAuth2, OpenID Connect, API Key)
Security requirements are derived from the union of each server's security settings, with an optional no-auth choice when some servers allow unauthenticated connections
AsyncAPI OAuth2 availableScopes are mapped to OpenAPI scopes so the scope list renders correctly
Security scheme warnings now name the actual document type (AsyncAPI or OpenAPI) instead of always saying OpenAPI
Plugin auth accessor now reads from the correct store so plugins see the credentials and security schemes users actually entered

Read full release notes

0.12.6 (2026-07-15)

Wed, 15 Jul 2026 00:00:00 GMT

Fixed npm package README display

This release fixes a metadata collision that caused the package README to display incorrectly on the npm registry. The mock server now publishes with the updated README that includes the Scalar platform overview.

Read full release notes

1.1.15 (2026-07-08)

Wed, 08 Jul 2026 00:00:00 GMT

1.62.5 (2026-07-08)

Wed, 08 Jul 2026 00:00:00 GMT

Deep-link fixes and read-only auth for plugins

Response property deep links now scroll correctly on fresh loads, and plugins can read authentication state without being able to mutate it.

Response property deep links now work when expandAllResponses is off and scroll to the correct operation on page load
Plugins can read the global authentication state through a new read-only accessor in lifecycle hooks and view components
Security scheme delete buttons are now hidden in API reference (schemes come from the document and cannot be removed)
Schemas with allOf base properties next to oneOf or anyOf now keep shared fields visible in each branch
Protocol and server filters no longer appear in the classic layout header for AsyncAPI documents

Read full release notes

1.62.2 (2026-07-02)

Thu, 02 Jul 2026 00:00:00 GMT

AsyncAPI tag layout improvements and SSR hydration fix

This release fixes how AsyncAPI tags render in the reference documentation and resolves a hydration warning when server-side rendering.

AsyncAPI channels nested under tags now align with the rest of the document instead of being indented too far
AsyncAPI tag headers now display a Channels card that lists the channels in the tag, replacing the empty Operations card
Fixed an SSR hydration mismatch caused by scrollbar detection running too early on the client

Read full release notes

0.12.16 (2026-07-02)

Thu, 02 Jul 2026 00:00:00 GMT

Remove duplicate heading from start panel

The Agent Chat start panel no longer renders a hidden heading tag, preventing SEO issues on API reference pages where crawlers were detecting duplicate headings.

Read full release notes

1.1.12 (2026-06-30)

Tue, 30 Jun 2026 00:00:00 GMT

1.62.1 (2026-06-30)

Tue, 30 Jun 2026 00:00:00 GMT

Advanced schema rendering and stability fixes

This release improves support for OpenAPI 3.1 schemas with JSON Schema 2020-12 features, polymorphic types from code generators like NSwag, and fixes a crash affecting deeply nested or recursive schemas.

Generic schemas using $dynamicRef now render their concrete bound types instead of empty shapes (for example, PaginatedResponse<User> shows the User fields)
Polymorphic types with only a discriminator.mapping (common in NSwag output) now show the variant dropdown again
Fixed a stack overflow crash when rendering schemas with self-references inside allOf branches

Read full release notes

1.1.11 (2026-06-26)

Fri, 26 Jun 2026 00:00:00 GMT

1.62.0 (2026-06-26)

Fri, 26 Jun 2026 00:00:00 GMT

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.1.10 (2026-06-22)

Mon, 22 Jun 2026 00:00:00 GMT

1.61.0 (2026-06-22)

Mon, 22 Jun 2026 00:00:00 GMT

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

0.12.0 (2026-06-22)

Mon, 22 Jun 2026 00:00:00 GMT

Mock AsyncAPI documents and validate all parameter styles

The mock server can now generate event-driven APIs from AsyncAPI 3.1 documents, serving channels over WebSocket and Server-Sent Events. Request validation has been extended to cover header and cookie parameters, and all OpenAPI serialization styles are now deserialized before validation.

AsyncAPI 3.1 documents are mocked through a new createAsyncApiMockServer function that serves channels over WebSocket and SSE.
Messages are generated from payload schemas using the same generator as REST endpoints, and custom transports can be added through an extension point.
The Docker mock server auto-detects AsyncAPI documents and starts the event-driven engine automatically.
Header and cookie parameters are validated against their schemas, with case-insensitive header matching and spec-compliant filtering of Accept, Content-Type, and Authorization.
Array and object parameters are deserialized by their OpenAPI style (form, simple, deepObject, label, matrix, and delimiter styles) before validation, so complex query strings and path segments validate correctly.

Read full release notes

1.1.9 (2026-06-17)

Wed, 17 Jun 2026 00:00:00 GMT

1.60.0 (2026-06-17)

Wed, 17 Jun 2026 00:00:00 GMT

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

0.11.1 (2026-06-17)

Wed, 17 Jun 2026 00:00:00 GMT

Smarter response selection and format fixes

This release improves how the mock server chooses which response to return when your API defines multiple status codes, and fixes edge cases with line-delimited JSON formats and array responses.

The mock server now prefers 2xx success responses over error codes when no specific status is requested, making default mocks more realistic
JSONL and NDJSON responses are now correctly formatted as single-line records instead of pretty-printed JSON
Singular examples are automatically wrapped in arrays when the response schema expects an array

Read full release notes

1.1.8 (2026-06-11)

Thu, 11 Jun 2026 00:00:00 GMT

1.59.3 (2026-06-11)

Thu, 11 Jun 2026 00:00:00 GMT

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

0.11.0 (2026-06-11)

Thu, 11 Jun 2026 00:00:00 GMT

Request validation and improved authentication

The mock server now validates incoming requests against your OpenAPI schema by default, returning detailed contract violations instead of mock responses when parameters or bodies do not match. Authentication evaluation has been corrected to follow the OpenAPI specification.

Request validation is now on by default—path, query parameters, and JSON bodies are checked against the schema, returning 422 with violation details when they do not match
Use the Prefer header to control mock responses: code=404 picks a specific status, example=bob selects a named example from the examples map
Authentication now evaluates security requirements as OR-of-ANDs, inherits document-level security when operations define none, and validates credential shape for Basic and Bearer tokens
Set validateRequest: false to restore previous behavior and always return mock responses

Read full release notes

1.1.6 (2026-06-09)

Tue, 09 Jun 2026 00:00:00 GMT

1.59.2 (2026-06-09)

Tue, 09 Jun 2026 00:00:00 GMT

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)

Tue, 09 Jun 2026 00:00:00 GMT

Fixed examples panel layout in operation view

Read full release notes

1.1.5 (2026-06-08)

Mon, 08 Jun 2026 00:00:00 GMT

1.59.0 (2026-06-08)

Mon, 08 Jun 2026 00:00:00 GMT

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

0.12.7 (2026-06-08)

Mon, 08 Jun 2026 00:00:00 GMT

Polish and bug fixes shipped

Read full release notes

0.10.17 (2026-06-08)

Mon, 08 Jun 2026 00:00:00 GMT

Improved OpenAPI reference resolution performance

The mock server now resolves OpenAPI $ref nodes on demand instead of processing the entire document upfront, improving startup time and memory usage for large specifications.

References are now resolved lazily only when needed for generating responses
Nested references (like a Planet referencing a User) now resolve correctly in examples
Broken references are handled gracefully without failing document processing

Read full release notes

1.1.4 (2026-06-01)

Mon, 01 Jun 2026 00:00:00 GMT

1.58.0 (2026-06-01)

Mon, 01 Jun 2026 00:00:00 GMT

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)

Wed, 27 May 2026 00:00:00 GMT

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.1.3 (2026-05-22)

Fri, 22 May 2026 00:00:00 GMT

1.1.2 (2026-05-21)

Thu, 21 May 2026 00:00:00 GMT

1.1.1 (2026-05-21)

Thu, 21 May 2026 00:00:00 GMT

1.57.3 (2026-05-21)

Thu, 21 May 2026 00:00:00 GMT

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.1.0 (2026-05-16)

Sat, 16 May 2026 00:00:00 GMT

1.57.2 (2026-05-15)

Fri, 15 May 2026 00:00:00 GMT

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.0.13 (2026-05-14)

Thu, 14 May 2026 00:00:00 GMT

1.57.0 (2026-05-14)

Thu, 14 May 2026 00:00:00 GMT

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

0.12.0 (2026-05-14)

Thu, 14 May 2026 00:00:00 GMT

AsyncAPI documents in the Agent workspace

The Agent chat UI now understands workspace documents that can be either OpenAPI or AsyncAPI, so mixed API descriptions load through the same flow.

Read full release notes

0.10.14 (2026-05-04)

Mon, 04 May 2026 00:00:00 GMT

Smaller initial bundle for the chat UI

Tailwind CSS is now code-split so the Agent chat interface loads less CSS up front.

Read full release notes

0.10.10 (2026-04-27)

Mon, 27 Apr 2026 00:00:00 GMT

0.10.9 (2026-04-26)

Sun, 26 Apr 2026 00:00:00 GMT

Clearer messaging around Agent credits

We updated the copy around Agent credits so free limits and usage are easier to understand in the chat UI.

Read full release notes

0.10.2 (2026-04-21)

Tue, 21 Apr 2026 00:00:00 GMT

OAuth refresh endpoints in mock authentication routes

Mock Server now generates authentication routes for OAuth refreshUrl endpoints defined in your OpenAPI security schemes.

Read full release notes

0.10.0 (2026-04-15)

Wed, 15 Apr 2026 00:00:00 GMT

Random data generation for mock responses

Mock Server can now generate random but schema-aware data for responses, making local testing feel closer to real API behavior.

Read full release notes