Vorschau: Diese Dokumentation beschreibt die WorkLogx Public API V1. Die Bereitstellung von V1 in der Produktionsumgebung ist noch nicht abgeschlossen.

Offene Backend-Findings

Nicht Teil des API-Vertrags. Diese Seite listet bekannte Abweichungen zwischen dem aktuellen Backend-Verhalten, der OpenAPI-Spezifikation und dem vorgesehenen V1-Vertrag. Die Punkte sind offen und können sich ändern. Bauen Sie keine Integrationen, die vom hier beschriebenen Verhalten abhängen.

Die Leitfäden beschreiben das aktuelle, geprüfte Verhalten. Wird ein Finding im Backend behoben, werden Leitfäden, OpenAPI-Snapshot, Tests und diese Seite gemeinsam aktualisiert.

#Verhaltens-Findings

ID	Finding	Status
BF-1	`conflict`-Fehler werden mit HTTP-Status 400 statt 409 geliefert.	Offen, Backend-Entscheidung ausstehend
BF-2	Der `Location`-Header von `201 Created`-Antworten enthält `/v1/<resource>/<id>` ohne das `/api`-Präfix der öffentlichen Basis-URL.	Offen
BF-3	Fehlerhafte Eingaben (eine ID, die keine UUID ist, ein ungültiger Datums- oder Zeitparameter, ein Request-Body ohne gültiges JSON) führen möglicherweise zu `500 internal_error` statt zu einem `4xx`-Fehler.	Nicht verifiziert: aus dem Code abgeleitet, nicht durch einen Laufzeittest bestätigt
BF-4	`400 invalid_api_client` kann bei Anlege-Anfragen auftreten, wenn der API Client in einem internen Zustand ist, den die Integration nicht ändern kann.	Offen
BF-5	Das Feld `detail` in Problem-Antworten wird nie gesetzt.	Offen, optional

#Findings in der OpenAPI-Spezifikation

Die API-Referenz wird aus einem eingefrorenen Snapshot der Spezifikation erzeugt. Folgende Abweichungen sind bekannt und werden in der Referenz nicht korrigiert:

ID	Finding
OAS-1	Die Spezifikation nennt eine `http://`-Server-URL. Die Referenz zeigt den HTTPS-TEST-Server als Vorschau.
OAS-2	`POST`-Operationen sind mit Status 200 dokumentiert. Die API liefert `201 Created`.
OAS-3	Fehlerantworten sind nicht als `application/problem+json` dokumentiert; einige verweisen auf fremde Seiten-Schemas.
OAS-4	Die Spezifikation enthält ein internes `bearerAuth`-Schema (JWT). Public-API-Anfragen nutzen ausschließlich API Keys.
OAS-5	Benötigte Scopes stehen nur in den Beschreibungen der Operationen, nicht maschinenlesbar.
OAS-6	Tag-Namen tragen das Präfix „Public API –“.

#Umgang mit diesen Findings

conflict (BF-1) anhand des code behandeln, nicht anhand des HTTP-Status.
Ressourcen-URLs aus Basis-URL und zurückgegebener id bilden, nicht aus Location (BF-2).
IDs und Datumswerte vor dem Senden selbst prüfen (BF-3).
Für erfolgreiche POST-Anfragen unabhängig von der Referenz 201 erwarten (OAS-2).