search

bundesAPI / sofortmassnahmen

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

API-API #68

Open jens-ox opened 2 years ago

jens-ox commented 2 years ago

Aktuell ist das API-Register nicht automatisiert. Gibt es irgendwelche technischen Hürden, die gegen eine Automatisierung sprechen?

Am einfachsten wäre wahrscheinlich ein GitHub-Actions-Cronjob in https://github.com/bundesAPI/apis, der folgendes macht:

wirthual commented 2 years ago

I like that idea!!

If we make it smart, it should check which entries are already there and not override them. This way we could also easily add the office manually at the beginning.

My approach would be using a python script for this, but I am also happy to do it in any other language if it's preferred.

Let me know what you think :)

jens-ox commented 2 years ago

I think the easiest would be to use JavaScript for this, because it can be directly called from GitHub Actions. Also I'm a JS person and don't know lots of Python, so it would be easier for me 😅

wirthual commented 2 years ago

Sounds good to me 😊

Do you want to start a skeleton for it? Happy to contribute in JS as well 👍

jens-ox commented 2 years ago

I'll raise a PR tomorrow morning ☺️

LilithWittmann commented 2 years ago

Hmm. not sure if we really should use the api description automatically. Or if there shouldn't be a seperate api description for the API list which is more user friendly.

Am Fr., 15. Juli 2022 um 16:32 Uhr schrieb wirthual < @.***>:

Sounds good to me 😊

Do you want to start a skeleton for it? Happy to contribute in JS as well 👍

— Reply to this email directly, view it on GitHub https://github.com/bundesAPI/sofortmassnahmen/issues/68#issuecomment-1185605116, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAGZRFVLETP3WXR6S4GO6VDVUFY67ANCNFSM53OFFO7A . You are receiving this because you are subscribed to this thread.Message ID: @.***>

jens-ox commented 2 years ago

Any reason why we can't just make the descriptions provided by the APIs more user-friendly? Also, I found the descriptions (e.g. Autobahn API) to be quite good so far ☺️

wirthual commented 2 years ago

I think taking the description from the file could be a good starting point (Better than leaving it empty I assume).

It should always be possible to overwrite it manually without the script overwriting it again.

jens-ox commented 2 years ago

It should always be possible to overwrite it manually without the script overwriting it again.

That would be nice, not sure if it's desirable though. What description is "true" if the description is manually changed in the output file and and the source repository?

I think that the source of truth should be kept inside the source repository whenever possible. Overwriting it in the output file should be nothing more than an escape hatch.

jens-ox commented 2 years ago

See linked PR in the API repository.

tl;dr:

Next, we should set the deployed Swagger URLs as the project URL for each repo (which is already done for most repos) and add/update repo descriptions. I think those two places are the sanest sources of truth for deploy URL and repo description.