BF: Dokumentation der Nutzung des Parsers verbessern

Ursprüngliche Anfrage:

Als Methode der Endpukte /parse/file und /parse/string wird in der Dokumentation "GET" angegeben, in den Tests jedoch client.post verwendet. Ausserdem fehlt die Datei docs/template/input-output.md im Repository.

---

Fehler

Als Nachutzer habe ich einen Fehler(Bug) in der Dokumentation gefunden, der behoben werden muss. Dazu liefere ich in dieser Vorlage bei allen kursiv beschriebenen Fragen/Unterpunkten alle relevanten Informationen für die Entwicklenden mit.

Bugbeschreibung

1. Die nicht funktionierende Verlinkung der Datei docs/template/input-output.md sollte nicht mehr in der Readme verlinked sein, da diese Datei kein Bestandteil der durch das Template zentral gesteuerten Dokumentation ist.

2. Das "GET" in api.md ist ein Fehler. Hier sollte entsprechend der endpoints.py für "parse/string" und "parse/file" "POST" stehen und der auf die Tabelle folgende Text sollte geprüft werden (bsw. Bennenung "parse/string" vs. "parse/text" korrigieren).

Reproduzierbarkeit

Blick in die Readme des Parsers

Erwartetes Verhalten

Als Nachutzer möchte ich eine inhaltlich korrekte und vollständige Dokumentation des Microservices haben.

Priorität

Mittel

Screenshots/Fehlermeldung des Systems