From d762c6c387478c207fb250f99586279a538d3d3b Mon Sep 17 00:00:00 2001 From: Andrew Tatomyr Date: Tue, 12 Nov 2024 14:15:13 +0200 Subject: [PATCH] docs: update bundle description --- docs/commands/bundle.md | 37 +++++++++++++++++++------------------ 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/docs/commands/bundle.md b/docs/commands/bundle.md index 062adc7f7..ea4372411 100644 --- a/docs/commands/bundle.md +++ b/docs/commands/bundle.md @@ -22,23 +22,23 @@ redocly bundle --version ## Options -| Option | Type | Description | -| -------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| apis | [string] | List of API description root filenames or names assigned in the `apis` section of your Redocly configuration file. Default values are names defined in the `apis` section of your configuration file. | -| --config | string | Specify the path to the [configuration file](#use-alternative-configuration-file). | -| --dereferenced, -d | boolean | Generate fully dereferenced bundle. | -| --ext | string | Specify the bundled file's extension. The possible values are `json`, `yaml`, or `yml`. Default value is `yaml`. | -| --extends | [string] | Can be used in combination with `--lint` to [extend a specific configuration](./lint.md#extend-configuration). The default values are taken from the Redocly configuration file. | -| --force, -f | boolean | Generate a bundle output even when errors occur. | -| --help | boolean | Show help. | -| --keep-url-references, -k | boolean | Preserve absolute URL references. | -| --lint-config | string | Specify the severity level for the configuration file.
**Possible values:** `warn`, `error`, `off`. Default value is `warn`. | -| --metafile | string | Path for the bundle metadata file. | -| --output, -o | string | Name or folder for the bundle file. If you don't specify the file extension, `.yaml` is used by default. If the specified folder doesn't exist, it's created automatically. **Overwrites existing bundler output file.** | -| --remove-unused-components | boolean | Remove unused components from the `bundle` output. | -| --skip-decorator | [string] | Ignore certain decorators. See the [Skip preprocessor, rule, or decorator section](#skip-preprocessor-rule-or-decorator). | -| --skip-preprocessor | [string] | Ignore certain preprocessors. See the [Skip preprocessor, rule, or decorator section](#skip-preprocessor-rule-or-decorator). | -| --version | boolean | Show version number. | +| Option | Type | Description | +| -------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| apis | [string] | List of API description root filenames or names assigned in the `apis` section of your Redocly configuration file. Default values are names defined in the `apis` section of your configuration file. | +| --config | string | Specify the path to the [configuration file](#use-alternative-configuration-file). | +| --dereferenced, -d | boolean | Generate fully dereferenced bundle. | +| --ext | string | Specify the bundled file's extension. The possible values are `json`, `yaml`, or `yml`. Default value is `yaml`. | +| --extends | [string] | Can be used in combination with `--lint` to [extend a specific configuration](./lint.md#extend-configuration). The default values are taken from the Redocly configuration file. | +| --force, -f | boolean | Generate a bundle output even when errors occur. | +| --help | boolean | Show help. | +| --keep-url-references, -k | boolean | Preserve absolute URL references. | +| --lint-config | string | Specify the severity level for the configuration file.
**Possible values:** `warn`, `error`, `off`. Default value is `warn`. | +| --metafile | string | Path for the bundle metadata file. | +| --output, -o | string | Name or folder for the bundle file specified via the command line. If you don't specify the file extension, `.yaml` is used by default. If the specified folder doesn't exist, it's created automatically. **Overwrites existing bundler output file.** | +| --remove-unused-components | boolean | Remove unused components from the `bundle` output. | +| --skip-decorator | [string] | Ignore certain decorators. See the [Skip preprocessor, rule, or decorator section](#skip-preprocessor-rule-or-decorator). | +| --skip-preprocessor | [string] | Ignore certain preprocessors. See the [Skip preprocessor, rule, or decorator section](#skip-preprocessor-rule-or-decorator). | +| --version | boolean | Show version number. | ## Examples @@ -65,7 +65,7 @@ dist/openapi.json dist/museum.json -You can specify the default `output` location for a bundled API in the `apis` section of your Redocly configuration file. +Alternatively, you can specify the default `output` location for a bundled API in the `apis` section of your Redocly configuration file. This is especially useful when bundling multiple APIs. ```yaml @@ -85,6 +85,7 @@ redocly bundle ``` Please note, that providing an API to the `bundle` command results in the command bundling only the specified API. +Additionally, the `--output` option is only meaningful when used with APIs specified in the command line. ### Create a fully dereferenced bundle