The OAS YAML file cannot be loaded by Redoc (an open source tool), which results in a browser crash and Out Of Memory error.
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
The OAS YAML file cannot be loaded by Redoc (an open source tool), which results in a browser crash and Out Of Memory error.
We would like to render the OAS YAML file on the Redoc open-source tool. Redoc cannot render OAS YAML because of the nested and circular schema definition. We have around 200 APIs that use schema definition often, which causes the rendering issues.
Here is an example of a circular reference in the SLM YAML file.
SampleEndpoint
--> SchemaA
--> SchemaB
--> SchemaC
--> SchemaA
--> SchemaD
--> SchemaB
NOTE: I ran it locally using the "redocly preview-docs" command. I tried pagination, which works fine in Redocly's premium version. Can it be supported in Redoc?
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 failure with the reported OAS YAML and the redocly preview-docs command, focusing on the circular SchemaA–SchemaD references. The issue names no repository file or test, so first identify the Redoc schema-rendering entry point and an existing reproduction path. Done means the document renders without a browser crash or out-of-memory error, with pagination support clarified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- api, documentation
- Issue type
- Bug
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100