From c5c07a4caa968743d07389e62fb3e5a1db3ecb7a Mon Sep 17 00:00:00 2001 From: Albina Blazhko Date: Wed, 13 May 2026 18:59:07 +0300 Subject: [PATCH 1/3] docs: add docs about bundle and new rules --- CONTRIBUTING.md | 1 + docs/@v2/commands/bundle.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fd7c4a38cb..a8c9e3fe64 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -178,6 +178,7 @@ The defaults are `off` or `warn` for `minimal` and `recommended` and `error` for Also add the rule to the built-in rules list in [the config types tree](./packages/core/src/types/redocly-yaml.ts). If the rule reflects a specification requirement, prefix it with `spec-` and add it to the [spec ruleset](./packages/core/src/config/spec.ts). +If a rule already exists for another specification, reuse the existing name so the same concept stays discoverable across specs. Separately, open a merge request with the corresponding documentation changes. To make changes to documentation: diff --git a/docs/@v2/commands/bundle.md b/docs/@v2/commands/bundle.md index 528087f5de..ce16d6ae45 100644 --- a/docs/@v2/commands/bundle.md +++ b/docs/@v2/commands/bundle.md @@ -10,7 +10,7 @@ Redocly CLI can help you combine separate API description files (such as if you The `bundle` command pulls the relevant parts of an API description into a single file output in JSON or YAML format. The `bundle` command differs from the [`join`](./join.md) command. -The `bundle` command takes a root OpenAPI file as input and follows the `$ref` mentions to include all the referenced components into a single output file. +The `bundle` command takes a root OpenAPI file as input and follows the `$ref` mentions to include all the referenced components into a single output file. All components are automatically resolved and included without requiring explicit definitions. The `join` command can combine multiple OpenAPI files into a single unified API description file. The `bundle` command first executes preprocessors, then rules, then decorators. From 01eb8620028128f15ea28c6dd86db90ffc13914b Mon Sep 17 00:00:00 2001 From: Albina Blazhko Date: Thu, 14 May 2026 11:00:22 +0300 Subject: [PATCH 2/3] docs: add flavor word --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a8c9e3fe64..80ffec9cfd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -178,7 +178,7 @@ The defaults are `off` or `warn` for `minimal` and `recommended` and `error` for Also add the rule to the built-in rules list in [the config types tree](./packages/core/src/types/redocly-yaml.ts). If the rule reflects a specification requirement, prefix it with `spec-` and add it to the [spec ruleset](./packages/core/src/config/spec.ts). -If a rule already exists for another specification, reuse the existing name so the same concept stays discoverable across specs. +If a rule already exists for another specification flavor, reuse the existing name so the same concept stays discoverable across specs. Separately, open a merge request with the corresponding documentation changes. To make changes to documentation: From 59cacd5628773e7c637dd28692b13bbc8c725a02 Mon Sep 17 00:00:00 2001 From: Albina Blazhko Date: Thu, 14 May 2026 11:15:40 +0300 Subject: [PATCH 3/3] chore: add break --- docs/@v2/commands/bundle.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/@v2/commands/bundle.md b/docs/@v2/commands/bundle.md index ce16d6ae45..e9d72f0313 100644 --- a/docs/@v2/commands/bundle.md +++ b/docs/@v2/commands/bundle.md @@ -10,7 +10,8 @@ Redocly CLI can help you combine separate API description files (such as if you The `bundle` command pulls the relevant parts of an API description into a single file output in JSON or YAML format. The `bundle` command differs from the [`join`](./join.md) command. -The `bundle` command takes a root OpenAPI file as input and follows the `$ref` mentions to include all the referenced components into a single output file. All components are automatically resolved and included without requiring explicit definitions. +The `bundle` command takes a root OpenAPI file as input and follows the `$ref` mentions to include all the referenced components into a single output file. +All components are automatically resolved and included without requiring explicit definitions. The `join` command can combine multiple OpenAPI files into a single unified API description file. The `bundle` command first executes preprocessors, then rules, then decorators.