Redocly / Redocly/redoc

Recursive schema readability compared to older version of Redoc

Open
#2,345 4 comments 0 reactions 1 assignee View on GitHub

@AlexVarchuk is already working on this.

Since Jul 18, 2023.

Type: Bug
Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

Describe the bug

Compared to an older version of Redoc (2.0.0-rc.66), recursive schemas and their examples are less readable in the new version. In the example below, columns can include columns, which can include more columns, and so on.

I checked with preview-docs, build-docs, and also as described in https://redocly.com/docs/redoc/quickstart/.

obraz

To Reproduce
Steps to reproduce the behavior:

  1. Have schema that includes a $ref to itself

Expected behavior

In the older version, that schema is printed inside itself again (also in the example in the right pane, which is not included in my attached screenshot) and the word "Recursive" is added in yellow.

In the newer version, the word "Recursive" is gone and the schema can't be collapsed. In the example, it becomes an empty array.

OpenAPI definition

3.0.0, but unfortunately, I can't share it.

Redocly Version(s)

1.0.0-beta.128

Node.js Version(s)

8.19.4

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.