Last updated 1 day ago

Developer portal changelog

1.0.0-beta.111 (2021-03-03)

Features

  • The Next to navigation button visible at the bottom right of portal pages can now be hidden. You can disable it for the entire developer portal by setting showNextButton to false in the siteConfig.yaml file. Alternatively, hide it for each individual page by setting showNextButton: false in the front matter of your MD(X) files.
  • Canonical URLs are now supported in the developer portal. To enable this, set a value for siteUrl in the meta section of your siteConfig.yaml file (for example, siteUrl: 'https://www.example.com'). This value will be used as the base URL for canonical links, and rel="canonical" will be automatically added to the head of all HTML pages in your portal.

1.0.0-beta.110 (2021-02-24)

Features

  • A new helper function called usePathPrefix is now available and can be imported from @redocly/ui.
  • A new front matter option exclude is now supported on MD and MDX pages. Use it to exclude an entire page from the portal build by adding exclude: true to the page front matter.
  • The WideTile component now supports the maxWidth property. You can configure the property as a percentage or as an exact amount of pixels.

Fixes

  • Issues with the Reference docs configuration option showRightPanelToggle have been resolved.
  • Tile components now properly support mailto: links.
  • If your developer portal project contains a top-level README.md file, this file will now be excluded from the portal build.
  • When using the WideTile component that contains an icon, the icon and the content will now be aligned to the top of the tile element instead of to the center.

1.0.0-beta.109 (2021-02-16)

Features

  • Implemented support for multiple identity providers in the on-premise Docker container. Identity providers can be configured in the auth section of the siteConfig.yaml file.
  • The LoginPageLink component now supports a new property called idpId. Use it to specify one of the identity providers configured in the siteConfig.yaml file. If you're using React hooks, you can now import the custom hook useLoginPageUrl from @redocly/ui and use it with idpId like in the following example:
const loginLink = useLoginPageUrl(idpId);

Note that these changes apply only to the on-premise Docker container, not to hosted Developer portals.

Deprecated

  • The allowLoginWith configuration option for the on-premise Docker container is now deprecated and should not be used.

1.0.0-beta.108 (2021-02-12)

Fixes

  • Fixed breaking builds after yarn.lock and node_modules are deleted.
  • Fixed the --relative-paths argument by using path prefixes from an environment variable.
  • Fixed incorrect path resolution of reusable Markdown snippets.

1.0.0-beta.107 (2021-02-12)

Broken release.


1.0.0-beta.106 (2021-02-02)

Fixes

  • Pinned mobx dependency to prevent crashes when upgrading.

1.0.0-beta.105 (2021-01-28)

Fixes

  • The search index will no longer crash when page names start with _.
  • Resolved a cryptic JavaScript error when the portal failed to load an OpenAPI definition.
  • Improved real-time reloading when the sidebar state changes to expanded.

1.0.0-beta.104 (2021-01-25)

Fixes

  • Fixed crashing when reusable Markdown snippets are embedded in MDX.
  • Added a warning that snippets are not supported in MDX.
  • Removed bad #undefined hash in some links.

1.0.0-beta.103 (2021-01-25)

Features

  • Redocly now supports single-source authoring and content reuse with Markdown snippets. Create "chunks" of text, save them as Markdown files in your developer portal project, and embed them into other pages across the portal.

Fixes

  • Implemented support for pathPrefix in the RBAC feature.
  • The HTTP scheme name (e.g. Bearer) is now capitalized in code samples.

1.0.0-beta.102 (2021-01-20)

Features

  • Users can now override defaults to customize SearchInput and SearchResults components.

1.0.0-beta.101 (2021-01-15)

Fixes

  • Removed many incorrect warnings that were cluttering the console output.

1.0.0-beta.100 (2021-01-15)

Fixes

  • Resolved an issue with mermaid diagrams overflowing the page size.
  • Resolved a HTML-related nesting issue by rendering ThinTile as a div if it doesn't have the to property.
  • Lint problems are now ignored for registry downloads.

1.0.0-beta.99 (2021-01-14)

Features

  • Developer portal now supports auto-generated C# and Python code samples in embedded API reference documentation.

Fixes

  • Implemented support for the correct default RBAC permission.
  • The mobile view button for expanding the sidebar menu has been temporarily disabled because of a bug in the full non-paginated reference docs page.

1.0.0-beta.98 (2021-01-04)

Features

  • A new front matter configuration option is available - excludeFromSearch. When you add excludeFromSearch: true to the front matter of a Markdown page, the page will be excluded from the search index and will not be accessible from the search results.
  • Implemented support for matchPath in MDX pages. This functionality is required for advanced client routes and for the upcoming Apigee portal integration.

Fixes

  • Hash fragments (named anchors) can now be used in relative links to MD and MDX pages; for example [link](./file.md#section-id).
  • Previously, OAS 2 API definitions could be imported only as files from the local filesystem. Now they can be imported from URLs, and they work with registry snapshot URLs (including the Logs > Snapshots > Get Snapshot option).
  • Resolved a minor styling issue with the position of anchor link icons when targeting a header.

1.0.0-beta.97 (2020-12-30)

Broken release.


1.0.0-beta.96 (2020-12-17)

Features

  • It is now possible to customize the entire sidebar menu. Check the developer portal starter repository for an example of how to change the sidebar style.
  • By popular demand, links in the navigation bar can now have custom icons. To add a custom icon for an item, provide the path to the icon image as the value of the new icon field in the nav section of the siteConfig.yaml file. An example is available in the developer portal starter repository.

Fixes

  • Improved the look of parameters with multiple examples in Reference docs.

1.0.0-beta.95 (2020-12-15)

Fixes

  • Implemented support for using API reference docs as the index page of the developer portal. This can be achieved either by renaming the reference docs page to index.page.yaml or by setting path: "/" in the corresponding .page.yaml file.
  • Button components without a to link will now be rendered as <button> instead of as <a>.
  • Portal will no longer crash when the siteConfig.yaml file contains an invalid page item in nav.

1.0.0-beta.94 (2020-12-03)

Features

  • Sidebar items can now be customized independently of the developer portal theme. Check the developer portal starter repository for an example of how to style the sidebar items.

1.0.0-beta.93 (2020-11-26)

Features

  • A new CLI option --ignore-openapi-errors is now supported. When this option is used, the portal build will not fail if validation errors are found in API definition files.
  • Implemented a new helper React hook called useAPICatalog in @redocly/ui. It returns a list of all API definitions in the developer portal project (plus some metadata), and can be used to create API catalog pages. ​

1.0.0-beta.92 (2020-11-23)

  • Internal release without changes.

1.0.0-beta.91 (2020-11-22)

Features

  • Implemented support for the RBAC (Role-based access control) feature. With RBAC, you can define permissions for accessing specific parts of your developer portal, and assign those permissions to different types of users (roles). This feature is available only to Enterprise customers, and only if the developer portal is hosted on-premise using Docker.

Fixes

  • Fixed the style for code blocks inside headings.

1.0.0-beta.90 (2020-11-18)

Features

  • The siteConfig.yaml file now supports linking to external API definition files by using $ref in the oasDefinitions section.

1.0.0-beta.89 (2020-11-13)

Fixes

  • Resolved an issue with alert content rendering when content was passed as React children.
  • Minor TypeScript type fixes been implemented.

1.0.0-beta.88 (2020-11-06)

Features

  • The Alert UI component now supports nested content for all alert variants. Nested content is added to an alert using the children property.

Fixes

  • Properly applied the fix for broken code highlighting on initial page load (issue carried over from previous release).
  • All page links on the portal now use lowercase letters. Page links that previously contained uppercase letters will be automatically transformed to all lowercase letters (for example, ./developer-portal/Getting-Started.md becomes /developer-portal/getting-started/). As a consequence, some links may break after updating to this version of the Developer portal.
  • When adding pages to the portal using the /* "spread" pattern to include all files from a path, the pages will now be grouped by folder in the navigation sidebar.

1.0.0-beta.87 (2020-11-02)

Fixes

  • Resolved an issue with broken code highlighting on initial page load.
  • Implemented a performance fix in search-indexer for API definitions that use deep-nested oneOf. This change potentially resolves the RAM overflow issue reported by some customers.
  • Fixed the 401 error for manifest.json file when using basic authentication.

1.0.0-beta.86 (2020-10-29)

Features

  • Code samples in Reference docs can now be automatically generated for curl, JavaScript, and Node.js. This feature can be enabled for on-premise Developer portal deployments by editing the .page.yaml configuration file.

Fixes

  • Reduced the clutter in the browser log output.

1.0.0-beta.85 (2020-10-28)

Features

  • Upgraded to the latest version of reference-docs. This version introduces support for CORS Proxy configuration, allowing more control over requests sent from the "Try It" API console.

1.0.0-beta.84 (2020-10-21)

Features

  • New options for styling the portal sidebar are now available; namely: sidebar.textColor, sidebar.activeTextColor, and sidebar.activeBgColor.

Fixes

  • The layout of API reference docs is no longer broken on small screen sizes in Firefox. GitHub issue reference
  • Styled components can now be used for styling ThinTile, WideTile and Alert.
  • Custom queries will be properly extracted from MDX files with Windows-style line endings.
  • colors.<color>.contrastText can now be used for the Alert text color, where <color> is warning, success, error, or info.

1.0.0-beta.83 (2020-10-20)

Features

  • Allow running development server on GitHub Codespaces.
  • Upgrade reference-docs to v1.1.5.
  • Copy auth metadata to artifacts folder (for on-prem auth-server).

Fixes

  • Reduced clutter in the log output.

1.0.0-beta.82 (2020-09-28)

Fixes

  • Resolved an issue with redirecting to the developer portal home page after the user logs out.
  • Exported the setSecurityDetails helper.

1.0.0-beta.81 (2020-09-15)

Fixes

  • Fix requireLogin infinite reloading.

1.0.0-beta.80 (2020-09-15)

Fixes

  • Fix some utility functions that were not exported.

1.0.0-beta.79 (2020-09-15)

Features

  • Export helpers for anonymous login.

Fixes

  • Fix JsonSchema style issue.

1.0.0-beta.78 (2020-09-11)

Features

  • Add new side menu style: drilldown.

1.0.0-beta.77 (2020-09-11)

Features

  • Add new OpenAPI-powered components: OpenApiRequestBody, OpenApiExample, JsonSchema.

Bug fixes

  • Fix non-expanded reference docs broken build.

Deprecations

  • Renamed APIResponse to OpenApiResponse.

1.0.0-beta.76 (2020-09-03)

Features

  • Use remote rendering for mermaid diagrams.
  • Support for IdP issued tokens for Redocly Workflows OIDC integration.

1.0.0-beta.75 (2020-09-03)

broken release


1.0.0-beta.74 (2020-08-26)

Bug fixes

  • Fixed badge label for webhooks (with x-webhooks usage).

1.0.0-beta.73 (2020-08-25)

Features

  • Upgrade to the latest Redocly reference-docs:

    • x-webhooks support
    • accessibility features

Bug fixes

  • Fixed broken pages with spread /*.

1.0.0-beta.72 (2020-08-17)

Bug fixes

  • Proper error message for missing pages with spread /* instead of crash.

Features

  • Export some auth helpers: useProxiedFetch, getUserJwt, getUserId.

1.0.0-beta.71 (2020-07-28)

Bug fixes

  • Fixed WideTile icon margins.

1.0.0-beta.70 (2020-07-28)

Bug fixes

  • Adjusted default style of Tiles.

1.0.0-beta.69 (2020-07-28)

Features

  • Add new style properties to ThinTile and WideTile.
  • Add colors.navbar.gradient toggle to the theme.ts.
  • Support code snippet title

    Example usage

    Syntax:

    ```js JavaScript Example
    console.log('Hello, JS');
    ```
    
    ```python Python Example
    print('Hello, python');
    ```

    Result:

    JavaScript ExamplePython Example
    console.log('Hello, JS');
    print('Hello, python');
  • Upgrade mermaid to ^8.6.0 (support auto-wrapping and newlines).
  • Add option tocMaxDepth to limit the number of nested levels (globally in siteConfig.yaml or in frontmatter).
  • Add option disableLastModified to hide last modified label (globally in siteConfig.yaml or in frontmatter).

Bug fixes

  • Fix local css loading on Windows.
  • Fix inconsistent box shadow for thin tile.
  • Fix site meta image [Roman Hotsiy].
  • Support relative paths starting with ./ in sidebar.yaml.
  • Support external: true to show external site icon for sidebar menu items.
  • Fix "Next to" button for groups with page.