Last updated

Reference docs changelog


2.42.2 (2023-10-24)

Features

  • Added marketing banner for VSCode extension.

2.42.1 (2023-08-14)

Fixes

  • Resolved an issue where Client ID and Client Secret fields were cleared by changing the Security Scheme in the Try It panel.

2.42.0 (2023-07-25)

Features

  • Added visual view for required value in request body.

Fixes

  • Resolved an issue where tryItOpen event does not send Closed actions.
  • Resolved an issue where option routingStrategy: hash has wrong anchor link.

2.41.2 (2023-07-17)

Fixes

  • Resolved an issue where description is duplicated for primitive types in oneOf schemas.

2.41.0 (2023-07-10)

Features

  • Added targetServerSwitch event that is called when users change the selection of the target server in the Try it console.

Fixes

  • Resolved an issue where the 'tryItOpen' analytics event triggered when the close button for the Try it console was clicked.

2.40.2 (2023-06-16)

Fixes

  • Resolved an issue where 'Go' code samples generating with syntax error

2.40.0 (2023-04-04)

Features

  • Updated banner for previewing the docs on localhost.

2.39.2 (2023-03-09)

Fixes

  • Upgraded openapi-core package to the latest version (1.0.0-beta.123).

2.39.1 (2023-01-19)

Fixes

  • Upgraded the Openapi sampler package to the latest version (1.3.1).

2.39.0 (2022-12-19)

Features

  • Added a new experimental config option unstable_hideServerUrlInTryIt to hide server URL in the Try it console.

Fixes

  • Fixed a broken code samples when server url contains a fragment.

2.38.2 (2022-11-11)

Fixes

  • Removed default server description from servers dropdown

2.38.1 (2022-09-30)

Fixes

  • Reverted the change related to custom name for an operation sidebar heading.

2.38.0 (2022-09-22)

Fixes

  • Resolved issue with showing empty security section
  • Resolved issue with incorrect validation on path params in Try it console.

2.37.1 (2022-09-20)

Fixes

  • Resolved issue with not valid links in the Developer Portal.

2.37.0 (2022-09-19)

Features

  • Added codeSamplesCopy event. Called when the user copies request or response samples across Reference docs UI.

2.36.1 (2022-09-12)

Fixes

  • Added spacing under the description text in Response samples panel.
  • Resolved issue with crashes when used with specific combination of discriminators and inheritance.

2.36.0 (2022-09-05)

Features

  • Added synchronization of discriminator state in the middle panel with samples and Try it panel.
  • Added support for markdown formatting inside server variable description field in Try it console.

Fixes

  • Resolve the issue with synchronization of discriminators inside oneOf in the middle panel.
  • Resolve the issue with clientCredentials OAuth2 flow not sending empty scopes
  • Resolve the issue with the mock server not working correctly with the list of servers.

2.35.0 (2022-08-31)

Features

  • Added new configuration option mockServer which allows to specify mock server URL and it's position in the Try It console

2.34.0 (2022-08-30)

Features

  • Added new custom hook AfterApiTitle to inject additional HTML or React component after API title.

2.33.1 (2022-08-29)

Fixes

  • Improve our C# code sample template to match real-life usage
  • Fix text-transform setting for Panel titles

2.33.0 (2022-08-23)

Features

  • Save state of the Request Body in the Try it console.

Fixes

  • Resolved an issue with display message if security schema is not valid.
  • Resolved an issue with switching languages in code samples not working correctly with duplicated language and different labels.
  • Resolved an issue with incorrect code samples with 204 status code.

2.32.0 (2022-08-18)

Features

  • The Target server field in the Try it console was moved to the top.
  • Added theming options for the titles and subtitles in the middle panel.

Fixes

  • Resolved an issue where labels.tryItAuthBasicUsername and labels.tryItAuthBasicPassword labels text was not reflected in the generated code samples.
  • Resolved an issue with the right panel layout change position while switching between code samples.
  • Resolved an issue with switching XML examples now working for the payload and response samples.

2.31.1 (2022-08-11)

Fixes

  • Resolved an issue with incorrect recursion handling in nested oneOf.
  • Resolved an issue with incorrect handling of OIDC authentication for code variant.

2.31.0 (2022-08-09)

Features

  • Added a new OpenAPI operation extension, x-tokenEndpointAuthMethod. Use it to provide a token endpoint auth method for OAuth2 security schemas.

Fixes

  • Resolved an issue with display operation path in sidebar if operation description or summary is not exist

2.30.0 (2022-08-03)

Features

  • Added visual view for deprecated in oneOf + discriminator.

2.29.0 (2022-08-02)

Features

  • Added new theme option nestedAlternativeBackground for customization background color alternative for nested schemas.

Fixes

  • Resolved an issue with sibling $refs in OpenAPI 3.1 definitions.

2.28.0 (2022-07-27)

Features

  • Added a support for array parameters (query, header, cookie, path) in the Try it console.
  • Add a support for a simple style in query parameters.
  • Added a copy button to the server list.

Fixes

  • Resolved an issue with a recursion crash for boolean schemas with boolean items.
  • Resolved an issue with an external pdf file in samples.

2.27.3 (2022-07-25)

Fixes

  • Resolved an issue with security details personalization not working with get code samples.
  • Resolved an issue with incorrect servers urls with pagination none and server URL without the host (/server/url)
  • Resolved an issue with duplicated enum values when schema uses a specific combination of oneOf and allOf.

2.27.2 (2022-07-19)

Fixes

  • Resolved an issue with incorrect property description, readOnly and writeOnly modifiers when schema uses a specific combination of allOf.

2.27.1 (2022-07-18)

Fixes

  • Resolved an issue with application/hal+json and similar mime-types not working properly in generated code samples.

2.27.0 (2022-07-13)

Features

  • Add a possibility to display the x- prefix for schema extensions.
  • Add new configuration option showAccessMode allowing to display read-only and write-only flags on properties and parameters.

Fixes

  • Resolved an issue with incorrect recursion handling in oneOf.
  • Resolved an issue with nested patternProperties.

2.26.4 (2022-07-06)

Fixes

  • Resolved an issue with invalid synchronization of request and response examples with different ids.

2.26.3 (2022-07-04)

Fixes

  • Resolved a small regression with false positive circular schema detection introduced in 2.26.2

2.26.2 (2022-07-04)

Fixes

  • Resolved an issue with false positive circular schema detection.
  • Resolved an issue with not displaying 0 as default parameter in Try it console.

2.26.1 (2022-07-01)

Fixes

  • Resolved an issue with OAuth2 state mismatch caused by base64 padding artifacts.

2.26.0 (2022-06-27)

Features

  • Add new configuration option markdownHeadingsAnchorLevel allowing to have anchors for headings H3 and H4.

Fixes

  • Resolved an issue with code sample being rendered for non-json media-types without the explicit example
  • Resolved an issue with different number of examples in the media type object.
  • Resolved an issue with displaying deep links inside arrays.

2.25.2 (2022-06-22)

Fixes

  • Resolved an issue with Authorization as the parameter is not being passed in the request.
  • Resolved an issue with failing preview build when the definition has unclosed PullRight component.

2.25.1 (2022-06-21)

Fixes

  • Resolved an issue with displaying an array of strings in the request body samples.

2.25.0 (2022-06-20)

Features

  • Allow to clear dropdown selection in the Try it console.

Fixes

  • Resolved an issue with the Try it console: the first enum value could not be selected from the dropdown.
  • Resolved an issue with invalid media content example/examples for parameters
  • Resolved an issue with parameters examples priority

2.24.0 (2022-06-17)

Features

  • Add support for reference docs customizations with functions in workflows

2.23.0 (2022-06-14)

Fixes

  • Resolved an issue with wrong link in Next button in pagination section.

Features

  • The code samples now use values from the Try it console.

2.22.1 (2022-06-08)

Fixes

  • Resolved an issue with displaying array samples in request body.
  • Resolved an issue with routingStrategy option not working.
  • Resolved an issue with copying null values in samples.

2.22.0 (2022-06-01)

Features

  • Add new configuration option hideSecuritySection allowing to disable the Security panel.

Fixes

  • Resolved an issue with displaying nested items with $ref.
  • Resolved an issue with a clear CDN cache.

2.21.0 (2022-05-30)

Features

  • Added support for OAS 3.1 prefixItems and additionalItems.
  • Added onLoaded callback to RedoclyReferenceDocs component.

2.20.0 (2022-05-26)

Features

  • Added support for additional datatypes in the multipart requests.
  • Added support for conditional operators in OpenAPI 3.1 definitions.
  • Added support for presentation of maxProperties and maxProperties in request and response object.

Fixes

  • Resolved an issue where symbols are not properly encoded in the Try it console by adding new configuration option disableTryItRequestUrlEncoding.

2.19.1 (2022-05-20)

Fixes

  • Reverted the change related to conditional operators from version 2.17.0.

2.19.0 (2022-05-19)

Features

  • Added new showSecuritySchemeType to show security scheme type along with security name.

Deprecated showSecuritySchemeType

  • The noAutoAuth configuration option has been deprecated in favor of the new approach of showing security on every endpoint.

2.18.0 (2022-05-19)

Features

  • Added support for pattern properties.

Fixes

  • Resolved an issue with Download button is visible in each endpoint.

2.17.0 (2022-05-18)

Features

  • Added an option showWebhookVerb to render the HTTP request method for webhooks in operations and in the sidebar.
  • Added support for conditional operators in OpenAPI 3.1 definitions.
  • Added an option hoverTextDecoration to the features.openapi.theme object (since renamed to theme.openapi.theme object). Use it to define how links should be decorated when users hover over them.

2.16.0 (2022-05-18)

Features

  • Added a new OpenAPI operation extension, x-hideTryItPanel. Use it to hide the Try it panel for a single operation.
  • Added an option schemaDefinitionsTagName to render all the schema components automatically.
  • Added an option showObjectSchemaExamples to render object schema example in the properties.

Deprecated

  • The showConsole configuration option has been deprecated in favor of the new option hideTryItPanel. The new option is set to false by default, which means the Try it functionality is enabled by default.

2.15.1 (2022-05-17)

Fixes

  • Resolved an issue with the impossibility to stylize the headers of the right panel

2.15.0 (2022-05-12)

Features

  • Added a new configuration option called maxResponseHeadersToShowInTryIt. Use it to set the maximum number of response headers to show in the Try it console.
  • Added support for OAS 3.1 unevaluatedProperties.

2.14.2 (2022-05-10)

Fixes

  • Resolved an issue with Responses section includes unnecessary divider.

2.14.1 (2022-05-10)

Fixes

  • Resolved an issue with Responses section styling.

2.14.0 (2022-04-27)

Fixes

  • Resolved an issue with scroll in sidebar menu.

Features

  • Add minCharacterLengthToInitSearch configuration option for sets the minimum amount of characters that need to be typed into the search dialog to initiate the search.

2.13.7 (2022-04-27)

Fixes

  • Resolved an issue with Responses section styling.
  • Resolved an issue with loosing local properties on circular oneOf/anyOf.
  • Resolved an issue with Expand All, Collapse All buttons for flat schema structures.

2.13.6 (2022-04-19)

Fixes

  • Resolved an issue with [,] symbols that are not properly encoded when included in query parameters.
  • Resolved an issue with navigation when operationId contains backslash or quotes.
  • Resolved an issue with Markdown headings containing quotes.

2.13.5 (2022-04-14)

Fixes

  • Resolved an issue with CORS if the servers object is defined per operation.

2.13.4 (2022-04-07)

Fixes

  • Resolved an issue with Download button behavior on multiple API versions.

2.13.3 (2022-04-04)

Fixes

  • Resolved an issue with the configuration option downloadDefinitionUrl not working as intended.

2.13.2 (2022-04-04)

Features

  • New SideNavStyle configuration option id-only - shows the operation id in sidebar menu.

2.13.1 (2022-03-31)

Fixes

  • Resolved an issue with merging generated code samples and passed with properties from the Developer portal where the array of strings was displayed as an array of objects.

2.13.0 (2022-03-25)

Features

  • The x-usePkce extension supports two new configuration options: disableManualConfiguration and hideClientSecretInput.
  • The Try it console lets you use example values with object properties to set initial values in the Body form.

Fixes

  • A warning message is displayed in the build log if tags in the API definition are invalid (should be an array).
  • Resolved a minor issue in the Try it console where OAuth scopes were truncated and displayed in two columns.

2.12.5 (2022-03-17)

  • Internal changes of redocly.yaml config structure.

2.12.4 (2022-03-14)

Fixes

  • Added support for customizing the floating action button visible in the mobile view. You can change the background and icon color for the button in the Reference theme, or hide the button altogether by setting hideFab: true in your Reference configuration file.

2.12.3 (2022-03-10)

Fixes

  • Resolved an issue where the Deprecated badge wasn't visible in oneOf and anyOf schemas.

2.12.2 (2022-03-03)

Fixes

  • Resolved issue with invalid behavior for server variable input.
  • Resolved issue with PKCE auth flow in Try it console.

2.12.1 (2022-02-28)

Fixes

  • Resolved a styling issue with the search popup when using dark background colors in the theme.

2.12.0 (2022-01-27)

Features

  • The list of supported languages for auto-generated code samples has grown! You can now configure Reference docs to automatically generate R code samples.

2.11.12 (2022-02-21)

Fixes

  • Resolved an issue with allow empty password for basic authorization.

2.11.10 (2022-02-16)

Fixes

  • Resolved an issue with the width of dropdown menus by making it dynamically adjust to content width.

  • Reverted the change related to absolute links from version 2.11.8.


2.11.9 (2022-02-16)

Fixes

  • Resolved an issue with broken layout rendering when a description field contains HTML elements.

2.11.8 (2022-02-15)

Fixes

  • Resolved an issue with incorrect absolute links in Markdown when using path prefixes.

2.11.7 (2022-02-15)

Fixes

  • Resolved an issue with incorrect rendering of options in dropdown menus.

2.11.2 (2022-02-08)

Fixes

  • Resolved an issue where Try it console incorrect display request body when it includes allOf/oneOf

2.11.0 (2022-01-27)

Features

  • Added the possibility to keep only the Download button on the API overview page.
  • Added an option to hide/minify endpoint requests by default.

Fixes

  • Changed link anchor image to SVG instead of a background image.

2.10.0 (2022-01-24)

Features

  • Added download button to "Try it" for responses with files.

2.9.5 (2022-01-20)

Fixes

  • Resolved an issue where Server URLs with many query arguments would overflow and break the Try it console layout.
  • Disabled sample code generation for webhooks.
  • Resolved an issue where schema titles were displayed incorrectly when the title propery was not provided.
  • Changed path parameter representation for curl code samples.
  • Resolved an issue with displaying writeOnly parameters for webhooks.

2.9.4 (2022-01-17)

Fixes

  • Resolved issue where "Try It" does not work when query param names are with dot notation.
  • Bump marked package version to 4.0.10.

2.9.3 (2022-01-14)

Fixes

  • Fixed an issue where scroll wasn't working in the "Try it" request body section.

2.9.2 (2022-01-14)

Fixes

  • Resolved issue: added markdown support for object description oneOf/anyOf.

2.9.1 (2022-01-13)

Fixes

  • Resolved issue where "Try It" has improper rendering of query params with dot notation.
  • Resolved issue where headings in blockquote is causing duplicates.

2.9.0 (2022-01-06)

Features

  • New theme option backgroundColor for Request and Response schema panels.
  • Implemented object description for oneOf/anyOf (new config option hideOneOfDescription to hide this feature).

Fixes

  • Resolved issue where links in description are not working as expected in docs

2.8.3 (2021-12-29)

Fixes

  • Resolved issue where "Try it" does not work with Basic Authentication.

2.8.2 (2021-12-28)

Fixes

  • Resolved a crash for node v12 after v2.7.9.

2.8.1 (2021-12-20)

Fixes

  • Resolved a crash for type: array schemas referencing themselves if used in an allOf.

2.8.0 (2021-12-13)

Fixes

  • The default value for the searchMaxDepth configuration option has been lowered to 1.

2.7.9 (2021-12-08)

Fixes

  • Resolved an issue where multi-version reference docs crash in workflows after v2.7.7

2.7.8 (2021-12-07)

Fixes

  • Undo a breaking change to the default value of theme.layout.showDarkRightPanel accidentally made in v2.7.4

2.7.7 (2021-12-07)

Fixes

  • Internal improvements: migrate to webpack 5 and esbuild-loader (instead of babel)

2.7.6 (2021-12-06)

Fixes

  • Resolve an issue Security links are not working where the pagination is turned off and routingBasePath is set

2.7.5 (2021-12-06)

Fixes

  • Set indentation in request/response samples to two characters.

2.7.4 (2021-12-02)

Fixes

  • Resolved an issue where right panels were partially cut off when showDarkRightPanel is enabled and both layout buttons are disabled.

2.7.3 (2021-12-01)

Fixes

  • Resolved an issue where server-side rendered styles did not match client-side styles.

2.7.2 (2021-11-25)

Fixes

  • Resolved an issue where the exclusiveMinimum/Maximum properties showed an incorrect number range (OpenAPI 3.1).
  • Resolved an issue with resolving nested $refs for OpenAPI 3.1.

2.7.1 (2021-11-22)

Fixes

  • Resolved an issue with breakFieldNames not working for expandable fields.

2.7.0 (2021-11-18)

Features

  • Long server URLs in the Try it console now automatically wrap and adjust to the width of their containing element, giving you a clearer look at the full server URL values. The Copy button for server URLs has also been removed to declutter the space.

Fixes

  • Resolved an issue with misaligned fields in schemas.

2.6.3 (2021-11-16)

Fixes

  • Resolved an issue with auto-generated NodeJS code samples that were not working properly.

  • Resolved an issue with auto-generated PHP code samples that were not showing the HTTP basic authentication details.

  • Resolved an issue with the downloadDefinitionUrl configuration option which did not allow users to directly download the API definition.


2.6.2 (2021-11-12)

Fixes

  • Internal improvements to the Try It console for compatibility with Portal components.

2.6.1 (2021-11-11)

Fixes

  • Resolved an issue with switching the content type in the request body section (when used as the OpenApiRequestBody component in the Developer portal).

2.6.0 (2021-11-10)

Features

  • Implemented a new configuration option called sendXUserAgentInTryIt to enable sending the X-User-Agent: Redocly Try it API console header with every request made from the Try it console.

NOTE: make sure to add X-User-Agent to your Access-Control-Allow-Headers CORS header.

Fixes

  • Resolved an issue with handling server template variables in code samples.

2.5.0 (2021-11-02)

Features

  • Two new configuration options - separator and separatorLine - are now supported for items configured in sidebarLinks. We've also added support for the corresponding theming option called sidebar > separatorLineColor.

2.4.2 (2021-10-28)

Features

  • Implemented support for wildcard domains in on-premise license keys.
  • The Try it console now supports PKCE for OAuth2 authorization code flow. To enable it for a specific security definition, add the x-usePkce: true specification extension:
components:
  securitySchemes:
    oauth2_auth:
      type: "oauth2"
      flows:
        authorizationCode:
          x-usePkce: true,
          authorizationUrl: "https://example.com/authorize",
          tokenUrl: "https://example.com/token",
          scopes: {
            api: "Grants complete read/write access to the API"

Fixes

  • Resolved an issue with security links not working properly with routingBasePath.
  • Resolved an issue with default boolean property values not rendered correctly when used with enumSkipQuotes setting.

2.4.1 (2021-10-25)

Fixes

  • Resolved an issue with Next to buttons and sidebar items that were not rendered as proper links, which prevented the search index from crawling Reference docs pages.

2.4.0 (2021-10-22)

Features

  • Implemented support for a new theming option called middlePanelMaxWidth. Add it to the layout > three-panel section of the Reference theme to control the width of the content in the middle panel. When this option is used, the content in the middle panel is automatically centered to fit the total middle panel area specified by the layout > three-panel > maxWidth option.

Fixes

  • Resolved an issue that prevented users from selecting the response content type from the dropdown in response schemas.

2.3.0 (2021-10-13)

Features

  • Upgraded the js-yaml package from v.3 to v.4 with YAML 1.2 support. This upgrade resolves issues with parsing timestamps and example strings with leading zeros in YAML.

Fixes

  • Resolved an issue with schemas displaying an incorrect number of items in an array when using maxItems.

  • Resolved an issue with Markdown headings overflowing the width of their containing element.


2.2.3 (2021-10-12)

  • Internal improvements to the Try It console for compatibility with Portal components.

2.2.2 (2021-10-11)

Fixes

  • Resolved an issue with sibling $refs in OpenAPI 3.1 definitions.

  • Resolved an issue with broken deep links for items with multiple content types.


2.2.1 (2021-10-05)

Fixes

  • The Try it console now correctly renders multiple input fields, supports x-www-url-encoded, and relies more on content type when validating the request body for the file upload helper.

2.1.24 (2021-10-05)

Fixes

  • Resolved an issue with incorrect vertical offset on Reference docs pages integrated into the portal with the pagination: item setting.

2.1.23 (2021-10-05)

Features

  • You can now configure search indexing depth for your Reference docs with the searchMaxDepth option. Set it to a number from 1 to 10 to control the maximum level of nested references that should be included in the search index. The default value is 8.

Fixes

  • Resolved a docs rendering issue when the disableSidebar configuration option is set to true. If you have been using disableSidebar as a way to disable the search feature, you must now explicitly add disableSearch: true to your configuration after upgrading to this version.

2.1.22 (2021-09-28)

Features

  • The Try It console now supports file uploads for OpenAPI 3.1 definitions that use the contentEncoding keyword according to the specification. If the requestBody schema is valid, the Choose file button is visible in the request body section of the Try It console. Select the button to open the file picker dialog and add one or more files to your request.

2.1.21 (2021-09-24)

Fixes

  • Resolved an issue with response sample tabs.

2.1.20 (2021-09-24)

Fixes

  • Resolved an issue with array response examples.

2.1.19 (2021-09-23)

Fixes

  • Resolved an internal issue with code sample component usage in the portal.

2.1.18 (2021-09-22)

Fixes

  • Resolved an issue with unnecessary transparency effect in the Request samples section when switching between code sample tabs.

2.1.17 (2021-09-21)

Fixes

  • Resolved a theming issue with the text color of response headers which was not applied properly in Reference docs integrated into the portal.