oxidecomputer / oxidecomputer/openapi-lint

Allow rules to be ignored, or document how to ignore a rule

Open
#17 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
12
Forks
4
PR merge metrics
No merged PRs in 30d

Description

I'd really like to use this to lint my openapi docs, but there are some of your rules that I can't follow. It would be great if there was a way to ignore particular rules or otherwise configure them. When documenting an existing API for example, making it compliant with your naming rules would break API compatibility. Thanks!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Begin by locating how openapi-lint applies rules and whether configuration is documented; done means either a documented way to ignore individual rules or an agreed implementation for configuring them without breaking API compatibility.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, rust
Domain
api, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.