[Epic] Neukonzeption der Codebeispiele
Warum?
In der Dokumentation gibt es leere Codebeispiel-Tabs. Diese Beispiele würden aber Entwickler viel helfen.
Um die Pflege der großen Zahl von Codebeispielen zu vereinfachen, suchen wir in eine wartbare Lösung für getestete Codebeispiele.
Bsp.: https://docs.fitko.de/fit-connect/docs/getting-started/authentication
Liste von Beispielen:
- OAuth-Token holen
- SETs erstellen und validieren
- Zustellpunkt ermitteln
- Areas/Gebiete ermitteln
- Destination via API ermitteln
- Einreichung anlegen
- Verschlüsseln
- Anlage hochladen
- Einreichung versenden
- Metadatensatz aufbauen (?) - existiert noch nicht
- Status abfragen
- Polling für Submissions
- Prüfung von Callbacks
- Einreichung herunterladen
- Anlagen herunterladen
- Entschlüsseln
- Validierung von Metadaten (?) - existiert noch nicht
Links/Bemerkungen
- JDoodle - Free AI powered Online Coding Platform (von @Martin_Vogel ) müsste im Detail angeschaut werden
Akzeptanzkriterien
-
[ ] Alle Codebeispiele liegen für Java, C# und Curl vor[ ] Alle Codebeispiele sind in Docusaurus-Tabs dargestellt (<Tabs><TabItem>...)[ ] Stellen für zusätzliche Codebeispiele sind markiert und als Issue angelegt
-
Codebeispiele werden nicht mehr manuell in der Doku gepflegt sondern nur noch an einem Ort und automatisch in der Dokumentation dargestellt. -
Es ist sichergestellt, dass die Codebesipiele funktionsfähig sind. -
~~[ ] Alle Codebeispiele erfüllen die ~~ Vorgaben für kryptographische Verfahren
Edited by Laura Elges