Last updated

Configuration options changes between reference docs 2.x and newest Redoc configuration

Feature/OptionOld Interface (Options)New Interface (Options)Notes
General
themeResolvedThemeInterfaceRemovedDeleted
scrollYOffset() => number() => numberUnchanged
hideHostnamebooleanRemovedDeleted
hideInfoDescriptionbooleanRemovedDeleted
expandResponses{ [code: string]: boolean } |'all'RemovedDeleted
requiredPropsFirstbooleansortRequiredPropsFirst: booleanRenamed
sortPropsAlphabeticallybooleanRemovedDeleted
sortEnumValuesAlphabeticallybooleanRemovedDeleted
sortOperationsAlphabeticallybooleanRemovedDeleted
sortTagsAlphabeticallybooleanRemovedDeleted
nativeScrollbarsbooleanRemovedDeleted
pathInMiddlePanelbooleanRemovedDeleted
untrustedDefinitionbooleanRemovedDeleted
hideDownloadButtonsboolean | nullboolean | nullUnchanged
downloadDefinitionUrlstringdownloadUrls?: DownloadUrlsConfigRenamed and type changed
disableSearchbooleanRemovedDeleted
showChangeLayoutButtonboolean | stringRemovedDeleted
onlyRequiredInSamplesbooleanbooleanUnchanged
showConsolebooleanRemovedDeleted
sendXUserAgentInTryItbooleanRemovedDeleted
generatedPayloadSamplesMaxDepthnumbergeneratedSamplesMaxDepth: numberRenamed
showExtensionsboolean | string[]string | string[] | booleanType changed
preserveOriginalExtensionsNamebooleanRemovedDeleted
hideSingleRequestSampleTabbooleanRemovedDeleted
hideRequestPayloadSamplebooleanRemovedDeleted
menuTogglebooleanRemovedDeleted
jsonSampleExpandLevelnumberjsonSamplesExpandLevel: numberRenamed
enumSkipQuotesbooleanRemovedDeleted
hideSchemaTitlesbooleanbooleanUnchanged
hideSecuritySectionbooleanRemovedDeleted
showSecuritySchemeTypebooleanRemovedDeleted
simpleOneOfTypeLabelbooleanRemovedDeleted
payloadSampleIdxnumberRemovedDeleted
expandSingleSchemaFieldbooleanRemovedDeleted
schemaExpansionLevelnumberschemasExpansionLevel: number | undefinedRenamed and type changed
samplesTabsMaxCountnumberRemovedDeleted
mockServer{ url: string; position: 'first' | 'last' | 'replace' | 'off'; description: string }{ url: string; position: 'first' | 'last' | 'replace' | 'off'; description: string }Unchanged
unstable_tryItButtonOverride{ label: string; link?: string; onClick?: () => void } | nullRemovedDeleted
allowedMdComponentsRecord<string, MDXComponentMeta>RemovedDeleted
expandDefaultServerVariablesbooleanRemovedDeleted
expandDefaultRequestbooleanRemovedDeleted
expandDefaultResponsebooleanRemovedDeleted
collapseRequestSamplePanelbooleanRemovedDeleted
collapseResponseSamplePanelbooleanRemovedDeleted
maxDisplayedEnumValuesnumbernumberUnchanged
ignoreNamedSchemasSet<string>Set<string>Unchanged
unstable_ignoreMimeParametersbooleanRemovedDeleted
unstable_externalCodeSamplesUnstable_ExternalCodeSample[]Unstable_ExternalCodeSample[]Unchanged
hooksHooksConfigunstable_hooks: HooksConfigRenamed and required
hideSchemaPatternbooleanRemovedDeleted
hideOneOfDescriptionbooleanRemovedDeleted
hideFabbooleanRemovedDeleted
markdownHeadingsAnchorLevelnumberRemovedDeleted
schemaDefinitionsTagNamestringstringUnchanged
minCharacterLengthToInitSearchnumberRemovedDeleted
maxResponseHeadersToShowInTryItnumberRemovedDeleted
showWebhookVerbbooleanRemovedDeleted
showObjectSchemaExamplesbooleanRemovedDeleted
showAccessModebooleanRemovedDeleted
disableTryItRequestUrlEncodingbooleanRemovedDeleted
New OptionsNot availableVarious (e.g., feedback, events, 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.