Skip to content

Commit 67e3ee4

Browse files
authored
docs: update (#1739)
1 parent d3d0fcf commit 67e3ee4

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

docs/cli.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,12 @@ In previous versions globbing was supported, but that has been **deprecated** in
6363

6464
:::
6565

66-
## Redoc config
66+
## Redocly config
6767

6868
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:
6969

7070
```bash
71-
npx openapi-typescript --redoc ./path/to/redocly.yaml
71+
npx openapi-typescript --redocly ./path/to/redocly.yaml
7272
```
7373

7474
You can read more about the Redoc’s configuration options [in their docs](https://redocly.com/docs/cli/configuration/).
@@ -104,7 +104,7 @@ The following flags are supported in the CLI:
104104
| `--help` | | | Display inline help message and exit |
105105
| `--version` | | | Display this library’s version and exit |
106106
| `--output [location]` | `-o` | (stdout) | Where should the output file be saved? |
107-
| `--redoc [location]` | | | Path to a `redocly.yaml` file (see [Multiple schemas](#multiple-schemas)) |
107+
| `--redocly [location]` | | | Path to a `redocly.yaml` file (see [Multiple schemas](#multiple-schemas)) |
108108
| `--additional-properties` | | `false` | Allow arbitrary properties for all schema objects without `additionalProperties: false` |
109109
| `--alphabetize` | | `false` | Sort types alphabetically |
110110
| `--array-length` | | `false` | Generate tuples using array `minItems` / `maxItems` |

docs/zh/cli.md

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

7070
```bash
71-
npx openapi-typescript --redoc ./path/to/redocly.yaml
71+
npx openapi-typescript --redocly ./path/to/redocly.yaml
7272
```
7373

7474
您可以在 [Redoc 文档](https://redocly.com/docs/cli/configuration/) 中详细了解 Redoc 的配置选项。
@@ -104,7 +104,7 @@ CLI 支持以下参数:
104104
| `--help` | | | 显示内联帮助消息并退出 |
105105
| `--version` | | | 显示此库的版本并退出 |
106106
| `--output [location]` | `-o` | (stdout) | 应将输出文件保存在何处? |
107-
| `--redoc [location]` | | | `redocly.yaml` 文件的路径(参见 [多个模式](#multiple-schemas)) |
107+
| `--redocly [location]` | | | `redocly.yaml` 文件的路径(参见 [多个模式](#multiple-schemas)) |
108108
| `--additional-properties` | | `false` | 允许所有模式对象使用 `additionalProperties: false` 之外的任意属性 |
109109
| `--alphabetize` | | `false` | 按字母顺序排序类型 |
110110
| `--array-length` | | `false` | 使用数组 `minItems` / `maxItems` 生成元组 |

0 commit comments

Comments
 (0)