feat: support external $ref resolution in OpenAPI loader
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 52/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- openapi, typescript
- Domain
- api
Research direction
Start in src/lib/openapi.ts by tracing external $ref handling and the V2→V3 conversion. Check how references are resolved relative to the spec file, then verify that consumes/produces become content-type entries and that the listed conversion gaps are covered. Done means external references no longer remain unresolved in rendered API docs and the specified V2 fields are preserved.
Written by the indexing model from the issue text.
Description
Problem
`src/lib/openapi.ts` only resolves internal `#/` JSON pointer references. External file references (e.g. `$ref: './common/errors.yaml'`) fail silently, resulting in unresolved `$ref` objects appearing in the rendered API docs.
The V2→V3 conversion is also incomplete:
- Ignores `consumes`/`produces` fields (assumes JSON for everything)
- Doesn't convert all security scheme types
- Missing request/response examples
Suggested Fix
- For external file refs, resolve relative to the spec file's directory
- For the V2 conversion, carry over `consumes`/`produces` as content type entries in V3 request/response objects
- Dominant language
- TypeScript
- Stars
- 2
- Forks
- 1
- Avg merge
- 5h 16m
- Merged PRs (30d)
- 10
Getting set up
- Ships a Dockerfile or Docker Compose file
- No pull request template
- No contributing 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.
More from raystack/chronicle
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 65/100
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
Maintainers usually reply within 1 day
All issues in raystack/chronicle
Similar issues
-
keytrace logo svg?Open
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
cyclofinance/cyclo.site#448 ·
-
[sanity-plugin-media] Searching for a word with an apostrophe shows an error instead of resultsOpen@sanity-io/studio bug sanity-plugin-media Sieve-Agent
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
bug via-triage
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
pingdotgg/t3code#15221 · 1 comment ·
Maintainers usually reply within 1 day