Skip to content
Last updated

Migration 2.x to 3.x

Configuration options changes between Redoc 2.x and newest Redoc 3.x configuration

Feature/OptionOld Interface (Options)New Interface (Options)Notes
General
themeResolvedThemeInterfaceRemovedDeleted
scrollYOffset() => number() => numberUnchanged
hideHostnamebooleanRemovedDeleted
expandResponses{ [code: string]: boolean } |'all'RemovedDeleted
requiredPropsFirstbooleansortRequiredPropsFirst: booleanRenamed
sortPropsAlphabeticallybooleanRemovedDeleted
sortEnumValuesAlphabeticallybooleanRemovedDeleted
sortOperationsAlphabeticallybooleanRemovedDeleted
sortTagsAlphabeticallybooleanRemovedDeleted
nativeScrollbarsbooleanRemovedDeleted
pathInMiddlePanelbooleanRemovedDeleted
hideDownloadButtonsboolean | nullboolean | nullUnchanged
downloadDefinitionUrlstringdownloadUrls?: DownloadUrlsConfigRenamed and type changed
disableSearchbooleanRemovedDeleted
onlyRequiredInSamplesbooleanbooleanUnchanged
generatedPayloadSamplesMaxDepthnumbergeneratedSamplesMaxDepth: numberRenamed
showExtensionsboolean | string[]string | string[] | booleanType changed
hideSingleRequestSampleTabbooleanRemovedDeleted
hideRequestPayloadSamplebooleanRemovedDeleted
menuTogglebooleanRemovedDeleted
jsonSampleExpandLevelnumberjsonSamplesExpandLevel: numberRenamed
enumSkipQuotesbooleanRemovedDeleted
hideSchemaTitlesbooleanbooleanUnchanged
hideSecuritySectionbooleanRemovedDeleted
showSecuritySchemeTypebooleanRemovedDeleted
simpleOneOfTypeLabelbooleanRemovedDeleted
payloadSampleIdxnumberRemovedDeleted
expandSingleSchemaFieldbooleanRemovedDeleted
schemaExpansionLevelnumberschemasExpansionLevel: number | undefinedRenamed and type changed
allowedMdComponentsRecord<string, MDXComponentMeta>RemovedDeleted
expandDefaultServerVariablesbooleanRemovedDeleted
maxDisplayedEnumValuesnumbernumberUnchanged
ignoreNamedSchemasSet<string>Set<string>Unchanged
unstable_ignoreMimeParametersbooleanRemovedDeleted
hideSidebarbooleanbooleanUnchanged
hideLoadingbooleanbooleanUnchanged
hidePropertiesPrefixbooleanbooleanUnchanged
hideSchemaPatternbooleanRemovedDeleted
schemaDefinitionsTagNamestringstringUnchanged
minCharacterLengthToInitSearchnumberRemovedDeleted
showWebhookVerbbooleanRemovedDeleted
showObjectSchemaExamplesbooleanRemovedDeleted
New OptionsNot availableVarious (e.g., layout, hidePropertiesPrefix, routingBasePath, etc.)Several new options added

Summary of changes

  1. Renamed Options: Some options have been renamed for clarity or alignment with their functionalities, such as generatedPayloadSamplesMaxDepth to generatedSamplesMaxDepth.
  2. Removed Features: Several options related to UI customizations and response handling have been removed.
  3. Unchanged Options: Some options remain unchanged, indicating their continued relevance in the new configuration.
  4. New Options: The new interface introduces several options, suggesting new functionalities or approaches.
 
Next page