Redocly / Redocly/redoc

Something went wrong: allOf with more out references

Open
#865 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

ReDoc shows: Something went wrong (Incompatible types in allOf at "") when a schema uses allOf with more out references. The example:

...
components:
  requestBodies:
    requestBody:
      description: "some"
      content:
        application/json:
          schema:
            allOf:
              - $ref: '../../components/schemas/schema1.yaml#/components/schemas/schema1'
              - $ref: '../../components/schemas/schema2.yaml#/components/schemas/schema2'

Everything seems ok, only the html side shows the problem above.

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 reproducing the provided OpenAPI YAML example in ReDoc and confirm the HTML rendering error. Trace handling of multiple external $ref entries within allOf; done means the schema renders without the reported incompatible-types error.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, typescript
Domain
api, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.