Skip to content

Document auto-expand setting for API parameters #774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 3, 2025
Merged

Document auto-expand setting for API parameters #774

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@
The eyebrows style of the content. Defaults to `section`.
</ResponseField>
<ResponseField name="codeblocks" type="&quot;system&quot; | &quot;dark&quot;">
The codeblock theme. Defaults to `system`.

Check warning on line 98 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L98 

Did you really mean 'codeblock'?
</ResponseField>
</Expandable>
</ResponseField>
Expand All @@ -114,7 +114,7 @@

<Expandable title="Fonts">
<ResponseField name="family" type="string" required>
The font family, such as "Open Sans", "Playfair Display"

Check warning on line 117 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L117 

Did you really mean 'Playfair'?
</ResponseField>
<ResponseField name="weight" type="number">
The font weight, such as 400, 700. Precise font weights such as 550 are supported for variable fonts.
Expand All @@ -123,7 +123,7 @@
The font source, such as https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2
</ResponseField>
<ResponseField name="format" type="&quot;woff&quot; | &quot;woff2&quot;">
The font format, can be one of woff, woff2

Check warning on line 126 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L126 

Did you really mean 'woff'?
</ResponseField>
<ResponseField name="heading" type="object">

Expand Down Expand Up @@ -215,11 +215,11 @@
### Structure

<ResponseField name="navbar" type="object">
Navbar content and settings

Check warning on line 218 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L218 

Did you really mean 'Navbar'?

<Expandable title="Navbar">
<ResponseField name="links" type="array of object">
The links in the navbar

Check warning on line 222 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L222 

Did you really mean 'navbar'?

<Expandable title="Links">
<ResponseField name="label" type="string" required>
Expand Down Expand Up @@ -498,7 +498,7 @@

<Expandable title="Api">
<ResponseField name="openapi" type="string or array or object">
A string or an array of strings of absolute or relative urls pointing to the OpenAPI file(s)

Check warning on line 501 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L501 

Did you really mean 'urls'?

<Expandable title="Openapi">
<ResponseField name="source" type="string">
Expand All @@ -522,6 +522,15 @@
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField name="params" type="object">
Configurations for the API parameters

<Expandable title="Params">
<ResponseField name="expanded" type="&quot;all&quot; | &quot;closed&quot;">
The view mode of expandable API parameters. Defaults to `closed`.
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField name="playground" type="object">
Configurations for the API playground

Expand Down