Last updated 6 minutes ago

Workflows changelog

February 2021

2021-02-26.2

Fixes

  • For projects with a configured custom domain subdirectory (example.com/docs), visitors will be redirected by default to the project URL with a trailing slash (example.com/docs/).

2021-02-26.1

Features

  • Workflows now supports subdirectories for custom domains, allowing you to set up more than one documentation project per custom domain. Previously, if a project had example.com/docs as a custom domain, you were not able to use example.com/testing for another project in your account. Now it's possible to do that, as well as to set up subdirectories for your projects without using a proxy. Your projects can also have subdirectories at different depths, such as example.com/docs in one project and example.com/docs/internal in another project. In this case, the longer path takes precedence and will be served when trying to directly access the shorter path.

Note that custom domains are only supported in Professional and Enterprise pricing plans.

  • To simplify the path prefix configuration process, we removed the Advanced settings page from Reference docs and Developer portal settings. The Custom domain field on the Settings > General page of your Reference docs or Developer portal is now the main place to configure a custom domain with an optional subdirectory.

2021-02-24.2

Features

  • Workflows now supports an environment variable called OPENAPI_CLI_LINT_ARGS for adding extra arguments to the OpenAPI CLI lint command (for example, OPENAPI_CLI_LINT_ARGS=--skip-rule no-enum-type-mismatch operation-2xx-response). You can configure environment variables for your API definition builds in API registry > API version > Settings > Environment variables.

2021-02-24.1

Fixes

  • The "Upgrade your plan" link on the Reference docs page for suspended projects was incorrectly leading to the Reference docs > Settings page. This issue has been resolved, and the link now leads to the Org settings > Billing page.

2021-02-23.3

Features

  • When you sign up for a new account on Redocly Workflows, you can now provide more information about your API management and documentation needs. This will help us tailor our services to support you more adequately. You can also schedule a product tour directly from the sign-up dialog.

2021-02-23.1

Fixes

  • Resolved an encoding mismatch issue that prevented the loading of logo and favicon images in Reference docs builds.

2021-02-16.1

Fixes

  • Resolved an issue with failing builds reported by our customer.

2021-02-12.1

Features

  • Implemented API catalog support for RBAC in Workflows.

Fixes

  • Resolved an issue with search not working when Developer portal access control was changed to "Members only".

2021-02-08.1

Fixes

  • Long names of API definitions and versions will no longer exceed the width of their containing UI element on the API version overview page.
  • Resolved an issue with S3 and the OpenAPI CLI push command.

2021-02-07.2

Fixes

  • Added missing s3:PutObject permission for GraphQL API to fix an issue with the OpenAPI CLI push command.
  • Secrets stored in environment variables will no longer be logged when running portal builds. Additionally, any existing logs that contained secret values have been removed.

January 2021

2021-01-30

Features

  • Implemented a new flow for inviting members to an organization.
  • The RBAC (Role-based access control) feature is now supported for Developer portals hosted in Workflows. Users can configure some of the RBAC settings from the Workflows interface, and define the rest in the configuration files in the developer portal project.
  • Server-side search is now enabled by default for all Developer portals, significantly improving the speed and the overall user experience.

Fixes

  • Resolved an issue with an inefficient GQL query that caused a timeout in cPanel.
  • Improved the text in emails that are sent when usage limits are reached.
  • API definitions that fail validation with errors will no longer be successfully bundled, and their log will now accurately reflect their failed status.
  • The registry API now supports GZIP for file compression.

2021-01-13

Features

  • You can now enable auto-generated Python and C# code samples in your Reference docs from the Workflows interface. Find the new options on the Reference docs > Settings > API reference settings page.

Fixes

  • Resolved an API registry failure caused by insufficient disk space.
  • Resolved a timeout issue that would cause the registry build to fail when there were too many dependent jobs.

December 2020

2020-12-28

Features

  • Implemented signing for files uploaded with the openapi-cli push command.

2020-12-21

Features

  • When you invite new members to your Workflows organization, the invitation email they receive will be more informative and look better from now on.

    Fixes

  • Updated the sender ("from") address for emails sent by Redocly Workflows.
  • Resolved a minor issue with the accordion for expanding job results.

2020-12-16

Features

  • Integrated the new version of Reference docs with the "Try it" button in a new default location. You can now configure the appearance of this button from Reference docs > Settings > API reference settings > Live configuration.

2020-12-10

Features

  • When inviting new members to your Workflows organization, you will see more detailed user role descriptions.

Fixes

  • Resolved an issue with the Mermaid diagram rendering service that affected only newly created diagrams due to caching.

2020-12-07

Features

  • Workflows now has a separate tab at the top called Portals for faster and more practical access to all developer portals in your organization. No more scrolling through the list of reference docs to get to the portals!

Fixes

  • If there are any errors after you log in or sign up to Workflows, an informative message is now displayed to help you resolve the issue.
  • ESLint cache is now enabled.

November 2020

2020-11-25

Features

  • When entering your password on the Workflows login or signup screen, you can now toggle password visibility.

Fixes

  • Resolved an issue with setting the status for jobs without commit data.
  • Aligned error messages to the center of the screen.
  • Resolved an issue with URL polling.
  • Added timeout and retry functionalities to GitLab calls.
  • Resolved an issue with the filename auto-complete functionality in repositories when switching branches.

2020-11-17

Fixes

  • Resolved an API registry issue with insufficient disk space reported by our customers.
  • The on-premise license keys page was not available for some customers.

2020-11-16

Features

  • Implemented a number of internal improvements to the service, including a unified logger and Sentry reporting.

Fixes

  • Resolved an issue with some large API definitions causing a “no space” crash and impacting customer builds.

2020-11-14

Fixes

  • Enabled Google Tag Manager and disabled Google Analytics for the service.

2020-11-11

Features

  • All subscriptions are now anchored to the first day of the month at 00:00 UTC.
  • All definition servers information is now saved to the definition_job table.

2020-11-09

Features

  • When configuring GitHub as your API source, auto-complete is now supported for root API definition filenames.
  • The Workflows interface now displays a Show/Hide value button for long environment variables in configuration pages.

Fixes

  • Resolved an issue with setting the definition name from storage.
  • After authorizing the GitHub Enterprise app, users will no longer be redirected to the wrong page.
  • Links in the "Source" section of the API version overview page are no longer broken for GitHub Enterprise users, and now lead to the appropriate repositories.
  • The "Upgrade plan" message will now be correctly shown when selecting the Upgrade your plan button on the API registry page.
  • Added missing placeholder text for the "Documentation Reader" user role that should be displayed when the organization doesn't have any docs yet.
  • When creating an API version and attempting to use an API version name that's already taken, the name validation error will no longer be displayed on the wrong page.
  • The Pay button will now remain disabled until the "Your transaction is approved" page loads to prevent misclicks and errors during the checkout process.
  • The source configuration dialog for portals no longer allows saving settings if the selected source is not a valid portal project.
  • Implemented validation for the URL field in the GitHub Enterprise integration settings (on the Org settings > Source control providers page).
  • Notification emails about usage limits now contain the organization name that the limits refer to. This makes usage management easier for customers with multiple organizations.
  • Implemented a solution for handling root file changes in Bitbucket.

2020-11-02

Fixes

  • Portal previews were inaccessible for branches with the / symbol in the name.
  • Added a correct link to GitHub documentation in the GitHub source selection dialog.

October 2020

2020-10-29

Features

  • You can now enable auto-generated code samples for curl, JavaScript and Node.js in your Reference docs from the Workflows interface. Access these options on the Reference docs > Settings > API reference settings page.

Fixes

  • Resolved an issue with lead source tracking.

2020-10-19

Features

  • Redocly now supports the CORS proxy feature, which you can configure for your reference docs on the Reference docs > Settings > API reference settings page. CORS proxy is enabled by default for all newly created reference docs.

Fixes

  • Resolved an issue with API crashing on partially refunded invoice status.
  • Added the portal scope to on-premise license keys.
  • Updated the contents of the initial starter email.
  • Resolved an issue where invited users were unable to accept the invitation because of extra space in the email.

2020-10-16

Fixes

  • Resolved issues with the "Try it" feature that would happen when API definitions contained server-variables or had empty body content.

2020-10-15

Fixes

  • Set up a basic GTM dashboard for Workflows.
  • Long branch names will no longer be displayed as cut off.

2020-10-12

Features

  • An informative message is now displayed if your organization has any outstanding invoices.
  • When you select a URL as the source of your API definition, Workflows now shows a helpful message if the provided URL responds with a non-200 status. Additionally, URLs that couldn't be accessed are now recorded in the service logs.
  • Implemented support for a special environment variable OPENAPI_CLI_BUNDLE_ARGS in API versions. This allows you to pass extra arguments such as --skip-decorator.

Fixes

  • Renamed "Redoc.ly" to "Redocly" on the login page.

2020-10-09

Features

  • You can now try Redocly faster than ever! Extra steps have been removed from the start trial process to streamline the experience for you.

2020-10-08

Features

  • You can now use environment variables for API version builds. On the Workflows side, environment variables can be configured from the API registry > Settings > Environment variables page for each API version in your organization.
  • Memory resources for portal builds have been increased.

2020-10-05

Features

  • Users can now remove their API key after creating it.
  • The old Redocly logo has been replaced by the new one in the Workflows login page. Spot the difference!

September 2020

2020-09-28

Features

  • Workflows now supports Bitbucket Self-Managed (server and datacenter) as a source when adding your APIs to the registry. Additional Bitbucket-related configuration options are available in the Org settings > Source control providers page.

2020-09-24

Features

  • Implemented support for OIDC implicit flow.
  • Improved language and writing style throughout the Workflows interface.

Fixes

  • Added a timeout for the success message on Access control and API reference settings pages.
  • The Last updated timestamp is no longer missing from the list of developer portals.
  • After successfully activating a Developer portal trial, users will now be redirected to the page from which they requested the trial.
  • When adding or editing a source, it's no longer possible to save the source settings until all required fields are filled in.
  • Resolved an issue with HTTP URLs in the GitHub Enterprise integration.
  • Changed body background color.

2020-09-17

Features

  • Anonymous (public) login with OIDC is now supported and configurable for Developer portals.

    Fixes

  • Fixed Azure integration to support repository names with spaces.

2020-09-14

Features

  • The Live configuration page for Reference docs has received many improvements.
  • Customers on the Enterprise plan can now generate their own license keys for offline use from the Org settings > On-premise license keys page. Note that you must be an organization owner to use this feature.
  • Developer portals now build two times faster thanks to a number of internal performance optimizations.
  • Integrated the new version of Reference docs with support for OIDC and oAuth implicit.

Fixes

  • Renamed the “Offline license keys” tab to “On-premise license keys” on the Org settings page.
  • Fixed an issue with large files in GitHub mistakenly reported as non-existing.

2020-09-09

Features

  • Added the "Password" label to the password field on the login page.

2020-09-08

Fixes

  • API Registry validation hard errors (bugs in Redocly or general errors) are now saved to the database.
  • Implemented a lot of minor UI improvements.

2020-09-03

Features

  • Implemented OpenID Connect support for access_token.
  • Path prefixes can now be configured for developer portals in their Settings > Advanced dialog. This allows you to serve documentation from non-root paths.
  • Minor UI improvements have been made to the usage details on the Org settings > Billing page and the Stats section in Reference docs > Overview.
  • Implemented the Mermaid diagram renderer microservice with support for remote rendering.

2020-09-01

Features

  • OIDC is now supported as an IdP for access to the docs.
  • Labels for GitLab sources have been renamed to improve their clarity.

August 2020

2020-08-24

Features

  • Improved OpenAPI CLI build speed (supported on OpenAPI CLI >=beta.9 and for API definitions from URLs and file uploads).
  • Implemented a new UI for validation problems (supported on OpenAPI CLI >=beta.9 and for API definitions from URLs and file uploads).
  • Multi-version Reference docs are now enabled for all pricing plans.
  • Implemented accessibility fixes for Reference docs that have previously been added to Redoc.
  • Implemented support for x-webhooks in Reference docs.
  • Users can now automatically access the portal upon submitting the Typeform request.

2020-08-13

Features

  • A guided tour is now displayed for new users when they first log into Workflows to improve the onboarding experience.
  • Implemented support for API proxies. Workflows organization owners can configure proxies from the Org settings > API gateways page.
  • The "Try it" feature in Reference docs is now enabled by default for newly created docs.

2020-08-31

Fixes

  • Resolved issues with root file validation caused by forward slashes (/).

2020-08-13

Fixes

  • Resolved an issue with bundle uploads.
  • Implemented several UI improvements.
  • Resolved an issue with case sensitivity in authorization server headers.