Modellierung in Self-Service API (1.0.0) möglicherweise nicht standardkonform - bitte prüfen.
Zusammenfassung
Die Modellierung in Self-Service API (1.0.0) möglicherweise nicht standardkonform und sollte auf konforme Beschreibung geprüft werden.
Das Self-Service API (1.0.0) definiert destinationId
unter components/parameters
. Der Typ wird in diversen Schemas, z.B. CreatedDestination
wiederverwendet. Das ist möglicherweise nicht standardkonform.
Der Abschnitt components/parameters
ist laut verbaler Beschreibung der OpenAPI-Spezifikation (OAS) ausschließlich für "Reusable path, query, header and cookie parameters" (https://swagger.io/docs/specification/components/) vorgesehen. Laut OAS (https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md) sind Referenzen auf components/parameters
nur aus einem Pfadparameter oder einem Operationsparameter, aber nicht aus properties
vorgesehen.
Darüber hinaus deutet auch der ungewöhnliche Referenzpfad #/components/parameters/destinationId/schema
auf ein Hilfskonstrukt.
Infolge der nicht standardkonformen Verwendung scheitert die Generierung von Domain-Objekten.
Deshalb bitte den Typ destinationId
in den Abschitt components/schemas
verschieben und den Rest entsprechend anpassen.
Schritte zum Reproduzieren
- ...
- ...
- ...
Wie verhält sich der aktuelle Fehler?
Was ist das erwartete richtige Verhalten?
Relevante Protokolle/Screenshots/Anfragen
Akzeptanzkriterien zur Fehlerbehebung
- [ ]
- [ ]
- [ ]