OpenAPITools / OpenAPITools/openapi-generator

[REQ] Example validation in OpenApi definition

Offen
#14,101 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Enhancement: Feature
Vorherrschende Sprache
Java
Sterne
26.8k
Forks
7.7k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

Describe the solution you'd like

Validation of examples declared in yaml definition. I would like to declare an example that is checked with schema defined in API response definition.

Additional context

https://stackoverflow.com/questions/74546598/openapi-generator-is-it-possible-to-declare-schema-of-example

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Das Issue nennt keine Dateien, Tests oder Einstiegspunkte. Beginne damit nachzuverfolgen, wie OpenAPI-YAML-Beispiele und API-Antwortschemas geparst und validiert werden, und sieh dir anschließend den verlinkten Stack-Overflow-Kontext an. Als abgeschlossen gilt die Aufgabe, wenn deklarierte Beispiele anhand des Antwortschemas geprüft werden und es Abdeckung für gültige und ungültige Beispiele gibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java, openapi
Bereich
api
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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