Improve support for definitions that have circular references
Open
Nobody has claimed this yet.
area:core
enhancement
- Dominant language
- TypeScript
- Stars
- 697
- Forks
- 31
- Avg merge
- 3d 21h
- Merged PRs (30d)
- 10
Description
Currently with v5 there are a number of issues in codegen, and in oas, that are preventing us supporting circular references out of the gate. We should improve on this.
Here's an example API definition that fails with codegen: https://api.apis.guru/v2/specs/amazonaws.com/ce/2017-10-25/openapi.json
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the codegen failure with the linked Amazon Web Services CE OpenAPI definition and inspect how v5 delegates circular-reference handling to oas. Trace the failure through codegen and oas; done means circular references are supported without breaking generation for this definition and related cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- api, backend-api-design, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100