Specifikace API

[JanMeritus]

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]

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:

• https://www.django-rest-framework.org/api-guide/schemas/
• https://www.django-rest-framework.org/topics/documenting-your-api/

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]

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]

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

[Fasand]

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é