Skip to content

Commit 1430a59

Browse files
authored
chore(docs): update description of --output option (#1994)
1 parent a08a8c3 commit 1430a59

File tree

2 files changed

+17
-3
lines changed

2 files changed

+17
-3
lines changed

.changeset/spotty-maps-grab.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
"@redocly/cli": patch
3+
"@redocly/respect-core": patch
4+
---
5+
6+
Updated `output` flag docs for `generate-arazzo` command.

docs/commands/generate-arazzo.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,19 +35,19 @@ npx @redocly/cli generate-arazzo <your-OAS-description-file> [-o | --output-file
3535

3636
- -o, --output-file
3737
- string
38-
- Path to the OAS description file. If the file name is not provided, the default name is used - `auto-generate.arazzo.yaml`. Example: `npx @redocly/cli generate-arazzo OAS-file.yaml -o=example.arazzo.yaml`
38+
- Name for the generated output file. Defaults to `auto-generated.arazzo.yaml` **If the file already exists, it's overwritten.** See the [specify output file](#specify-output-file) section.
3939

4040
{% /table %}
4141

4242
## Examples
4343

4444
Run the command: `npx @redocly/cli generate-arazzo 'https://warp-single-sidebar.redocly.app/_spec/apis/index.yaml'`
4545

46-
The command generates a `auto-generate.arazzo.yaml` file in the current directory.
46+
The command generates an `auto-generated.arazzo.yaml` file in the current directory.
4747

4848
The contents of the generated file are:
4949

50-
```yaml {% title="auto-generate.arazzo.yaml" %}
50+
```yaml {% title="auto-generated.arazzo.yaml" %}
5151
arazzo: 1.0.1
5252
info:
5353
title: Warp API
@@ -115,6 +115,14 @@ workflows:
115115
116116
The generated file is not a complete test file and needs to be extended to be functional.
117117
118+
### Specify output file
119+
120+
By default, the CLI tool writes the generated file as `auto-generated.arazzo.yaml` in the current working directory. Use the optional `--output` argument to provide an alternative output file path.
121+
122+
```bash Command
123+
redocly generate-arazzo <your-OAS-description-file> --output=arazzo-custom.yaml
124+
```
125+
118126
## Resources
119127

120128
- [Learn more about Arazzo](/learn/arazzo/what-is-arazzo).

0 commit comments

Comments
 (0)