From e4149308b0ad63336074b9c59622a258205e1992 Mon Sep 17 00:00:00 2001 From: Andrew Tatomyr Date: Thu, 5 Sep 2024 13:32:13 +0300 Subject: [PATCH] fix example --- docs/commands/bundle.md | 44 ++++++++++++++++++++--------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/commands/bundle.md b/docs/commands/bundle.md index 18b3cb048..881d3431a 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 all names defined in the `apis` section within your configuration file. | -| --config | string | Specify path to the [configuration file](#use-alternative-configuration-file). | -| --dereferenced, -d | boolean | Generate fully dereferenced bundle. | -| --ext | string | Specify bundled file extension. 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). Default values are taken from the Redocly configuration file. | -| --force, -f | boolean | Generate bundle output even when errors occur. | -| --help | boolean | Show help. | -| --keep-url-references, -k | boolean | Keep 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. | +| 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 all names defined in the `apis` section within your configuration file. | +| --config | string | Specify path to the [configuration file](#use-alternative-configuration-file). | +| --dereferenced, -d | boolean | Generate fully dereferenced bundle. | +| --ext | string | Specify bundled file extension. 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). Default values are taken from the Redocly configuration file. | +| --force, -f | boolean | Generate bundle output even when errors occur. | +| --help | boolean | Show help. | +| --keep-url-references, -k | boolean | Keep 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. **If the file specified as the bundler's output already exists, it's overwritten.** Use this option when bundling a single API only; otherwise use the `output` option in per-API configuration. | -| --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. | +| --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 @@ -70,12 +70,12 @@ This is especially useful when bundling multiple APIs. ```yaml apis: - foo: - root: openapi/foo.yaml - output: dist/foo.json - bar: - root: openapi/bar.yaml - output: dist/bar.json + orders@v1: + root: orders/openapi.yaml + output: dist/orders.json + accounts@v1: + root: accounts/openapi.yaml + output: dist/accounts.json ``` Given the `redocly.yaml` configuration file above, the following command bundles the APIs `foo` and `bar` into the `dist/` folder.