rstudio/plumber

Use `openapi-schema-validator` for `validate_api_spec()`

Open

#817 geöffnet am 9. Aug. 2021

Auf GitHub ansehen
 (0 Kommentare) (1 Reaktion) (0 zugewiesene Personen)R (257 Forks)batch import
difficulty: intermediateeffort: lowhelp wantedpriority: mediumtheme: OpenAPI

Repository-Metriken

Stars
 (1.437 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

Found while resolving #796

npmjs.com/package/openapi-schema-validator has added support for OAS v3. (Live) Example: runkit.com/embed/fitj6h1o17e8

Describe the problem in detail

swagger-parser does not validate OAS v3. https://github.com/APIDevTools/swagger-parser/issues/164#issuecomment-895261437 This is 😢 .

openapi-schema-validator does validate OAS v3 and has a quarter million downloads a week. Should work fine.

Plan, remove swagger-validator and use openapi-schema-validator instead.

Contributor Guide

Research-Richtung
Untersuche die aktuelle Verwendung von swagger validator in der Codebasis von plumber, wahrscheinlich im Validierungsmodul. Überprüfe die Dokumentation und API des openapi schema validator Pakets. Implementiere den Ersatz in der Funktion validate api spec. Stelle sicher, dass OAS v3 Unterstützung hinzugefügt wird. Teste mit OAS v2 und v3 Spezifikationen.
Tech Stack
javascriptnodejs
Domain
api
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Gitnpm
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70