search

WebarchivCZ / Seeder

Seeder - Czech webarchive curating tool and public site
MIT License
15 stars 2 forks source link

Specifikace API #599

Open JanMeritus opened 3 years ago

JanMeritus commented 3 years ago

Ahoj,

je mozne popsat APIcko pro verejny i neverejny endpoint pomoci ve standardu OpenAPI prostrednictvim napr. Swaggeru?

vyslovene to nehori, ale kdyz si sa ted uz tim api intenzivne zabyval, bolo by to takove hezke uzavreni

FYI @Fasand @habetpet @mariehaskovcova

Fasand commented 3 years ago

Ahoj, vygenerovat OpenAPI schema a prezentovat ho přes Swagger by neměl být problém, Rest Framework je na to zdá se dobře připraven:

Co jenom prosím myslíš veřejným endpointem? Jsou nyní nějaké API endpointy, které by měly být dostupné veřejně?

JanMeritus commented 3 years ago

verejny - bez autorizace. Zatim by som na tom jenom proved pripravu. Pokud ma @mariehaskovcova nejake datove sady k zverejneni, musi potvrdit, ale dle meho by mozno bylo mozne konzumovat napr seznam zazmluvnenych seminek @mariehaskovcova

mariehaskovcova commented 3 years ago

souhlasím, volně dostupná mohou být nasmlouvaná semínka, tzn. whitelist, což souvisí s issue #467

Fasand commented 2 years ago

Dodělat dokumentaci k API na Github Wiki - vše, co je dostupné, jaké endpointy, co se načítá, co se posílá, co je veřejné/autorizované