oxidecomputer / oxidecomputer/oxide.go
Document OpenAPI generation design
Open
Nobody has claimed this yet.
Go SDK
Task
- Dominant language
- Go
- Stars
- 26
- Forks
- 6
- Avg merge
- 5h 33m
- Merged PRs (30d)
- 9
Description
We've been making some changes to the OpenAPI generation logic per RFD-614 but we should document our design in this repository so that both humans and LLMs can benefit from it. We don't want to make a decision today and then next week forget the decision.
Things to cover.
- How OpenAPI concepts (e.g.,
nullable,required) translate into Go types. - How we handle enums.
- When we decide to use pointer or value receivers for methods.
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 reading RFD-614 and tracing the existing OpenAPI generation logic in this Go SDK; the issue does not name a file or test. Document how nullable and required concepts map to Go types, how enums are handled, and when pointer or value receivers are used, with the written design serving as the completion check.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100