oxidecomputer / oxidecomputer/openapi-lint
Require a `summary` on every endpoint
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 12
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
Working on the API docs, running into the issue of us forgetting these on some endpoints.
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 identifies API documentation and OpenAPI endpoints but names no files or tests. Start by reading the existing schema-validation rules and their tests, then trace how endpoints are checked. Done means validation consistently reports an error whenever an endpoint lacks a summary.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100