Update dependency @redocly/cli to v2 #698
Open
+337
−396
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.34.5
->2.0.2
Release Notes
Redocly/redocly-cli (@redocly/cli)
v2.0.2
Compare Source
Patch Changes
executionTimeout
parameter optional in therun
function exported fromrespect-core
.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.SpecVersion
,SpecMajorVersion
,OPENAPI3_METHOD
, andOPENAPI3_COMPONENT
enums with types for improved flexibility and type safety.Removed the unused
OasVersion
enum.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.extends
bundling and array-based plugin configuration.Fixed the extends order in the configuration.
assert/
prefix in configurable rules. Userule/
prefix instead.Update to Node.js version 20.19.0+, 22.12.0+, or 23+.
Removed
StyleguideConfig
class in favor of the unifiedConfig
class.Removed
getMergedConfig
function - useConfig.forAlias()
method instead to retrieve API-specific configurations.Minor Changes
Added
x-security
extension for Respect that enables secure handling of authentication in Arazzo workflows.Use this extension to:
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
Patch Changes
ignoreLastPathSegment
option of thepath-segment-plural
rule had no effect if the path contained only one segment, resulting in an error.extends
section.@redocly/respect-core
to eliminate Node.js-specific dependencies, improving cross-platform compatibility.residency
from the Redocly configuration file.constructor
property.Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ Rebasing: Whenever PR is behind base branch, 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.