add swagger response body for user #67

[iamsahebgiri]

Description

Added response body for user in swagger UI.

Related Issue

• Document user controller

Fixes # [ISSUE]
#67

Type of Change:

• Code
• User Interface
• New Feature
• Documentation
• Testing

Code/Quality Assurance Only

• Bug fix (non-breaking change which fixes an issue)
• This change requires a documentation update (software upgrade on readme file)

How Has This Been Tested?

Additional Info (OPTIONAL)

Checklist

• My code follows the code style of this project.
• My UI is responsive
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• All new and existing tests passed.
• My changes generate no new warnings
• The title of my pull request is a short description of the requested changes.

Screenshots

Original	Updated
Original	Updated

[Devesh21700Kumar]

@iamsahebgiri APIproperty is not needed as the nest-cli automatically adds it from example comment

[iamsahebgiri]

Thank you for your reply @Devesh21700Kumar.

But nest wasn't showing the response body, so I had to mention it explicitly. Please tell me if I am missing something.

[Devesh21700Kumar]

Thank you for your reply @Devesh21700Kumar.

But nest wasn't showing the response body, so I had to mention it explicitly. Please tell me if I am missing something.

yeah.. you have to tun the command nest start instead of npm start or npm run dev or any other command
That will compile the nest script correctly.

Lemme show you, (See the pic below)

[Devesh21700Kumar]

Thank you for your reply @Devesh21700Kumar.
But nest wasn't showing the response body, so I had to mention it explicitly. Please tell me if I am missing something.

yeah.. you have to tun the command nest start instead of npm start or npm run dev or any other command
That will compile the nest script correctly.

Lemme show you, (See the pic below)

feel free to ask any other doubt you might have regarding this

[iamsahebgiri]

I totally get it. Now I will have to undo all the commits and then add comments to those classes which lack such comments if exists any.

---

After going through the entire codebase, I got to know that most of the work is already done. If there is any work that you want me to try then do let me know.

There are few questions though -

• Why was the announcement and mentor routes are capitalized? Does it signify anything important?
• Are you planning to add API versioning?
• Any plans to update it to nestjs 8?

[Devesh21700Kumar]

I totally get it. Now I will have to undo all the commits and then add comments to those classes which lack such comments if exists any.

After going through the entire codebase, I got to know that most of the work is already done. If there is any work that you want me to try then do let me know.

There are few questions though -

• Why was the announcement and mentor routes are capitalized? Does it signify anything important?
• Are you planning to add API versioning?
• Any plans to update it to nestjs 8?

Actually they don't have to be capitalised. They had to be converted to lowercase.

Haven't thought about the rest of them.

but you can do the APi versioning and bump to nestjs 8 if you want