Skip to content

[Feature Request] Fix OpenAPI documentation generator crash for RPC endpoints #1717

@daaain

Description

@daaain

Is your feature request related to a problem? Please describe.
Currently for RPC endpoints the OpenAPI plugin generates a massive JSON file (100K+ lines for ~20 models), which makes the browser stall when using Swagger UI and trying to expand an API definition (eventually a popup asks to stop the script) and crash Redocly CLI with FATAL ERROR: Reached heap limit Allocation failed - JavaScript heap out of memory.

Describe the solution you'd like
A way to configure the depth the types that are generated by the OpenAPI plugin to put a limit on the size of each endpoint's schema.

Describe alternatives you've considered
I guess the documentation generators could also prevent this issue on their side.

Additional context
See this Discord thread for more context.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions