Skip to content

Conversation

@renovate
Copy link
Contributor

@renovate renovate bot commented Jul 24, 2025

This PR contains the following updates:

Package Change Age Confidence
@redocly/cli ^1.27.1 -> ^2.0.0 age confidence

Release Notes

Redocly/redocly-cli (@​redocly/cli)

v2.5.0

Compare Source

Minor Changes
  • Added response size to the Respect terminal and JSON file outputs.
Patch Changes

v2.4.0

Compare Source

Minor Changes
  • Added the no-secrets-masking option to the respect command, allowing raw (unmasked) output to be generated.
Patch Changes

v2.3.1

Compare Source

Patch Changes
  • Fixed an issue where JSONPath-based success criteria did not support property names with hyphens in Respect.
  • Updated @​redocly/openapi-core to v2.3.1.

v2.3.0

Compare Source

Minor Changes
  • Added basic support for OpenAPI 3.2 specification.
Patch Changes

v2.2.3

Compare Source

Patch Changes
  • Fixed an issue where the Respect workflow separator did not render correctly in GitHub CI environments.

v2.2.2

Compare Source

Patch Changes
  • Resolved an issue with CLI dependencies to ensure proper package resolution.

v2.2.1

Compare Source

Patch Changes
  • Fixed an issue where the remove-unused-components decorator was not functioning when configured at the API level.
  • Updated @​redocly/openapi-core to v2.2.1.

v2.2.0

Compare Source

Minor Changes
  • Adjusted the calculation of Respect's workflow-level totalTimeMs to sum the network request times of all steps.
Patch Changes

v2.1.5

Compare Source

v2.1.4

Compare Source

Patch Changes
  • Fixed undefined variable used in the remove-unused-components decorator, which prevented an invalid reference error from being reported.
  • Updated @​redocly/openapi-core to v2.1.4.

v2.1.3

Compare Source

Patch Changes
  • Updated authentication logic to get the residency from scorecard.fromProjectUrl.
  • Updated @​redocly/openapi-core to v2.1.3.

v2.1.2

Compare Source

Patch Changes

v2.1.1

Compare Source

Patch Changes

v2.1.0

Compare Source

Minor Changes
  • Updated authentication logic to ensure consistency with the VS Code extension's behavior.
Patch Changes
  • Improved error reporting and handling for Digest authentication failures in Respect. Now users receive clearer feedback when required headers or status codes are missing.
  • Fixed push and push-status commands mistakenly requiring the --max-execution-time option.
  • Fixed an issue where wildcard file patterns were not recognized in the Docker image.
  • Updated @​redocly/respect-core to v2.1.0.

v2.0.8

Compare Source

Patch Changes

v2.0.7

Compare Source

Patch Changes

v2.0.6

Compare Source

Patch Changes
  • Fixed an issue where files specified in decorators parameters were not always resolved correctly.
    The resolution logic now properly locates the specified files relative to the config file for info-description-override, media-type-examples-override, operation-description-override, and tag-description-override decorators.
  • Improved messaging to clarify when API alias configuration is implicitly applied during linting or bundling by filename.
  • Updated the retryAfter property in Respect to use seconds (instead of milliseconds) for consistency with the Arazzo specification.
  • Updated @​redocly/openapi-core to v2.0.6.

v2.0.5

Compare Source

Patch Changes
  • Fixed an issue where the root config was not properly merged with the apis config.
  • Resolved an issue that caused configuration parsing to fail when the config value was set to null.
  • Improved join command server handling for specifications with differing servers.
  • Updated @​redocly/respect-core to v2.0.5.

v2.0.4

Compare Source

Patch Changes
  • Fixed an issue where the openapi config options were ignored when running the build-docs command.
  • Ensure externalRefResolver option is correctly passed to nested workflow contexts.
  • Updated @​redocly/respect-core to v2.0.4.

v2.0.3

Compare Source

Patch Changes
  • Fixed type definitions for Respect input and server options to support both string and string[] values.
  • Fixed binary response data in Respect results by properly encoding it as base64.
  • Updated @​redocly/respect-core to v2.0.3.

v2.0.2

Compare Source

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.

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.
  • Replaced the SpecVersion, SpecMajorVersion, OPENAPI3_METHOD, and OPENAPI3_COMPONENT enums with types for improved flexibility and type safety.
    Removed the unused OasVersion enum.
  • 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.
  • Added support for extends bundling and array-based plugin configuration.
    Fixed the extends order in the configuration.
  • 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+.
  • Streamlined Redocly configuration interfaces for improved developer experience.
    Removed StyleguideConfig class in favor of the unified Config class.
    Removed getMergedConfig function - use Config.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:

    • 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 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
Patch Changes
  • Improved performance of configuration parsing.
  • Updated @​redocly/config to v0.26.4.
  • Updated @​redocly/config to v0.24.3.
  • Fixed an issue where the ignoreLastPathSegment option of the path-segment-plural rule had no effect if the path contained only one segment, resulting in an error.
  • Fixed plugins validation in config files referenced in the extends section.
  • Refactored @redocly/respect-core to eliminate Node.js-specific dependencies, improving cross-platform compatibility.
  • Updated @​redocly/config to v0.24.1.
  • Fixed an issue where the config resolver grouped assertions instead of returning unchanged rules.
  • Fixed Redocly CLI to correctly read residency from the Redocly configuration file.
  • Fixed incorrect validation logic for the constructor property.

Configuration

📅 Schedule: Branch creation - "every weekday" (UTC), 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.

Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Redocly CLI Update Breaks Node.js 18 Compatibility

Node.js version incompatibility introduced by the @redocly/cli v2.0.0 update. The project's package.json specifies engines.node: ">=18.0.0", but the new @redocly/cli requires node: ">=22.12.0 || >=20.19.0 <21.0.0". This prevents users on Node.js 18.x or 19.x from installing or running redocly commands, leading to build or runtime failures.

package.json#L79-L80

apify-docs/package.json

Lines 79 to 80 in 9519f1f

"@mdx-js/react": "^3.0.1",
"@redocly/cli": "^2.0.0",

package.json#L94-L97

apify-docs/package.json

Lines 94 to 97 in 9519f1f

"react": "^19.1.0",
"react-dom": "^19.1.0",
"react-github-btn": "^1.4.0",
"search-insights": "2.17.3",

Fix in CursorFix in Web


Comment bugbot run to trigger another review on this PR

@apify-service-account
Copy link

Preview for this PR was built for commit 9519f1f and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from 9519f1f to e33b636 Compare July 25, 2025 17:55
@apify-service-account
Copy link

Preview for this PR was built for commit e33b636 and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from e33b636 to 6620a3b Compare July 29, 2025 09:08
@apify-service-account
Copy link

Preview for this PR was built for commit 6620a3b and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from 6620a3b to b688b28 Compare July 30, 2025 16:28
@apify-service-account
Copy link

Preview for this PR was built for commit b688b28 and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from b688b28 to 595edd3 Compare July 30, 2025 23:59
@apify-service-account
Copy link

Preview for this PR was built for commit 595edd3 and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from 595edd3 to b35eb82 Compare August 2, 2025 03:50
@apify-service-account
Copy link

Preview for this PR was built for commit b35eb82 and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from b35eb82 to fa7b8e1 Compare August 10, 2025 15:46
@apify-service-account
Copy link

Preview for this PR was built for commit fa7b8e1 and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from fa7b8e1 to ab8b7e5 Compare August 11, 2025 19:22
@apify-service-account
Copy link

Preview for this PR was built for commit ab8b7e5 and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from ab8b7e5 to 898219e Compare August 12, 2025 16:14
@apify-service-account
Copy link

Preview for this PR was built for commit 898219e and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from 898219e to a8b0088 Compare August 13, 2025 11:45
@apify-service-account
Copy link

Preview for this PR was built for commit a8b0088 and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from a8b0088 to 6761fc4 Compare August 13, 2025 20:00
@apify-service-account
Copy link

Preview for this PR was built for commit 6761fc4 and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from 6761fc4 to a9d2aff Compare August 19, 2025 12:08
@apify-service-account
Copy link

Preview for this PR was built for commit a9d2aff and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from a9d2aff to 7897223 Compare August 22, 2025 17:57
@apify-service-account
Copy link

Preview for this PR was built for commit 7897223 and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from 7897223 to 86425c7 Compare August 27, 2025 16:51
@apify-service-account
Copy link

Preview for this PR was built for commit 86425c7 and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from 86425c7 to f044835 Compare August 31, 2025 11:58
@apify-service-account
Copy link

Preview for this PR was built for commit f044835 and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch 2 times, most recently from cd76020 to 1a814cd Compare October 8, 2025 12:23
@apify-service-account
Copy link

Preview for this PR was built for commit cd76020 and is ready at https://pr-1723.preview.docs.apify.com!

@apify-service-account
Copy link

Preview for this PR was built for commit 1a814cd and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch 2 times, most recently from e3b52f8 to 9c47cd9 Compare October 8, 2025 13:12
@apify-service-account
Copy link

Preview for this PR was built for commit e3b52f8 and is ready at https://pr-1723.preview.docs.apify.com!

@apify-service-account
Copy link

Preview for this PR was built for commit 9c47cd9 and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from 9c47cd9 to afbc636 Compare October 9, 2025 08:37
@apify-service-account
Copy link

Preview for this PR was built for commit afbc636 and is ready at https://pr-1723.preview.docs.apify.com!

@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from afbc636 to 658a9bd Compare October 9, 2025 08:58
@apify-service-account
Copy link

Preview for this PR was built for commit 658a9bd and is ready at https://pr-1723.preview.docs.apify.com!

@B4nan B4nan mentioned this pull request Oct 9, 2025
@renovate renovate bot force-pushed the renovate/redocly-cli-2.x branch from 658a9bd to 1df55f5 Compare October 9, 2025 20:39
@apify-service-account
Copy link

Preview for this PR was built for commit 1df55f5 and is ready at https://pr-1723.preview.docs.apify.com!

@apify-service-account
Copy link

Preview for this PR was built for commit e9375aa4 and is ready at https://pr-1723.preview.docs.apify.com!

@barjin barjin linked an issue Oct 10, 2025 that may be closed by this pull request
@apify-service-account
Copy link

Preview for this PR was built for commit e2c70c4b and is ready at https://pr-1723.preview.docs.apify.com!

@barjin barjin requested a review from B4nan October 10, 2025 12:51

theme:
openapi:
htmlTemplate: openapi/docs/index.html
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can drop this too (as well as the file), its no longer user for anything

@renovate
Copy link
Contributor Author

renovate bot commented Oct 10, 2025

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠️ Warning: custom changes will be lost.

@B4nan B4nan merged commit ec2a409 into master Oct 14, 2025
12 checks passed
@B4nan B4nan deleted the renovate/redocly-cli-2.x branch October 14, 2025 07:52
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.

Redocly version update

5 participants