oxidecomputer / oxidecomputer/omicron
Improve documentation of external API endpoints
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 572
- Forks
- 97
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 96
Description
With #640 we now have both summary and description fields populated in the OpenAPI output. This has made more apparent that our documentation could be more expansive. Perhaps this issue is too broad, but it might make sense for someone at some point to take a big swing through all the endpoints to properly document them. If there is some automation we can put in place (beyond the extant generation of OpenAPI spec and hope that code reviewers maintain a more loquacious standard of documentation) we should do that as well.
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 reviewing the OpenAPI output and the endpoint definitions affected by #640. Determine which external endpoints lack useful summaries or descriptions and whether documentation checks or generation improvements are feasible; done means the endpoint documentation is expanded consistently and any agreed automation is in place.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100