Skip to content
Open
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
1 change: 0 additions & 1 deletion api-playground/openapi-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -147,11 +147,10 @@
}
```

The `x-default` extension supports `apiKey` and `http` bearer security scheme types. The value appears as the default input in the playground's authentication fields. Prefill for security schemes is unconditional and does not require any additional configuration.

Check warning on line 150 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L150

Use 'prefill(s|ing|ed)?' instead of 'Prefill'.

Use `x-default` on other schema properties in your OpenAPI specification to set a default value in the API playground without affecting the `default` field in the schema definition. Unlike security schemes, prefill for non-security-scheme properties only takes effect when you set [`api.examples.prefill`](/organize/settings-api) to `true` in your [`docs.json`](/api-playground/overview#example-configuration).


## Let visitors download your spec

Opt into a "Download API spec" entry in the [page context menu](/organize/settings-structure#contextual) by adding `"download-spec"` to `contextual.options` in your `docs.json`:
Expand Down
19 changes: 19 additions & 0 deletions api-playground/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,25 @@ If your API pages aren't displaying correctly, check these common configuration
2. **Invalid operations**: Operations with validation errors in the OpenAPI spec may be skipped. Check your OpenAPI document for syntax errors.
3. **Manual vs automatic inclusion**: If you reference any endpoints from an OpenAPI spec, only the explicitly referenced operations appear in navigation. No other pages are automatically added. This includes operations that are referenced in child navigation elements.
</Accordion>
<Accordion title="The Authorization field description is generic or unhelpful">
Mintlify auto-generates a description for the `Authorization` field in the API playground based on the security scheme type. Override it by adding a `description` to the security scheme in your OpenAPI specification.

```json {7}
{
"components": {
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"description": "Your API key from the [dashboard](https://example.com/dashboard). Send it as `Bearer <key>`."
}
}
}
}
```

The `description` supports Markdown and replaces the auto-generated text on every endpoint that uses the security scheme.
</Accordion>
<Accordion title="Mixed navigation (OpenAPI and MDX pages) not working correctly">
When combining OpenAPI operations with regular documentation pages in navigation:

Expand Down