Skip to content

config: add defaults in api examples #657

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
Apr 16, 2025
Merged

config: add defaults in api examples #657

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
3 changes: 3 additions & 0 deletions settings/global.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/global.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/global.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/global.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/global.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/global.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/global.mdx#L126 

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

Expand Down Expand Up @@ -538,6 +538,9 @@
<ResponseField name="languages" type="array of string">
Example languages for the autogenerated API snippets
</ResponseField>
<ResponseField name="defaults" type="&quot;required&quot; | &quot;all&quot;">
Whether to show optional parameters in api examples, defaults to `all`
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField name="mdx" type="object">
Expand Down Expand Up @@ -1615,14 +1618,14 @@
"pages": ["analytics/posthog"]
}
],
"footerSocials": {

Check warning on line 1621 in settings/global.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/global.mdx#L1621 

Did you really mean 'footerSocials'?
"github": "https://github.com/mintlify",
"slack": "https://mintlify.com/community",
"x": "https://x.com/mintlify"
},
"integrations": {
"intercom": "APP_ID",
"frontchat": "CHAT_ID"

Check warning on line 1628 in settings/global.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/global.mdx#L1628 

Did you really mean 'frontchat'?
}
}
```
Expand Down