Pattern nicht referenzieren

Im Dokument (document.json) wird bei der Property "signature" als Pattern eine Referenz auf base64url.json gesetzt:

    "signature": {
      "pattern": {
        "$ref": "../common/base64url.json#/pattern"
      },
      "type": "string",
      "description": "Sofern der Antragstellers dieses Dokument signiert hat, wird die Signatur hier base64url-encoded eingebettet"
    }

Dies führt beim Swagger-Codegen und dem OpenAPI-Generator zu Fehlern. Um die Codegenerierung zu erleichtern sollte das Pattern daher dorthin kopiert werden:

    "signature": {
      "type": "string",
      "description": "Sofern der Antragstellers dieses Dokument signiert hat, wird die Signatur hier base64url-encoded eingebettet",
      "pattern": "^[a-zA-Z0-9-_=]+$"
    }

Die Spezifikation sollte auf weitere Pattern-Referenzen geprüft werden. Auch werden damit einige Modelle nicht mehr referenziert und können entfernt werden.

added 1 deleted label

changed the description

26.08.2020:

• Verifizieren, dass $ref für Pattern zulässig ist (OpenAPI 3.0)
• Es sollte ein Ticket bei den Code-Generatoren geöffnet werden.
• Automatische Pipline für Tests aufbauen
• Liste der unterstützten Generatoren dokumentieren; vorerst Java und C#

changed milestone to %beta7

added 1 deleted label and removed 1 deleted label

added 1 deleted label and removed 1 deleted label

assigned to @Andreas_Huber

mentioned in commit 1d814f70

Gibt es hier schon einen neuen Stand?

Die einzige vorhandene Referenz wurden in dem verlinkten Commit 1d814f70 entfernt. Wir könnten darüber hinaus eine Regel mit Spectral ergänzen, die prüft, dass keine Referenzen auf Patterns eingebaut werden. Das würde ich aber als separates Issue aufmachen.

Ja, die anderen Punkte gerne in eigenen Issues bearbeiten.

closed

marked this issue as related to #48 (closed)