OpenAPI

OpenAPI-Spezifikation und API-Referenz.

Die ARD Eventhub-APIs sind im OpenAPI-Format dokumentiert (ein standardisiertes, sprachunabhängiges Interface für RESTful APIs).

API-Referenz in diesen Docs

Die Spezifikation aus openapi.json wird in diesen Docs als API-Referenz gerendert — eine Seite pro Operation, durchsuchbar und in llms.txt enthalten.

Spezifikation pflegen

Request-/Response-Schemas leben als Zod-Schemas unter src/schemas/. Path-Metadaten und die Dokument-Assembly liegen in src/openapi/document.ts.

Nach Schema- oder Path-Änderungen regenerieren:

just openapi

Das schreibt openapi.json via z.toJSONSchema(..., { target: 'openapi-3.0' }) und formatiert die Datei.

Named Zod-Schemas (.meta({ id })) werden nach components.schemas gehoben und als #/components/schemas/{id} referenziert. Ohne diesen Schritt bleiben Untertypen wie mediaItem in der API-Referenz nur ein Name ohne Felder.