oxidecomputer / oxidecomputer/dropshot
enum openapi descriptions
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.2k
- Forks
- 104
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 22
Description
This is a nice to have but in the OpenAPI spec since individual items in an enum don't have a "description" field would be cool, if JSONSchema or whatever the backend is here, took all those individual comments and made one much longer description for the entire summary including them
cc @ahl for if this is possible
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
The issue names no files, tests, or entry points. Start by locating the OpenAPI schema generation for Rust enums and checking how individual enum comments are represented; done means the generated specification includes those comments in the enum's overall description, with coverage for the relevant output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, rust
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100