chore(deps): update dependency @redocly/cli to v2 #5179
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
1.29.0
->2.0.1
Warning
Some dependencies could not be looked up. Check the Dependency Dashboard for more information.
Release Notes
Redocly/redocly-cli (@redocly/cli)
v2.0.1
Compare Source
Patch Changes
no-required-schema-properties-undefined
rule incorrectly resolved nested$ref
s relative to the file in which they were defined.v2.0.0
Compare Source
Major Changes
spec
rule. Usestruct
instead.apiDefinitions
option in the Redocly config. Useapis
instead.Removed the
labels
field within theapis
section, which was associated with the legacy Redocly API Registry product.redocly.yaml
.features.openapi
andfeatures.mockServer
configuration options. Useopenapi
andmockServer
directly instead.lint
andstyleguide
options in the Redocly config.Use
rules
,decorators
and other related options on the root level instead.disallowAdditionalProperties
option support in rules. UseallowAdditionalProperties
instead.theme
property of Redocly config.All the properties of
theme
are now available in the config root.path-excludes-patterns
andinfo-license-url
rules.undefined
assertion. Usedefined
instead.Reunite provides improved API management capabilities and better integration with Redocly's tooling ecosystem.
Migrated the
login
andpush
commands to work exclusively with Reunite.Removed the
preview-docs
command as part of platform modernization.Use the
preview
command instead.referenceDocs
option, which was related to the legacy Reference docs product.assert/
prefix in configurable rules. Userule/
prefix instead.Update to Node.js version 20.19.0+, 22.12.0+, or 23+.
Minor Changes
Added
x-security
extension for Respect that enables secure handling of authentication in Arazzo workflows.Use this extension to:
Added environment variable support for CLI arguments using Yargs
.env()
method to parse environment variables with matching prefixes.Added validation for JSON Schema format.
Extracted
nullable
validation from thestruct
rule into a newnullable-type-sibling
rule for OpenAPI 3.0. This allows users to disablenullable
validation separately from other structural checks.Configured the
spec
ruleset for OpenAPI, AsyncAPI, Arazzo, and Overlay specifications.This ruleset is designed to strictly follow the specifications.
Added the
no-duplicated-tag-names
rule to check for duplications in thetags
field in API descriptions.Enabled
no-required-schema-properties-undefined
,no-schema-type-mismatch
, andno-enum-type-mismatch
rules for AsyncAPI and Arazzo specifications.Adjusted the rules' severities in the
recommended
andminimal
rulesets. Refer to the following table:off
->warn
off
->warn
error
warn
warn
->error
off
->warn
Implemented automatic masking of sensitive fields (such as tokens and passwords) in response bodies to enhance security and prevent accidental exposure of secrets in logs and outputs.
Added new CLI options for the
respect
command to improve test execution control.Patch Changes
extends
section.no-undefined-server-variable
crash when encounteringnull
values in the server list.@redocly/respect-core
to eliminate Node.js-specific dependencies, improving cross-platform compatibility.--config
from a different folder than the current working directory.[email protected]
injected an unintended message into the output.residency
from the Redocly configuration file.v1.34.5
Compare Source
Patch Changes
form-data
to 4.0.4 for Redocly CLI v1.v1.34.4
Compare Source
Patch Changes
[email protected]
injected an unintended message into the output.v1.34.3
Compare Source
Patch Changes
v1.34.2
Compare Source
Patch Changes
v1.34.1
Compare Source
Patch Changes
v1.34.0
Compare Source
Minor Changes
respect
command execution to prevent infinite test runs. You can configure this timer using theRESPECT_TIMEOUT
environment variable (defaults to 1 hour).Patch Changes
v1.33.1
Compare Source
Patch Changes
generate-arazzo
command to properly handle output file paths. Theoutput-file
parameter must have a value when provided.v1.33.0
Compare Source
Minor Changes
generate-arazzo
command now automatically generates operationPaths using the URL pattern:{$sourceDescriptions.<name>.url}#/paths/<path>/<method>
.Patch Changes
v1.32.2
Compare Source
Patch Changes
warn
|off
severity allows subsequent steps to execute).v1.32.1
Compare Source
Patch Changes
basic
,bearer
, andapiKey
security schemes in workflow generation withgenerate-arazzo
command.v1.32.0
Compare Source
Minor Changes
Patch Changes
type
keyword enum, removednull
.v1.31.3
Compare Source
Patch Changes
v1.31.2
Compare Source
Patch Changes
sourceDescription
name generation ingenerate-arazzo
command when using OpenAPI files that contain multiple periods "." in their filenames.v1.31.1
Compare Source
Patch Changes
respect-core
import in Redocly CLI package.v1.31.0
Compare Source
Minor Changes
generate-arazzo
command to scaffold Arazzo description templates out of OpenAPI descriptions.respect
command to test APIs against Arazzo description files.Patch Changes
v1.30.0
Compare Source
Minor Changes
Patch Changes
operation-tag-defined
built-in rule to verify tags are defined on the operation prior to matching them to a global tag.Configuration
📅 Schedule: Branch creation - "after 4pm on friday,before 9am on monday,every weekend" in timezone Europe/Paris, Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.