NatLabRockies / NatLabRockies/developer.nlr.gov
Empty search on High Performance Building Database docs crashes browser
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 60
- Forks
- 57
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 3
Description
If you want to crash your browser (which you probably don't want to do):
- Navigate to the High Performance Building Database docs.
- Expand the first documentation for
/project - Hit "Try it out" without filling in any other fields.
After processing for a while, then your browser will likely crash. I think this is due to the volume of XML data that's coming back and trying to be displayed. While there are use-cases for bulk-downloading all the data, the Swagger docs should probably have some additional default filters so that the default search performed doesn't return so much data.
Reported during our API Usability Testing.
Contributor guide
No contributing guide indexed for this repository
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 at the linked High Performance Building Database Swagger docs and reproduce the empty Try it out request for /project. Identify how the default request is formed and verify that an unfiltered search no longer returns enough XML data to crash or overwhelm the browser.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- api
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100