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

sync: Synced local 'docs/' with remote 'docs/cli/'

Browse Source
This commit is contained in:
redocly-bot
2022-06-09 11:26:19 +00:00
parent 3d2ad3986b
commit b1b7b3c8f1
2 changed files with 35 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/changelog.md
View File

@@ -6,6 +6,11 @@ tocMaxDepth: 2
## 1.0.0-beta.102 (2022-06-09)
### Fixes
- Hotfix for version `1.0.0-beta.101`.
## 1.0.0-beta.101 (2022-06-09)
### Features
- The `join` command supports a new option `--without-x-tag-groups`. Use it to skip the creation and population of `x-tagGroups`.
@@ -16,10 +21,6 @@ tocMaxDepth: 2
- Fixed issue with `additionalItems` array type.
## 1.0.0-beta.101 (2022-06-09)
Broken release.
## 1.0.0-beta.100 (2022-05-27)
### Fixes

34
docs/commands/join.md
View File

@@ -44,7 +44,8 @@ entrypoints | array | **REQUIRED.** 1. Array of paths to API definition files t
--help | boolean | Show help.
--lint | boolean | Lint definition files.
--prefix-components-with-info-prop | string | 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 | 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-info-prop | boolean | Prefix tags with property value from info object. See the [prefix-tags-with-info-prop](#prefix-tags-with-info-prop) section.
--without-x-tag-groups | boolean | Skip automated `x-tagGroups` creation. See the [without-x-tag-groups](#without-x-tag-groups) section.
--prefix-tags-with-filename | string | Prefix tags with property value from file name. See the [prefix-tags-with-filename section](#prefix-tags-with-filename) below.
--version | boolean | Show version number.
@@ -110,8 +111,8 @@ If the `join` command detects any conflicting content while trying to combine th
```bash
Conflict on tags => all : pets in files: petstore.yaml,test.yaml
1 conflict(s) on tags.
Suggestion: please use prefix-tags-with-filename or prefix-tags-with-info-prop to prevent naming conflicts.
1 conflict(s) on tags.
Suggestion: please use prefix-tags-with-filename, prefix-tags-with-info-prop or without-x-tag-groups to prevent naming conflicts.
Conflict on paths => /pets : get in files: petstore.yaml,test.yaml
Conflict on paths => /pets : post in files: petstore.yaml,test.yaml
@@ -120,9 +121,17 @@ Conflict on paths => operationIds : createPets in files: petstore.yaml,test.yaml
Conflict on paths => operationIds : showPetById in files: petstore.yaml,test.yaml
Conflict on paths => /pets/{petId} : get in files: petstore.yaml,test.yaml
openapi.yaml: join processed in 49ms
Please fix conflicts before running join.
```
Use the [`--without-x-tag-groups`](#without-x-tag-groups) option to skip the creation and population of `x-tagGroups` in the output file.
:::warning
These options are mutually exclusive: `without-x-tag-groups`, `prefix-tags-with-filename`, and `prefix-tags-with-info-prop`.
:::
### prefix-tags-with-info-prop
If any of the input files contain the `tags` object, tags in the output file will be prefixed by the selected property from the `info` object of the corresponding input file.
@@ -168,6 +177,23 @@ redocly join first-api.yaml second-api.json --prefix-tags-with-filename true
x-displayName: pets
```
### without-x-tag-groups
If you have the same tags in multiple API definitions, you can allow tag duplication by using the `without-x-tag-groups` option. In this case, the `x-tagGroups` property will not be created in the joined file.
#### Usage
```bash Command
redocly join first-api.yaml second-api.json --without-x-tag-groups
```
The tag description is taken from the first file that contains the tag. You may see a warning about conflicts in the command output:
```bash
warning: 1 conflict(s) on tags description.
openapi.yaml: join processed in 69ms
```
### prefix-components-with-info-prop
If any of the input files have conflicting component names, this option can be used to resolve that issue and generate the output file. All component names in the output file will be prefixed by the selected property from the `info` object of the corresponding input file(s).