oxidecomputer / oxidecomputer/omicron
`source_error` should not be empty in the API spec
Open
Nobody has claimed this yet.
api
openapi
- Dominant language
- Rust
- Stars
- 572
- Forks
- 97
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 96
Description
The source_error type returned from SagaErrorInfo is an empty object in the openapi spec. I ran across this while working on the TypeScript generator. I haven't dug into why it's this way yet, but we should fix it.
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 at openapi/nexus.json around line 10292 and inspect the generated schema for source_error in SagaErrorInfo. Trace how that schema is produced, then verify that source_error is represented with its intended fields rather than as an empty object. Check the resulting OpenAPI output in the TypeScript generator context.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust, typescript
- Domain
- api, backend-api-design
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100