[WLANnews] Neue API Version! Updated eure Dateien

[Andreas Bräu]

> 
> Mir ist bewusst, dass das json ist, aber ich habe nicht jedesmal lust, 
> wenn die
> api sich ändert, den ganzen generator zu befüllen, um mir ein 
> vollständiges
> Bespiel zu erzeugen, von dem ich dann die scripts ableiten kann.
> Es ist extrem schwer, dann noch die Unterschiede zwischen den json 
> versionen erst
> zu ermittelen.

du kannst im Generator deine alte JSON-Datei auswählen und validieren
lassen. Wenn Felder nicht mehr konform sind, sagt es dir der Generator
und du kannst sie hinzufügen oder ändern.

> 
> >> beinhaltet die Struktur "Kommentar-elemente" , um die Dokumentation
> >> direkt ins json zubringen?
> > das steht eigentlich alles im Schema drin.
> das generierte json schema enthält keine beschreibungen und dokumentiert 
> sich
> somit nicht. Wenn ich dann immer gezwungen bin den generator mit daten 
> zu befüllen,
> um die zuordung im json file zu erraten, verzichte ich lieber auf eine 
> aktualisierung
> der api und bleibe bei einer alten version.
> Der zeitliche Aufwand eine fehlerfreie anpassung zu garantieren ist dann 
> einfach zu hoch.

Schema <> API-File. Das Schema spezifiziert, wie das API-File aussehen
soll. Das Schema, aus dem wir dann auch den Generator erzeugen enthält
die Beschreibungen zu den Feldern so gut es geht. In die generierte
Datei gehören auch keine Kommentare und Beschreibungen, dazu ist das
Schema da.
Für unsere Datei in Weimar habe ich die Anpassung auch so vorgenommen,
dass ich sie in den Generator geladen und die notwendigen Änderungen
durchgeführt habe. Dauer: 2 Minuten.
Die automatischen Aktualisierungen, die wir laufen lassen brauchten gar
keine Anpassung, da sie nur die Felder, die notwenig sind ersetzen, bei
uns sind das die Nodeanzahl und die Services.
Was habt ihr alles angepasst?

> 
> Ich schätze die idee des generators, aber für die authoren, der api 
> sollte es doch leicht
> sein, ein vollständiges json file mit kommentar elementen in jedem zweig 
> (die optional sind)
> zu erzeugen. zumal die api ja sowieso mit vollständigen datensätzen 
> getestet werden muss und
> die files somit ja vorhanden sein müssten.

Wenn du die Muse hast, kannst du gern ein Beispiel komplett ausfüllen.
Wir checken das dann im Github ein.
> 
> Es gäbe auf jedenfall mehr freiheit, und beschränkt die nutzung nicht 
> auf die notwendigkeit
> des generators.

Ui, jetzt holst du die ganz große Keule raus :-) Der Generator ist nur
ein Hilfsmittel, um eben solche Dateien anzulegen oder zu aktualisieren.
Nicht, um Freiheiten zu nehmen.

Liebe Grüße

Andi
-------------- nächster Teil --------------
Ein Dateianhang mit Binärdaten wurde abgetrennt...
Dateiname   : smime.p7s
Dateityp    : application/x-pkcs7-signature
Dateigröße  : 5546 bytes
Beschreibung: nicht verfügbar
URL         : <http://lists.freifunk.net/pipermail/wlannews-freifunk.net/attachments/20140708/339a38de/attachment.bin>