Skip to content

Commit

Permalink
docs: remove description for xtaggroup when using join command (#1422)
Browse files Browse the repository at this point in the history
* docs: update join command docs related to x-taggroups changes

Co-authored-by: Andrew Tatomyr <[email protected]>

---------

Co-authored-by: Andrew Tatomyr <[email protected]>
  • Loading branch information
malis42 and tatomyr authored Feb 14, 2024
1 parent 356821b commit 838c179
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/commands/join.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,26 +94,26 @@ externalDocs

By default, the `info.description` property is taken only from the first file, even if it exists in other input files.

However, if any of the input files contain the `tags` object, the `join` command automatically creates the `x-tagGroups` object in the output file. This object contains the `info.description` property from each of the input files.
However, if any of the input files contain the `tags` object, the `join` command automatically creates the `x-tagGroups` object in the output file.

```yaml
x-tagGroups:
- name: first-api
tags:
- expanded
- other
description: 'Text from info: description of the first input file'
- name: second-api
tags:
- partner
description: 'Text from info: description of the second input file'
```
{% admonition type="info" %}
If some operations in an input file don't have a tag assigned to them, the `join` command automatically adds the `other` tag to those operations in the output file. The `other` tag is also included in the `x-tagGroups` object.

If any of the input files contain the `x-tagGroups` object, the content of this object is ignored by the `join` command and not included in the output file.

The `info.title` field is used as a name in `x-tagGroups` instead of a file name for the `join` command, so you can join files with the same names. If you need to adjust the `info.title` field, you can also use the [info-override decorator](https://redocly.com/docs/cli/decorators/info-override/).

{% /admonition %}

The `servers` object combines the content from all input files, starting with the content from the first file. Commented lines are not included in the output file.
Expand Down

1 comment on commit 838c179

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 76.19% 4326/5678
🟡 Branches 65.97% 2258/3423
🟡 Functions 68.93% 699/1014
🟡 Lines 76.39% 4067/5324

Test suite run success

710 tests passing in 101 suites.

Report generated by 🧪jest coverage report action from 838c179

Please sign in to comment.