Excluded pages from sitemaps if they are excluded from search.
- Realm
- Reef
- Revel
- Redoc
- Reunite
Next release
Try the "next" release candidate or wait until it is promoted to the latest version at the beginning of each month
Latest release
Features
Added support for
additionalOperationsin OpenAPI 3.2.0.Added a
bannercomponent to display announcements on project pages.Added GraphQL overview section customization with the
graphql.infoconfiguration option.Added search and curation support for
Reactpages.Added support for downloading API description files up to 15MB.
Updated header UI on the Replay request page.
Finalized
x-mcpsupport by adding resources and prompts.Added
hideOtherSecuritySchemesoption to@redocly/replayto hide the Other security scheme group in the Authorization type dropdown, displaying only the documented schemes from the OpenAPI description.Added code generation for requests in
Try It.Added support to close Replay modals with the
ESCkey or by clicking outside of them.Added search functionality to the API selection dropdown.
Updated layout of the Response panel.
Redesigned the Select environments dropdown in Replay.
Added a
Previewtab to Replay that closes automatically when inactive.Added search functionality to all editors in
Try it.Enabled autocompletion in OAuth token generation fields.
Double clicking a request preview tab in
Try itkeeps it open while previewing other tabs.
Fixes
The Connect to MCP page action option does not display when the MCP server is not available.
Fixed an issue where items from different versions appeared simultaneously in the sidebar when using
$refinsidebars.yaml.Fixed an issue where the AI Search form unintentionally submitted during text entry in Japanese.
Fixed content flickering in the OpenAPI sidebar navigation for non-default layouts.
Fixed incorrect application of
rel="noreferrer"on internal links.Fixed an issue where the
Ask AIbutton overlapped code examples.Fixed scorecard badge linking to a non-existent page when multiple catalogs were defined.
Fixed where
oneOfwas incorrectly labeled as recursive on API documentation pages.Fixed an issue where versioned API descriptions appeared multiple times in the classic catalog.
Fixed an issue where an
index.yamlOpenAPI file in the project root caused all pages to return a 500 error.Fixed security vulnerability in CORS middleware by upgrading
honoto v4.10.6.Fixed an issue where scorecard didn't work for projects with path prefix.
Fixed an issue where switching versions at the project root redirected to the first sidebar page instead of the current one.
Updated the
useConfigureReplayhook to allow saving Replay inputs for multiple security schemes.Fixed an issue where the AI Search feedback buttons weren't shown when a message had no resources.
Fixed an issue where a negative AI Search feedback was submitted without a provided reason but not shown as selected when the form was closed. Users were still able to change the feedback from negative to positive it was submitted.
Fixed incorrect detection of
RecursiveandComplextypes and restored missing title and description display foroneOf.Fixed code sample generation for
x-www-form-urlencodedandmultipart/form-datacontent types.Fixed an issue where the close button on Replay tabs also caused tabs to drag.
Fixed error message in
Generate tokento display the correct reason.Fixed tabs overlapping the drop-down list in Step view.
Fixed server URL resolution for relative OAuth token URLs in
Replay.Fixed a rendering issue that prevented line numbers from appearing in the editor when the content size exceeded certain limits.
Fixed saving Replay inputs for multiple security schemes from
useConfigureReplay.Fixed incorrect tab selection in the Replay Step view after switching tabs.
Fixed path parameters separated by underscores being parsed as a single parameter.
Fixed Avro schema support to correctly handle named schemas.
Previous releases
Fixes
Updated
@redocly/openapi-coreand@redocly/clito version2.12.3.
Features
Added synchronization of reviews and comments from Reunite to external Git providers.
Fixes
Updated
@redocly/ajvto version8.17.1.Updated
@redocly/openapi-coreand@redocly/clito version2.12.1.
Features
Removed
Theme componentspanel from editor page for unsupported productsREDOC,REEF, andREDOC_REEF.Fixed product type and version resolution during component ejection in the
Theme componentspanel whenpackage.jsonspecifies a product below the organization’s subscription plan.
Fixes
Skipped visual review check on external Git providers for pull requests targeting non-default branches.
Fixes
Fixed an issue where merged pull requests appeared as open for PRO plan subscriptions.
Fixes
Fixed editor reconnection failures caused by unexpected errors during connection.
Fixed issue where new files were not backed up to browser storage.
Features
Fixed an issue where filtering by values containing commas did not work correctly in API requests.
Fixes
Updated
@redocly/openapi-coreand@redocly/clito version2.11.1.Updated
@redocly/ajvto version8.11.4.
Fixes
Synchronized date range filters between feedback export modal and feedback list.
Features
Added
x-keywordsextension support for OpenAPI documents to boost or exclude search terms through keywords.Added
connect-mcpMarkdoc tag.Added support for configuring mock server settings at the product level.
Added Ask AI floating action button to trigger AI Search. Deprecated
search.aiconfig option and replaced it withaiAssistant.Added a possibility to send feedback for AI Search responses.
Added page actions that allow to connect to the MCP server via VSCode and Cursor.
Added support for
discriminator.defaultMappingin OpenAPI 3.2.0.Added
projectTitleparameter toseoconfiguration to append project name to page titles.Added
frontmatterTranslateutility to localize React front matter.Added
additionalPropstonavbar,sidebar, andfooteritems to enable adding custom properties.Added support for anchor links to the
tabsMarkdoc tag.Updated CSS styles for the
tagcomponent.
Fixes
Fixed a path prefix issue for static assets from
staticdirectory.Fixed an issue where disabling
mockServerdid not remove its paths.Fixed an issue where valid links caused link checker errors for API description file download links.
Fixed incorrect paths in anchor links when
REDOCLY_PREFIX_PATHSwas used.Fixed an issue where scorecard level rules were not overridden with target rules.
Fixed an issue where the link checker incorrectly reported links with configured wildcard redirects as broken.
Fixed navigation issues in sidebar, product, and version pickers for projects using path prefixes.
Fixed an issue where static assets were served without path prefix when it was enabled.
Updated
@redocly/openapi-coreto version2.10.0.Fixed an issue where renaming route paths and changing API functions required full restart in the preview mode.
Fixed security vulnerability
CVE-2025-62610.Fixed a conflict in the router between MCP server and file with the same name in the root directory.
Fixed an issue where API output files listed in the
ignoreconfiguration were not excluded.Fixed an issue in AsyncAPI docs where
schemaFormatwith$refin message payloads caused crashes.Fixed an issue where the sidebar didn't preserve its state between reloads.
Fixed an issue where component ejection failed with npm installations.
Fixed an issue where search didn't parse Markdoc variables and partials.
Fixed an issue where URLs in the sitemap didn't respect the path prefix.
Fixed an issue that caused redirects to not work in locales.
Fixed card links leading to incorrect locations in GraphQL and AsyncAPI docs.
Fixed an issue where navigation actions could not be disabled for a page using front matter.
Fixed an issue where link checker reported HTML
atag valid links in project under path prefix.Improved layout of the tabs component.
Improved AI assistant usability on mobile devices.
Content slugger no longer takes media assets and ignored files into account.
Fixed an issue where page actions appeared for each
partialMarkdoc tag on a page.Fixed an issue where
oneOftitles were overridden by the parent schema's title.Fixed an issue where servers in OpenAPI documentation pages were not inherited from the root server.
Fixed malformed operation link URL in Replay.
Updated
openapi-samplerfrom version 1.6.1 to 1.6.2.Updated
@redocly/openapi-coreand@redocly/respect-coreto version2.10.0.Changed Ask AI button default icon from
redoclytosparkles.Fixed an issue where the navbar link to the root ("/") path in projects under path prefix was not active.
Fixed the
Cardcomponent missing list bullets and limited Markdown support.Improved Download panel height to fit the content size for Graphql docs.
Fixes
Updated
@redocly/openapi-coreand@redocly/clito version2.10.0.
Features
Improved text color of disabled items in the file context menu.
Fixes
Fixed file upload for allowed folders with RBAC.
Updated
@redocly/openapi-coreand@redocly/clito version2.7.0.Fixed issue that allowed deletion of protected files from the file tree using keyboard shortcuts.
Fixes
Fixed an issue where successive sidebar items were not activated when users were scrolling API document pages.
Fixes
Renamed the
get-full-definitionMCP tool toget-full-spec-document.Fixed visual issue in
x-mcpoverview section.
Features
Added front matter keywords configuration to boost or demote search rankings for Markdown pages through includes/excludes lists.
Added validation for React pages to catch runtime errors during the build process.
Added
openapi.showSchemaCatalogLinksconfiguration option to display links to schemas and requests on an OpenAPI page. These links can be used as$refvalues in other OpenAPI files within the same project.Added support for
_partialsfolders at any directory level. Added glob pattern support for thepartialsFoldersconfiguration.Added
showBuiltInScalarsandshowBuiltInDirectivesoptions to control visibility of built-in GraphQL scalars and directives.Added validation to ensure
residencystarts withhttp://orhttps://.Added built-in MCP server to expose API docs to AI assistants.
Added support for OpenAPI 3.2.0 security updates:
deprecatedandoauth2MetadataUrlfields,deviceAuthorizationflow, and code samples generation for device authorization flow.Added support for the OpenAPI 3.2.0
servers.nameproperty.Improved memory efficiency when creating search indexes, reducing build failures due to out-of-memory errors on large projects.
Improved heading anchor ID generation by removing dots and slashes to create cleaner URL fragments.
Added path prefix support for HTML
hrefattributes.Added support to configure
Replaywith dynamic API data.Added support for the
x-mcpvendor extension in OpenAPI to render MCP server documentation.Added the OpenAPI
infoobject to theuseConfigureReplaycontext.Added persistence for user-created environments in
Try itbetween page reloads.
Fixes
Fixed an issue where environment variables were not resolved inside
redocly.yamlwhen building OpenAPI documents.Fixed an issue where tooltips could obscure the parent UI element.
Fixed responses without parameters not being included in
llms.txt.Fixed search issue where queries with text enclosed in backticks in API descriptions returned no results.
Fixed display of active element in
code-grouptag after page refresh.Fixed an issue with displaying multiple active elements in a
code-grouptag when they had the same names.Improved error message for broken sidebar links in front matter.
Fixed search dialog results being unscrollable on small screens. Fixed advanced search filters overflowing the viewport on small screens.
Fixed an issue where
x-rbacandmarkdocdid not work in Swagger (Open API 2.0.x) descriptions.Improved build logs by separating AI Search and
llms.txtmessages.Fixed an issue where external links in the sidebar appeared as active.
Added
iconoption to sidebarseparator.Fixed an issue that prevented focusing the first section of the API documentation when content was minimal.
Fixed an issue where following an anchor link did not cause the page to scroll to the target heading.
Fixed duplicated descriptions in
oneOfoptions.Fixed an issue where the AI search icon shrank with long queries; the icon maintains its size and the query text wraps correctly.
Fixed missing
Expand Allbutton in requests usingoneOf.Fixed an issue with the sidebar active item when using
REDOCLY_PREFIX_PATHSand the OpenAPI document was in the root directory.Fixed partial tags not rendering correctly when containing schema components such as OpenAPI examples and code samples.
Fixed security vulnerability CVE-2025-59139 in
bodyLimitmiddleware by upgradinghonoto v4.9.7.Fixed an issue where the API Catalog displayed only one API from versioned subfolders.
Fixed
replay-openapiMarkdoc tag not updating until page refresh.Normalized trailing slash handling in SSR to prevent hydration mismatches.
Fixed double prefixes in image URLs.
Fixed an issue where the OpenAPI download URLs did not work with the
outputproperty if the output path was in the/static/_spec/directory.Fixed an issue where plugins writing data to the files in project interfered with the processing causing link checker errors.
Removed empty catalog sidebar when no filters were configured.
Enhanced
JsonViewerwithcontrolsprop to manageCodeBlockheaders; removedhideHeaderprop.Added handling for special characters in query strings.
Fixed processing of relative OAuth 2.0 authorization and token URLs during the OAuth flow. Parsed OAuth 2.0 scopes from the API definition and displayed them in the security tab.