[dependabot]

Bumps redoc from 2.5.1 to 3.0.1.

Release notes

Sourced from redoc's releases.

redoc@3.0.1

Patch Changes

• fc5ac9a: Improved the Copy for LLM output for a single operation, tag, schema, channel, or GraphQL item: it now starts with the API and page title and a link to the full specification, the slice is wrapped in a fenced code block, and a long info.description is cut to 100 characters.

redoc@3.0.0

Redoc 3.0 is a new renderer built on the same engine as Redocly's commercial API reference. See What's new in Redoc 3 and the migration guide from 2.x.

Features

• ES module build. The package and the standalone bundle ship as ES modules. Load the bundle with <script type="module" src="…/bundles/redoc.standalone.js"> and import init (and hydrate for server-rendered markup) from it.
• Multiple specification types: One renderer for OpenAPI 3.2, 3.1 and 3.0, Swagger 2.0 (converted to OpenAPI 3 on load), AsyncAPI 3.x and 2.x, GraphQL SDL, and MCP servers described with x-mcp. The type is detected from the description. Format adapters load on demand.
• OpenAPI 3.2 support: additionalOperations, querystring parameters, itemSchema for streaming media types, and the tag summary, parent and kind fields for nested navigation.
• New design: Three-panel and stacked layouts (layout option), per-entity pages, deep links down to individual fields, and viewport-aware rendering for large descriptions.
• Hash and history routing: Every operation, schema and entity has its own route.
  • Hash routing (#/events/listspecialevents) is the default for the <redoc> element, the init function and the Docker image, and works on any static host.
  • History routing gives clean, shareable URLs such as /docs/events/listspecialevents. Enable it with router="history" and basePath. The server must return the page for every path under basePath.
  • The RedocStandalone React component uses history routing by default under basePath, or the host application's React Router when it renders inside one.
• Dark theme: Built-in light and dark color modes that follow the system preference, with a switcher in the sidebar.
• Customization with CSS variables: Override design tokens such as --color-primary-base or --sidebar-width in a stylesheet, scoped with :root.light and :root.dark.
• Search across operations, schemas, parameters and response codes, always enabled.
• Copy for LLM, Open in Claude and Open in ChatGPT actions in the page header.
• New options: router, basePath, events, codeSamples.languages, skipBundle, disableTelemetry, and AsyncAPI and GraphQL options such as jsonSamplesDepth, menu and info.
• Anonymous OpenTelemetry usage telemetry, on by default.

Breaking Changes

• The UMD bundle and the global Redoc object are removed. Redoc.init(spec, options, element, callback) becomes init(spec, options, element) imported from the bundle, without a callback.
• The theme option is removed with no compatibility shim. Use CSS variables instead.
• Requires Node.js 22 or later. Peer dependencies are now react and react-dom 18.3 or 19, react-router 7 or 8, styled-components 6 and @redocly/config. mobx and core-js are no longer needed.
• Deep links use the new route format, for example #/events/listspecialevents. 2.x links redirect on load, except links to schemas (#schema/<name>) and to single security schemes.
• Renamed options:
  • hideDownloadButton → hideDownloadButtons
  • jsonSampleExpandLevel → jsonSamplesExpandLevel
  • schemaExpansionLevel → schemasExpansionLevel

... (truncated)

Changelog

Sourced from redoc's changelog.

3.0.1

Patch Changes

• fc5ac9a: Improved the Copy for LLM output for a single operation, tag, schema, channel, or GraphQL item: it now starts with the API and page title and a link to the full specification, the slice is wrapped in a fenced code block, and a long info.description is cut to 100 characters.

3.0.0

Redoc 3.0 is a new renderer built on the same engine as Redocly's commercial API reference. See What's new in Redoc 3 and the migration guide from 2.x.

Features

• ES module build. The package and the standalone bundle ship as ES modules. Load the bundle with <script type="module" src="…/bundles/redoc.standalone.js"> and import init (and hydrate for server-rendered markup) from it.
• Multiple specification types: One renderer for OpenAPI 3.2, 3.1 and 3.0, Swagger 2.0 (converted to OpenAPI 3 on load), AsyncAPI 3.x and 2.x, GraphQL SDL, and MCP servers described with x-mcp. The type is detected from the description. Format adapters load on demand.
• OpenAPI 3.2 support: additionalOperations, querystring parameters, itemSchema for streaming media types, and the tag summary, parent and kind fields for nested navigation.
• New design: Three-panel and stacked layouts (layout option), per-entity pages, deep links down to individual fields, and viewport-aware rendering for large descriptions.
• Hash and history routing: Every operation, schema and entity has its own route.
  • Hash routing (#/events/listspecialevents) is the default for the <redoc> element, the init function and the Docker image, and works on any static host.
  • History routing gives clean, shareable URLs such as /docs/events/listspecialevents. Enable it with router="history" and basePath. The server must return the page for every path under basePath.
  • The RedocStandalone React component uses history routing by default under basePath, or the host application's React Router when it renders inside one.
• Dark theme: Built-in light and dark color modes that follow the system preference, with a switcher in the sidebar.
• Customization with CSS variables: Override design tokens such as --color-primary-base or --sidebar-width in a stylesheet, scoped with :root.light and :root.dark.
• Search across operations, schemas, parameters and response codes, always enabled.
• Copy for LLM, Open in Claude and Open in ChatGPT actions in the page header.
• New options: router, basePath, events, codeSamples.languages, skipBundle, disableTelemetry, and AsyncAPI and GraphQL options such as jsonSamplesDepth, menu and info.
• Anonymous OpenTelemetry usage telemetry, on by default.

Breaking Changes

• The UMD bundle and the global Redoc object are removed. Redoc.init(spec, options, element, callback) becomes init(spec, options, element) imported from the bundle, without a callback.
• The theme option is removed with no compatibility shim. Use CSS variables instead.
• Requires Node.js 22 or later. Peer dependencies are now react and react-dom 18.3 or 19, react-router 7 or 8, styled-components 6 and @redocly/config. mobx and core-js are no longer needed.
• Deep links use the new route format, for example #/events/listspecialevents. 2.x links redirect on load, except links to schemas (#schema/<name>) and to single security schemes.
• Renamed options:
  • hideDownloadButton → hideDownloadButtons

... (truncated)

Commits

• fc5257d chore: 🔖 release new versions v3.0.1 (#2866)
• fc5ac9a fix: add prefix to copy for LLM functionality (#2865)
• de82d25 chore: simplify playground specs (#2864)
• 8daca1c chore: update readme (#2863)
• 0379c62 chore: update Readme file after release (#2862)
• 6d97729 feat: Redoc v3.0.0 (#2735)
• 2e30cab chore(deps): resolve handlebars CVE (GHSA-p8wg-vrv2-v86f, GHSA-8r5x-fm3f-whwj...
• feaa439 chore(deps): resolve proxy-addr CVE (dependabot #265) (#2858)
• 9fa343a chore(deps): resolve shell-quote CVE (dependabot #269) (#2859)
• e94f30a chore(deps): resolve js-yaml CVE-2026-84375 (#2848)
• Additional commits viewable in compare view

Maintainer changes

This version was pushed to npm by GitHub Actions, a new releaser for redoc since your current version.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

---

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)