Skip to content

fix: migrate editor preview from @redocly/openapi-docs to @redocly/api-docs - #411

Merged
Daryna-del merged 4 commits into
mainfrom
fix/editor-preview-api-docs
Sep 10, 2026
Merged

fix: migrate editor preview from @redocly/openapi-docs to @redocly/api-docs#411
Daryna-del merged 4 commits into
mainfrom
fix/editor-preview-api-docs

Conversation

@Daryna-del

@Daryna-del Daryna-del commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

What/Why/How?

@redocly/openapi-docs was removed from Realm in 0.137.0-next.7 and replaced by @redocly/api-docs. The editor preview page in marketing-pages still expected the old RedoclyOpenAPIDocs component API, so the website build failed on Realm 0.137.0-next.9 with Could not resolve "@redocly/openapi-docs".

Reference

Website build failed

Once PR in marketing-pages is merged, version of marketing-pages should be updated here

Testing

Locally

Screenshots (optional)

Check yourself

  • Code is linted
  • Tested
  • All new/updated code is covered with tests

Security

  • Security impact of change has been considered
  • Code follows company security practices and guidelines

@Daryna-del Daryna-del self-assigned this Sep 10, 2026
@Daryna-del
Daryna-del marked this pull request as ready for review September 10, 2026 15:58
@Daryna-del
Daryna-del requested a review from a team as a code owner September 10, 2026 15:58

@redocly redocly Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

marketing-site AI Review: 🟢 Completed

Note

Low Risk

Isolated change updating the editor preview route and package dependencies following the replacement of @redocly/openapi-docs with @redocly/api-docs in Realm. Blast radius is low and limited to the embedded editor preview page.

Overview

  • Migrates @theme/preview.route.tsx imports from deprecated @redocly/openapi-docs to @redocly/api-docs (RedocStandalone and safeSlugify).
  • Updates @redocly/marketing-pages to ^0.2.35 and @redocly/realm to 0.137.0-next.9.
  • Adds events and url dependencies and updates package overrides for @redocly/theme to align with the Realm upgrade.

@Daryna-del
Daryna-del merged commit b5af34e into main Sep 10, 2026
2 of 5 checks passed
@Daryna-del
Daryna-del deleted the fix/editor-preview-api-docs branch September 10, 2026 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants