Pagination
Warum machen wir das?
Relevante Links
- Umsetzung in der Routing-API: https://git.fitko.de/fit-connect/routing-api/-/blob/main/schemas/route-result.yaml
Akzeptanzkriterien
Funktionale Anforderungen
-
In der API Spec ist Pagniation für folgende Endpunkte spezifiziert
-
Pagination ist im Endpunkt
get /destinations
umgesetzt -
Pagination ist im Endpunkt
get /submissions
umgesetzt -
Pagination ist im Endpunkt
get /submissions/.../events
umgesetzt -
Query Parameter
limit
undoffset
für die entsprechenden Pfade hinzufügen
-
Pagination ist im Endpunkt
-
Es gibt eine Spectral-Regel, die prüft, ob Pagination umsetzt ist
- Spectral-Regel wird Upstream bei den Italienischen Regeln contributed: https://github.com/italia/api-oas-checker/issues/145
Nicht-funktionale Anforderungen
Definition of Done
- Dokumentation:
- API-Changes sind für Konsumenten der API dokumentiert
- Prozessänderungen sind für Konsumenten der API dokumentiert
- Code:
- Code Qualität & Formatierung eingehalten
- Commits orientieren sich an Conventional Commits
- Bei neuen Dateien sind Lizenz- und Urheberrechtshinweise gemäs der REUSE-Spezifikation vorhanden
- Leistung:
- Code ist in einer Testinstanz deployt
- Es gibt keine bekannten Bugs
- Testen:
- Alle funktionale Anforderungen sind durch Testfälle abgedeckt
Kann die Story umgesetzt werden? (Definition Ready)
- Ist für jeden Beteiligten klar verständlich
- Ist geschätzt
- Hat Akzeptanzkriterien
- Von der API-Änderung betroffene Softwareartefakte sind im Durchführungsplan identifiziert
Durchführungsplan
Betroffene Softwareartefakte
- Zustelldienst
- Self-Service-Portal
- OAuth Dienst
- Token Validator
- Software Tools und SDKs für Entwickler
Umsetzungsschritte
- ...
- ...
- ...