Aufbau der Referenz

Die öffentliche API-Referenz von YOWO7 wird aus der OpenAPI-Spezifikation aufgebaut. Diese Felder bestimmen die Seiten.

Seiten

• tags wird zur Gruppe.

• Jeder Eintrag unter paths mit seiner Methode (get, post, put, patch, delete) wird zur Unterseite dieser Gruppe.

• components.schemas liegt unter Schemas.

• components.securitySchemes steht auf der Seite Authentication.

Titel

summary ist der Seitentitel. Fehlt summary, setzt sich der Titel aus Methode und Pfad zusammen.

Scope

security nennt den Scope der Operation. Derselbe Scope steht zusätzlich als Satz in description.

Request

Die Felder kommen aus dem Schema von requestBody. Ein gesetztes example wird übernommen. Fehlt es, entsteht das Beispiel aus den Property-Typen.

Fehler

responses mit application/problem+json verweist auf das Schema ApiProblem. Darin stehen type, title, status, code, instance und traceId. Der Katalog x-error-codes listet die Codes der öffentlichen API als code und name.