OpenAPI Spec Längenbeschreibung
Description of the bug:
- In der Destination hat die KeyID (
encryptionKid
) eine Maximallänge von 64 Zeichen - Der Endpunkt zum Abrufen des Schlüssels definiert die
keyId
mit maximal 36 Zeichen - Im Body des Endpunkts ist die
keyId
wieder mit 64 Zeichen definiert.
Current behavior:
wir haben derzeit ein fehlerhaftes Verhalten in der Validierung von KeyIDs beim Abfragen von Destination Informationen. In der Doku (https://docs.fitko.de/fit-connect/docs/apis/submission-api) ist folgendes vermerkt: Der Endpunkt /v1/destinations/{destinationId} beschreibt in seinem Schema für das Attribut encryptionKid eine max. Länge von 64 Zeichen. Der Endpunkt /v1/destinations/{destinationId}/keys/{keyId} definiert das Attribut kid ebenfalls aber mit maximal 36 Zeichen. Dies führt bei uns dazu, dass die Validierung des Keys sporadisch fehlschlägt. Gibt es einen Grund, dass die max. Stringlänge dort unterschiedlich ist, oder ist das ein Bug in Ihrer OpenAPI Spezifikation?
Expected behavior:
Die keyId
hat überall die gleiche Maximallänge.
Da die Key-ID keine UUID sein muss, sind Längen >36 Zeichen plausibel.
Daher sollte die Maximallänge 64 Zeichen sein.
Environments:
Additional Information:
Dependency / relationship to other issues:
Responsible person / team:
Contact persons including contact details:
Screenshots / Logs / Requests:
Checklist:
-
Add Severity label -
Add team label -
Related/affected issues/stories/epics linked and explained in the bug issue -
Creation of an automated test -
Bugfix deployed on DEV -
Bugfix tested on DEV -
Bugfix deployed on TEST -
Bugfix tested on TEST (possibly also by the connection project itself) -
Successful fix reported to Team Operations (Teams channel) -
Bugfix deployed on STAGE -
Bugfix tested on STAGE if necessary -
Bugfix deployed on PROD -
Bugfix tested on PROD (possibly also by the connection project itself) -
Final communication by Team Operations if necessary -
Internal documentation was checked and updated if necessary -
External documentation has been checked and updated if necessary -
Updated changelog if necessary
Approach/Solution:
-
Im Endpunkt GET /v1/destinations/{destinationId}/keys/{keyId}
der Submission API wurde der Path ParameterkeyId
in "8 to 64 chars" geändert. -
Im der Destination wurde eine Minimallänge von 8 Zeichen für encryptionKid
gesetzt. -
Die geänderte Submission API wurde als neue Patchversion released.