Skip to content

chore(deps): update dependency @redocly/cli to v2 #5179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jul 26, 2025

This PR contains the following updates:

Package Change Age Confidence
@redocly/cli 1.29.0 -> 2.0.1 age confidence

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
  • Fixed an issue where the no-required-schema-properties-undefined rule incorrectly resolved nested $refs relative to the file in which they were defined.
  • Fixed an issue where multipart form-data parameters were not properly resolved and evaluated before sending requests.
  • Updated @​redocly/openapi-core to v2.0.1.

v2.0.0

Compare Source

Major Changes
  • Removed backward compatibility for the spec rule. Use struct instead.
  • Removed support for the deprecated apiDefinitions option in the Redocly config. Use apis instead.
    Removed the labels field within the apis section, which was associated with the legacy Redocly API Registry product.
  • Removed support for default config file names other than redocly.yaml.
  • Removed support for the deprecated features.openapi and features.mockServer configuration options. Use openapi and mockServer directly instead.
  • Removed backward compatibility for the deprecated lint and styleguide options in the Redocly config.
    Use rules, decorators and other related options on the root level instead.
  • Removed the deprecated disallowAdditionalProperties option support in rules. Use allowAdditionalProperties instead.
  • Removed support for the deprecated theme property of Redocly config.
    All the properties of theme are now available in the config root.
  • Removed the deprecated path-excludes-patterns and info-license-url rules.
  • Removed the deprecated undefined assertion. Use defined instead.
  • 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 the login and push commands to work exclusively with Reunite.
    Removed the preview-docs command as part of platform modernization.
    Use the preview command instead.
  • Removed support for the deprecated referenceDocs option, which was related to the legacy Reference docs product.
  • Removed support for the deprecated assert/ prefix in configurable rules. Use rule/ 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-security extension 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 validation for JSON Schema format.

  • Extracted nullable validation from the struct rule into a new nullable-type-sibling rule for OpenAPI 3.0. This allows users to disable nullable 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 the tags field in API descriptions.

  • Enabled no-required-schema-properties-undefined, no-schema-type-mismatch, and no-enum-type-mismatch rules for AsyncAPI and Arazzo specifications.
    Adjusted the rules' severities in the recommended and minimal rulesets. Refer to the following table:

    Rule \ Ruleset recommended minimal
    no-required-schema-properties-undefined off -> warn off -> warn
    no-enum-type-mismatch error warn
    no-schema-type-mismatch 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
  • Fixed plugins validation in config files referenced in the extends section.
  • Fixed no-undefined-server-variable crash when encountering null values in the server list.
  • Refactored @redocly/respect-core to eliminate Node.js-specific dependencies, improving cross-platform compatibility.
  • Updated Redoc to v2.5.0.
  • Fixed alias detection when using --config from a different folder than the current working directory.
  • Resolved an issue where [email protected] injected an unintended message into the output.
  • Fixed Redocly CLI to correctly read residency from 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.

v1.34.5

Compare Source

Patch Changes

v1.34.4

Compare Source

Patch Changes

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
  • Added global execution timeout timer to respect command execution to prevent infinite test runs. You can configure this timer using the RESPECT_TIMEOUT environment variable (defaults to 1 hour).
Patch Changes

v1.33.1

Compare Source

Patch Changes
  • Fixed generate-arazzo command to properly handle output file paths. The output-file parameter must have a value when provided.
  • Updated @​redocly/respect-core to v1.33.1.

v1.33.0

Compare Source

Minor Changes
  • Added support for generating workflows from OpenAPI operations without operationIds. The 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
  • Fixed step execution to respect severity levels when handling step failures. Previously, steps would always break workflow execution on failure when onFailure is omitted, but now they properly consider the configured severity level (e.g., warn | off severity allows subsequent steps to execute).
  • Updated @​redocly/openapi-core to v1.32.2.

v1.32.1

Compare Source

Patch Changes
  • Added support for basic, bearer, and apiKey security schemes in workflow generation with generate-arazzo command.
  • Updated @​redocly/openapi-core to v1.32.1.

v1.32.0

Compare Source

Minor Changes
  • Added support for linting, preprocessors, decorators, and type extensions for Overlay v1 documents.
Patch Changes
  • Updated OAS3 Schema type definition to correct type keyword enum, removed null.
  • Fixed an issue where JSON logs did not properly capture data from nested external workflows.
  • Updated @​redocly/openapi-core to v1.32.0.

v1.31.3

Compare Source

Patch Changes

v1.31.2

Compare Source

Patch Changes
  • Fixed sourceDescription name generation in generate-arazzo command when using OpenAPI files that contain multiple periods "." in their filenames.
  • Updated @​redocly/respect-core to v1.31.2.

v1.31.1

Compare Source

Patch Changes

v1.31.0

Compare Source

Minor Changes
  • Added the generate-arazzo command to scaffold Arazzo description templates out of OpenAPI descriptions.
  • Added the respect command to test APIs against Arazzo description files.
Patch Changes

v1.30.0

Compare Source

Minor Changes
Patch Changes
  • Updated operation-tag-defined built-in rule to verify tags are defined on the operation prior to matching them to a global tag.
  • Updated @​redocly/openapi-core to v1.30.0.

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.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot requested a review from a team as a code owner July 26, 2025 19:06
@renovate renovate bot requested review from morganleroi and millotp and removed request for a team July 26, 2025 19:06
@algolia-bot
Copy link
Collaborator

algolia-bot commented Jul 26, 2025

🪓 The generated code will be pushed at the end of the CI.

Action triggered by commit 9214cd69d59c00c6b1de017352054c57dd8e64b0.

Please do not push any generated code to this pull request.

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from 7fbdb30 to 5278d31 Compare July 26, 2025 20:54
@shortcuts shortcuts closed this Jul 28, 2025
Copy link
Contributor Author

renovate bot commented Jul 28, 2025

Renovate Ignore Notification

Because you closed this PR without merging, Renovate will ignore this update. You will not get PRs for any future 2.x releases. But if you manually upgrade to 2.x then Renovate will re-enable minor and patch updates automatically.

If you accidentally closed this PR, or if you changed your mind: rename this PR to get a fresh replacement PR.

@renovate renovate bot deleted the renovate/redocly-cli-2.x branch July 28, 2025 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants