Upgrading redoc from 2.x to 3.x

Comparison of the public API of redoc 2.5.4 and 3.0.0, computed automatically from their TypeScript types. A changed signature is a candidate for a breaking change, not a certainty.

Summary

Removed import paths	0
Removed exports	238
Changed signatures	5
Removed class or interface members	0
Changed class or interface members	0
Newly deprecated	0
Requirement changes (engines, peer dependencies)	9
New exports	5

Removed exports

import	export	kind	Before
`redoc`	`Row`	variable	`any`
`redoc`	`css`	variable	`styledComponents.ThemedCssFunction<ResolvedThemeInterface>`
`redoc`	`media`	variable	{ lessThan(breakpoint: any, print?: boolean \| undefined, extra?: string \| undefined): (...args: any[]) => styledComponents.FlattenInterpolation<styledComponents.ThemedStyledProps<object, ResolvedThemeInterface>>; greaterThan(breakpoint: any): (...args: any[]) => styledComponents.FlattenInterpolation<styledComponents.ThemedStyledProps<object, ResolvedThemeInterface>>; between(firstBreakpoint: any, secondBreakpoint: any): (...args: any[]) => styledComponents.FlattenInterpolation<styledComponents.ThemedStyledProps<object, ResolvedThemeInterface>>; }
`redoc`	`Schema`	class	`class`
`redoc`	`styled`	variable	`styledComponents.ThemedStyledInterface<ResolvedThemeInterface>`
`redoc`	`ApiInfo`	class	`class`
`redoc`	`ApiLogo`	class	`class`
`redoc`	`Example`	function	`({ example, mimeType }: ExampleProps): React.JSX.Element`
`redoc`	`Loading`	class	`class`
`redoc`	`Section`	variable	`any`
`redoc`	`TagInfo`	type	`OpenAPITag & { operations: ExtendedOpenAPIOperation[]; used?: boolean \| undefined; }`
`redoc`	`history`	variable	`HistoryService`
`redoc`	`isArray`	function	`(value: unknown): value is any[]`
`redoc`	`mapLang`	function	`(lang: string): string`
`redoc`	`memoize`	function	`<T>(target: any, name: string, descriptor: TypedPropertyDescriptor<T>): TypedPropertyDescriptor<T>`
`redoc`	`pushRef`	function	`(stack: string[], ref?: string \| undefined): string[]`
`redoc`	`AppStore`	class	`class`
`redoc`	`Dropdown`	variable	`any`
`redoc`	`Markdown`	class	`class`
`redoc`	`MenuItem`	class	`class`
`redoc`	`SideMenu`	class	`class`
`redoc`	`TagGroup`	interface	`interface`
`redoc`	`Throttle`	function	`(delay: number): (_: any, _2: any, desc: PropertyDescriptor) => void`
`redoc`	`html2Str`	function	`(html: string): string`
`redoc`	`isObject`	variable	`(item: unknown): item is Record<string, unknown>`
`redoc`	`titleize`	function	`(text: string): string`
`redoc`	`useStore`	function	`(): AppStore \| undefined`
`redoc`	`IMenuItem`	interface	`interface`
`redoc`	`JsonProps`	interface	`interface`
`redoc`	`MenuItems`	class	`class`
`redoc`	`MenuStore`	class	`class`
`redoc`	`MimeLabel`	variable	`any`
`redoc`	`Operation`	variable	`({ operation }: OperationProps): JSX.Element`
`redoc`	`RedocWrap`	variable	`any`
`redoc`	`SearchBox`	class	`class`
`redoc`	`SpecStore`	class	`class`
`redoc`	`debugTime`	function	`(label: string): void`
`redoc`	`highlight`	function	`(source: string \| number \| boolean, lang?: string \| undefined): string`
`redoc`	`isBoolean`	function	`(value: unknown): value is boolean`
`redoc`	`isNumeric`	function	`(n: any): n is number`
`redoc`	`keyframes`	variable	`(strings: any, ...interpolations: styledComponents.SimpleInterpolation[]): styledComponents.Keyframes`
`redoc`	`mapValues`	function	`<T, P>(object: Record<string, T>, iteratee: (val: T, key: string, obj: Record<string, T>) => P): Record<string, P>`
`redoc`	`AUTH_TYPES`	variable	`{ oauth2: string; apiKey: string; http: string; openIdConnect: string; }`
`redoc`	`FieldModel`	class	`class`
`redoc`	`GroupModel`	class	`class`
`redoc`	`IS_BROWSER`	variable	`boolean`
`redoc`	`JsonViewer`	variable	`any`
`redoc`	`MenuItemLi`	variable	`any`
`redoc`	`MenuItemUl`	variable	`any`
`redoc`	`Parameters`	class	`class`
`redoc`	`RightPanel`	variable	`any`
`redoc`	`SourceCode`	variable	`(props: SourceCodeProps): React.JSX.Element`
`redoc`	`StoreState`	interface	`interface`
`redoc`	`detectType`	function	`(schema: OpenAPISchema): string`
`redoc`	`isJsonLike`	function	`(contentType: string): boolean`
`redoc`	`resolveUrl`	function	`(url: string, to: string): string`
`redoc`	`ArraySchema`	class	`class`
`redoc`	`BodyContent`	function	`(props: { content: MediaContentModel; description?: string \| undefined; bodyRequired?: boolean \| undefined; }): JSX.Element`
`redoc`	`ContentItem`	class	`class`
`redoc`	`GROUP_DEPTH`	variable	`0`
`redoc`	`JsonPointer`	class	`class`
`redoc`	`MenuBuilder`	class	`class`
`redoc`	`MiddlePanel`	variable	`any`
`redoc`	`OneOfButton`	class	`class`
`redoc`	`OneOfSchema`	class	`class`
`redoc`	`SchemaModel`	class	`class`
`redoc`	`SchemaProps`	interface	`interface`
`redoc`	`SearchStore`	class	`class`
`redoc`	`SectionItem`	class	`class`
`redoc`	`TagsInfoMap`	type	`{ [x: string]: TagInfo; }`
`redoc`	`createStore`	function	`(spec: object, specUrl: string \| undefined, options?: RedocRawOptions \| undefined): Promise<AppStore>`
`redoc`	`getBasePath`	function	`(serverUrl: string): string`
`redoc`	`mapWithLast`	function	`<T, P>(array: T[], iteratee: (item: T, isLast: boolean) => P): P[]`
`redoc`	`mergeParams`	function	`(parser: OpenAPIParser, pathParams?: Referenced<OpenAPIParameter>[] \| undefined, operationParams?: Referenced<OpenAPIParameter>[] \| undefined): Referenced<OpenAPIParameter>[]`
`redoc`	`safeSlugify`	function	`(value: string): string`
`redoc`	`sortByField`	function	`(fields: FieldModel[], param: "name" \| "description" \| "kind"): FieldModel[]`
`redoc`	`ApiInfoModel`	class	`class`
`redoc`	`ApiInfoProps`	interface	`interface`
`redoc`	`ContentItems`	class	`class`
`redoc`	`ExampleModel`	class	`class`
`redoc`	`ExampleProps`	interface	`interface`
`redoc`	`LabelsConfig`	interface	`interface`
`redoc`	`LoadingProps`	interface	`interface`
`redoc`	`MenuItemType`	type	`MenuItemGroupType \| "operation"`
`redoc`	`ObjectSchema`	variable	`({ schema: { fields, title }, showTitle, discriminator, skipReadOnly, skipWriteOnly, level, fieldParentsName, }: ObjectSchemaProps): React.JSX.Element`
`redoc`	`ResponseView`	variable	`({ response }: ResponseViewProps): React.ReactElement`
`redoc`	`SECTION_ATTR`	variable	`"data-section-id"`
`redoc`	`SearchResult`	interface	`interface`
`redoc`	`SecurityDefs`	class	`class`
`redoc`	`StoreBuilder`	function	`(props: StoreBuilderProps): any`
`redoc`	`StoreContext`	variable	`React.Context<AppStore \| undefined>`
`redoc`	`debugTimeEnd`	function	`(label: string): void`
`redoc`	`isStatusCode`	function	`(statusCode: string): boolean`
`redoc`	`langFromMime`	function	`(contentType: string): string`
`redoc`	`mergeObjects`	variable	`(target: any, ...sources: any[]): any`
`redoc`	`CallbackModel`	class	`class`
`redoc`	`DropdownLabel`	variable	`any`
`redoc`	`ErrorBoundary`	class	`class`
`redoc`	`LEGACY_REGEXP`	variable	`"^ {0,3}<!-- ReDoc-Inject:\\s+?<({component}).?/?>\\s+?-->\\s$"`
`redoc`	`MarkdownProps`	type	`BaseMarkdownProps & StylingMarkdownProps & { source: string; className?: string \| undefined; 'data-role'?: string \| undefined; }`
`redoc`	`MarkerService`	class	`class`
`redoc`	`MenuItemLabel`	variable	`any`
`redoc`	`MenuItemProps`	interface	`interface`
`redoc`	`MenuItemTitle`	variable	`any`
`redoc`	`NoSampleLabel`	variable	`any`
`redoc`	`OpenAPIParser`	class	`class`
`redoc`	`OperationItem`	class	`class`
`redoc`	`ResponseModel`	class	`class`
`redoc`	`ResponseTitle`	variable	`React.NamedExoticComponent<ResponseTitleProps>`
`redoc`	`ResponsesList`	class	`class`
`redoc`	`SchemaOptions`	interface	`interface`
`redoc`	`ScrollService`	class	`class`
`redoc`	`StoreConsumer`	variable	`React.Consumer<AppStore \| undefined>`
`redoc`	`StoreProvider`	variable	`React.Provider<AppStore \| undefined>`
`redoc`	`ThemeProvider`	variable	`styledComponents.BaseThemeProviderComponent<ResolvedThemeInterface, ResolvedThemeInterface>`
`redoc`	`flattenByProp`	function	`<T extends object, P extends keyof T>(collectionItems: T[], prop: P): T[]`
`redoc`	`isAbsoluteUrl`	function	`(url: string): boolean`
`redoc`	`menuItemDepth`	variable	`{ 0: any; 1: any; }`
`redoc`	`pluralizeType`	function	`(displayType: string): string`
`redoc`	`querySelector`	function	`(selector: string): Element \| null`
`redoc`	`ApiContentWrap`	variable	`any`
`redoc`	`BackgroundStub`	variable	`any`
`redoc`	`DropdownOption`	interface	`interface`
`redoc`	`HistoryService`	class	`class`
`redoc`	`MediaTypeModel`	class	`class`
`redoc`	`MenuItemsProps`	interface	`interface`
`redoc`	`OperationBadge`	variable	`any`
`redoc`	`OperationModel`	class	`class`
`redoc`	`OperationProps`	interface	`interface`
`redoc`	`OptionsContext`	variable	`React.Context<RedocNormalizedOptions>`
`redoc`	`PayloadSamples`	class	`class`
`redoc`	`SearchBoxProps`	interface	`interface`
`redoc`	`SearchBoxState`	interface	`interface`
`redoc`	`SearchDocument`	interface	`interface`
`redoc`	`SimpleDropdown`	variable	`any`
`redoc`	`XPayloadSample`	interface	`interface`
`redoc`	`extensionsHook`	function	`(styledName: string): (props: any) => any`
`redoc`	`sortByRequired`	function	`(fields: FieldModel[], order?: string[] \| undefined): FieldModel[]`
`redoc`	`DropdownOrLabel`	function	`(props: DropdownOrLabelProps): JSX.Element`
`redoc`	`DropdownWrapper`	variable	`any`
`redoc`	`ExternalExample`	function	`({ example, mimeType }: ExampleProps): React.JSX.Element`
`redoc`	`LabelsConfigRaw`	type	{ enum?: string \| undefined; enumSingleValue?: string \| undefined; enumArray?: string \| undefined; default?: string \| undefined; deprecated?: string \| undefined; example?: string \| undefined; examples?: string \| undefined; recursive?: string \| undefined; arrayOf?: string \| undefined; webhook?: string \| undefined; const?: string \| undefined; noResultsFound?: string \| undefined; download?: string \| undefined; downloadSpecification?: string \| undefined; responses?: string \| undefined; callbackResponses?: string \| undefined; requestSamples?: string \| undefined; responseSamples?: string \| undefined…
`redoc`	`MarkdownHeading`	interface	`interface`
`redoc`	`OpenAPIEncoding`	interface	`interface`
`redoc`	`OptionsConsumer`	variable	`React.Consumer<RedocNormalizedOptions>`
`redoc`	`OptionsProvider`	variable	`React.Provider<RedocNormalizedOptions>`
`redoc`	`ParametersProps`	interface	`interface`
`redoc`	`RedocRawOptions`	interface	`interface`
`redoc`	`ResponseDetails`	class	`class`
`redoc`	`ResponseHeaders`	class	`class`
`redoc`	`ResponseSamples`	class	`class`
`redoc`	`SourceCodeProps`	interface	`interface`
`redoc`	`concatRefStacks`	function	`(base: string[], stack?: string[] \| undefined): string[]`
`redoc`	`isOperationName`	function	`(key: string): boolean`
`redoc`	`isPayloadSample`	function	`(sample: XPayloadSample \| OpenAPIXCodeSample): sample is XPayloadSample`
`redoc`	`isPrimitiveType`	function	`(schema: OpenAPISchema, type?: string \| string[] \| undefined): any`
`redoc`	`shortenHTTPVerb`	variable	`(verb: any): any`
`redoc`	`COMPONENT_REGEXP`	variable	`string`
`redoc`	`ClipboardService`	class	`class`
`redoc`	`ContentItemModel`	type	`GroupModel \| OperationModel`
`redoc`	`ContentItemProps`	interface	`interface`
`redoc`	`MDXComponentMeta`	interface	`interface`
`redoc`	`MarkdownRenderer`	class	`class`
`redoc`	`MediaTypesSwitch`	class	`class`
`redoc`	`OneOfButtonProps`	interface	`interface`
`redoc`	`RedocAttribution`	variable	`any`
`redoc`	`RequestBodyModel`	class	`class`
`redoc`	`SchemaDefinition`	class	`class`
`redoc`	`SideNavStyleEnum`	enum	`SideNavStyleEnum`
`redoc`	`isFormUrlEncoded`	function	`(contentType: string): boolean`
`redoc`	`isRedocExtension`	function	`(key: string): boolean`
`redoc`	`normalizeServers`	function	`(specUrl: string \| undefined, servers: OpenAPIServer[]): OpenAPIServer[]`
`redoc`	`BaseMarkdownProps`	interface	`interface`
`redoc`	`MediaContentModel`	class	`class`
`redoc`	`MenuItemGroupType`	type	`"schema" \| "group" \| "tag" \| "section"`
`redoc`	`MenuItemLabelType`	interface	`interface`
`redoc`	`ObjectSchemaProps`	interface	`interface`
`redoc`	`ResponseListProps`	interface	`interface`
`redoc`	`ResponseViewProps`	interface	`interface`
`redoc`	`SecurityDefsProps`	interface	`interface`
`redoc`	`StoreBuilderProps`	interface	`interface`
`redoc`	`StoreBuilderState`	interface	`interface`
`redoc`	`appendToMdHeading`	function	`(md: string, heading: string, content: string): string`
`redoc`	`argValueToBoolean`	function	`(val?: string \| boolean \| undefined, defaultValue?: boolean \| undefined): boolean`
`redoc`	`createGlobalStyle`	variable	`<P extends object = {}>(first: any, ...interpolations: styledComponents.Interpolation<styledComponents.ThemedStyledProps<P, ResolvedThemeInterface>>[]): styledComponents.GlobalStyleComponent<P, ResolvedThemeInterface>`
`redoc`	`extractExtensions`	function	`(obj: object, showExtensions: true \| string[]): Record<string, any>`
`redoc`	`getDefinitionName`	function	`(pointer?: string \| undefined): string \| undefined`
`redoc`	`getStatusCodeType`	function	`(statusCode: string \| number, defaultAsError?: boolean \| undefined): string`
`redoc`	`isNamedDefinition`	function	`(pointer?: string \| undefined): boolean`
`redoc`	`loadAndBundleSpec`	function	`(specUrlOrObject: string \| object): Promise<OpenAPISpec>`
`redoc`	`unescapeHTMLChars`	function	`(str: string): string`
`redoc`	`DownloadUrlsConfig`	type	`{ title?: string \| undefined; url: string; }[]`
`redoc`	`ResponseTitleProps`	interface	`interface`
`redoc`	`SourceCodeWithCopy`	variable	`(props: SourceCodeProps): React.JSX.Element`
`redoc`	`StickySidebarProps`	interface	`interface`
`redoc`	`StickySidebarState`	interface	`interface`
`redoc`	`getSerializedValue`	function	`(field: FieldModel, example: any): any`
`redoc`	`stripTrailingSlash`	function	`(path: string): string`
`redoc`	`MediaTypeChildProps`	interface	`interface`
`redoc`	`MergedOpenAPISchema`	type	`OpenAPISchema & { 'x-refsStack'?: string[] \| undefined; 'x-parentRefs'?: string[] \| undefined; 'x-circular-ref'?: boolean \| undefined; }`
`redoc`	`PayloadSamplesProps`	interface	`interface`
`redoc`	`SecuritySchemeModel`	class	`class`
`redoc`	`StyledMarkdownBlock`	variable	`StyledComponent<"div", ResolvedThemeInterface, { $compact?: boolean \| undefined; $inline?: boolean \| undefined; }, never>`
`redoc`	`escapeHTMLAttrChars`	function	`(str: string): string`
`redoc`	`getOperationSummary`	function	`(operation: ExtendedOpenAPIOperation): string`
`redoc`	`humanizeConstraints`	function	`(schema: OpenAPISchema): string[]`
`redoc`	`humanizeNumberRange`	function	`(schema: OpenAPISchema): string \| undefined`
`redoc`	`DropdownOrLabelProps`	interface	`interface`
`redoc`	`MDX_COMPONENT_REGEXP`	variable	`string`
`redoc`	`ResponseHeadersProps`	interface	`interface`
`redoc`	`ResponseSamplesProps`	interface	`interface`
`redoc`	`SecuritySchemesModel`	class	`class`
`redoc`	`StylingMarkdownProps`	interface	`interface`
`redoc`	`alphabeticallyByProp`	function	`<T>(property: string): (a: T, b: T) => number`
`redoc`	`urlFormEncodePayload`	function	`(payload: object, encoding?: { [field: string]: OpenAPIEncoding; } \| undefined): string`
`redoc`	`DiscriminatorDropdown`	class	`class`
`redoc`	`MediaTypesSwitchProps`	interface	`interface`
`redoc`	`buildComponentComment`	function	`(name: string): string`
`redoc`	`InvertedSimpleDropdown`	variable	`any`
`redoc`	`ObjectDescriptionProps`	interface	`interface`
`redoc`	`RedocNormalizedOptions`	class	`class`
`redoc`	`ResolvedThemeInterface`	interface	`interface`
`redoc`	`mergeSimilarMediaTypes`	function	`(types: Record<string, OpenAPIMediaType>): Record<string, OpenAPIMediaType>`
`redoc`	`scrollIntoViewIfNeeded`	function	`(el: HTMLElement, centerIfNeeded?: boolean \| undefined): void`
`redoc`	`StickyResponsiveSidebar`	class	`class`
`redoc`	`serializeParameterValue`	function	`(parameter: FieldModel \| (OpenAPIParameter & { serializationMime?: string \| undefined; }), value: any): string`
`redoc`	`setSecuritySchemePrefix`	function	`(prefix: string): void`
`redoc`	`ExtendedOpenAPIOperation`	type	`{ pointer: string; pathName: string; httpVerb: string; pathParameters: Referenced<OpenAPIParameter>[]; pathServers: OpenAPIServer[] \| undefined; isWebhook: boolean; } & OpenAPIOperation`
`redoc`	`OperationMenuItemContent`	variable	`(props: OperationMenuItemContentProps): React.JSX.Element`
`redoc`	`removeQueryStringAndHash`	function	`(serverUrl: string): string`
`redoc`	`SCHEMA_DEFINITION_JSX_NAME`	variable	`"SchemaDefinition"`
`redoc`	`expandDefaultServerVariables`	function	`(url: string, variables?: object \| undefined): string`
`redoc`	`getContentWithLegacyExamples`	function	`(info: OpenAPIRequestBody \| OpenAPIResponse): { [mime: string]: OpenAPIMediaType; } \| undefined`
`redoc`	`OperationMenuItemContentProps`	interface	`interface`
`redoc`	`SECURITY_DEFINITIONS_JSX_NAME`	variable	`"SecurityDefinitions"`
`redoc`	`SECURITY_SCHEMES_SECTION_PREFIX`	variable	`string`
`redoc`	`serializeParameterValueWithMime`	function	`(value: any, mime: string): string`
`redoc`	`OLD_SECURITY_DEFINITIONS_JSX_NAME`	variable	`"security-definitions"`

Changed signatures

export	Before	After
`redoc · Redoc`	`class`	`FC<any>`
`redoc · RedocProps`	`interface`	`RedoclyApiDocsInnerProps & { store: ApiStore; options: RawApiDocsOptions; layout?: any; }`
`redoc · RedocStandalone`	`(props: RedocStandaloneProps): React.JSX.Element`	`({ spec, specUrl, options, basePath, logo, markdownAdapter, onLoaded, children, }: RedocStandaloneProps): any`
`redoc · RedocStandaloneProps`	`interface`	`{ spec?: string \| Record<string, unknown> \| undefined; specUrl?: string \| undefined; options?: Partial<RawApiDocsOptions> \| undefined; basePath?: string \| undefined; logo?: RawLogo \| undefined; markdownAdapter?: MarkdownAdapter \| undefined; onLoaded?: ((error?: Error \| undefined) => void) \| undefined; children?: any; }`
`redoc · convertSwagger2OpenAPI`	`(spec: any): Promise<OpenAPISpec>`	`(document: Record<string, unknown>): Promise<OpenAPIDefinition>`

Removed class or interface members

None detected.

Changed class or interface members

None detected.

Newly deprecated

None detected.

Requirement changes (engines, peer dependencies)

	Before	After
`engines.npm`	`>=3.0.0`	`>=10.0.0`
`engines.node`	`>=6.9`	`>=22`
`peerDependencies.mobx`	`^6.0.4`	`—`
`peerDependencies.react`	`^16.8.4 \|\| ^17.0.0 \|\| ^18.0.0 \|\| ^19.0.0`	`^18.3.0 \|\| ^19.0.0`
`peerDependencies.core-js`	`^3.1.4`	`—`
`peerDependencies.react-dom`	`^16.8.4 \|\| ^17.0.0 \|\| ^18.0.0 \|\| ^19.0.0`	`^18.3.0 \|\| ^19.0.0`
`peerDependencies.styled-components`	`^4.1.1 \|\| ^5.1.1 \|\| ^6.0.5`	`^6.0.0`
`peerDependencies.react-router`	`—`	`^7.0.0 \|\| ^8.0.0`
`peerDependencies.@redocly/config`	`—`	`>=0.65.0`

New exports (5)

import	export	kind
`redoc`	`logoFromSpec`	function
`redoc`	`prepareApiDocs`	function
`redoc`	`ServerStyleSheet`	variable
`redoc`	`RedoclyApiDocsStandalone`	variable
`redoc`	`RedoclyApiDocsStandaloneProps`	type

Give your AI agent these facts

Vigia is a free MCP server: your coding agent checks versions, breaking changes and vulnerabilities before it writes code. No signup, no API key.

claude mcp add --transport http vigia https://vigia.coredls.cloud/mcp

Add to Cursor Add to VS Code ★ Star on GitHub

Any other MCP client

{ "mcpServers": { "vigia": { "url": "https://vigia.coredls.cloud/mcp" } } }

Agent skill (SKILL.md): tells the agent when to use Vigia · GitHub Action for pull requests

Frequently asked questions

What are the breaking changes when upgrading redoc from 2 to 3?

Between redoc 2.5.4 and 3.0.0, Vigia found 238 removed exports, 5 changed signatures and 0 removed or changed class or interface members.

What became deprecated in redoc 3?

0 exports or members are newly marked as deprecated in redoc 3.0.0.

For agents

GET https://vigia.coredls.cloud/v1/packages/npm/redoc/upgrade?from=2.5.4&to=3.0.0