Rule "ibm-success-response-example" fails for some operations but not others

Offen
#643 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
32/100
Issue-Typ
Bug
Klarheit
Muss geklärt werden
Aktivitätsstatus
Veraltet
Tech-Stack
javascript, openapi
Bereich
api, tooling

Rechercherichtung

Beginne damit, das Verhalten der Regel „ibm-success-response-example“ mit Operationen zu reproduzieren, deren Antwortschemas die Prüfung bestehen bzw. nicht bestehen, und vergleiche diese Schemas anschließend mit den Beispielen, die Swagger UI generiert. Im Issue werden keine Dateien oder Tests genannt, daher ist das Auffinden der Implementierung der Regel und der relevanten Testabdeckung der erste Schritt. Als abgeschlossen gilt die Aufgabe, wenn entweder eine klare Erklärung der fehlenden Schemaanforderungen oder eine definierte Änderung am Validator vorliegt und Tests die unterschiedlichen Operationen abdecken.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

I'd like to understand why the above rule complains for some operations, but not others, even if I haven't explicitly defined examples in any of the api responses.
It seems that in some cases the rule accepts that an example can be generated based on the schema of the response, and in other cases the schema is not enough.

Is there a way to tell what's missing from the inadequate schemas?

Also, Swagger UI shows auto generated examples for all my operations, so it's difficult to understand what's missing from some schemas

Vorherrschende Sprache
JavaScript
Sterne
635
Forks
98
Ø Merge
1 T. 5 Std.
Gemergte PRs (30 T.)
8

Entwicklungsumgebung

Erste Schritte

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

Mehr aus IBM/openapi-validator

Alle Issues in IBM/openapi-validator

Ähnliche Issues

Weitere Issues zu JavaScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.