Skip to content

Remove duplicate schemas

Jonas Gröger requested to merge remove-duplicates into main

Sieht man sich das generierte Schema an so stellt man fest, dass die Felder in components alle dupliziert sind:

Beispiel aus der generierten Spec in components/schemas:

components:
  schemas: 
    ContactInformation:
      $ref: '#/components/schemas/contact-information'
    contact-information:
      title: Kontakt
      description: Angaben zum Ansprechpartner des Zustellpunktes
      …

Das liegt daran, dass sich Redocly anders als Swagger CLI verhält und die Schemas, Callbacks, etc. (eben alles was gelöscht ist im PR) selbst in die generierte Spec einbaut (was auch eigentlich das bessere Verhalten ist).

Eine Lösung ist, alle Elements aus dem components tree (bis auf securitySchemes) zu löschen. Der Bundler fügt diese dann automatisch hinzu. Allerdings wird dabei eine Namensänderung vorgenommen: ContactInformation -> contact-information.

Die API an sich bleibt kompatibel, es kann nur sein dass wir Codegeneratoren brechen. Das ist aber IMHO kein Breaking Change aus Sicht der API.

Edited by Jonas Gröger

Merge request reports