From 528e62f0bc2acd970b9a06b28e7cc5e9157297c3 Mon Sep 17 00:00:00 2001 From: dino475 Date: Thu, 12 Dec 2024 10:58:15 -0800 Subject: [PATCH 1/2] adding info about mintlify openapi-check --- api-playground/openapi/setup.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/api-playground/openapi/setup.mdx b/api-playground/openapi/setup.mdx index 7d45da4f6..c96dc12c6 100644 --- a/api-playground/openapi/setup.mdx +++ b/api-playground/openapi/setup.mdx @@ -10,6 +10,8 @@ document in either JSON or YAML format that follows the [OpenAPI specification](https://swagger.io/specification/). Your document must follow OpenAPI specification 3.0+. +To validate your OpenAPI spec, you can use this command:
`mintlify openapi-check ` + ## Auto-populate API pages The fastest way to get started with OpenAPI is to add an `openapi` field to a tab or anchor in the `mint.json`. This field can contain either the path to an OpenAPI document in your docs repo, or the URL of a hosted OpenAPI document. Mintlify will automatically generate a page for each OpenAPI operation and place them in the tab/anchor. From 1fb40f4e3c537046c05cd00bbd867d2d94258c4b Mon Sep 17 00:00:00 2001 From: dino475 Date: Thu, 12 Dec 2024 12:52:53 -0800 Subject: [PATCH 2/2] updated location of the tip --- api-playground/openapi/setup.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/api-playground/openapi/setup.mdx b/api-playground/openapi/setup.mdx index c96dc12c6..5dd4a29cc 100644 --- a/api-playground/openapi/setup.mdx +++ b/api-playground/openapi/setup.mdx @@ -10,8 +10,6 @@ document in either JSON or YAML format that follows the [OpenAPI specification](https://swagger.io/specification/). Your document must follow OpenAPI specification 3.0+. -To validate your OpenAPI spec, you can use this command:
`mintlify openapi-check ` - ## Auto-populate API pages The fastest way to get started with OpenAPI is to add an `openapi` field to a tab or anchor in the `mint.json`. This field can contain either the path to an OpenAPI document in your docs repo, or the URL of a hosted OpenAPI document. Mintlify will automatically generate a page for each OpenAPI operation and place them in the tab/anchor. @@ -49,6 +47,8 @@ The fastest way to get started with OpenAPI is to add an `openapi` field to a ta ![](/images/autogeneration-with-tabs.png) +To validate your OpenAPI spec, you can use this command:
`mintlify openapi-check ` + When using this option, the metadata for the generated pages will have the following default values: * `title`: The `summary` field from the OpenAPI operation, if present. Otherwise a title generated from the HTTP method and endpoint.