PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs
The long API call gets lost
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.1k
- Forks
- 315
- Avg merge
- 7d 5h
- Merged PRs (30d)
- 7
Description
Describe the bug
When calling APIs that take a long time, the response gets 'lost'. If it's an internal client timeout, it would be ideal to configure the client timeout parametrically."
Expected behavior
First of all, the interface should display the issue rather than ignoring it. For example, it should indicate a timeout.
Second, it would be convenient if the timeout duration could be configurable.
Current behavior
For an API call that takes a long time (but in a 'expected' way), the response is completely lost and ignored.
Possible solution
see "Expected behavior"
Steps to reproduce
- Pre-requisite: Set up an API that takes a long time to respond.
- Pre-requisite: Configure OpenAPI for that API and integrate it into the implementation.
- Call the API using the docusaurus-openapi-docs plugin.
Screenshots
Your Environment
- Version used: v3.0.0-beta.4 (Docusaurus version 3.1.0)
- Environment name and version:
- Docusaurus side: Chrome Browser 122.0.6261.71 (Official build 64 bit);
- BE side: SpringBoot BE engine and NGINX web server
- Operating System and version (desktop or mobile): Windows 11 Desktop
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the long-running API call through the docusaurus-openapi-docs plugin with an OpenAPI-integrated backend. Trace how the client handles a delayed response and determine where the interface currently drops it. Done means the interface reports a timeout and the client timeout duration can be configured.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, react, typescript
- Domain
- api, frontend
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100