OpenAPI-Spezifikation

Outcome: Complete the task with OpenAPI-Spezifikation (OpenAPI Specification). User context: Eine Partner-API beschreibt `POST /claims` und den dafür erforderlichen Idempotenz-Header. Sie listet außerdem den OAuth-Bereich, JSON-Schema-Regeln, 201- und Problem-Antworten sowie Beispiele mit fiktiven Daten auf. CI blockiert eine brechende Antwort, die nicht dokumentiert war. Generierte Clients werden weiterhin überprüft statt ohne Prüfungen vertraut. Technical concept or control: OpenAPI-Spezifikation (OpenAPI Specification). Why it fits: Verwenden Sie es als Vertrag, den Personen für Dokumentation, Prüfungen, Mock-Server, Client-Generierung und Kompatibilitätstests überprüfen können. Do not use it when: Generierte Dokumente ersetzen keine echten Beispiele, Autorisierungstests, Prüfungen zur Laufzeit oder klares Produktionsverhalten. Engineering requirements: Define inputs, outputs, contracts, and rules that must always hold. Set authorization and input checks. Define failures, timeouts, retries, one-time effects, data moves, and compatibility limits. Operations: Add useful signals and logs that hide sensitive data. Set capacity limits and write an operator guide. Test recovery and rollback. Acceptance criteria: Contract and failure-path tests pass. Data and authorization rules still hold during retries and partial failures. Check performance limits, monitoring, recovery, and rollback. Evidence and limits (evidence boundary): Ein formelles Dokument kann trotzdem ein Entwurf, ein Release Candidate oder die finale Version sein. Prüfe seinen Status und die Browser- oder Plattform-Unterstützung. Unknowns to confirm: Where the code runs, data stores, traffic shape, consistency needs, and the security boundary. Also confirm the compatibility period, service goals, and rollback limits.