search

OParl / spec

Spezifikation für eine offene Schnittstelle für Ratsinformationssysteme
https://oparl.org
Creative Commons Attribution Share Alike 4.0 International
61 stars 21 forks source link

"Gelöschte Objekte" #395

Closed akuckartz closed 6 years ago

akuckartz commented 6 years ago

[Inhalt ist aus https://github.com/OParl/spec/issues/392#issuecomment-362929374 von #392 kopiert]

Mehrere Ausführungen in dem Abschnitt "Gelöschte Objekte" sind nicht eindeutig, z.B.:

konstin commented 6 years ago

Was ist ein "gültiges" Objekt?

Offensichtlich ein Objekt, dass der Spezifikation entspricht.

Was bedeutet "einfach" gelöscht?

Das wird im Halbsatz dahinter erklärt.

Zu dem Attribut "deleted" steht dort (und in dem ganzen Dokument) nur "Wenn ein Objekt gelöscht wird, muss das Objekt das zusätzliche Attribut deleted: true bekommen". Was ist mit anderen Attributen als "modified", "id", "type", "created": Dürfen die alle entfernt werden oder sind sie möglicherweise weiterhin obligatorisch?

Das ist zwar auch offensichtlich, ich habe es jetzt trotzdem mal in d24d276790c8d3909626d7cc18ae1f714de72f7b dazu geschrieben.

Die Formulierung "Wenn ein Objekt gelöscht wird ... muss das Objekt das zusätzliche Attribut ... bekommen" enthält einen Widerspruch: Ist das Objekt danach gelöscht oder existiert es noch?

Nein, das ist kein Widerspruch: Gelöschte Objekte werden als solche definiert, die deleted: true haben. Das Design Pattern nennt sich soft delete.

Weder in dem Abschnitt noch im Rest des Dokuments taucht das Wort "Update" auf. Das ist nach der Diskussion in #375 (und auch dem Ergebnis #380) etwas überraschend.

In der Spezifikation verwenden wir die deutsche Übersetzung von "Update", d.h. "Aktualisierung". Mit den Erfahrung aus 1.0 und dem konstruktiven Feedback in #392 werden wir darauf auch noch genauer eingehen.

akuckartz commented 6 years ago

Danke für die eine Verbesserung. In Spezifikationen ist es selten ein Problem, dass sie "offensichtliche" Aussagen enthalten. Sehr viel häufiger führt es zu Problemen, dass scheinbar offensichtliche Anforderungen nicht explizit oder klar genug festgelegt werden.