Open
Conversation
3061c44 to
8a43da6
Compare
b1234f5 to
8978a8d
Compare
817e290 to
533a374
Compare
533a374 to
d5c01a2
Compare
5647019 to
0be4aa4
Compare
1deee38 to
a683c66
Compare
a4c4ed6 to
08c0b65
Compare
9871d12 to
3965ed7
Compare
8011f0e to
40569e4
Compare
f18b0db to
49d526e
Compare
ebb9010 to
dc9934c
Compare
8d3d869 to
507cc6b
Compare
6349379 to
055abcd
Compare
6f0bc3b to
6730a0a
Compare
233749e to
842d31b
Compare
47932b0 to
8ab877b
Compare
0461b3d to
425a63d
Compare
f4aae15 to
2b35a4b
Compare
80bbd30 to
2a75aef
Compare
ea8f4b1 to
1f47ddc
Compare
8675574 to
a59adde
Compare
a59adde to
734b245
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.3→^2.0.0Release Notes
Redocly/redocly-cli (@redocly/cli)
v2.19.2Compare Source
v2.19.1Compare Source
Patch Changes
v2.19.0Compare Source
Minor Changes
spec-querystring-parametersrule (OpenAPI 3.2).This rule enforces that
queryandquerystringare not mixed in the same operation/path parameter set, and that at most onequerystringparameter is declared per operation or path.Patch Changes
v2.18.2Compare Source
Patch Changes
v2.18.1Compare Source
Patch Changes
requiredwithreadOnlyorwriteOnlyproperties would incorrectly generate warnings.v2.18.0Compare Source
Minor Changes
lintEntityWithScorecardLevelfunction to validate entity files against scorecard level configurations andlintSchemafunction to lint individual schemas from API description files.Patch Changes
v2.17.0Compare Source
Minor Changes
outputs-definedArazzo rule, ensuring outputs are defined before use.v2.16.0Compare Source
Minor Changes
--component-renaming-conflicts-severityoption for thebundlecommand to control how naming conflicts are reported when bundling API descriptions with external references.Patch Changes
stderrinstead ofstdoutto avoid interfering with the bundled output.v2.15.2Compare Source
Patch Changes
v2.15.1Compare Source
Patch Changes
descriptionanddocumentationLinkproperties to NodeTypes.Renamed Redocly configuration types to better reflect their purpose and relations.
v2.15.0Compare Source
Patch Changes
chokidardependency.v2.14.9Compare Source
Patch Changes
v2.14.8Compare Source
Patch Changes
v2.14.7Compare Source
Patch Changes
v2.14.6Compare Source
Patch Changes
v2.14.5Compare Source
Patch Changes
ajvnpm alias dependency to satisfy peer dependency requirements and prevent installation warnings.v2.14.4Compare Source
Patch Changes
Respectdid not properly JSON-encode request bodies for custom content-types containing numbers.v2.14.3Compare Source
Patch Changes
splitcommand to properly handle root-level paths.Previously, the root path
/was converted to an empty string as a filename, leading to incorrect file structure and broken links.Now, it correctly maps to the specified path separator.
v2.14.2Compare Source
Patch Changes
v2.14.1Compare Source
Patch Changes
v2.14.0Compare Source
Patch Changes
v2.13.0Compare Source
Minor Changes
Patch Changes
v2.12.7Compare Source
Patch Changes
scorecard-classiccommand to evaluate API descriptions against project scorecard configurations.v2.12.6Compare Source
Patch Changes
v2.12.5Compare Source
Patch Changes
v2.12.4Compare Source
Patch Changes
HTTP_PROXYenvironment variable for thepushcommand.v2.12.3Compare Source
Patch Changes
v2.12.2Compare Source
Patch Changes
logincommand were deleted by Redocly VS Code extension when opening VS Code.v2.12.1Compare Source
Patch Changes
--mtlsoptions in the Respect command did not merge as expected.v2.12.0Compare Source
Minor Changes
Patch Changes
no-required-schema-properties-undefinedcaused a crash when encountering unresolved$refs.v2.11.1Compare Source
Patch Changes
$refs inside example values was erroneously resolved during bundling and linting.no-invalid-media-type-examplesfor schemas usinganyOf/oneOf.v2.11.0Compare Source
Patch Changes
v2.10.0Compare Source
Patch Changes
v2.9.0Compare Source
Patch Changes
mount-pathoption was not validated, leading to errors when used with an empty path or a path identical to the project path.v2.8.0Compare Source
Minor Changes
no-invalid-schema-examplesandno-invalid-parameter-examplesto therecommendedruleset.Added the
no-duplicated-tag-namesto thespecruleset.Patch Changes
v2.7.1Compare Source
Patch Changes
v2.7.0Compare Source
Patch Changes
v2.6.0Compare Source
Minor Changes
spec-no-invalid-tag-parents,spec-example-values,spec-discriminator-defaultMapping, andspec-no-invalid-encoding-combinations.Deprecated the
no-example-value-and-externalValuerule in favor ofspec-example-values.Patch Changes
v2.5.1Compare Source
Patch Changes
no-http-verbs-in-pathsrule was incorrectly flagging path names containing the verbquery.v2.5.0Compare Source
Minor Changes
Respectterminal and JSON file outputs.Patch Changes
v2.4.0Compare Source
Minor Changes
no-secrets-maskingoption to the respect command, allowing raw (unmasked) output to be generated.Patch Changes
v2.3.1Compare Source
Patch Changes
Respect.v2.3.0Compare Source
Minor Changes
Patch Changes
v2.2.3Compare Source
Patch Changes
verboseoption in thelogincommand to provide additional output during authentication.v2.2.2Compare Source
Patch Changes
v2.2.1Compare Source
Patch Changes
remove-unused-componentsdecorator was not functioning when configured at the API level.v2.2.0Compare Source
Minor Changes
totalTimeMsto sum the network request times of all steps.Patch Changes
v2.1.5Compare Source
Patch Changes
status code check.v2.1.4Compare Source
Patch Changes
remove-unused-componentsdecorator, which prevented an invalid reference error from being reported.v2.1.3Compare Source
Patch Changes
scorecard.fromProjectUrl.v2.1.2Compare Source
Patch Changes
v2.1.1Compare Source
Patch Changes
v2.1.0Compare Source
Minor Changes
Patch Changes
pushandpush-statuscommands mistakenly requiring the--max-execution-timeoption.v2.0.8Compare Source
Patch Changes
v2.0.7Compare Source
Patch Changes
v2.0.6Compare Source
Patch Changes
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, andtag-description-overridedecorators.retryAfterproperty in Respect to use seconds (instead of milliseconds) for consistency with the Arazzo specification.v2.0.5Compare Source
Patch Changes
apisconfig.null.v2.0.4Compare Source
Patch Changes
openapiconfig options were ignored when running thebuild-docscommand.externalRefResolveroption is correctly passed to nested workflow contexts.v2.0.3Compare Source
Patch Changes
inputandserveroptions to support both string and string[] values.Respectresults by properly encoding it as base64.v2.0.2Compare Source
Patch Changes
executionTimeoutparameter optional in therunfunction exported fromrespect-core.v2.0.1Compare Source
Patch Changes
no-required-schema-properties-undefinedrule incorrectly resolved nested$refs relative to the file in which they were defined.v2.0.0Compare Source
Major Changes
specrule. Usestructinstead.apiDefinitionsoption in the Redocly config. Useapisinstead.Removed the
labelsfield within theapissection, which was associated with the legacy Redocly API Registry product.redocly.yaml.features.openapiandfeatures.mockServerconfiguration options. UseopenapiandmockServerdirectly instead.lintandstyleguideoptions in the Redocly config.Use
rules,decoratorsand other related options on the root level instead.disallowAdditionalPropertiesoption support in rules. UseallowAdditionalPropertiesinstead.themeproperty of Redocly config.All the properties of
themeare now available in the config root.path-excludes-patternsandinfo-license-urlrules.undefinedassertion. Usedefinedinstead.Reunite provides improved API management capabilities and better integration with Redocly's tooling ecosystem.
Migrated the
loginandpushcommands to work exclusively with Reunite.Removed the
preview-docscommand as part of platform modernization.Use the
previewcommand instead.referenceDocsoption, 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-securityextension 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
nullablevalidation from thestructrule into a newnullable-type-siblingrule for OpenAPI 3.0. This allows users to disablenullablevalidation separately from other structural checks.Configured the
specruleset for OpenAPI, AsyncAPI, Arazzo, and Overlay specifications.This ruleset is designed to strictly follow the specifications.
Added the
no-duplicated-tag-namesrule to check for duplications in thetagsfield in API descriptions.Enabled
no-required-schema-properties-undefined,no-schema-type-mismatch, andno-enum-type-mismatchrules for AsyncAPI and Arazzo specifications.Adjusted the rules' severities in the
recommendedandminimalrulesets. Refer to the following table:off->warnoff->warnerrorwarnwarn->erroroff->warnImplemented 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
respectcommand to improve test execution control.Patch Changes
extendssection.no-undefined-server-variablecrash when encounteringnullvalues in the server list.@redocly/respect-coreto eliminate Node.js-specific dependencies, improving cross-platform compatibility.--configfrom a different folder than the current working directory.dotenv@16.6.0injected an unintended message into the output.residencyfrom the Redocly configuration file.v1.34.8Compare Source
v1.34.7Compare Source
Patch Changes
v1.34.6Compare Source
Patch Changes
v1.34.5Compare Source
Patch Changes
form-datato 4.0.4 for Redocly CLI v1.v1.34.4Compare Source
Patch Changes
dotenv@16.6.0injected an unintended message into the output.Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ 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.