search

somakeit / smib

1 stars 0 forks source link

Add/improve Swagger docs in fastapi #9

Closed sam57719 closed 3 months ago

sam57719 commented 5 months ago

Utilise the fastapi swagger documention capabilities

sam57719 commented 4 months ago

@sjefferson99 you seem better at documentation than myself - any pointers? I cant think of the words to put (see the branch)

sjefferson99 commented 4 months ago

@sam57719 Not being familiar with fastAPI or swagger beyond occasionally consuming it elsewhere, I'm not sure what the actual outcome of this issue will look like. Is it along the lines of if you go to /doc you get swagger and you can use it to make API calls (insert link to swagger general docs) or something more smib specific? Can discuss on Wednesday and get something written up.

sam57719 commented 4 months ago

Mainly talking about the readme.md file - which is getting pulled into the head of the swagger docs