feat(theme): add requestCredentials option for API requests#1300
Merged
feat(theme): add requestCredentials option for API requests#1300
Conversation
|
Size Change: 0 B Total Size: 2.17 MB ℹ️ View Unchanged
|
|
Visit the preview URL for this PR (updated for commit b08ca76): https://docusaurus-openapi-36b86--pr1300-68ircm3r.web.app (expires Wed, 04 Mar 2026 18:24:42 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: bf293780ee827f578864d92193b8c2866acd459f |
Add a new `requestCredentials` configuration option to control cookie
and credential behavior in ApiExplorer requests. This is useful when
API documentation is hosted on the same domain as the application,
where browsers automatically include session cookies.
Options:
- "omit": Never send cookies
- "same-origin": Send cookies for same-origin requests (browser default)
- "include": Always send cookies, even for cross-origin
Usage in docusaurus.config.js:
```js
themeConfig: {
api: {
requestCredentials: "omit",
},
},
```
Fixes #1296
sserrata
force-pushed
the
feat/request-credentials-option
branch
from
cb169d1 to
b08ca76
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Add a new
requestCredentialsconfiguration option to control cookie and credential behavior in ApiExplorer requests. This is useful when API documentation is hosted on the same domain as the application, where browsers automatically include session cookies.Options:
Usage in docusaurus.config.js:
Fixes #1296