Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api-playground/openapi-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ We recommend the following resources to learn about and construct your OpenAPI s
- [Swagger's OpenAPI Guide](https://swagger.io/docs/specification/v3_0/basic-structure/) to learn the OpenAPI syntax.
- [The OpenAPI specification Markdown sources](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/) to reference details of the latest OpenAPI specification.
- [Swagger Editor](https://editor.swagger.io/) to edit, validate, and debug your OpenAPI document.
- [The Mint CLI](https://www.npmjs.com/package/mint) to validate your OpenAPI document with the command: `mint openapi-check <openapiFilenameOrUrl>`.
- [The Mint CLI](https://www.npmjs.com/package/mint) to validate your OpenAPI document with the command: `mint validate`.

<Note>
Swagger's OpenAPI Guide is for OpenAPI v3.0, but nearly all of the information is applicable to v3.1. For more information on the differences between v3.0 and v3.1, see [Migrating from OpenAPI 3.0 to 3.1.0](https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0) in the OpenAPI blog.
Expand Down
2 changes: 1 addition & 1 deletion api-playground/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ We recommend generating your API playground from an OpenAPI specification. Howev
<Steps>
<Step title="Add your OpenAPI specification file.">
<Tip>
Validate your OpenAPI specification file using the [Swagger Editor](https://editor.swagger.io/) or [Mint CLI](https://www.npmjs.com/package/mint) command `mint openapi-check <filename>`.
Validate your OpenAPI specification file using the [Swagger Editor](https://editor.swagger.io/) or [Mint CLI](https://www.npmjs.com/package/mint) command `mint validate`.
</Tip>

```bash {3}
Expand Down
2 changes: 1 addition & 1 deletion api-playground/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
<Accordion title="Requests from the API Playground don't work">
If you have a custom domain configured, this could be an issue with your reverse proxy. By
default, requests made via the API Playground start with a `POST` request to the
`/_mintlify/api/request` path on the docs site. If your reverse proxy is configured to only allow `GET`

Check warning on line 68 in api-playground/troubleshooting.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/troubleshooting.mdx#L68

In general, use active voice instead of passive voice ('is configured').
requests, then all of these requests fail. To fix this, configure your reverse proxy to
allow `POST` requests to the `/_mintlify/api/request` path.

Expand All @@ -92,7 +92,7 @@

2. **OpenAPI spec inheritance**: If using nested navigation, ensure child groups inherit the correct OpenAPI spec or specify their own.

3. **Validation issues**: Use `mint openapi-check <path-to-openapi-file>` to verify your OpenAPI document is valid.
3. **Validation issues**: Use `mint validate` to verify your OpenAPI document is valid.
</Accordion>
<Accordion title="Some OpenAPI operations appear in navigation but others don't">

Expand Down
2 changes: 1 addition & 1 deletion es/api-playground/openapi-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Recomendamos los siguientes recursos para aprender y elaborar tu especificación
* [Guía de OpenAPI de Swagger](https://swagger.io/docs/specification/v3_0/basic-structure/) para aprender la sintaxis de OpenAPI.
* [Fuentes Markdown de la especificación OpenAPI](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/) para consultar los detalles de la versión más reciente de la especificación.
* [Swagger Editor](https://editor.swagger.io/) para editar, validar y depurar tu documento de OpenAPI.
* [La CLI de Mint](https://www.npmjs.com/package/mint) para validar tu documento de OpenAPI con el comando: `mint openapi-check <openapiFilenameOrUrl>`.
* [La CLI de Mint](https://www.npmjs.com/package/mint) para validar tu documento de OpenAPI con el comando: `mint validate`.

<Note>
La Guía de OpenAPI de Swagger corresponde a OpenAPI v3.0, pero casi toda la información es aplicable a v3.1. Para obtener más información sobre las diferencias entre v3.0 y v3.1, consulta [Migrating from OpenAPI 3.0 to 3.1.0](https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0) en el blog de OpenAPI.
Expand Down
2 changes: 1 addition & 1 deletion es/api-playground/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Recomendamos generar tu playground de API a partir de una especificación OpenAP
<Steps>
<Step title="Añade tu archivo de especificación de OpenAPI.">
<Tip>
Valida tu archivo de especificación de OpenAPI con el [Swagger Editor](https://editor.swagger.io/) o con el comando de la [Mint CLI](https://www.npmjs.com/package/mint) `mint openapi-check <filename>`.
Valida tu archivo de especificación de OpenAPI con el [Swagger Editor](https://editor.swagger.io/) o con el comando de la [Mint CLI](https://www.npmjs.com/package/mint) `mint validate`.
</Tip>

```bash {3}
Expand Down
2 changes: 1 addition & 1 deletion es/api-playground/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Si sus páginas de la API no se muestran correctamente, revise estos problemas d

2. **Herencia de la especificación OpenAPI**: Si usas navigation anidada, asegúrate de que los grupos hijos hereden la especificación OpenAPI correcta o definan la suya propia.

3. **Problemas de validación**: Usa `mint openapi-check <path-to-openapi-file>` para verificar que tu documento OpenAPI sea válido.
3. **Problemas de validación**: Usa `mint validate` para verificar que tu documento OpenAPI sea válido.
</Accordion>

<Accordion title="Algunas operaciones de OpenAPI aparecen en navigation, pero otras no">
Expand Down
17 changes: 3 additions & 14 deletions es/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -254,22 +254,11 @@ Utiliza flags para configurar el comando de validación.
### Verificar la especificación de OpenAPI
</div>

Verifica tu archivo de OpenAPI en busca de errores con el siguiente comando:

```bash
mint openapi-check <OpenAPI filename or URL>
```

Pasa un nombre de archivo (por ejemplo, `./openapi.yaml`) o una URL (por ejemplo, `https://petstore3.swagger.io/api/v3/openapi.json`).

Para verificar un archivo de OpenAPI alojado localmente y servido a través de HTTP, usa la opción `--local-schema`:

```bash
mint openapi-check http://localhost:8080/openapi.json --local-schema
```
El comando `mint validate` valida automáticamente todos los archivos OpenAPI especificados en `docs.json`. Para omitir la validación de OpenAPI, usa la opción `--disable-openapi`.

<Note>
Los despliegues de producción solo admiten URL HTTPS. La opción `--local-schema` es solo para desarrollo local.
El comando `mint openapi-check` está obsoleto. Usa `mint validate` en su lugar,
que valida tanto tu build de documentación como tus especificaciones OpenAPI.
</Note>

<div id="create-a-workflow">
Expand Down
2 changes: 1 addition & 1 deletion fr/api-playground/openapi-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Nous recommandons les ressources suivantes pour apprendre et rédiger votre spé
* [Guide OpenAPI de Swagger](https://swagger.io/docs/specification/v3_0/basic-structure/) pour apprendre la syntaxe d’OpenAPI.
* [Sources Markdown de la spécification OpenAPI](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/) pour consulter les détails de la dernière version de la spécification OpenAPI.
* [Swagger Editor](https://editor.swagger.io/) pour modifier, valider et déboguer votre document OpenAPI.
* [Mint CLI](https://www.npmjs.com/package/mint) pour valider votre document OpenAPI avec la commande : `mint openapi-check <openapiFilenameOrUrl>`.
* [Mint CLI](https://www.npmjs.com/package/mint) pour valider votre document OpenAPI avec la commande : `mint validate`.

<Note>
Le guide OpenAPI de Swagger porte sur OpenAPI v3.0, mais la quasi-totalité des informations s’applique à v3.1. Pour en savoir plus sur les différences entre v3.0 et v3.1, consultez l’article du blog OpenAPI [Migrating from OpenAPI 3.0 to 3.1.0](https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0).
Expand Down
2 changes: 1 addition & 1 deletion fr/api-playground/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Nous recommandons de générer votre playground API à partir d’une spécifica
<Steps>
<Step title="Ajoutez votre fichier de spécification OpenAPI.">
<Tip>
Validez votre fichier de spécification OpenAPI avec le [Swagger Editor](https://editor.swagger.io/) ou la commande [Mint CLI](https://www.npmjs.com/package/mint) `mint openapi-check <filename>`.
Validez votre fichier de spécification OpenAPI avec le [Swagger Editor](https://editor.swagger.io/) ou la commande [Mint CLI](https://www.npmjs.com/package/mint) `mint validate`.
</Tip>

```bash {3}
Expand Down
2 changes: 1 addition & 1 deletion fr/api-playground/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Si vos pages API ne s’affichent pas correctement, consultez ces problèmes de

2. **Héritage de la spécification OpenAPI** : Si vous utilisez une navigation imbriquée, assurez-vous que les groupes enfants héritent de la bonne spécification OpenAPI ou définissent la leur.

3. **Problèmes de validation** : Utilisez `mint openapi-check <path-to-openapi-file>` pour vérifier que votre document OpenAPI est valide.
3. **Problèmes de validation** : Utilisez `mint validate` pour vérifier que votre document OpenAPI est valide.
</Accordion>

<Accordion title="Certaines opérations OpenAPI apparaissent dans la navigation, mais d’autres non">
Expand Down
17 changes: 3 additions & 14 deletions fr/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -254,22 +254,11 @@ Utilisez des options pour configurer la commande de validation.
### Vérifier la spécification OpenAPI
</div>

Vérifiez votre fichier OpenAPI à la recherche d’erreurs avec la commande suivante :

```bash
mint openapi-check <nom de fichier OpenAPI ou URL>
```

Indiquez un nom de fichier (par exemple, `./openapi.yaml`) ou une URL (par exemple, `https://petstore3.swagger.io/api/v3/openapi.json`).

Pour vérifier un fichier OpenAPI hébergé localement et servi via HTTP, utilisez l’option `--local-schema` :

```bash
mint openapi-check http://localhost:8080/openapi.json --local-schema
```
La commande `mint validate` valide automatiquement tous les fichiers OpenAPI spécifiés dans `docs.json`. Pour ignorer la validation OpenAPI, utilisez l'option `--disable-openapi`.

<Note>
Les déploiements en production ne prennent en charge que les URL HTTPS. L’option `--local-schema` est réservée au développement local.
La commande `mint openapi-check` est obsolète. Utilisez `mint validate` à la place,
qui valide à la fois votre build de documentation et vos spécifications OpenAPI.
</Note>

<div id="create-a-workflow">
Expand Down
17 changes: 3 additions & 14 deletions installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -230,22 +230,11 @@

### Check OpenAPI spec

Check your OpenAPI file for errors with the following command:

```bash
mint openapi-check <OpenAPI filename or URL>
```

Pass a filename (for example, `./openapi.yaml`) or a URL (for example, `https://petstore3.swagger.io/api/v3/openapi.json`).

To check a locally hosted OpenAPI file served over HTTP, use the `--local-schema` flag:

```bash
mint openapi-check http://localhost:8080/openapi.json --local-schema
```
The `mint validate` command automatically validates any OpenAPI files specified in `docs.json`. To skip OpenAPI validation, use the `--disable-openapi` flag.

<Note>
Production deployments only support HTTPS URLs. The `--local-schema` flag is for local development only.
The `mint openapi-check` command is deprecated. Use `mint validate` instead,

Check warning on line 236 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L236

In general, use active voice instead of passive voice ('is deprecated').
which validates both your documentation build and OpenAPI specifications.
</Note>

### Create a workflow
Expand Down
2 changes: 1 addition & 1 deletion zh/api-playground/openapi-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ OpenAPI 是用于描述 API 的规范。Mintlify 支持 OpenAPI 3.0 和 3.1 文
* [Swagger 的 OpenAPI 指南](https://swagger.io/docs/specification/v3_0/basic-structure/),用于学习 OpenAPI 语法。
* [OpenAPI 规范的 Markdown 源文件](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/),用于查阅最新版 OpenAPI 规范的详细信息。
* [Swagger Editor](https://editor.swagger.io/),用于编辑、验证和调试你的 OpenAPI 文档。
* [Mint CLI](https://www.npmjs.com/package/mint),可通过以下命令验证你的 OpenAPI 文档:`mint openapi-check <openapiFilenameOrUrl>`。
* [Mint CLI](https://www.npmjs.com/package/mint),可通过以下命令验证你的 OpenAPI 文档:`mint validate`。

<Note>
Swagger 的 OpenAPI 指南面向 OpenAPI v3.0,但其中几乎所有信息同样适用于 v3.1。关于 v3.0 与 v3.1 的差异,请参阅 OpenAPI 博客中的 [Migrating from OpenAPI 3.0 to 3.1.0](https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0)。
Expand Down
2 changes: 1 addition & 1 deletion zh/api-playground/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Playground 会基于你的 OpenAPI 规范或 AsyncAPI 模式为端点生成交
<Steps>
<Step title="添加你的 OpenAPI 规范文件。">
<Tip>
使用 [Swagger Editor](https://editor.swagger.io/) 或 [Mint CLI](https://www.npmjs.com/package/mint) 命令 `mint openapi-check <filename>` 验证你的 OpenAPI 规范文件。
使用 [Swagger Editor](https://editor.swagger.io/) 或 [Mint CLI](https://www.npmjs.com/package/mint) 命令 `mint validate` 验证你的 OpenAPI 规范文件。
</Tip>

```bash {3}
Expand Down
2 changes: 1 addition & 1 deletion zh/api-playground/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ keywords: ["API 故障排查", "OpenAPI 无效", "配置问题"]

2. **OpenAPI 规范继承**:如果使用嵌套导航,确保子 groups 继承正确的 OpenAPI 规范,或为其分别指定自己的规范。

3. **验证问题**:使用 `mint openapi-check <path-to-openapi-file>` 验证你的 OpenAPI 文档是否有效。
3. **验证问题**:使用 `mint validate` 验证你的 OpenAPI 文档是否有效。
</Accordion>

<Accordion title="某些 OpenAPI 操作会出现在导航中,但其他则不会出现">
Expand Down
17 changes: 3 additions & 14 deletions zh/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -254,22 +254,11 @@ mint validate
### 检查 OpenAPI 规范
</div>

使用以下命令检查你的 OpenAPI 文件是否存在错误:

```bash
mint openapi-check <OpenAPI 文件名或 URL>
```

传入文件名 (例如 `./openapi.yaml`) 或 URL (例如 `https://petstore3.swagger.io/api/v3/openapi.json`) 。

要检查通过 HTTP 提供的本地 OpenAPI 文件,请使用 `--local-schema` 标志:

```bash
mint openapi-check http://localhost:8080/openapi.json --local-schema
```
`mint validate` 命令会自动验证 `docs.json` 中指定的所有 OpenAPI 文件。要跳过 OpenAPI 验证,请使用 `--disable-openapi` 标志。

<Note>
生产环境部署仅支持 HTTPS URL。`--local-schema` 标志仅用于本地开发。
`mint openapi-check` 命令已弃用。请改用 `mint validate`,
它可以同时验证你的文档构建和 OpenAPI 规范。
</Note>

<div id="create-a-workflow">
Expand Down
Loading