Document settings.disable-explorer-proxy in docs.yml #1699
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Document the new settings.disable-explorer-proxy option in docs.yml that allows the API explorer to bypass the proxy when sending requests. Include a warning about CORS requirements when this feature is enabled. Co-Authored-By: Catherine Deskur <catherine@buildwithfern.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| </ParamField> | ||
|
|
||
| <ParamField path="settings.disable-explorer-proxy" type="boolean" required={false} default="false" toc={true}> | ||
| If set to true, the API explorer will bypass the proxy when sending requests directly to your API. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[FernStyles.Reject] Use 'API Explorer' instead of 'API explorer'.
| If set to true, the API explorer will bypass the proxy when sending requests directly to your API. | ||
|
|
||
| <Warning> | ||
| When this feature is enabled, your API must have CORS (Cross-Origin Resource Sharing) enabled to allow requests from the documentation domain. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'CORS' has no definition.
Contributor
- Capitalize 'API Explorer' per FernStyles.Reject rule - Define CORS acronym on first use per FernStyles.Acronyms rule Co-Authored-By: Catherine Deskur <catherine@buildwithfern.com>
Contributor
devalog
approved these changes
Nov 2, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Document settings.disable-explorer-proxy in docs.yml
Summary
Added documentation for the new
settings.disable-explorer-proxyconfiguration option in the docs.yml reference page. This setting allows the API Explorer to bypass the proxy when sending requests directly to the user's API. The documentation includes a warning that Cross-Origin Resource Sharing (CORS) must be enabled on the API when this feature is used.Changes:
disable-explorer-proxy: falseto the settings configuration exampleReview & Testing Checklist for Human
*.buildwithfern.com, custom domains) or link to setup instructionsdisable-searchanddark-mode-codeand that the Warning component renders properlyNotes