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

Beispiele in examples/ sind fehlerhaft/veraltet #61

Closed stefanschramm closed 10 years ago

stefanschramm commented 10 years ago

Die Beispiele in examples/ entsprechen nicht der Spezifikation. In koerperschaft.json fehlt z.B. das Feld "id" oder in person.json das Feld "last_modified", welche laut aktuellem Stand der Spezifikation nicht optional, sondern erforderlich sind.

Um Irritationen zu vermeiden schlage ich vor, dass examples/ entweder komplett gelöscht wird, oder aber mit den original-Beispielen aus der Spezifikation befüllt wird - es wäre sowieso hilfreich, wenn die Dateinamen den englischsprachigen Begriffen entsprechen würden.

Ich habe hier ein Script angelegt, welches versucht die Beispiele aus der aktuellen Version des Markdown-Dokuments (chapter_02.md) zu extrahieren, könnte evt. dafür genutzt werden: https://raw.github.com/stefanschramm/oparl-utils/master/extract_examples.py

marians commented 10 years ago

Danke für das Feedback! Du hast Recht, die Beispieldateien werden aktuell nicht gut gepflegt.

marians commented 10 years ago

Aktuellere Beispieldaten können hier beim Referenz-Server gepflegt werden:

https://github.com/OParl/reference-server

Siehe da die Datei data.json. Ziel der Datei ist es nicht, als einzelne ein übersichtliches Beispiel zu bieten. Übersichtlicher wird es, wenn man den Referenz-Server betreibt und dann z.B. http://127.0.0.1:5000/bodies/0 aufruft.

marians commented 10 years ago

Der Reference Server ist inzwischen öffentlicher unter http://refserv.oparl.de/ erreichbar.

Die Beispiele im specs-Respository werden gelöscht.