oxidecomputer / oxidecomputer/oxide.ts
Wrap all API response types in `Readonly`
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 33
- Forks
- 4
- Avg merge
- 6d 9h
- Merged PRs (30d)
- 4
Description
Seems like the right thing to do. I don't think we'd want to do it for request bodies because we might mutate them while building them. If there are any types used for both a request and response, we can just leave Readonly off.
Contributor guide
No contributing guide indexed for this repository
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 locating the TypeScript definitions for API response types and checking which types are also used as request bodies. Apply the issue's distinction consistently: response-only types should be readonly, while shared request/response types should remain unchanged; completion means all applicable API response types follow this rule.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100