Wie in einer API zu definieren, seit welcher Version ein Pfad/Parameter unterstützt wird

Question

Wir haben eine wachsende swagger API/openAPI und für die Dokumentation von Änderungen dokumentieren wir gerne auf einem Pfad oder Parameter (und vielleicht Definition) seit welcher Version der API ist verfügbar.

Die Swagger-Spezifikation kennt das Feld info.version, aber auf paths oder parameters konnte ich nicht etwas finden, das sich auf diese Version bezieht.

Vielleicht beginnend mit einem x-... wie x-since könnte hilfreich sein. Zumindest scheitert die Validierung nicht daran, sie zu verwenden.

Aber gibt es vielleicht eine vorhandene Implementierung für diesen Anwendungsfall?

Answer 1

Mir ist kein vorhandenes Attribut in OpenAPI/Swagger 2.0-Spezifikation bekannt, um Ihre Anforderungen zu erfüllen, also sollten Sie mit Herstellererweiterungen gehen (x-since, x-created-on, x-created-by, usw.)