Skip to content

Commit 5cd96cb

Browse files
Document settings.disable-explorer-proxy in docs.yml (#1699)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Catherine Deskur <[email protected]>
1 parent b081fe1 commit 5cd96cb

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

fern/products/docs/pages/customization/what-is-docs-yml.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -536,6 +536,7 @@ layout:
536536
settings:
537537
search-text: "Search the docs..."
538538
disable-search: false
539+
disable-explorer-proxy: false
539540
dark-mode-code: true
540541
default-search-filters: true
541542
http-snippets: false
@@ -551,6 +552,14 @@ settings:
551552
If set to true, the searchbar will be disabled. Use this if you want to use a custom search solution.
552553
</ParamField>
553554

555+
<ParamField path="settings.disable-explorer-proxy" type="boolean" required={false} default="false" toc={true}>
556+
If set to true, the API Explorer will bypass the proxy when sending requests directly to your API.
557+
558+
<Warning>
559+
When this feature is enabled, your API must have Cross-Origin Resource Sharing (CORS) enabled to allow requests from the documentation domain.
560+
</Warning>
561+
</ParamField>
562+
554563
<ParamField path="settings.dark-mode-code" type="boolean" required={false} default="false" toc={true}>
555564
If set to true, the code blocks will be displayed in dark mode, regardless of the selected theme.
556565
</ParamField>

0 commit comments

Comments
 (0)