@redocly/cli@2.0.0-next.0
Pre-release
Pre-release
Major Changes
- Removed backward compatibility for the
specrule. Usestructinstead. - Removed support for the deprecated
apiDefinitionsoption in the Redocly config. Useapisinstead.
Removed thelabelsfield within theapissection, which was associated with the legacy Redocly API Registry product. - Removed support for the deprecated
features.openapiandfeatures.mockServerconfiguration options. UseopenapiandmockServerdirectly instead. - Removed backward compatibility for the deprecated
lintandstyleguideoptions in the Redocly config.
Userules,decoratorsand other related options on the root level instead. - Removed the deprecated
disallowAdditionalPropertiesoption support in rules. UseallowAdditionalPropertiesinstead. - Removed the deprecated
undefinedassertion. Usedefinedinstead. - Removed support for the legacy Redocly API Registry in favor of the new Reunite platform.
Reunite provides improved API management capabilities and better integration with Redocly's tooling ecosystem.
Migrated theloginandpushcommands to work exclusively with Reunite.
Removed thepreview-docscommand as part of platform modernization.
Use thepreviewcommand instead. - Removed support for the deprecated
referenceDocsoption, which was related to the legacy Reference docs product. - Removed support for the deprecated
assert/prefix in configurable rules. Userule/prefix instead. - Migrated the codebase to ES Modules from CommonJS, bringing improved code organization and better support for modern JavaScript features.
Update to Node.js version 20.19.0+, 22.12.0+, or 23+.
Minor Changes
-
Added
x-securityextension for Respect that enables secure handling of authentication in Arazzo workflows.
Use this extension to:- Define security schemes at the step level using either predefined schemes or inline definitions
- Pass values of secrets (passwords, tokens, API keys)
- Support multiple authentication types including API Key (query, header, or cookie), Basic Authentication, Bearer Token, Digest Authentication, OAuth2, and OpenID Connect
- Automatically transform security parameters into appropriate HTTP headers or query parameters
-
Added environment variable support for CLI arguments using Yargs
.env()method to parse environment variables with matching prefixes. -
Added new CLI options for the
respectcommand to improve test execution control.
Patch Changes
- Fixed
no-undefined-server-variablecrash when encounteringnullvalues in the server list. - Updated Redoc to v2.5.0.
- Fixed alias detection when using
--configfrom a different folder than the current working directory. - Fixed Redocly CLI to correctly read
residencyfrom the Redocly configuration file. - Improved Respect's error handling when server URLs are missing from both OpenAPI descriptions and CLI options.
- Updated @redocly/respect-core to v2.0.0-next.0.