LukeParke/redocly-cli
1
0
Fork 0
mirror of https://github.com/LukeHagar/redocly-cli.git synced 2025-12-10 12:47:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: made content more consistent on the cli join command page

Browse Source
This commit is contained in:
Anton Zolotukhin
2021-09-07 02:40:24 +03:00
parent f548213d94
commit ab635d64d0
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/commands/join.md
View File

@@ -11,7 +11,9 @@ The `join` command is considered an experimental feature. This means it's still
The `join` command supports OpenAPI 3.x definitions only. The `join` command supports OpenAPI 3.x definitions only.
::: :::
With the `join` command, Redocly OpenAPI CLI can combine two or more API definition files into one so that maintainers of multiple API definitions can benefit from storing each endpoint as a standalone API definition file. However, this approach is not supported by the majority of OpenAPI tools, as they require a single API definition file. Maintainers of multiple API definitions can benefit from storing each endpoint as a standalone API definition file. However, this approach is not supported by the majority of OpenAPI tools, as they require a single API definition file.
With Redocly OpenAPI CLI, you can solve this problem by using the `join` command that can combine two or more API definition files into a single one.
To easily distinguish the origin of OpenAPI objects and properties, you can optionally instruct the `join` command to append custom prefixes to them. To easily distinguish the origin of OpenAPI objects and properties, you can optionally instruct the `join` command to append custom prefixes to them.
@@ -34,14 +36,14 @@ openapi join --version
## Options ## Options
option | type | required? | default | description Option | Type | Required | Default | Description
-------------------------------------|:------------------:|:------------:|:-----------:|------------ -------------------------------------|:------------------:|:------------:|:-----------:|------------
`entrypoints` | `array`, wildcard | yes | `[]`, - | 1. Array of paths to API definition files that need to be joined. At least two input files are required.<br />2. A wildcard pattern to match API definition files within a specific folder `entrypoints` | `array`, wildcard | yes | `[]`, - | 1. Array of paths to API definition files that you want to join. At least two input files are required.<br />2. A wildcard pattern to match API definition files within a specific folder
`--help` | `boolean` | no | - | Show help `--help` | `boolean` | no | - | Show help
`--lint` | `boolean` | no | `false` | Lint definition files `--lint` | `boolean` | no | `false` | Lint definition files
`--prefix-components-with-info-prop` | `string` | no | - | Prefix components with property value from info object. See the [section](#) below `--prefix-components-with-info-prop` | `string` | no | - | Prefix components with property value from info object. See the [prefix-components-with-info-prop section](#prefix-components-with-info-prop) below
`--prefix-tags-with-info-prop` | `string` | no | - | Prefix tags with property value from info object. See the [section](#) below `--prefix-tags-with-info-prop` | `string` | no | - | Prefix tags with property value from info object. See the [prefix-tags-with-info-prop section](#prefix-tags-with-info-prop) below
`--prefix-tags-with-filename` | `boolean` | no | `false` | Prefix tags with property value from file name. See the [section](#) below `--prefix-tags-with-filename` | `boolean` | no | `false` | Prefix tags with property value from file name. See the [prefix-tags-with-filename section](#prefix-tags-with-filename) below
`--version` | `boolean` | no | - | Show version number `--version` | `boolean` | no | - | Show version number
## Examples ## Examples