Add swagger docs for API

[comoser]

We have a postman collection in the repository, and that's great for developers. But, there may be people that want to only build the UI and don't want to rely on the postman collection to get the endpoint information.

We need to add swagger annotations appropriately to every endpoint in order to publish an open API doc for whoever wants to consume it.

[jeffugo]

Hi @comoser I'd like to work on this.

[comoser]

Hi @comoser I'd like to work on this.

Hey @jeffugo! Feel free to pick it up, the main thing here is that it's important to expose the request and response DTOs in the controller docs for swagger.

Also, it would be good to have the authentication with the bearer token working to test the endpoints swagger provides.

[jeffugo]

Alright, @comoser. If I may, I'll ask for clarity where I need it.

[comoser]

Alright, @comoser. If I may, I'll ask for clarity where I need it.

Anytime you have any kind of doubt, reach out to me of course, we can clarify those here @jeffugo

[jeffugo]

Alright @comoser. Thank you.

[jeffugo]

Hi @comoser. I'm sorry you haven't heard from me. Been trying to figure this out in the past few days. Couldn't find any resources online to help. It appears this is a tad too technical for my skill set.

[comoser]

Hi @comoser. I'm sorry you haven't heard from me. Been trying to figure this out in the past few days. Couldn't find any resources online to help. It appears this is a tad too technical for my skill set.

@jeffugo The solution is technical, although the result is documentation. The solutions is mostly given by the documentation of the framework used to build the API: https://docs.nestjs.com/openapi/introduction

Following that gives the first steps to solve this issue, but indeed it requires a bit of technical knowledge.

[jeffugo]

Thanks @comoser for the link. I'll go through the resource and see if I understand it enough to go ahead. I'll let you know.

[comoser]

@jeffugo how do you fare on this issue? :)

[jeffugo]

Hi @comoser. I'm just getting around to studying the resource you sent. It's too technical for my current skill set. I'm so sorry for the delay and the inconvenience this may have caused.

[comoser]

Hi @comoser. I'm just getting around to studying the resource you sent. It's too technical for my current skill set. I'm so sorry for the delay and the inconvenience this may have caused.

There's no inconvenience at all! Feel free to take your time and understand the issue. I just wanted to know if you were still invested in it, given that it's more technical than you thought :)