Redocly / Redocly/redoc

Issues with importing models with inheritance

Open
#1,226 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

I have an openapi 3.0.1 specification which defines a few response objects which is referenced to another file over the web. This works perfectly fine in the scenario that the object is purely simple, but when the referenced object uses inheritance, redoc stops working.

Part of original contract with disguised URL
image

Shortened version of the referenced contract:
image

Result:
image

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 failure with the OpenAPI 3.0.1 specification described in the issue: a response object references another web-hosted file whose schema uses inheritance. Compare this with the simple referenced-object case and the screenshots; done means Redoc renders the inherited response objects instead of stopping.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, typescript
Domain
api, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.