bundesAPI / sofortmassnahmen

Zivilgesellschaftliche Beteiligung zu den „Sofortmaßnahmen Zweites Open Data Gesetz“
96 stars 3 forks source link

Lobbyregister Bundestag #53

Closed jfowl closed 2 years ago

jfowl commented 2 years ago

Vom Lobbyregister des Bundestags kann man sich Suchergebnisse (auch für alle Eintrage, also Suche nach "") und Einzelseiten als JSON herunterladen.

Auch einzelne Ergebnisse können abgefragt werden:

Die Dokumentation sollte aufgrund der Übersichtlichkeit der API nicht zu schwer sein, kann ich auch gerne mal machen.

Weiterführende Links:

AndreasFischer1985 commented 2 years ago

Sehr schön, spannende API und schöne Dokumentation. Kannst du schon absehen, wann du dazu kommen wirst? Ich könnte auch gerne helfen, die Dokumentation der API in Form zu bringen.

jfowl commented 2 years ago

Kannst du schon absehen, wann du dazu kommen wirst?

Ich setze mich jetzt mal daran, das kurz in eine OpenAPI spec umzuwandeln:

https://md.fachschaften.org/zkGRnfU7SBmRcXuJTqWeyg#

wirthual commented 2 years ago

Hi,

Sehr coole Sache.

Hier gibt es ein Repo Template welches hilfreich sein kann :)

Ist noch ziemlich neu, wenn ihr es verwendet und auf Probleme stosst, lasst es mich wissen :+1:

jfowl commented 2 years ago

Wie ist denn der Workflow? Angenommen, ich habe die API-Spec als yaml fertig gestellt. Was nun? Mache ich ein repo bei mir auf und ihr kopiert das dann?

wirthual commented 2 years ago

Ich kann ein Repo unter BundesAPI erstellen das ihr forken koennt.

Was fuer ein Name wuerde hier sinn machen: bundestag-lobbyregister, lobbyregister-bundestag oder nur lobbyregister?

jfowl commented 2 years ago

Was fuer ein Name wuerde hier sinn machen: bundestag-lobbyregister, lobbyregister-bundestag oder nur lobbyregister?

Da es schon einmal bundestag-api gibt, würde ich bundestag-lobbyregister vorschlagen.

wirthual commented 2 years ago

Jap da stimme ich dir zu. Hier ist ein repo dafuer:

bundestag-lobbyregister

jfowl commented 2 years ago

Ich habe das Schema mal soweit vervollständigt, kommt zu normaleren Uhrzeiten noch mal per PR.

wirthual commented 2 years ago

Danke dir. Habs mal gemerged um zu schauen wos noch klemmt.

Der Generator ist irgendwie mit DetailedSearchResults nicht zufrieden:

Exception in thread "main" org.openapitools.codegen.SpecValidationException: There were issues with the specification. The option can be disabled via validateSpec (Maven/Gradle) or --skip-validate-spec (CLI).
 | Error count: 1, Warning count: 0
Errors: 
    -attribute components.schemas.DetailedSearchResults.items is missing

    at org.openapitools.codegen.config.CodegenConfigurator.toContext(CodegenConfigurator.java:556)
    at org.openapitools.codegen.config.CodegenConfigurator.toClientOptInput(CodegenConfigurator.java:583)
    at org.openapitools.codegen.cmd.Generate.execute(Generate.java:433)
    at org.openapitools.codegen.cmd.OpenApiGeneratorCommand.run(OpenApiGeneratorCommand.java:32)
    at org.openapitools.codegen.OpenAPIGenerator.main(OpenAPIGenerator.java:66)

Liegt wahrscheinlich daran das er ein array statt ein object erwartet oder irgendwie anderstherum.

jfowl commented 2 years ago

Ich habe mal einige Dinge in https://github.com/bundesAPI/bundestag-lobbyregister-api/pull/2 ergänzt.