oxidecomputer / oxidecomputer/dropshot
openapi: examples
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.2k
- Forks
- 104
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 22
Description
OpenAPI has a pretty rich interface to provide examples of path, query, and body inputs and responses.
It would be cool to allow developers to specify these. It could make sense to do this in the endpoint macro or with the structures for path, query, body, and response. The former might get a bit redundant, but may also allow for more highly tailored examples that pertain not just to a struct (that may be reused with multiple endpoints) but to the specific endpoint.
In either case, we can validate the example against the struct/schema to make sure the example isn't invalid.
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 reading the endpoint macro and the structures for path, query, body, and response mentioned in the issue. Compare how each could accept endpoint- or struct-level examples, then determine how schema validation would fit. Done means developers can specify OpenAPI examples for these inputs and responses and invalid examples are rejected.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, rust
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100