Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dependecy refs #2620

Open
hacan359 opened this issue Nov 20, 2024 · 1 comment
Open

Dependecy refs #2620

hacan359 opened this issue Nov 20, 2024 · 1 comment

Comments

@hacan359
Copy link

Describe the bug
I am experiencing an issue with ReDoc where nested objects are rendered inconsistently at different levels of depth in my API documentation. Specifically, I have defined a set of objects in my OpenAPI specification, and while they render correctly at one level of nesting, they do not render correctly at deeper levels.

Details:
I am using the same object definitions throughout my OpenAPI specification.
At a certain level of nesting, the objects display their properties correctly, but at deeper levels, the objects are rendered incorrectly or not at all.
This inconsistency makes it difficult for users to understand the API structure and the data being returned.
Example:
Correct Rendering: At level 1, the object displays all properties as expected.
Incorrect Rendering: At level 2 or deeper, the object appears as an empty object {} or does not show its properties.

Screenshots
Image

Additional context
I use last version readoc https://cdn.jsdelivr.net/npm/redoc@latest/bundles/redoc.standalone.js

@audipasuatmadi
Copy link

Hi @hacan359, I experience the same issue times ago.
I got it fixed by configuring Redoc's generatedSamplesMaxDepth. It seems in my experience, its caused by having it reaches the max depth of the samples. Set it to like 21 or higher value and see the results.

Reference: https://redocly.com/docs/realm/config/openapi/generated-samples-max-depth

It seems it's not in the config.md of the open-source code, I will add it soon.

Hope it helps.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants