Skip to content

Commit 6728010

Browse files
authored
docs: fix the name of cli argument (openapi-ts#1942)
1 parent c65795a commit 6728010

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

docs/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ In previous versions globbing was supported, but that has been **deprecated** in
6565

6666
## Redocly config
6767

68-
A `redocly.yaml` file isn’t required to use openapi-typescript. By default it extends the `"minimal"` built-in config. But it is recommended if you want to have custom validation rules (or build types for [multiple schemas](#multiple-schemas)). The CLI will try to automatically find a `redocly.yaml` in the root of your project, but you can also provide its location with the `--redoc` flag:
68+
A `redocly.yaml` file isn’t required to use openapi-typescript. By default it extends the `"minimal"` built-in config. But it is recommended if you want to have custom validation rules (or build types for [multiple schemas](#multiple-schemas)). The CLI will try to automatically find a `redocly.yaml` in the root of your project, but you can also provide its location with the `--redocly` flag:
6969

7070
```bash
7171
npx openapi-typescript --redocly ./path/to/redocly.yaml

docs/ja/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ npx openapi-typescript
6565

6666
## Redocly config
6767

68-
openapi-typescript を使用するには `redocly.yaml` ファイルは必須ではありません。デフォルトでは、組み込みの `"minimal"` 設定を拡張します。ただし、カスタム検証ルールや[複数のスキーマ](#複数のスキーマ)の型を構築したい場合には使用をお勧めします。CLI はプロジェクトのルートディレクトリで `redocly.yaml` を自動的に見つけようとしますが、`--redoc` フラグを使用してその場所を指定することもできます:
68+
openapi-typescript を使用するには `redocly.yaml` ファイルは必須ではありません。デフォルトでは、組み込みの `"minimal"` 設定を拡張します。ただし、カスタム検証ルールや[複数のスキーマ](#複数のスキーマ)の型を構築したい場合には使用をお勧めします。CLI はプロジェクトのルートディレクトリで `redocly.yaml` を自動的に見つけようとしますが、`--redocly` フラグを使用してその場所を指定することもできます:
6969

7070
```bash
7171
npx openapi-typescript --redocly ./path/to/redocly.yaml

docs/zh/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ npx openapi-typescript
6565

6666
## Redoc 配置
6767

68-
使用 openapi-typescript 不需要 `redocly.yaml` 文件。默认情况下,它扩展了内置配置中的 `"minimal"`。但如果您想要自定义验证规则(或构建[多个模式](#multiple-schemas)的类型),建议使用它。CLI 将尝试在项目根目录自动找到 `redocly.yaml`,但您也可以使用 `--redoc` 标志提供其位置:
68+
使用 openapi-typescript 不需要 `redocly.yaml` 文件。默认情况下,它扩展了内置配置中的 `"minimal"`。但如果您想要自定义验证规则(或构建[多个模式](#multiple-schemas)的类型),建议使用它。CLI 将尝试在项目根目录自动找到 `redocly.yaml`,但您也可以使用 `--redocly` 标志提供其位置:
6969

7070
```bash
7171
npx openapi-typescript --redocly ./path/to/redocly.yaml

0 commit comments

Comments
 (0)