Redocly / Redocly/redoc

HTML rendering broken / unusable when allOf and oneOf even if spec is considered 0 warning

Open
#2,562 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Describe the bug

given a specification with no error , no warning using redocly lint , the documentation generated via redocly build-docs "crashes" at rendering , and make it unusable

To Reproduce
given the Open API description attached

run redocly build-docs .\component-descriptor.yml

Open the HTML File produce ,

select for kind the value CAT , the HTML rendering is ok
select for kind the value DOG ; the HTML rendering is broken and does not allow anymore to choose a value

Expected behavior

Either the API specification is considered as invalid are not renderable , and the build doc should shoot an error ,can be at the build doc or at the linter level

Either it is considered as correct and the rendering should be OK

Logs
NA

OpenAPI description
cf attached file (notice that yml or json does not matter)

Redocly Version(s)
redocly --version
1.16.0

Node.js Version(s)
node --version
v18.16.0

Additional context

component-descriptor.json

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.

Research direction

Start by running redocly build-docs .\component-descriptor.yml with the attached component-descriptor.json and compare rendering after selecting CAT and DOG. Trace the HTML rendering path for the allOf/oneOf case; done means either the build or lint reports the specification as unsupported, or the generated HTML remains usable after selecting DOG.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, frontend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.