Skip to content

Add docs for disableProxy param #250

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
mayankshouche merged 1 commit into from
Aug 12, 2024
Merged

Add docs for disableProxy param #250

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
11 changes: 9 additions & 2 deletions settings/global.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Global Settings"
description: "Customize your documentation using the mint.json file"
icon: 'wrench'
icon: "wrench"
---

Every Mintlify site needs a `mint.json` file with the core configuration
Expand All @@ -17,7 +17,9 @@ settings. Learn more about the [properties](#properties) or from an
</ResponseField>

<ResponseField name="logo" type="string or object">
Path to logo image or object with path to "light" and "dark" mode logo images, and where the logo links to. SVG format is recommended. It does not pixelate and the file size is generally smaller.
Path to logo image or object with path to "light" and "dark" mode logo images,
and where the logo links to. SVG format is recommended. It does not pixelate
and the file size is generally smaller.
<Expandable title="Logo">
<ResponseField name="light" type="string">
Path to the logo in light mode. For example: `/path/to/logo.svg`
Expand Down Expand Up @@ -335,6 +337,11 @@ Example:

Learn more at the [playground guides](/api-playground)
</ResponseField>
<ResponseField name="disableProxy" type="boolean" default={false}>
By default, API playground requests are proxied by Mintlify. This setting can be used to disable this behavior.

Required for select request types, such as file uploads.
</ResponseField>
</Expandable>
</ResponseField>

Expand Down