-
Notifications
You must be signed in to change notification settings - Fork 55
Commit d656965
authored
Update dependency @redocly/cli to v2 (#698)
This PR contains the following updates:
| Package | Change | Age | Confidence |
|---|---|---|---|
| [@redocly/cli](https://redirect.github.com/Redocly/redocly-cli) |
[`1.34.5` ->
`2.0.4`](https://renovatebot.com/diffs/npm/@redocly%2fcli/1.34.5/2.0.4)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
---
### Release Notes
<details>
<summary>Redocly/redocly-cli (@​redocly/cli)</summary>
###
[`v2.0.4`](https://redirect.github.com/Redocly/redocly-cli/releases/tag/%40redocly/cli%402.0.4)
[Compare
Source](https://redirect.github.com/Redocly/redocly-cli/compare/@redocly/[email protected]...@redocly/[email protected])
##### 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](https://redirect.github.com/redocly/respect-core)
to v2.0.4.
###
[`v2.0.3`](https://redirect.github.com/Redocly/redocly-cli/releases/tag/%40redocly/cli%402.0.3)
[Compare
Source](https://redirect.github.com/Redocly/redocly-cli/compare/@redocly/[email protected]...@redocly/[email protected])
##### 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](https://redirect.github.com/redocly/respect-core)
to v2.0.3.
###
[`v2.0.2`](https://redirect.github.com/Redocly/redocly-cli/releases/tag/%40redocly/cli%402.0.2)
[Compare
Source](https://redirect.github.com/Redocly/redocly-cli/compare/@redocly/[email protected]...@redocly/[email protected])
##### Patch Changes
- Made `executionTimeout` parameter optional in the `run` function
exported from `respect-core`.
- Updated
[@​redocly/respect-core](https://redirect.github.com/redocly/respect-core)
to v2.0.2.
###
[`v2.0.1`](https://redirect.github.com/Redocly/redocly-cli/releases/tag/%40redocly/openapi-core%402.0.1)
[Compare
Source](https://redirect.github.com/Redocly/redocly-cli/compare/@redocly/[email protected]...@redocly/[email protected])
##### Patch Changes
- Fixed an issue where the `no-required-schema-properties-undefined`
rule incorrectly resolved nested `$ref`s relative to the file in which
they were defined.
###
[`v2.0.0`](https://redirect.github.com/Redocly/redocly-cli/releases/tag/%40redocly/cli%402.0.0)
[Compare
Source](https://redirect.github.com/Redocly/redocly-cli/compare/@redocly/[email protected]...@redocly/[email protected])
##### 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](https://redirect.github.com/redocly/respect-core)
to v2.0.0.
</details>
---
### 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.
---
- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box
---
This PR was generated by [Mend Renovate](https://mend.io/renovate/).
View the [repository job
log](https://developer.mend.io/github/get-convex/convex-helpers).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0MS40MC4wIiwidXBkYXRlZEluVmVyIjoiNDEuNjAuNCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOltdfQ==-->
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>1 parent fe37f36 commit d656965Copy full SHA for d656965
File tree
Expand file treeCollapse file tree
2 files changed
+337
-382
lines changedFilter options
Expand file treeCollapse file tree
2 files changed
+337
-382
lines changed
0 commit comments