RSS-Feed konzipieren
Warum machen wir das?
Motivation: Am 02.05.2023 erwähnte Volker Schmitz die Notwendigkeit eines RSS-Feeds, der besser als der im FIM-Portal sei.
Entwurf einer User Story: Als nutzende Person eines Redaktionssystems (=Editor für Dokumentsteckbriefe oder Datenschemata) oder FIM-Portals möchte ich, dass eine Liste der in einem auswählbaren Zeitraum geänderten Ressourcen des Sammelrepository angezeigt werden, sodass ich über Modellierungsaktivitäten (auch in anderen Themenfeldern, Bundesländern etc.) auf dem Laufenden sein kann.
Zusätzliche Anforderungen von d-nrw aus fim-portal-relaunch-forum#47:
- Statusänderung (Silber/Gold)
- Schlüsseländerung
- Neue Leistung
- Wegfall von Leistungen
- Neuer Stammtext/geänderter
- Filterbar oder abonnierbar nach Themenfeldern (OZG) oder OZG-IDs
Zusätzliche Anforderungen des Bausteins Datenfelder aus fim-portal-relaunch-forum#3
Über den RSS-Feed des FIM-Portals werden für den FIM-Baustein Datenfelder momentan keine Informationen übertragen, hier könnte die Überarbeitung des FIM-Portals Abhilfe schaffen. Es erscheint momentan ein Feed (ohne Informationen) wenn ein neues Element veröffentlicht wird. Hier muss dringend ergänzt werden Pflichtattribute
-
Name des veröffentlichten Elements
-
Tags für Detailierungsstufe und Anwendungsgebiet
-
ID des veröffentlichten Elements
-
Status des veröffentlichten Elements
-
fachlicher Ersteller des veröffentlichten Elements
-
letzte Aktualisierung
-
Handlungsgrundlage einfache Ergänzung
-
den Namen des Bundeslandes, welches ein neues Element veröffentlicht hat, identifizierbar über die Länderschlüssel sehr sinnvoll, aber schwierig umzusetzen Hinweis darauf, was es am veröffentlichten Element neues zu sehen gibt. Beispiele:
-
Es hat sich der Status eines Elements von Gold auf inaktiv geändert.
-
Verwendung eines Baukastenelementes in einer neueren Version.
-
Änderungen an einer referenzierten Codeliste
Relevante Informationen
- Unser Feed könnte das Ergebnis eines
GET
-Requests sein; bei den geringen Performanz-Anforderungen ist Polling ausreichend. Die erforderlichen Daten könnten auf Basis des Upload-Datums von Datenschemata und Dokumentsteckbriefen gewonnen werden. - Unser Feed könnte ein Standardformat wie ATOM verwenden.
- Wir könnten vorhandene Endpunkte wie
GET /api/v0/schema
durch zusätzliche Request-Parameter verwenden oder eigens einen neuen einrichten, dessen Response die für diesen spezifischen Use Case erforderlichen Daten und keine anderen enthält.
Akzeptanzkriterien
-
beim Refinement zu ermitteln -
... -
...