Fast alle URLs in der aktuellen FIT-Connect API-Doc sind kaputt
Zusammenfassung
In der API-Spec gibt es Links in die Dokumentation. Die sind fast alle Fehlerhaft (z.B. 404).
Schritte zum Reproduzieren
- Link aus der Doku (z.B. in
spec/callbacks/new-events.yaml) https://docs.fitko.de/fit-connect/getting-started/receiving/query anklicken
Wie verhält sich der aktuelle Fehler?
Fehler 404
Was ist das erwartete richtige Verhalten?
Die korrekte Seite
Relevante Protokolle/Screenshots/Anfragen
Alle docs.fitko.de Links in der API-Spec
$ cd submission-api
$ ag https://docs.fitko.de spec
spec/callbacks/new-events.yaml
5: Bei neuen Events im Event Log wird ein Zustellpunkt mit Hilfe dieses Callbacks benachrichtigt. Voraussetzung ist die vorherige Konfiguration der [Callback-URL](https://docs.fitko.de/fit-connect/getting-started/receiving/query#callback).
spec/endpoints/attachments/uuid.yaml
10: [Dokumentation](https://docs.fitko.de/fit-connect/docs/getting-started/receiving/download-submission/) beschrieben
56: ist in der [Dokumentation](https://docs.fitko.de/fit-connect/docs/getting-started/sending/attachments/) beschrieben.
spec/endpoints/cases/events/index.yaml
8: Über diesen Endpunkt kann der [Event Log](https://docs.fitko.de/fit-connect/docs/getting-started/event-log/) eines Vorgangs
58: [hier](https://docs.fitko.de/fit-connect/docs/getting-started/receiving/process-and-acknowledge/) beschrieben ist.
spec/endpoints/destinations/index.yaml
45: Beschreibung ist in der [Dokumentation](https://docs.fitko.de/fit-connect/docs/getting-started/receiving/destination) zu finden.
spec/endpoints/submissions/uuid.yaml
9: Eine Beschreibung, wie diese Daten weiter verarbeitet werden ist [hier](https://docs.fitko.de/fit-connect/docs/getting-started/receiving/download-submission/) zu finden.
spec/callbacks/new-submissions.yaml
5: Bei neue eintreffenden Submissions wird ein Zustellpunkt mit Hilfe dieses Callbacks benachrichtigt. Voraussetzung ist die vorherige Konfiguration der [Callback-URL](https://docs.fitko.de/fit-connect/getting-started/receiving/query#callback).
spec/schemas/destination-public.yaml
40: description: Status des Zustellpunktes. Eine Beschreibung der Status finden Sie in den Detailinformationen unter [Zustellpunktverwaltung](https://docs.fitko.de/fit-connect/docs/details/destination-management).
spec/schemas/patch-destination.yaml
11: description: Status des Zustellpunktes. Eine Beschreibung der Status finden Sie in den Detailinformationen unter [Zustellpunktverwaltung](https://docs.fitko.de/fit-connect/docs/details/destination-management).
spec/schemas/event-log.yaml
3: Dieses Objekt enthält den [Event Log einer Einreichung](https://docs.fitko.de/fit-connect/docs/getting-started/event-log).
5: Der Aufbau und die Bedeutung einzelner Events ist [in der Dokumentation zum Abruf von Events beschrieben](https://docs.fitko.de/fit-connect/docs/getting-started/sending/query-status).
spec/schemas/security-event-token.yaml
5: Der Aufbau und die Bedeutung der Felder sind [in der Dokumentation beschrieben](https://docs.fitko.de/fit-connect/docs/getting-started/event-log/).
spec/schemas/update-destination.yaml
18: description: Status des Zustellpunktes. Eine Beschreibung der Status finden Sie in den Detailinformationen unter [Zustellpunktverwaltung](https://docs.fitko.de/fit-connect/docs/details/destination-management).
spec/submission-api.yaml
9: url: https://docs.fitko.de/fit-connect/contact
13: termsOfService: https://docs.fitko.de/fit-connect/docs/details/terms-of-use-testing/
19: url: https://docs.fitko.de/fit-connect
26: url: https://docs.fitko.de/fit-connect/docs/getting-started/sending/overview
30: url: https://docs.fitko.de/fit-connect/docs/getting-started/receiving/overview
Edited by Jonas Gröger