search

wlmac / metropolis

William Lyon Mackenzie's online hub for announcements, calendar events, clubs, and timetables
https://maclyonsden.com
GNU Affero General Public License v3.0
21 stars 6 forks source link

write full OpenAPI spec for api3 (look into drf-spectacular & drf-yasg) #246

Open JasonLovesDoggo opened 7 months ago

JasonLovesDoggo commented 7 months ago

drf-spectacular

has been chosen

JasonLovesDoggo commented 7 months ago

https://www.rootstrap.com/blog/automating-django-rest-apis-documentation-made-easy-with-drf-spectacular-part-2 https://www.rootstrap.com/blog/automating-django-rest-apis-documentation-made-easy-with-drf-spectacular-part-1

quite helpful as examples

JasonLovesDoggo commented 7 months ago

For comments https://drf-spectacular.readthedocs.io/en/latest/blueprints.html#polymorphic-models may be needed

JasonLovesDoggo commented 7 months ago

api3 sans api3/obj: @Cqctxs standard api (all endpoints besides api3): @ohi-711 api3 objects: @JasonLovesDoggo