Improve API request error handling and add support for customizing requestTimeout #1267
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
- Add custom RequestError class with typed error categories (timeout, network, cors, unknown) - Replace Promise.race timeout with AbortController for cleaner timeout handling - Add descriptive error messages for different failure scenarios - Add translation IDs for internationalization of error messages - Update Request component to display context-specific error messages
…port - Increase default request timeout from 5s to 30s - Add requestTimeout option to themeConfig.api for site-wide configuration - Support proxy in themeConfig.api as site-wide default (per-spec plugin option takes precedence) - Update documentation in README.md, plugin README.md, and intro.mdx
|
Size Change: +4.91 kB (+0.23%) Total Size: 2.15 MB
ℹ️ View Unchanged
|
|
Visit the preview URL for this PR (updated for commit 8512674): https://docusaurus-openapi-36b86--pr1267-dpqrf91n.web.app (expires Sun, 18 Jan 2026 17:01:51 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: bf293780ee827f578864d92193b8c2866acd459f |
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.
Description
Implements better error handling for network and CORS-related errors and introduces
requestTimeoutoption tothemeConfig.apifor globally customizing timeout.Motivation and Context
In some cases, errors due to timeouts were getting masked in the UI resulting in confusion for end users.
How Has This Been Tested?
Deploy preview
Screenshots (if appropriate)
Types of changes
Checklist