npm · #3910

@redocly/openapi-core

2.48.0Redocly/redocly-cli ↗

See https://github.com/Redocly/redocly-cli

Last release today
26 Aug 2026
Ships on a steady schedule
a new release about every 9 days
Nearly every release is documented
notes for 60 of the last 60 stable releases
Nothing withdrawn
no release was ever pulled
6 years old
728 releases · first in 2020

Release timeline

728 releases since 2020

202120222023202420252026

Releases

1.4.026 Oct 2023
Release notes
Minor Changes
- Added recommended-strict ruleset which uses the same rules as recommended but with the severity level set to error for all rules.
- Add JSON output support to the split and join commands.
Patch Changes
- The --host/-h argument in the preview-docs command is now also used by the WebSocket server for hot reloading.
- Updated @redocly/openapi-core to v1.4.0.
Open source →
1.3.019 Oct 2023
Release notes
Minor Changes
- Added the possibility to configure the linting severity level of the configuration file for all CLI commands. Redocly CLI exits with an error if there are any issues with the configuration file, and the severity is set to error.
Patch Changes
- Updated @redocly/openapi-core to v1.3.0.
Open source →
1.2.118 Oct 2023
Release notes
Patch Changes
- Fixed an issue with nested refs in the join command.
- Fixed pattern for no-server-example.com rule to improve detection accuracy.
- Changed the report location for pattern and notPattern assertions to be more precise.
- Updated unevaluatedItems type definition to resolve either boolean or object schema per JSON Schema 2019-09 specification.
- Updated @redocly/openapi-core to v1.2.1.
Open source →
1.2.018 Sept 2023
Release notes
Minor Changes
- Added support for linting AsyncAPI v2 files, so that a wider range of API descriptions can use the Redocly linting workflow.
Patch Changes
- Renamed API definition to API description for consistency.
- Updated @redocly/openapi-core to v1.2.0.
Open source →
1.1.014 Sept 2023
Release notes
Minor Changes
- Added ignoreCase option for tags-alphabetical rule.
- Added join support for OAS 3.1 descriptions.
- Added support for Redoc v2.1.2, and aligned the dependencies for both projects.
Patch Changes
- Fixed an issue where the --remove-unused-components option removed used components that were referenced as child objects.
- Updated Redocly config validation.
- Fixed the location pointer when reporting on the no-path-trailing-slash rule.
- Updated minimum required version of Node.js to v14.19.0, NPM to v7.0.0, and removed deprecated packages.
- Updated @redocly/openapi-core to v1.1.0.
Open source →
1.0.27 Aug 2023
Release notes
Patch Changes
- No code changes.
- Updated @redocly/openapi-core to v1.0.2.
Open source →
1.0.17 Aug 2023
Release notes
Patch Changes
- Fixed the build-docs command failing when running outside the root folder.
- Updated @redocly/openapi-core to v1.0.1.
Open source →
1.0.025 Jul 2023
Release notes
This release marks the stable version 1.0. There are no changes from previous releases.

Open source →
1.0.0-rc.320 Jul 2023pre-release
Release notes
Fixes
- Fixed issue with publishing to Docker Hub (no code changes).
- Fixed smoke tests in Yarn and Docker environments.
Changes
- Added job for testing new version (no code changes).
Open source →
1.0.0-rc.219 Jul 2023pre-release
Release notes
- Update package publishing process (no code changes).
Open source →
1.0.0-rc.117 Jul 2023pre-release
Release notes
No code changes.

Open source →
1.0.0-beta.13110 Jul 2023pre-release
Release notes
Fixes
- Handled aborted request in the docker and removed a redundant call.
- Resolved problem with installation failing in node 14- and yarn due to unresolved peer dependencies.
Changes
- Removed the cdn option from the build-docs command as it was not functional.
- Updated Redocly config validation schemas.
Open source →
1.0.0-beta.1306 Jul 2023pre-release
Release notes
Features
- Added new rule component-name-unique to check for unique component names (kudos to @pboos 🎉).
- Added docker container to GitHub container registry.
Fixes
- Fixed an issue when the --files option of the push command did not upload extra files.
- Fixed nullable schema type validation for OAS 3.1.
- Added peer dependencies to fix an issue with styles seen in the build-docs command.
Changes
- Additional data masking for the anonymous data collection feature.
- Added fetch request timeout to prevent hanging the tool when executing commands.
Open source →
1.0.0-beta.12926 Jun 2023pre-release
Release notes
Features
- Added product metrics collection.
Fixes
- Fixed build-docs command not working in Docker.
- Other stability fixes and improvements.
Changes
- Streamlined the push command interface. The previous syntax also continues to work.
- Improved Redocly configuration validation.
- Documentation and messaging corrections.
Open source →
1.0.0-beta.1287 Jun 2023pre-release
Release notes
Features
- Resolve $refs in preprocessors.
- Create the spec-strict-refs rule to ensure $ref usage is in accordance with the OpenAPI specification.
Fixes
- Handle syntax errors from plugins.
- Apply the following regular expression, ^[a-zA-Z0-9\.\-_]+$, only to fixed fields under components.
Changes
- Change the prefix from assert/ to rule/ as a prefix for configurable rules. The assert/ prefix continues to work with a warning of the deprecated syntax.
Open source →
1.0.0-beta.12725 May 2023pre-release
Release notes
Features
- Inform the user if a new version is available.
Fixes
- Improved messages on wrong schemas.
- Fixed components duplication and self-referencing when bundling.
- Fixed typos.
Changes
- Adjusted CLI arguments behavior for array-like options: it's required to specify the option multiple times to add multiple values. For example, --skip-rule rule1 --skip-rule rule2 instead of --skip-rule rule1 rule2.
Open source →
1.0.0-beta.12610 May 2023pre-release
Release notes
Features
- Added new options for the join command: --decorate and --preprocess.
Fixes
- Fixed a bug with OAS (x-) specification extensions that contain an array.
- Display an error if the API path refers to a folder.
- Fixed the push command not recognizing API descriptions with spaces.
- Defined default allowedValues in the all ruleset for mime-type rules.
Changes
- Display an error if apis or rules for the lint command are not provided.
- Stopped executing decorators and preprocessors upon the join command.
- Sort top-level OAS3 keys in bundle and join commands.
Open source →
1.0.0-beta.1256 Apr 2023pre-release
Release notes
Features
- Added the required-min-length-string-type-property rule that requires required properties in the API description with type string to have a minLength.
Fixes
- Fixed an issue with $ref in path parameters during the join command.
- This release also includes various internal stability fixes and improvements.
Changes
- Changed the arguments for assertion custom functions. Now as the third parameter, instead of a location object, assertion custom functions include a ctx object. See Custom functions.
Open source →
1.0.0-beta.12413 Mar 2023pre-release
Release notes
- Fixed an issue with remote file inside the lint ignore file.
Open source →
1.0.0-beta.1231 Feb 2023pre-release
Release notes
Fixes
- Fixed the push command when organization is provided in the redocly.yaml configuration file.
Open source →
1.0.0-beta.12226 Jan 2023pre-release
Release notes
Fixes
- Fixed an issue with the push command not working with a valid organizationId.
Open source →
1.0.0-beta.12125 Jan 2023pre-release
Release notes
Features
- Added custom output file option to the join command.
- Added an option to include webhooks to operation-4xx-response rule.
- Added a new built-in decorator info-override.
- Added support for / as a separator which puts paths into subdirectories for each path segment with the split command.
Fixes
- Ignored case when inferring file extension from code sample lang property.
Changes
- Moved and renamed the features.openapi and features.mockServer into the theme object with the names openapi and mockServer.
Before:
```
features.openapi: {}
features.mockServer: {}
```
After:
```
theme:
  openapi: {}
  mockServer: {}
```
Open source →
1.0.0-beta.1205 Jan 2023pre-release
Release notes
Fixes
- Fixed an issue where $refs weren't resolved inside specification extensions.
Open source →
1.0.0-beta.1193 Jan 2023pre-release
Release notes
Fixes
- Fixed an issue where the spec rule showed an error for x-logo properties in the 3.1 OpenAPI description.
Open source →
1.0.0-beta.11829 Dec 2022pre-release
Release notes
Features
- Enabled removing unused components in the config to use within the bundle command.
- Implemented special SpecExtension type VendorExtension.
- Added an error handler for the case when the API description file or a plugin does not exist.
- Added media-type-examples-override decorator.
Fixes
- Fixed an issue where the rule spec-components-invalid-map-name is not applied for all examples and adjusted the logic behind the rule in general.
Open source →
1.0.0-beta.1178 Dec 2022pre-release
Nothing published for this version
1.0.0-beta.1167 Dec 2022pre-release
Release notes
Fixes
- Fixed an issue with scalar assertion failing when an object is of invalid type.
Features
- Added Redoc vendor extensions to supported types.
Open source →
1.0.0-beta.11529 Nov 2022pre-release
Release notes
Features
- Added support for any type in assertions.
Changes
- Renamed the Docker image on Docker Hub.
- Changed assertions errors grouping.
- Removed orphaned git submodule public_api_docs.
Open source →
1.0.0-beta.11418 Nov 2022pre-release
Release notes
Features
- Added a new assertion notPattern to the custom rules.
Open source →
1.0.0-beta.11316 Nov 2022pre-release
Release notes
Changes
- Removed automatically adding the recommended configuration when there is a config defined without an extends list.
Fixes
- Fixed an issue with undefined process.cwd in browser environment.
- Fixed an issue with $anchors in OpenAPI documents are not properly parsed.
- Fixed an issue with the spec rule not reporting on nullable in Schema object that don't have a type sibling.
- Added missing OAS2 and OAS3 list types.
- Don't show false media type example errors when a discriminator is used with the allOf keyword.
Open source →
1.0.0-beta.1122 Nov 2022pre-release
Release notes
Changes
- Changed assertions syntax and renamed to custom rules.
- Removed info-description rule.
- Removed deprecated fields suggestions in Redocly config file.
Open source →
1.0.0-beta.11110 Oct 2022pre-release
Release notes
Changes
- Renamed four type names for alignment with the OpenAPI specification.
  - PathsMap to Paths
  - ResponsesMap to Responses
  - EncodingsMap to EncodingMap
  - SecuritySchemeFlows to OAuth2Flows
Features
- Added a new option --keep-url-references to the bundle command that disables bundling of absolute URL $ref-s.
Fixes
- Improved location of problems produced by security-defined rule.
- Fixed an issue with response-contains-header being case-sensitive.
- Fixed an issue with path-params-defined rule that was not accounting for params defined on the operation level.
- Fixed an issue with type not being validated if it is an array.
- Fixed an issue with apis overrides not picking up some base values from the root config.
- Fixed an issue with api not being detected from the apis list if used as a file name.
Open source →
1.0.0-beta.11021 Sept 2022pre-release
Release notes
Features
- Added the build-docs command which builds Redoc API docs into a zero-dependency HTML file.
- Added the ability to upload other files and folders with the push command.
- Added support for custom assertions as plugins.
Fixes
- Fixed incorrect behavior for the no-invalid-media-type-examples rule in combination with the allOf keyword.
Open source →
1.0.0-beta.10913 Sept 2022pre-release
Release notes
Features
- Added rfc7807 problem details rule.
- Improved error messages by adding referenced from information.
- Added the spec-components-invalid-map-name rule for component map names validation.
- Added a new lint --format option: summary.
Fixes
- Fixed an issue with multi-line strings in literal mode.
- Fixed an issue with multi-line Markdown with Windows-style new lines.
- Fixed the Header object type to require content or schema.
- Fixed a error message for operation-4xx-response rule.
- Fixed an issue with paths not being correctly handled by the join command.
- Fixed the operation-security-defined rule to check the security on the root and in each operation.
Changes
- Renamed 'DefinitionRoot', 'ServerVariableMap', 'PathMap', 'CallbackMap', 'MediaTypeMap', 'ExampleMap', 'EncodingMap', 'HeaderMap', and 'LinkMap' definition node types.
- Removed the styleguide object from the configuration file.
- Renamed the operation-security-defined rule to security-defined.
Open source →
1.0.0-beta.10822 Aug 2022pre-release
Release notes
Changes
- Renamed no-servers-empty-enum to no-server-variables-empty-enum and fixed incorrect docs of no-empty-enum-servers.
Features
- Add browser support for openapi-core.
- Allow accessing config field in subclasses extending BaseResolver class.
- Ability to create config (e.g. redocly.yaml) from string or object.
Fixes
- Fixed docs for no-server-example.com.
- Incorrect schema description dereferenced.
Open source →
1.0.0-beta.10716 Aug 2022pre-release
Release notes
Changes
- Add allowAdditionalProperties to built-in rules and mark disallowAdditionalProperties as deprecated.
Fixes
- Introduced severity level off for assertions.
Open source →
1.0.0-beta.10610 Aug 2022pre-release
Release notes
Fixes
- Now errors exit with return code 1.
Changes
- Renamed lint into styleguide in Redocly configuration.
- Improved naming consistency.
Open source →
1.0.0-beta.10527 Jul 2022pre-release
Release notes
Fixes
- Fixed bug with an invalid path to the configuration file causing issues with the ignore file.
Open source →
1.0.0-beta.10411 Jul 2022pre-release
Release notes
Fixes
- Fixed incorrect boolean filtering in filter-out rule.
- Fixed bug with tags duplication for the join command.
- Other internal stability fixes and improvements.
Open source →
1.0.0-beta.10327 Jun 2022pre-release
Release notes
Features
- Added new property ref to assertation object.
- Added the --lint-config option for the lint command. Use it to validate the configuration file with appropriate severity level.
- Added new built-in decorators filter-in and filter-out.
Fixes
- Resolved an issue with the --run-id option for the push command. The --run-id option renamed to the --batch-id, added the --batch-size option.
- Improved types for the configuration file.
Open source →
1.0.0-beta.1029 Jun 2022pre-release
Release notes
Features
- The join command supports a new option --without-x-tag-groups. Use it to skip the creation and population of x-tagGroups.
- Added new property requireAny to assertation object.
- Updated types. Added showSecuritySchemeType and disableTryItRequestUrlEncoding configuration options.
Fixes
- Fixed issue with additionalItems array type.
Open source →
1.0.0-beta.1019 Jun 2022pre-release
Release notes
Broken release.

Open source →
1.0.0-beta.10027 May 2022pre-release
Release notes
Fixes
- Fixed types for Callback and NamedCallbacks.
- Fixed an issue with the scalar-property-missing-example built-in rule that didn't work on examples containing falsy values.
Open source →
1.0.0-beta.9926 May 2022pre-release
Release notes
Features
- Added three new built-in rules: response-contains-header, response-contains-property, scalar-property-missing-example.
- The bundle command supports a new option --keep-url-references. Use it to prevent Redocly CLI from resolving external URL references during bundling.
- Added addinionalItems, minContains and maxContains array types.
Fixes
- Resolved an issue with escaping symbols in code sample language names (the lang value in the x-codeSamples specification extension).
Open source →
1.0.0-beta.9818 May 2022pre-release
Release notes
Features
- Updated types. Added hideTryItPanel, schemaDefinitionsTagName configuration options and x-hideTryItPanel, x-tags OpenAPI specification extensions.
Open source →
1.0.0-beta.9711 May 2022pre-release
Release notes
Features
- Added the --public option to the push command. With this option, you can upload OpenAPI descriptions and make them publicly accessible.
- Changed assertions syntax to this pattern: assert/{assert name}
Fixes
- Fixed an issue with process.* in core package that caused crashes in client-side builds.
- Fixed preview-docs hot reload.
Open source →
1.0.0-beta.966 May 2022pre-release
Release notes
Technical release for changing the package name from @redocly/openapi-cli to @redocly/cli.

Open source →
1.0.0-beta.955 May 2022pre-release
Release notes
{% admonition type="warning" name="Product name change" %} The product name has changed from OpenAPI CLI to Redocly CLI.

This change is reflected in all Redocly product documentation, in the npm package name (more on that in the "Deprecated" section), and in the official project GitHub repository.

The change also affects the CLI commands. The legacy name openapi is supported for now, but we strongly recommend you use the new name redocly. (To illustrate, if you previously used openapi lint, now you should use redocly lint).

If you encounter any issues and suspect they may be related to this change, let us know by reporting an issue.

{% /admonition %}

Features
- The lint.extends section in the Redocly configuration file supports file paths and URLs as values. This means you can define your own lint rulesets in local or remote files, and list those files in the extends section. The following example shows how to do it:
```
extends:
  - recommended
  - ./path/to/local/lint-ruleset.yaml
  - https://url-to-remote/lint-ruleset.yaml
```
The contents of those referenced files must correspond to the standard format used in the rules object to configure the rules. Here is an example lint-ruleset.yaml file referenced above:
```
rules:
  tags-alphabetical: error
```
- The lint command supports a new output formatting option called codeclimate that you can use with the --format argument.
Fixes
- Fixed an issue with resolvable scalar values not working in assertions.
Deprecated
- Deprecated the @redocly/openapi-cli npm package. From this version forward, use @redocly/cli instead.
Open source →
1.0.0-beta.9413 Apr 2022pre-release
Release notes
Features
- The lint command supports using unevaluatedProperties as boolean in OAS 3.1.x and no longer reports this as an error.
- Internal changes.
Open source →
1.0.0-beta.935 Apr 2022pre-release
Release notes
Fixes
- Resolved an issue with the push command skipping dependencies.
Open source →
1.0.0-beta.924 Apr 2022pre-release
Release notes
Features
- Introduced configurable rules - a new, powerful lint feature, which helps you enforce API design standards without coding (named assertions at the time of the release).
- The push command supports a new --skip-decorator option.
Fixes
- Resolved an issue with openapi preview-docs failing during authorization.
Open source →
1.0.0-beta.9129 Mar 2022pre-release
Nothing published for this version
1.0.0-beta.9024 Mar 2022pre-release
Release notes
Fixes
- Updated types to support validation of the Redocly configuration file according to the new file structure.
Open source →
1.0.0-beta.8921 Mar 2022pre-release
Release notes
Features
- Internal changes of redocly.yaml config structure - add new mock server options to redocly.yaml schema.
Fixes
- Fixed crash when there's an empty redocly.yaml file.
Open source →
1.0.0-beta.8816 Mar 2022pre-release
Release notes
Features
- Internal changes of redocly.yaml config structure.
Fixes
- Fixed an issue with the lint command highlighting the entire file when servers are missing in OAS3. Now it highlights only the openapi field, indicating an incorrect OpenAPI description.
- Fixed an issue with the lint command highlighting all parent values when one of the child fields has an empty value instead of highlighting the field itself.
Open source →
1.0.0-beta.8710 Mar 2022pre-release
Release notes
Fixes
- Fixed an issue with process.env assignment that caused crashes in client-side builds.
- Fixed an issue with no-path-parameter rule reporting false-positives.
Open source →
1.0.0-beta.869 Mar 2022pre-release
Release notes
Features
- Allowed to name the config file either .redocly.yaml (deprecated) or redocly.yaml.
Fixes
- The spec rule triggers an error when a parameter is missing schema or content fields.
Open source →
1.0.0-beta.852 Mar 2022pre-release
Release notes
- Internal improvements
Open source →
1.0.0-beta.8423 Feb 2022pre-release
Release notes
Fixes
- Fixed an issue with the lint command crashing when the servers.url field is empty in the OpenAPI description.
- Fixed an issue with the lint command crashing when an enum value is invalid.
Open source →
1.0.0-beta.8322 Feb 2022pre-release
Release notes
Features
- Added the webhooks and x-webhooks support to the split command.
Open source →

@redocly/openapi-core

Release timeline

Releases

Minor Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Patch Changes

Fixes

Changes

Fixes

Changes

Features

Fixes

Changes

Features

Fixes

Changes

Features

Fixes

Changes

Features

Fixes

Changes

Features

Fixes

Changes

Features

Fixes

Changes

Fixes

Fixes

Features

Fixes

Changes

Fixes

Fixes

Features

Fixes

Fixes

Features

Features

Changes

Features

Changes

Fixes

Changes

Changes

Features

Fixes

Features

Fixes

Features

Fixes

Changes

Changes

Features

Fixes

Changes

Fixes

Fixes

Changes

Fixes

Fixes

Features

Fixes

Features

Fixes

Fixes

Features

Fixes

Features

Features

Fixes