feat: add --json / --output-format=json flag for structured error output in CI pipelines

Offen

#515 erstellt am 19.6.2026 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 3/5
Geschätzter Aufwand: 1-2 Tage
Anfängerfreundlichkeit: 65/100

Issue-Typ: Feature
Klarheit: Klar beschrieben
Aktivitätsstatus: Ruhig
Tech-Stack: openapi, python
Bereich: api, cli, devtools

Rechercherichtung

Look at the existing CLI output formatters in the codebase, likely in a module like openapi_spec_validator/cli.py or openapi_spec_validator/formatters.py. Study how spectral and vacuum implement JSON output. The first step is to add a --format json argument to the CLI parser and create a new formatter class that outputs structured error objects with the specified fields. Test by running the validator on a sample spec and verifying the JSON output is valid and contains the expected keys.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

The CLI currently outputs human-readable error messages, which works well for interactive use but is harder to parse in CI/CD pipelines or editor integrations.

Issue #160 ("No specific error information available", open since 2022) highlights how vague error messages make debugging difficult. A structured JSON output mode would solve this by emitting parseable error objects with:

path: the location in the spec where the error occurred
message: human-readable description
rule: the specification rule that was violated (e.g. openapi.3.1.schema-validation)
severity: error / warning / info
suggestion: (optional) guidance on how to fix

This could be activated via --format json or controlled through the Python API by passing a structured formatter. Existing validators like spectral (--format json) and vacuum already support this pattern.

The openapi-core ecosystem would also benefit — consumers like prism or openapi-core could consume structured validation results without string-parsing output.

Vorherrschende Sprache: Python
Sterne: 409
Forks: 73
PR-Merge-Kennzahlen: Keine gemergten PRs in 30 T.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus python-openapi/openapi-spec-validator

Unbounded cache in SpecValidator.iter_errors retains validator instances and schemas Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 55/100

python-openapi/openapi-spec-validator#523 · Erstellt am 08.9.2026
Bug: internal library exception is leaked Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100

python-openapi/openapi-spec-validator#511 · Erstellt am 09.6.2026
version 0.7.2 is not compatible with open api version 0.19.4 Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 30/100

python-openapi/openapi-spec-validator#401 · Erstellt am 10.6.2025
Possible Regression: RecursionError validating oneOf/allOf schema in 0.7.2 (works in 0.7.1) Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 42/100

python-openapi/openapi-spec-validator#400 · 1 Kommentar · Erstellt am 10.6.2025
Validation of required fields inconsistent Offen

kind/bug/confirmed

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100

python-openapi/openapi-spec-validator#373 · 1 Kommentar · Erstellt am 09.8.2024

Alle Issues in python-openapi/openapi-spec-validator